This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
FileReflection.php
313 lines (277 loc) · 6.86 KB
/
FileReflection.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
310
311
312
313
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Code
*/
namespace Zend\Code\Reflection;
use Zend\Code\Scanner\CachingFileScanner;
/**
* @category Zend
* @package Zend_Reflection
*/
class FileReflection implements ReflectionInterface
{
/**
* @var string
*/
protected $filePath = null;
/**
* @var string
*/
protected $docComment = null;
/**
* @var int
*/
protected $startLine = 1;
/**
* @var int
*/
protected $endLine = null;
/**
* @var string
*/
protected $namespaces = array();
/**
* @var string[]
*/
protected $uses = array();
/**
* @var string[]
*/
protected $requiredFiles = array();
/**
* @var ReflectionClass[]
*/
protected $classes = array();
/**
* @var FunctionReflection[]
*/
protected $functions = array();
/**
* @var string
*/
protected $contents = null;
/**
* Constructor
*
* @param string $filename
* @throws Exception\RuntimeException
* @return FileReflection
*/
public function __construct($filename)
{
if (($fileRealPath = realpath($filename)) === false) {
$fileRealPath = stream_resolve_include_path($filename);
}
if (!$fileRealPath || !in_array($fileRealPath, get_included_files())) {
throw new Exception\RuntimeException('File ' . $filename . ' must be required before it can be reflected');
}
$this->filePath = $fileRealPath;
$this->reflect();
}
/**
* Export
*
* Required by the Reflector interface.
*
* @todo What should this do?
* @return null
*/
public static function export()
{
return null;
}
/**
* Return the file name of the reflected file
*
* @return string
*/
public function getFileName()
{
// @todo get file name from path
return $this->filePath;
}
/**
* Get the start line - Always 1, staying consistent with the Reflection API
*
* @return int
*/
public function getStartLine()
{
return $this->startLine;
}
/**
* Get the end line / number of lines
*
* @return int
*/
public function getEndLine()
{
return $this->endLine;
}
/**
* Return the doc comment
*
* @return string
*/
public function getDocComment()
{
return $this->docComment;
}
/**
* Return the DocBlock
*
* @return DocBlockReflection
*/
public function getDocBlock()
{
if (!($docComment = $this->getDocComment())) {
return false;
}
$instance = new DocBlockReflection($docComment);
return $instance;
}
public function getNamespaces()
{
return $this->namespaces;
}
/**
* getNamespace()
*
* @return string
*/
public function getNamespace()
{
if (count($this->namespaces) > 0) {
return $this->namespaces[0];
}
return null;
}
/**
* getUses()
*
* @return string[]
*/
public function getUses()
{
return $this->uses;
}
/**
* Return the reflection classes of the classes found inside this file
*
* @return array Array of \Zend\Code\Reflection\ReflectionClass instances
*/
public function getClasses()
{
$classes = array();
foreach ($this->classes as $class) {
$instance = new ClassReflection($class);
$classes[] = $instance;
}
return $classes;
}
/**
* Return the reflection functions of the functions found inside this file
*
* @return array Array of Zend_Reflection_Functions
*/
public function getFunctions()
{
$functions = array();
foreach ($this->functions as $function) {
$instance = new FunctionReflection($function);
$functions[] = $instance;
}
return $functions;
}
/**
* Retrieve the reflection class of a given class found in this file
*
* @param null|string $name
* @return ClassReflection
* @throws Exception\InvalidArgumentException for invalid class name or invalid reflection class
*/
public function getClass($name = null)
{
if ($name === null) {
reset($this->classes);
$selected = current($this->classes);
$instance = new ClassReflection($selected);
return $instance;
}
if (in_array($name, $this->classes)) {
$instance = new ClassReflection($name);
return $instance;
}
throw new Exception\InvalidArgumentException('Class by name ' . $name . ' not found.');
}
/**
* Return the full contents of file
*
* @return string
*/
public function getContents()
{
return file_get_contents($this->filePath);
}
public function toString()
{
return ''; // @todo
}
/**
* Serialize to string
*
* Required by the Reflector interface
*
* @todo What should this serialization look like?
* @return string
*/
public function __toString()
{
return '';
}
/**
* This method does the work of "reflecting" the file
*
* Uses Zend\Code\Scanner\FileScanner to gather file information
*
* @return void
*/
protected function reflect()
{
$scanner = new CachingFileScanner($this->filePath);
$this->docComment = $scanner->getDocComment();
$this->requiredFiles = $scanner->getIncludes();
$this->classes = $scanner->getClassNames();
$this->namespaces = $scanner->getNamespaces();
$this->uses = $scanner->getUses();
}
/**
* Validate / check a file level DocBlock
*
* @param array $tokens Array of tokenizer tokens
* @return void
*/
protected function checkFileDocBlock($tokens)
{
foreach ($tokens as $token) {
$type = $token[0];
$value = $token[1];
$lineNum = $token[2];
if (($type == T_OPEN_TAG) || ($type == T_WHITESPACE)) {
continue;
} elseif ($type == T_DOC_COMMENT) {
$this->docComment = $value;
$this->startLine = $lineNum + substr_count($value, "\n") + 1;
return;
} else {
// Only whitespace is allowed before file DocBlocks
return;
}
}
}
}