1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace PhpBoot\Annotation; |
4
|
|
|
use Doctrine\Common\Cache\ApcCache; |
5
|
|
|
use Doctrine\Common\Cache\Cache; |
6
|
|
|
use PhpBoot\Cache\CheckableCache; |
7
|
|
|
use PhpBoot\Cache\ClassModifiedChecker; |
8
|
|
|
use phpDocumentor\Reflection\DocBlock\DescriptionFactory; |
9
|
|
|
use phpDocumentor\Reflection\DocBlock\StandardTagFactory; |
10
|
|
|
use phpDocumentor\Reflection\DocBlock\Tag; |
11
|
|
|
use phpDocumentor\Reflection\DocBlock\Tags\Formatter; |
12
|
|
|
use phpDocumentor\Reflection\DocBlockFactory; |
13
|
|
|
use phpDocumentor\Reflection\FqsenResolver; |
14
|
|
|
use phpDocumentor\Reflection\TypeResolver; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* AnnotationEnabledTest |
18
|
|
|
*/ |
19
|
|
|
class AnnotationEnabledTest |
20
|
|
|
{ |
21
|
|
|
/** |
22
|
|
|
* testMethod |
23
|
|
|
*/ |
24
|
|
|
public function testMethod() |
25
|
|
|
{ |
26
|
|
|
|
27
|
|
|
} |
28
|
|
|
} |
29
|
|
|
|
30
|
|
|
class AnnotationTagsOutput implements Formatter |
|
|
|
|
31
|
|
|
{ |
32
|
|
|
/** |
33
|
|
|
* Formats a tag into a string representation according to a specific format, such as Markdown. |
34
|
|
|
* |
35
|
|
|
* @param Tag $tag |
36
|
|
|
* |
37
|
|
|
* @return string |
38
|
|
|
*/ |
39
|
5 |
|
public function format(Tag $tag) |
40
|
|
|
{ |
41
|
5 |
|
$this->tags[] = $tag; |
42
|
5 |
|
return strval($tag); |
43
|
|
|
} |
44
|
|
|
public $tags = []; |
45
|
|
|
} |
46
|
|
|
class AnnotationReader implements \ArrayAccess |
|
|
|
|
47
|
|
|
{ |
48
|
20 |
|
static public function createDocBlockFactory(){ |
|
|
|
|
49
|
20 |
|
$fqsenResolver = new FqsenResolver(); |
50
|
20 |
|
$tagFactory = new StandardTagFactory($fqsenResolver,[]); |
51
|
20 |
|
$descriptionFactory = new DescriptionFactory($tagFactory); |
52
|
20 |
|
$tagFactory->addService($descriptionFactory); |
53
|
20 |
|
$tagFactory->addService(new TypeResolver($fqsenResolver)); |
54
|
20 |
|
$docBlockFactory = new DocBlockFactory($descriptionFactory, $tagFactory); |
55
|
20 |
|
return $docBlockFactory; |
56
|
|
|
} |
57
|
|
|
|
58
|
20 |
|
static public function assertAnnotationEnabled() |
|
|
|
|
59
|
|
|
{ |
60
|
20 |
|
$rfl = new \ReflectionClass(AnnotationEnabledTest::class); |
61
|
20 |
|
!empty($rfl->getDocComment()) or \PhpBoot\abort('Annotation dose not work! If opcache is enable, please set opcache.save_comments=1 and opcache.load_comments=1'); |
|
|
|
|
62
|
20 |
|
} |
63
|
|
|
/** |
64
|
|
|
* load from class with local cache |
65
|
|
|
* TODO 增加 filter 能力 |
66
|
|
|
* @param string $className |
67
|
|
|
* @param Cache $localCache |
68
|
|
|
* @return object |
69
|
|
|
*/ |
70
|
20 |
|
static public function read($className, Cache $localCache = null) |
|
|
|
|
71
|
|
|
{ |
72
|
20 |
|
self::assertAnnotationEnabled(); |
73
|
20 |
|
$rfl = new \ReflectionClass($className) or \PhpBoot\abort("load class $className failed"); |
|
|
|
|
74
|
20 |
|
$fileName = $rfl->getFileName(); |
75
|
20 |
|
$key = str_replace('\\','.',self::class).md5($fileName.$className); |
76
|
20 |
|
$oldData = null; |
77
|
20 |
|
$cache = new CheckableCache($localCache?:new ApcCache()); |
|
|
|
|
78
|
20 |
|
$res = $cache->get('ann:'.$key, null, $oldData, false); |
79
|
20 |
|
if($res === null){ |
80
|
|
|
try{ |
81
|
20 |
|
$meta = self::readWithoutCache($className); |
82
|
20 |
|
$cache->set($key, $meta, 0, $fileName?new ClassModifiedChecker($className):null); |
83
|
20 |
|
return $meta; |
84
|
1 |
|
}catch (\Exception $e){ |
85
|
|
|
$cache->set($key, $e->getMessage(), 0, $fileName?new ClassModifiedChecker($className):null); |
86
|
|
|
throw $e; |
87
|
1 |
|
} |
88
|
|
|
}elseif(is_string($res)){ |
89
|
|
|
\PhpBoot\abort($res); |
90
|
|
|
}else{ |
91
|
|
|
return $res; |
92
|
|
|
} |
93
|
|
|
} |
94
|
|
|
/** |
95
|
|
|
* @param $className |
96
|
|
|
* @return self |
97
|
|
|
*/ |
98
|
20 |
|
static function readWithoutCache($className) |
99
|
|
|
{ |
100
|
20 |
|
$reader = new self(); |
101
|
|
|
|
102
|
20 |
|
$rfl = new \ReflectionClass($className); |
103
|
20 |
|
$reader->class = self::readAnnotationBlock($rfl->getDocComment()); |
104
|
20 |
|
$reader->class->name = $className; |
105
|
|
|
|
106
|
|
|
//method annotations |
107
|
20 |
|
foreach ($rfl->getMethods() as $i){ |
108
|
16 |
|
$block = self::readAnnotationBlock($i->getDocComment()); |
109
|
16 |
|
$block->name = $i->getName(); |
|
|
|
|
110
|
16 |
|
$reader->methods[$i->getName()]=$block; |
|
|
|
|
111
|
20 |
|
} |
112
|
|
|
//property annotations |
113
|
20 |
View Code Duplication |
foreach ($rfl->getProperties() as $i){ |
|
|
|
|
114
|
19 |
|
if ($i->isStatic()) { |
115
|
15 |
|
continue; |
116
|
|
|
} |
117
|
19 |
|
$block = self::readAnnotationBlock($i->getDocComment()); |
118
|
19 |
|
$block->name = $i->getName(); |
119
|
19 |
|
$reader->properties[$i->getName()]=$block; |
120
|
20 |
|
} |
121
|
20 |
|
while ($rfl = $rfl->getParentClass()) { |
122
|
1 |
View Code Duplication |
foreach ($rfl->getProperties(\ReflectionProperty::IS_PRIVATE) as $i) { |
|
|
|
|
123
|
1 |
|
if ($i->isStatic()) { |
124
|
|
|
continue; |
125
|
|
|
} |
126
|
1 |
|
$block = self::readAnnotationBlock($i->getDocComment()); |
127
|
1 |
|
$block->name = $i->getName(); |
128
|
1 |
|
$reader->properties[$i->getName()]=$block; |
129
|
1 |
|
} |
130
|
1 |
|
} |
131
|
20 |
|
return $reader; |
132
|
|
|
} |
133
|
|
|
|
134
|
20 |
|
static private function readAnnotationBlock($doc) |
|
|
|
|
135
|
|
|
{ |
136
|
20 |
|
$annBlock = new AnnotationBlock(); |
137
|
20 |
|
if(empty($doc)){ |
138
|
19 |
|
return $annBlock; |
139
|
|
|
} |
140
|
20 |
|
$docFactory = AnnotationReader::createDocBlockFactory(); |
141
|
20 |
|
$docBlock = $docFactory->create($doc); |
142
|
20 |
|
$annBlock->summary = $docBlock->getSummary(); |
143
|
20 |
|
$annBlock->description = strval($docBlock->getDescription()); |
144
|
20 |
|
$annBlock->children = []; |
145
|
20 |
|
$tags = $docBlock->getTags(); |
146
|
20 |
|
foreach ($tags as $tag) { |
147
|
20 |
|
$annTag = new AnnotationTag(); |
148
|
20 |
|
$desc = $tag->getDescription(); |
149
|
20 |
|
$annTag->parent = $annBlock; |
150
|
20 |
|
$annTag->description = strval($desc); |
151
|
20 |
|
$annTag->name = $tag->getName(); |
152
|
20 |
|
$annTag->children=[]; |
153
|
20 |
|
if($desc){ |
154
|
20 |
|
$output = new AnnotationTagsOutput(); |
155
|
20 |
|
$desc->render($output); |
156
|
20 |
|
foreach ($output->tags as $child) { |
157
|
5 |
|
$childTag = new AnnotationTag(); |
158
|
5 |
|
$childTag->parent = $annTag; |
|
|
|
|
159
|
5 |
|
$childTag->name = $child->getName(); |
160
|
5 |
|
$childTag->description = strval($child->getDescription()); |
161
|
5 |
|
$annTag->children[] = $childTag; |
162
|
20 |
|
} |
163
|
20 |
|
} |
164
|
20 |
|
$annBlock->children[] = $annTag; |
165
|
20 |
|
} |
166
|
20 |
|
return $annBlock; |
167
|
|
|
} |
168
|
|
|
|
169
|
|
|
/** |
170
|
|
|
* @var AnnotationBlock |
171
|
|
|
*/ |
172
|
|
|
public $class; |
173
|
|
|
/** |
174
|
|
|
* @var AnnotationBlock[] |
175
|
|
|
*/ |
176
|
|
|
|
177
|
|
|
public $methods=[]; |
178
|
|
|
/** |
179
|
|
|
* @var AnnotationBlock[] |
180
|
|
|
*/ |
181
|
|
|
public $properties=[]; |
182
|
|
|
|
183
|
20 |
|
public function offsetExists($offset) |
184
|
|
|
{ |
185
|
20 |
|
return isset($this->$offset); |
186
|
|
|
} |
187
|
|
|
|
188
|
20 |
|
public function offsetGet($offset) |
189
|
|
|
{ |
190
|
20 |
|
return $this->$offset; |
191
|
|
|
} |
192
|
|
|
|
193
|
|
|
public function offsetSet($offset, $value) |
194
|
|
|
{ |
195
|
|
|
$this->$offset = $value; |
196
|
|
|
} |
197
|
|
|
|
198
|
|
|
public function offsetUnset($offset) |
199
|
|
|
{ |
200
|
|
|
unset($this->$offset); |
201
|
|
|
} |
202
|
|
|
} |
Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule.