-
Notifications
You must be signed in to change notification settings - Fork 0
/
DocComment.php
309 lines (284 loc) · 7.38 KB
/
DocComment.php
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?php
/**
* This software package is licensed under AGPL, Commercial license.
*
* @package maslosoft/addendum
* @licence AGPL, Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com> (Meta container, further improvements, bugfixes)
* @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
* @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
* @link http://maslosoft.com/addendum/ - maslosoft addendum
* @link https://code.google.com/p/addendum/ - original addendum project
*/
namespace Maslosoft\Addendum\Builder;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;
class DocComment
{
private static $use = [];
private static $useAliases = [];
private static $namespaces = [];
private static $classNames = [];
private static $classes = [];
private static $methods = [];
private static $fields = [];
private static $parsedFiles = [];
public static function clearCache()
{
self::$namespaces = [];
self::$classNames = [];
self::$classes = [];
self::$methods = [];
self::$fields = [];
self::$parsedFiles = [];
}
public function get($reflection)
{
if ($reflection instanceof ReflectionClass)
{
return $this->forClass($reflection);
}
elseif ($reflection instanceof ReflectionMethod)
{
return $this->forMethod($reflection);
}
elseif ($reflection instanceof ReflectionProperty)
{
return $this->forProperty($reflection);
}
}
/**
* Get doc comment for file
* If file contains several classes, $className will be returned
* If file name matches class name, this class will be returned
* @param string $name
* @param string $className
*/
public function forFile($name, $className = null)
{
$fqn = $this->process($name);
if (null !== $className)
{
$fqn = $className;
}
/**
* TODO Use some container here with ArrayAccess interface. Array-like access is *required* here.
*/
$result = [
'namespace' => isset(self::$namespaces[$fqn]) ? self::$namespaces[$fqn] : [],
'use' => isset(self::$use[$fqn]) ? self::$use[$fqn] : [],
'useAliases' => isset(self::$useAliases[$fqn]) ? self::$useAliases[$fqn] : [],
'className' => isset(self::$classNames[$fqn]) ? self::$classNames[$fqn] : [],
'class' => isset(self::$classes[$fqn]) ? self::$classes[$fqn] : '',
'methods' => isset(self::$methods[$fqn]) ? self::$methods[$fqn] : [],
'fields' => isset(self::$fields[$fqn]) ? self::$fields[$fqn] : []
];
return $result;
}
public function forClass($reflection)
{
$this->process($reflection->getFileName());
$fqn = $reflection->getName();
$result = [
'namespace' => isset(self::$namespaces[$fqn]) ? self::$namespaces[$fqn] : [],
'use' => isset(self::$use[$fqn]) ? self::$use[$fqn] : [],
'useAliases' => isset(self::$useAliases[$fqn]) ? self::$useAliases[$fqn] : [],
'className' => isset(self::$classNames[$fqn]) ? self::$classNames[$fqn] : [],
'class' => isset(self::$classes[$fqn]) ? self::$classes[$fqn] : '',
'methods' => isset(self::$methods[$fqn]) ? self::$methods[$fqn] : [],
'fields' => isset(self::$fields[$fqn]) ? self::$fields[$fqn] : []
];
return $result;
}
public function forMethod($reflection)
{
$this->process($reflection->getDeclaringClass()->getFileName());
$class = $reflection->getDeclaringClass()->getName();
$method = $reflection->getName();
return isset(self::$methods[$class][$method]) ? self::$methods[$class][$method] : false;
}
public function forProperty($reflection)
{
$this->process($reflection->getDeclaringClass()->getFileName());
$class = $reflection->getDeclaringClass()->getName();
$field = $reflection->getName();
return isset(self::$fields[$class][$field]) ? self::$fields[$class][$field] : false;
}
private function process($file)
{
if (!isset(self::$parsedFiles[$file]))
{
$fqn = $this->parse($file);
self::$parsedFiles[$file] = $fqn;
}
return self::$parsedFiles[$file];
}
protected function parse($file)
{
$use = [];
$aliases = [];
$namespace = '\\';
$tokens = $this->getTokens($file);
$class = false;
$fqn = false;
$comment = null;
$max = count($tokens);
$i = 0;
while ($i < $max)
{
$token = $tokens[$i];
if (is_array($token))
{
list($code, $value) = $token;
// $tokenName = token_name($code);
switch ($code)
{
case T_DOC_COMMENT:
$comment = $value;
break;
case T_NAMESPACE:
$comment = false;
$tokensCount = count($tokens);
for ($j = $i + 1; $j < $tokensCount; $j++)
{
if ($tokens[$j][0] === T_STRING)
{
$namespace .= '\\' . $tokens[$j][1];
}
elseif ($tokens[$j] === '{' || $tokens[$j] === ';')
{
break;
}
}
$namespace = preg_replace('~^\\\\+~', '', $namespace);
break;
case T_USE:
// After class declaration, this should ignore `use` trait
if ($class)
{
break;
}
$comment = false;
$useNs = '';
$tokensCount = count($tokens);
$as = false;
for ($j = $i + 1; $j < $tokensCount; $j++)
{
$tokenName = $tokens[$j][0];
if (isset($tokens[$j][1]) && $tokens[$j][1] == 'IMatcher')
{
echo 's';
}
if ($tokenName === T_STRING && !$as)
{
$useNs .= '\\' . $tokens[$j][1];
}
if ($tokenName === T_STRING && $as)
{
$alias = $tokens[$j][1];
break;
}
if ($tokenName === T_AS)
{
$as = true;
}
if ($tokens[$j] === '{' || $tokens[$j] === ';')
{
break;
}
}
$use[] = preg_replace('~^\\\\+~', '', $useNs);
if ($as)
{
$aliases[$useNs] = $alias;
}
break;
case T_TRAIT:
case T_CLASS:
case T_INTERFACE:
// Ignore magic constant `::class`
if ($tokens[$i - 1][0] == T_DOUBLE_COLON)
{
break;
}
$class = $this->getString($tokens, $i, $max);
$fqn = sprintf('%s\%s', $namespace, $class);
if ($comment !== false)
{
self::$classes[$fqn] = $comment;
$comment = false;
}
self::$namespaces[$fqn] = $namespace;
self::$classNames[$fqn] = $class;
self::$use[$fqn] = $use;
self::$useAliases[$fqn] = $aliases;
break;
case T_VARIABLE:
if ($comment !== false && $class)
{
$field = substr($token[1], 1);
self::$fields[$fqn][$field] = $comment;
$comment = false;
}
break;
case T_FUNCTION:
if ($comment !== false && $class)
{
$function = $this->getString($tokens, $i, $max);
self::$methods[$fqn][$function] = $comment;
$comment = false;
}
break;
// ignore
case T_WHITESPACE:
case T_PUBLIC:
case T_PROTECTED:
case T_PRIVATE:
case T_ABSTRACT:
case T_FINAL:
case T_VAR:
break;
default:
$comment = false;
break;
}
}
else
{
$comment = false;
}
$i++;
}
return $fqn;
}
private function getString($tokens, &$i, $max)
{
do
{
/**
* TODO Workaround for problem desribed near T_CLASS token
*/
if (!isset($tokens[$i]))
{
$i++;
continue;
}
$token = $tokens[$i];
$i++;
if (is_array($token))
{
if ($token[0] == T_STRING)
{
return $token[1];
}
}
}
while ($i <= $max);
return false;
}
private function getTokens($file)
{
return token_get_all(file_get_contents($file));
}
}