创建PHP类大纲

时间:2011-01-22 19:28:54

标签: php architecture object class-design outline

我正在寻找一个可以有效勾画一个类的函数或类:

class MyClass{

  /*
  * Perhaps include the function comments
  * in the function.
  */
  function mainFunction(){
    //Does Something
  } 

  function functionWithArgs($arg1,$arg2=false){
    //Does Something
    //The function I want will give e the arguments w/default values
  }

}

是否存在可以让我对此类甚至文件的信息进行某种访问的函数或库。

离。

get_file_outline('fileWithAboveClass.php');

get_class_outline('MyClass');

有没有人知道,或知道一种轻松写出来的方法?

2 个答案:

答案 0 :(得分:6)

查看PHP Reflection API

//use the ReflectionClass to find out about MyClass
$classInfo = new ReflectionClass('MyClass'); 

//then you can find out pretty much anything you want to know...
$methods = $classInfo->getMethods(); 
var_dump($methods);

//you can even extract your comments, e.g.
$comment=$classInfo->getMethod('mainFunction')->getDocComment();

请注意,要使注释提取起作用,必须将其格式化为PHPDoc / Doxygen注释,并以开头/**

开头

答案 1 :(得分:0)

还有一个命令行选项可用于检查函数和类。

$ php --rc DateTime

将为您提供有关DateTime-class的所有详细信息,而

$ php --rf in_array

将为您提供“in_array”函数的参数。

如果您在编码时使用终端,则可以非常方便地使用而不是一直在PHP手册中查找;)