使用PHP反射机制获取函数文档

反射 Reflection

反射可以简单理解为扫描类的属性、方法和注释的能力。

PHP 为我们提供了丰富的方法，使我们可以方便的使用。

$reflect = new ReflectionClass('App\Foo');
$reflect->getmethods(); // 获取方法的数组
$reflect->getDocComment(); // 获取文档注释
……

应用

有时系统需要向用户提供内置方法文档说明来使用，那么我们则可以通过 PHP 反射实现。

创建内置函数类

class FooFunction{
    /**
     * 获取当前周周一时间戳
     *
     * @return false|string
     */
    public static function mondayTimeStamp(){
        $targetTime = strtotime('Now');
        $w = date('w', $targetTime);
        $w = ($w == 0 ? 7 : $w);
        return mktime(0,0,0, date('m', $targetTime), date('d', $targetTime)-($w-1), date('Y', $targetTime));
    }
    /**
     * 获取当前周周一日期
     *
     * @return false|string
     */
    public static function mondayDate(){
        return date('Y-m-d', self::mondayTimeStamp());
    }
}

扫描内置函数类，生成文档

// 利用 PHP 反射
$reflect = new ReflectionClass('FooFunction');
$data = [];
// 获取类中的方法
$methods = $reflect->getmethods();
foreach ($methods as $method){
    $methodName = $method->getName();
    $methodDocStr = $reflect->getmethod($methodName)->getDocComment();
    // 过滤方法注释前面的（*）
    $pattern = /[@a-zA-Z\\x{4e00}-\\x{9fa5}]+.*/u;
    preg_match_all($pattern, $methodDocStr, $matches, PREG_PATTERN_ORDER);
    $data[] = [
        'name' => $methodName,
        'doc' => $matches[0]
    ];
}
echo json_encode($data);

结果

[
    {
        name: mondayTimeStamp,
        doc: [
            返回当前周周一时间戳,
            @return false|string
        ]
    },
    {
        name: mondayDate,
        doc: [
            返回当前周周一日期,
            @return false|string
        ]
    }
]

推荐教程：《PHP教程》

使用PHP反射机制获取函数文档

相关文章