加入收藏 | 设为首页 | 会员中心 | 我要投稿 阳江站长网 (https://www.0662zz.cn/)- 办公协同、云通信、区块链、物联平台、高性能计算!
当前位置: 首页 > 站长学院 > PHP教程 > 正文

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

发布时间:2022-06-30 09:42:48 所属栏目:PHP教程 来源:互联网
导读:反射 Reflection 反射可以简单理解为扫描类的属性、方法和注释的能力。 用法 PHP 为我们提供了丰富的方法,使我们可以方便的使用。 $reflect = new ReflectionClass(AppFoo); $reflect-getMethods(); // 获取方法的数组 $reflect-getDocComment(); // 获取
  反射 Reflection
 
  反射可以简单理解为扫描类的属性、方法和注释的能力。
 
  用法
 
  PHP 为我们提供了丰富的方法,使我们可以方便的使用。
 
  $reflect = new ReflectionClass('AppFoo');
   
  $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-Zx{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"
   
          ]
   
      }
   
  ]
 

(编辑:阳江站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    热点阅读