利用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"
        ]
    }
]

參考 https://www.php.net/manual/zh...