反射 Reflection

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

用法

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

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

应用

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

创建内置函数类

1. class FooFunction{
3.     /**
5.      * 获取当前周周一时间戳
7.      *
9.      * @return false|string
11.      */
13.     public static function mondayTimeStamp(){
15.         $targetTime = strtotime('now');
17.         $w = date('w', $targetTime);
19.         $w = ($w == 0 ? 7 : $w);
21.         return mktime(0,0,0, date('m', $targetTime), date('d', $targetTime)-($w-1), date('Y', $targetTime));
23.     }
25.     /**
27.      * 获取当前周周一日期
29.      *
31.      * @return false|string
33.      */
35.     public static function mondayDate(){
37.         return date('Y-m-d', self::mondayTimeStamp());
39.     }
41. }

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

1. // 利用 PHP 反射
3. $reflect = new ReflectionClass('FooFunction');
5. $data = [];
7. // 获取类中的方法
9. $methods = $reflect->getMethods();
11. foreach ($methods as $method){
13.     $methodName = $method->getName();
15.     $methodDocStr = $reflect->getMethod($methodName)->getDocComment();
17.     // 过滤方法注释前面的（*）
19.     $pattern = "/[@a-zA-Z\\x{4e00}-\\x{9fa5}]+.*/u";
21.     preg_match_all($pattern, $methodDocStr, $matches, PREG_PATTERN_ORDER);
23.     $data[] = [
25.         'name' => $methodName,
27.         'doc' => $matches[0]
29.     ];
31. }
33. echo json_encode($data);

结果：

1. [
3.     {
5.         "name": "mondayTimeStamp",
7.         "doc": [
9.             "返回当前周周一时间戳",
11.             "@return false|string"
13.         ]
15.     },
17.     {
19.         "name": "mondayDate",
21.         "doc": [
23.             "返回当前周周一日期",
25.             "@return false|string"
27.         ]
29.     }
31. ]