composer/php-rpc-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

getApiDoc

Browse Source
This commit is contained in:
IT小强xqitw.cn 2018-06-05 18:10:10 +08:00
parent 051cc4f34d
commit 6d98a59014
1 changed files with 54 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/ApiDoc.php
View File

@ -21,12 +21,63 @@ use itxq\apidoc\lib\ParseComment;
*/ */
class ApiDoc class ApiDoc
{ {
/**
* @var array - 结构化的数组
*/
private $ApiTree = [];
/**
* @var array - 要生成API的Class类名
*/
private $class = [];
/**
* @var array - 忽略生成的类方法名
*/
private $filterMethod = ['__construct'];
/**
* ApiDoc 构造函数.
* @param array $config - 配置信息
*/
public function __construct($config) {
// 需要解析的类
if (isset($config['class'])) {
$this->class = array_merge($this->class, $config['class']);
}
// 忽略生成的类方法
if (isset($config['filter_method'])) {
$this->filterMethod = array_merge($this->filterMethod, $config['filter_method']);
}
}
/**
* 获取API文档数据
* @param int $type - 方法过滤，默认只获取 public类型 方法
* ReflectionMethod::IS_STATIC
* ReflectionMethod::IS_PUBLIC
* ReflectionMethod::IS_PROTECTED
* ReflectionMethod::IS_PRIVATE
* ReflectionMethod::IS_ABSTRACT
* ReflectionMethod::IS_FINAL
* @return array
*/
public function getApiDoc($type = \ReflectionMethod::IS_PUBLIC) {
foreach ($this->class as $classItem) {
$this->ApiTree[$classItem] = [
'class' => $this->_getClassComment($classItem),
'action' => $this->_getActionComment($classItem, $type)
];
}
return $this->ApiTree;
}
/** /**
* 获取类的注释 * 获取类的注释
* @param $class - 类名称(存在命名空间时要完整写入) eg: $class = 'itxq\\apidoc\\ApiDoc'; * @param $class - 类名称(存在命名空间时要完整写入) eg: $class = 'itxq\\apidoc\\ApiDoc';
* @return array - 返回格式为数组（未获取到注释时返回空数组） * @return array - 返回格式为数组（未获取到注释时返回空数组）
*/ */
public function getDocComment($class) { private function _getClassComment($class) {
try { try {
$reflection = new \ReflectionClass($class); $reflection = new \ReflectionClass($class);
$classDocComment = $reflection->getDocComment(); $classDocComment = $reflection->getDocComment();
@ -40,7 +91,7 @@ class ApiDoc
/** /**
* 获取指定类下方法的注释 * 获取指定类下方法的注释
* @param $class - 类名称(存在命名空间时要完整写入) eg: $class = 'itxq\\apidoc\\ApiDoc'; * @param $class - 类名称(存在命名空间时要完整写入) eg: $class = 'itxq\\apidoc\\ApiDoc';
* @param $type - 方法过滤，默认只获取 public类型 方法 * @param int $type - 方法过滤，默认只获取 public类型 方法
* ReflectionMethod::IS_STATIC * ReflectionMethod::IS_STATIC
* ReflectionMethod::IS_PUBLIC * ReflectionMethod::IS_PUBLIC
* ReflectionMethod::IS_PROTECTED * ReflectionMethod::IS_PROTECTED
@ -49,7 +100,7 @@ class ApiDoc
* ReflectionMethod::IS_FINAL * ReflectionMethod::IS_FINAL
* @return array - 返回格式为数组（未获取到注释时返回空数组） * @return array - 返回格式为数组（未获取到注释时返回空数组）
*/ */
public function getActionComment($class, $type = \ReflectionMethod::IS_PUBLIC) { private function _getActionComment($class, $type = \ReflectionMethod::IS_PUBLIC) {
try { try {
$reflection = new \ReflectionClass($class); $reflection = new \ReflectionClass($class);
//只允许生成public方法 //只允许生成public方法