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

參考 www.php.net/manual/zh/class.reflec...

本作品採用《CC 協議》，轉載必須註明作者和本文連結