-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassDoc.php
More file actions
133 lines (127 loc) · 3.95 KB
/
Copy pathclassDoc.php
File metadata and controls
133 lines (127 loc) · 3.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?php
// +----------------------------------------------------------------------
// | github: phpth
// +----------------------------------------------------------------------
// | Copyright (c) 2018
// +----------------------------------------------------------------------
// | Licensed MIT
// +----------------------------------------------------------------------
// | Author: luajia
// +----------------------------------------------------------------------
// | Date: 2018/8/13 0007
// +----------------------------------------------------------------------
// | Time: 下午 17:18
// +----------------------------------------------------------------------
namespace phpth\tool;
use ReflectionParameter;
use ReflectionMethod;
use ReflectionClass;
use Exception;
/**
* 类的注释生成工具
* Class classDoc
* @package phpth\tool
*/
class classDoc
{
/**
* @param $class
* @return array|string
* @throws \ReflectionException
*/
public function createDoc($class)
{
$ref_class = new ReflectionClass($class);
$ref_method = $ref_class->getMethods();
$ref_property = $ref_class->getProperties();
// title doc
$doc[] = '/**';
$doc[] = ' * Class '.$ref_class->getName();
$doc[] = ' * @package '.$ref_class->getNamespaceName().$ref_class->getName();
// property doc
foreach($ref_property as $k=>$property)
{
if($property->isDefault())
{
$doc[] = ' * @property mixed $'. $property->getName();
}
}
// method doc
foreach($ref_method as $k=>$method)
{
$params= $method->getParameters();
$param_list = [] ;
foreach($params as $param)
{
$default = $this->getParamDefaultValue($param);
$param_type = $param->getType()?:'mixed';
$param_list[] = $param_type.' $'.$param->name.($default!==false?' = '.$default :null) ;
}
$param_list = join(',',$param_list);
$return_type = $method->getReturnType();
if(!$return_type)
{
$return_type = $this->getReturnType($method);
}
if(!$return_type)
{
$return_type = 'null';
}
$doc[] = " * @method {$return_type} {$method->name}({$param_list}) ";
}
$doc[] = " */\r\n";
$doc = join("\r\n",$doc);
return $doc ;
}
protected function getReturnType( ReflectionMethod $method)
{
$return_type = false ;
$doc_str = $method->getDocComment();
$doc_str = preg_split('/(\/{0,1}\s*\*{1,2}\s+)|(\s+\*\/\s*)/', $doc_str);
foreach($doc_str as $v)
{
if(stripos($v, '@return')!==false)
{
$return_type = preg_split('/\s+/', $v)[1]?:'null';
break;
}
}
return $return_type;
}
/**
* @param ReflectionParameter $p
* @return bool|mixed|string
*/
protected function getParamDefaultValue( ReflectionParameter $p)
{
try{
$value = $p->getDefaultValue();
$type = gettype($value);
switch (strtolower($type))
{
case 'double':
case "integer":
break;
case "boolean":
$value?$value='true':$value='false';
break;
case 'unknown type':
case "string" :
$value = "'{$value}'";
break;
case "null":
$value='null';
break;
case "array" :
$value = '['.join(',',$value).']';
break;
case "object" :
break;
}
return $value;
}catch (Exception $e)
{
return false ;
}
}
}