使用PHP反射機制取得函數文檔

Guanhui
發布: 2023-04-08 15:30:02
轉載
4064 人瀏覽過

反射 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反射機制取得函數文檔的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
php
來源:learnku.com
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板