-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathReflection.php
More file actions
307 lines (258 loc) · 8.02 KB
/
Reflection.php
File metadata and controls
307 lines (258 loc) · 8.02 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
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
<?php
namespace UniMapper\Entity;
use UniMapper\Entity;
use UniMapper\Exception;
use UniMapper\Convention;
class Reflection
{
/** @var string */
private $adapterName;
/** @var string */
private $adapterResource;
/** @var array */
private $properties = [];
/** @var string */
private $className;
/** @var string */
private $fileName;
/** @var array $registered Registered reflections */
private static $registered = [];
/**
* @param string $class Entity class name
*
* @throws Exception\InvalidArgumentException
* @throws Exception\ReflectionException
*/
public function __construct($class)
{
$this->className = (string) $class;
if (!is_subclass_of($this->className, "UniMapper\Entity")) {
throw new Exception\InvalidArgumentException(
"Class must be subclass of UniMapper\Entity but "
. $this->className . " given!",
$this->className
);
}
// Register reflection
self::load($this);
$reflectionClass = new \ReflectionClass($this->className);
$this->fileName = $reflectionClass->getFileName();
$docComment = $reflectionClass->getDocComment();
$this->_parseAdapter($docComment);
$this->_parseProperties($docComment, $reflectionClass);
}
private function _parseAdapter($docComment)
{
try {
$adapter = Reflection\Annotation::parseAdapter($docComment);
} catch (Exception\AnnotationException $e) {
throw new Exception\ReflectionException(
$e->getMessage(),
$this->className,
$e->getDefinition()
);
}
if ($adapter) {
list($this->adapterName, $this->adapterResource) = $adapter;
}
if (empty($this->adapterResource)) {
$this->adapterResource = $this->getName();
if (Convention::hasAdapterConvention($this->adapterName)) {
$this->adapterResource = Convention::getAdapterConvention(
$this->adapterName
)->mapResource($this->adapterResource);
}
}
}
/**
* Load and register reflection
*
* @param string|Entity|Collection|Reflection $arg
*
* @throws Exception\InvalidArgumentException
*
* @return Reflection
*/
public static function load($arg)
{
if (is_object($arg) && $arg instanceof Entity) {
$class = get_class($arg);
} elseif (is_object($arg) && $arg instanceof Collection) {
$class = $arg->getEntityClass();
} elseif (is_object($arg) && $arg instanceof Reflection) {
$class = $arg->getClassName();
if (!isset(self::$registered[$class])) {
return self::$registered[$class] = $arg;
}
return $arg;
} elseif (is_string($arg)) {
$class = $arg;
} else {
throw new Exception\InvalidArgumentException(
"Entity identifier must be object, collection, class or name!",
$arg
);
}
if (!is_subclass_of($class, "UniMapper\Entity")) {
$class = Convention::nameToClass($arg, Convention::ENTITY_MASK);
}
if (!class_exists($class)) {
throw new Exception\InvalidArgumentException(
"Entity class " . $class . " not found!"
);
}
if (isset(self::$registered[$class])) {
return self::$registered[$class];
}
return self::$registered[$class] = new Reflection($class);
}
public function createEntity($values = null)
{
$entityClass = $this->className;
return new $entityClass($values);
}
public function getClassName()
{
return $this->className;
}
public function getFileName()
{
return $this->fileName;
}
public function getName()
{
return Convention::classToName($this->className, Convention::ENTITY_MASK);
}
/**
* Parse properties from annotations
*
* @param string $docComment
* @param \ReflectionClass $reflectionClass
*
* @throws Exception\ReflectionException
*/
private function _parseProperties($docComment, \ReflectionClass $reflectionClass)
{
$properties = [];
foreach (Reflection\Annotation::parseProperties($docComment) as $definition) {
try {
$property = new Reflection\Property(
$definition[2],
$definition[3],
$this,
!$definition[1],
$definition[4]
);
} catch (Exception\PropertyException $e) {
throw new Exception\ReflectionException(
$e->getMessage(),
$this->className,
$definition[0]
);
}
// Prevent duplications
if (isset($properties[$property->getName()])) {
throw new Exception\ReflectionException(
"Duplicate property with name '" . $property->getName() . "'!",
$this->className,
$definition[0]
);
}
// Prevent class property duplications
if ($reflectionClass->hasProperty($property->getName())) {
throw new Exception\ReflectionException(
"Property '" . $property->getName() . "' already defined as"
. " public property!",
$this->className,
$definition[0]
);
}
$this->properties[$property->getName()] = $property;
}
}
public function getAdapterName()
{
return $this->adapterName;
}
public function getAdapterResource()
{
return $this->adapterResource;
}
public function hasAdapter()
{
return !empty($this->adapterName);
}
public function hasProperty($name)
{
return isset($this->properties[$name]);
}
/**
* Get property reflection object
*
* @param string $name
*
* @return Reflection\Property
*
* @throws Exception\InvalidArgumentException
*/
public function getProperty($name)
{
if (!$this->hasProperty($name)) {
throw new Exception\InvalidArgumentException(
"Unknown property " . $name . "!"
);
}
return $this->properties[$name];
}
public function getProperties()
{
return $this->properties;
}
/**
* Get arg's related files
*
* @param array $files
*
* @return array
*/
public function getRelatedFiles(array $files = [])
{
if (in_array($this->fileName, $files)) {
return $files;
}
$files[] = $this->fileName;
foreach ($this->properties as $property) {
if (in_array($property->getType(), [Reflection\Property::TYPE_COLLECTION, Reflection\Property::TYPE_ENTITY])) {
$files += self::load($property->getTypeOption())->getRelatedFiles($files);
}
}
return $files;
}
public function hasPrimary()
{
foreach ($this->properties as $property) {
if ($property->hasOption(Entity\Reflection\Property\Option\Primary::KEY)) {
return true;
}
}
return false;
}
/**
* Get primary property reflection
*
* @return Reflection\Property
*
* @throws \Exception
*/
public function getPrimaryProperty()
{
foreach ($this->properties as $property) {
if ($property->hasOption(Entity\Reflection\Property\Option\Primary::KEY)) {
return $property;
}
}
throw new \Exception(
"Primary property not defined in " . $this->className . "!"
);
}
}