Repository navigation
Expand file tree
/
Copy pathAnnotationReader.php
More file actions
130 lines (113 loc) · 3.99 KB
/
Copy pathAnnotationReader.php
File metadata and controls
130 lines (113 loc) · 3.99 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
<?php
declare(strict_types=1);
/**
* This file is part of Hyperf.
*
* @link https://www.hyperf.io
* @document https://hyperf.wiki
* @contact [email protected]
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE
*/
namespace Hyperf\Di\Annotation;
use Hyperf\Di\Exception\NotFoundException;
use ReflectionClass;
use ReflectionClassConstant;
use ReflectionMethod;
use ReflectionProperty;
use Reflector;
/**
* A reader for docblock annotations.
*/
class AnnotationReader
{
public function __construct(protected array $ignoreAnnotations = [])
{
}
public function getClassAnnotations(ReflectionClass $class)
{
return $this->getAttributes($class);
}
public function getClassAnnotation(ReflectionClass $class, $annotationName)
{
$annotations = $this->getClassAnnotations($class);
foreach ($annotations as $annotation) {
if ($annotation instanceof $annotationName) {
return $annotation;
}
}
return null;
}
public function getPropertyAnnotations(ReflectionProperty $property)
{
return $this->getAttributes($property);
}
public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
{
$annotations = $this->getPropertyAnnotations($property);
foreach ($annotations as $annotation) {
if ($annotation instanceof $annotationName) {
return $annotation;
}
}
return null;
}
public function getMethodAnnotations(ReflectionMethod $method)
{
return $this->getAttributes($method);
}
public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
{
$annotations = $this->getMethodAnnotations($method);
foreach ($annotations as $annotation) {
if ($annotation instanceof $annotationName) {
return $annotation;
}
}
return null;
}
public function getAttributes(Reflector $reflection): array
{
$result = [];
if (! method_exists($reflection, 'getAttributes')) {
return $result;
}
$attributes = $reflection->getAttributes();
foreach ($attributes as $attribute) {
if (in_array($attribute->getName(), $this->ignoreAnnotations, true)) {
continue;
}
if (! class_exists($attribute->getName())) {
$className = $methodName = $propertyName = $classConstantName = '';
if ($reflection instanceof ReflectionClass) {
$className = $reflection->getName();
} elseif ($reflection instanceof ReflectionMethod) {
$className = $reflection->getDeclaringClass()->getName();
$methodName = $reflection->getName();
} elseif ($reflection instanceof ReflectionProperty) {
$className = $reflection->getDeclaringClass()->getName();
$propertyName = $reflection->getName();
} elseif ($reflection instanceof ReflectionClassConstant) {
$className = $reflection->getDeclaringClass()->getName();
$classConstantName = $reflection->getName();
}
$message = sprintf(
"No attribute class found for '%s' in %s",
$attribute->getName(),
$className
);
if ($methodName) {
$message .= sprintf('->%s() method', $methodName);
}
if ($propertyName) {
$message .= sprintf('::$%s property', $propertyName);
}
if ($classConstantName) {
$message .= sprintf('::%s class constant', $classConstantName);
}
throw new NotFoundException($message);
}
$result[] = $attribute->newInstance();
}
return $result;
}
}