Создать план класса PHP

Question

Я ищу функцию или класс, которые могут эффективно обрисовать класс:

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');

Кто-нибудь знает об этом или знает, как это легко написать?

Answer 1

Взгляните на 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, и начать соткрытие /**

Answer 2

Также имеется опция командной строки для проверки функций и классов.

$ php --rc DateTime

предоставит вам все подробности о классе DateTime, а

$ php --rf in_array

даст вам аргументы функции "in_array".

Если вы используете Терминал при кодировании, его может быть очень удобно использовать вместо постоянного поиска в Руководстве по PHP;)