-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
ClassMetadataFactory.php
524 lines (436 loc) · 16.6 KB
/
ClassMetadataFactory.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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
<?php
declare(strict_types=1);
namespace Doctrine\ORM\Mapping;
use Doctrine\Common\Cache\Cache;
use Doctrine\Common\EventManager;
use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory as PersistenceClassMetadataFactory;
use Doctrine\Common\Persistence\Mapping\MappingException as PersistenceMappingException;
use Doctrine\DBAL\Platforms;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
use Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs;
use Doctrine\ORM\Events;
use Doctrine\ORM\Exception\ORMException;
use Doctrine\ORM\Reflection\ReflectionService;
use Doctrine\ORM\Reflection\RuntimeReflectionService;
use Doctrine\ORM\Sequencing\Executor\ValueGenerationExecutor;
use Doctrine\ORM\Sequencing\Planning\CompositeValueGenerationPlan;
use Doctrine\ORM\Sequencing\Planning\NoopValueGenerationPlan;
use Doctrine\ORM\Sequencing\Planning\SingleValueGenerationPlan;
use Doctrine\ORM\Utility\StaticClassNameConverter;
use InvalidArgumentException;
use ReflectionException;
use function array_map;
use function array_reverse;
use function count;
use function reset;
/**
* The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
* metadata mapping information of a class which describes how a class should be mapped
* to a relational database.
*/
class ClassMetadataFactory implements PersistenceClassMetadataFactory
{
/**
* Salt used by specific Object Manager implementation.
*
* @var string
*/
protected $cacheSalt = '$CLASSMETADATA';
/** @var bool */
protected $initialized = false;
/** @var ReflectionService|null */
protected $reflectionService;
/** @var EntityManagerInterface|null */
private $em;
/** @var AbstractPlatform */
private $targetPlatform;
/** @var Driver\MappingDriver */
private $driver;
/** @var EventManager */
private $evm;
/** @var Cache|null */
private $cacheDriver;
/** @var ClassMetadata[] */
private $loadedMetadata = [];
/**
* Sets the entity manager used to build ClassMetadata instances.
*/
public function setEntityManager(EntityManagerInterface $em)
{
$this->em = $em;
}
/**
* Sets the cache driver used by the factory to cache ClassMetadata instances.
*/
public function setCacheDriver(?Cache $cacheDriver = null) : void
{
$this->cacheDriver = $cacheDriver;
}
/**
* Gets the cache driver used by the factory to cache ClassMetadata instances.
*/
public function getCacheDriver() : ?Cache
{
return $this->cacheDriver;
}
/**
* Returns an array of all the loaded metadata currently in memory.
*
* @return ClassMetadata[]
*/
public function getLoadedMetadata() : array
{
return $this->loadedMetadata;
}
/**
* Sets the reflectionService.
*/
public function setReflectionService(ReflectionService $reflectionService) : void
{
$this->reflectionService = $reflectionService;
}
/**
* Gets the reflection service associated with this metadata factory.
*/
public function getReflectionService() : ReflectionService
{
if ($this->reflectionService === null) {
$this->reflectionService = new RuntimeReflectionService();
}
return $this->reflectionService;
}
/**
* {@inheritDoc}
*/
public function isTransient($className) : bool
{
if (! $this->initialized) {
$this->initialize();
}
$entityClassName = StaticClassNameConverter::getRealClass($className);
return $this->getDriver()->isTransient($entityClassName);
}
/**
* Checks whether the factory has the metadata for a class loaded already.
*
* @param string $className
*
* @return bool TRUE if the metadata of the class in question is already loaded, FALSE otherwise.
*/
public function hasMetadataFor($className) : bool
{
return isset($this->loadedMetadata[$className]);
}
/**
* Sets the metadata descriptor for a specific class.
*
* NOTE: This is only useful in very special cases, like when generating proxy classes.
*
* @param string $className
* @param ClassMetadata $class
*/
public function setMetadataFor($className, $class) : void
{
$this->loadedMetadata[$className] = $class;
}
/**
* Forces the factory to load the metadata of all classes known to the underlying
* mapping driver.
*
* @return ClassMetadata[] The ClassMetadata instances of all mapped classes.
*
* @throws InvalidArgumentException
* @throws ReflectionException
* @throws MappingException
* @throws PersistenceMappingException
* @throws ORMException
*/
public function getAllMetadata() : array
{
if (! $this->initialized) {
$this->initialize();
}
$driver = $this->getDriver();
$metadata = [];
foreach ($driver->getAllClassNames() as $className) {
$metadata[] = $this->getMetadataFor($className);
}
return $metadata;
}
/**
* {@inheritdoc}
*
* @throws ORMException
*/
protected function initialize() : void
{
$this->driver = $this->em->getConfiguration()->getMetadataDriverImpl();
$this->evm = $this->em->getEventManager();
$this->initialized = true;
}
/**
* {@inheritdoc}
*/
protected function getDriver() : Driver\MappingDriver
{
return $this->driver;
}
public function getTargetPlatform() : Platforms\AbstractPlatform
{
if (! $this->targetPlatform) {
$this->targetPlatform = $this->em->getConnection()->getDatabasePlatform();
}
return $this->targetPlatform;
}
/**
* {@inheritdoc}
*/
protected function isEntity(ClassMetadata $class) : bool
{
return isset($class->isMappedSuperclass) && $class->isMappedSuperclass === false;
}
/**
* Gets the class metadata descriptor for a class.
*
* @param string $className The name of the class.
*
* @throws InvalidArgumentException
* @throws PersistenceMappingException
* @throws ORMException
*/
public function getMetadataFor($className) : ClassMetadata
{
if (isset($this->loadedMetadata[$className])) {
return $this->loadedMetadata[$className];
}
$entityClassName = StaticClassNameConverter::getRealClass($className);
if (isset($this->loadedMetadata[$entityClassName])) {
// We do not have the alias name in the map, include it
return $this->loadedMetadata[$className] = $this->loadedMetadata[$entityClassName];
}
$metadataBuildingContext = $this->newClassMetadataBuildingContext();
$loadingException = null;
try {
if ($this->cacheDriver) {
$cached = $this->cacheDriver->fetch($entityClassName . $this->cacheSalt);
if ($cached instanceof ClassMetadata) {
$this->loadedMetadata[$entityClassName] = $cached;
$cached->wakeupReflection($metadataBuildingContext->getReflectionService());
} else {
foreach ($this->loadMetadata($entityClassName, $metadataBuildingContext) as $loadedClass) {
$loadedClassName = $loadedClass->getClassName();
$this->cacheDriver->save($loadedClassName . $this->cacheSalt, $loadedClass, null);
}
}
} else {
$this->loadMetadata($entityClassName, $metadataBuildingContext);
}
} catch (PersistenceMappingException $loadingException) {
$fallbackMetadataResponse = $this->onNotFoundMetadata($entityClassName, $metadataBuildingContext);
if (! $fallbackMetadataResponse) {
throw $loadingException;
}
$this->loadedMetadata[$entityClassName] = $fallbackMetadataResponse;
}
if ($className !== $entityClassName) {
// We do not have the alias name in the map, include it
$this->loadedMetadata[$className] = $this->loadedMetadata[$entityClassName];
}
$metadataBuildingContext->validate();
return $this->loadedMetadata[$entityClassName];
}
/**
* Loads the metadata of the class in question and all it's ancestors whose metadata
* is still not loaded.
*
* Important: The class $name does not necessarily exist at this point here.
* Scenarios in a code-generation setup might have access to XML
* Mapping files without the actual PHP code existing here. That is why the
* {@see Doctrine\ORM\Reflection\ReflectionService} interface
* should be used for reflection.
*
* @param string $name The name of the class for which the metadata should get loaded.
*
* @return ClassMetadata[]
*
* @throws InvalidArgumentException
* @throws ORMException
*/
protected function loadMetadata(string $name, ClassMetadataBuildingContext $metadataBuildingContext) : array
{
if (! $this->initialized) {
$this->initialize();
}
$loaded = [];
$parentClasses = $this->getParentClasses($name);
$parentClasses[] = $name;
// Move down the hierarchy of parent classes, starting from the topmost class
$parent = null;
foreach ($parentClasses as $className) {
if (isset($this->loadedMetadata[$className])) {
$parent = $this->loadedMetadata[$className];
continue;
}
$class = $this->doLoadMetadata($className, $parent, $metadataBuildingContext);
$this->loadedMetadata[$className] = $class;
$parent = $class;
$loaded[] = $class;
}
array_map([$this, 'resolveDiscriminatorValue'], $loaded);
return $loaded;
}
/**
* Gets an array of parent classes for the given entity class.
*
* @param string $name
*
* @return string[]
*
* @throws InvalidArgumentException
*/
protected function getParentClasses($name) : array
{
// Collect parent classes, ignoring transient (not-mapped) classes.
$parentClasses = [];
foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) {
if (! $this->getDriver()->isTransient($parentClass)) {
$parentClasses[] = $parentClass;
}
}
return $parentClasses;
}
/**
* {@inheritdoc}
*/
protected function onNotFoundMetadata(
string $className,
ClassMetadataBuildingContext $metadataBuildingContext
) : ?ClassMetadata {
if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) {
return null;
}
$eventArgs = new OnClassMetadataNotFoundEventArgs($className, $metadataBuildingContext, $this->em);
$this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
return $eventArgs->getFoundMetadata();
}
/**
* {@inheritdoc}
*
* @throws MappingException
* @throws ORMException
*/
protected function doLoadMetadata(
string $className,
?ClassMetadata $parent,
ClassMetadataBuildingContext $metadataBuildingContext
) : ?ComponentMetadata {
$reflectionService = $metadataBuildingContext->getReflectionService();
$reflectionClass = $reflectionService->getClass($className);
$className = $reflectionClass ? $reflectionClass->getName() : $className;
/** @var ClassMetadata $classMetadata */
$classMetadata = $this->driver->loadMetadataForClass($className, $parent, $metadataBuildingContext);
if ($this->evm->hasListeners(Events::loadClassMetadata)) {
$eventArgs = new LoadClassMetadataEventArgs($classMetadata, $this->em);
$this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs);
}
$classMetadata->wakeupReflection($metadataBuildingContext->getReflectionService());
$this->buildValueGenerationPlan($classMetadata);
$this->validateRuntimeMetadata($classMetadata, $parent);
return $classMetadata;
}
/**
* Validate runtime metadata is correctly defined.
*
* @throws MappingException
*/
protected function validateRuntimeMetadata(ClassMetadata $class, ?ClassMetadata $parent = null) : void
{
if (! $class->getReflectionClass()) {
// only validate if there is a reflection class instance
return;
}
$class->validateIdentifier();
$class->validateLifecycleCallbacks($this->getReflectionService());
// verify inheritance
if (! $class->isMappedSuperclass && $class->inheritanceType !== InheritanceType::NONE) {
if (! $parent) {
if (! $class->discriminatorMap) {
throw MappingException::missingDiscriminatorMap($class->getClassName());
}
if (! $class->discriminatorColumn) {
throw MappingException::missingDiscriminatorColumn($class->getClassName());
}
}
} elseif (($class->discriminatorMap || $class->discriminatorColumn) && $class->isMappedSuperclass && $class->isRootEntity()) {
// second condition is necessary for mapped superclasses in the middle of an inheritance hierarchy
throw MappingException::noInheritanceOnMappedSuperClass($class->getClassName());
}
}
/**
* {@inheritdoc}
*/
protected function newClassMetadataBuildingContext() : ClassMetadataBuildingContext
{
return new ClassMetadataBuildingContext(
$this,
$this->getReflectionService(),
$this->getTargetPlatform(),
$this->em->getConfiguration()->getNamingStrategy()
);
}
/**
* Populates the discriminator value of the given metadata (if not set) by iterating over discriminator
* map classes and looking for a fitting one.
*
* @throws InvalidArgumentException
* @throws ReflectionException
* @throws MappingException
* @throws PersistenceMappingException
*/
private function resolveDiscriminatorValue(ClassMetadata $metadata) : void
{
if ($metadata->discriminatorValue || ! $metadata->discriminatorMap || $metadata->isMappedSuperclass ||
! $metadata->getReflectionClass() || $metadata->getReflectionClass()->isAbstract()) {
return;
}
// minor optimization: avoid loading related metadata when not needed
foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
if ($discriminatorClass === $metadata->getClassName()) {
$metadata->discriminatorValue = $discriminatorValue;
return;
}
}
// iterate over discriminator mappings and resolve actual referenced classes according to existing metadata
foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) {
if ($metadata->getClassName() === $this->getMetadataFor($discriminatorClass)->getClassName()) {
$metadata->discriminatorValue = $discriminatorValue;
return;
}
}
throw MappingException::mappedClassNotPartOfDiscriminatorMap($metadata->getClassName(), $metadata->getRootClassName());
}
private function buildValueGenerationPlan(ClassMetadata $class) : void
{
$valueGenerationExecutorList = [];
foreach ($class->getPropertiesIterator() as $property) {
$executor = $property->getValueGenerationExecutor($this->getTargetPlatform());
if ($executor instanceof ValueGenerationExecutor) {
$valueGenerationExecutorList[$property->getName()] = $executor;
}
}
switch (count($valueGenerationExecutorList)) {
case 0:
$valueGenerationPlan = new NoopValueGenerationPlan();
break;
case 1:
$valueGenerationPlan = new SingleValueGenerationPlan($class, reset($valueGenerationExecutorList));
break;
default:
$valueGenerationPlan = new CompositeValueGenerationPlan($class, $valueGenerationExecutorList);
break;
}
$class->setValueGenerationPlan($valueGenerationPlan);
}
}