Complex classes like ClassMetadataFactory often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ClassMetadataFactory, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
46 | class ClassMetadataFactory extends AbstractClassMetadataFactory |
||
47 | { |
||
48 | /** |
||
49 | * @var EntityManagerInterface|null |
||
50 | */ |
||
51 | private $em; |
||
52 | |||
53 | /** |
||
54 | * @var \Doctrine\DBAL\Platforms\AbstractPlatform |
||
55 | */ |
||
56 | private $targetPlatform; |
||
57 | |||
58 | /** |
||
59 | * @var \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver |
||
60 | */ |
||
61 | private $driver; |
||
62 | |||
63 | /** |
||
64 | * @var \Doctrine\Common\EventManager |
||
65 | */ |
||
66 | private $evm; |
||
67 | |||
68 | /** |
||
69 | * @var array |
||
70 | */ |
||
71 | private $embeddablesActiveNesting = array(); |
||
72 | |||
73 | /** |
||
74 | * {@inheritDoc} |
||
75 | */ |
||
76 | 435 | protected function loadMetadata($name) |
|
77 | { |
||
78 | 435 | $loaded = parent::loadMetadata($name); |
|
79 | |||
80 | 412 | array_map([$this, 'resolveDiscriminatorValue'], array_map([$this, 'getMetadataFor'], $loaded)); |
|
81 | |||
82 | 412 | return $loaded; |
|
83 | } |
||
84 | |||
85 | /** |
||
86 | * @param EntityManagerInterface $em |
||
87 | */ |
||
88 | 2346 | public function setEntityManager(EntityManagerInterface $em) |
|
89 | { |
||
90 | 2346 | $this->em = $em; |
|
91 | 2346 | } |
|
92 | |||
93 | /** |
||
94 | * {@inheritDoc} |
||
95 | */ |
||
96 | 503 | protected function initialize() |
|
97 | { |
||
98 | 503 | $this->driver = $this->em->getConfiguration()->getMetadataDriverImpl(); |
|
99 | 503 | $this->evm = $this->em->getEventManager(); |
|
100 | 503 | $this->initialized = true; |
|
101 | 503 | } |
|
102 | |||
103 | /** |
||
104 | * {@inheritDoc} |
||
105 | */ |
||
106 | 4 | protected function onNotFoundMetadata($className) |
|
107 | { |
||
108 | 4 | if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) { |
|
109 | 2 | return; |
|
110 | } |
||
111 | |||
112 | 2 | $eventArgs = new OnClassMetadataNotFoundEventArgs($className, $this->em); |
|
|
|||
113 | |||
114 | 2 | $this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs); |
|
115 | |||
116 | 2 | return $eventArgs->getFoundMetadata(); |
|
117 | } |
||
118 | |||
119 | /** |
||
120 | * {@inheritDoc} |
||
121 | */ |
||
122 | 433 | protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents) |
|
123 | { |
||
124 | /* @var $class ClassMetadata */ |
||
125 | /* @var $parent ClassMetadata */ |
||
126 | 433 | if ($parent) { |
|
127 | 125 | $class->setInheritanceType($parent->inheritanceType); |
|
128 | 125 | $class->setDiscriminatorColumn($parent->discriminatorColumn); |
|
129 | 125 | $class->setIdGeneratorType($parent->generatorType); |
|
130 | 125 | $this->addInheritedFields($class, $parent); |
|
131 | 125 | $this->addInheritedRelations($class, $parent); |
|
132 | 124 | $this->addInheritedEmbeddedClasses($class, $parent); |
|
133 | 124 | $class->setIdentifier($parent->identifier); |
|
134 | 124 | $class->setVersioned($parent->isVersioned); |
|
135 | 124 | $class->setVersionField($parent->versionField); |
|
136 | 124 | $class->setDiscriminatorMap($parent->discriminatorMap); |
|
137 | 124 | $class->setLifecycleCallbacks($parent->lifecycleCallbacks); |
|
138 | 124 | $class->setChangeTrackingPolicy($parent->changeTrackingPolicy); |
|
139 | |||
140 | 124 | if ( ! empty($parent->customGeneratorDefinition)) { |
|
141 | 1 | $class->setCustomGeneratorDefinition($parent->customGeneratorDefinition); |
|
142 | } |
||
143 | |||
144 | 124 | if ($parent->isMappedSuperclass) { |
|
145 | 51 | $class->setCustomRepositoryClass($parent->customRepositoryClassName); |
|
146 | } |
||
147 | } |
||
148 | |||
149 | // Invoke driver |
||
150 | try { |
||
151 | 433 | $this->driver->loadMetadataForClass($class->getName(), $class); |
|
152 | 7 | } catch (ReflectionException $e) { |
|
153 | throw MappingException::reflectionFailure($class->getName(), $e); |
||
154 | } |
||
155 | |||
156 | // If this class has a parent the id generator strategy is inherited. |
||
157 | // However this is only true if the hierarchy of parents contains the root entity, |
||
158 | // if it consists of mapped superclasses these don't necessarily include the id field. |
||
159 | 426 | if ($parent && $rootEntityFound) { |
|
160 | 79 | $this->inheritIdGeneratorMapping($class, $parent); |
|
161 | } else { |
||
162 | 422 | $this->completeIdGeneratorMapping($class); |
|
163 | } |
||
164 | |||
165 | 424 | if (!$class->isMappedSuperclass) { |
|
166 | 422 | foreach ($class->embeddedClasses as $property => $embeddableClass) { |
|
167 | |||
168 | 13 | if (isset($embeddableClass['inherited'])) { |
|
169 | 1 | continue; |
|
170 | } |
||
171 | |||
172 | 13 | if ( ! (isset($embeddableClass['class']) && $embeddableClass['class'])) { |
|
173 | 1 | throw MappingException::missingEmbeddedClass($property); |
|
174 | } |
||
175 | |||
176 | 12 | if (isset($this->embeddablesActiveNesting[$embeddableClass['class']])) { |
|
177 | 2 | throw MappingException::infiniteEmbeddableNesting($class->name, $property); |
|
178 | } |
||
179 | |||
180 | 12 | $this->embeddablesActiveNesting[$class->name] = true; |
|
181 | |||
182 | 12 | $embeddableMetadata = $this->getMetadataFor($embeddableClass['class']); |
|
183 | |||
184 | 11 | if ($embeddableMetadata->isEmbeddedClass) { |
|
185 | 11 | $this->addNestedEmbeddedClasses($embeddableMetadata, $class, $property); |
|
186 | } |
||
187 | |||
188 | 11 | $identifier = $embeddableMetadata->getIdentifier(); |
|
189 | |||
190 | 11 | if (! empty($identifier)) { |
|
191 | 5 | $this->inheritIdGeneratorMapping($class, $embeddableMetadata); |
|
192 | } |
||
193 | |||
194 | 11 | $class->inlineEmbeddable($property, $embeddableMetadata); |
|
195 | |||
196 | 11 | unset($this->embeddablesActiveNesting[$class->name]); |
|
197 | } |
||
198 | } |
||
199 | |||
200 | 421 | if ($parent) { |
|
201 | 124 | if ($parent->isInheritanceTypeSingleTable()) { |
|
202 | 33 | $class->setPrimaryTable($parent->table); |
|
203 | } |
||
204 | |||
205 | 124 | if ($parent) { |
|
206 | 124 | $this->addInheritedIndexes($class, $parent); |
|
207 | } |
||
208 | |||
209 | 124 | if ($parent->cache) { |
|
210 | 3 | $class->cache = $parent->cache; |
|
211 | } |
||
212 | |||
213 | 124 | if ($parent->containsForeignIdentifier) { |
|
214 | $class->containsForeignIdentifier = true; |
||
215 | } |
||
216 | |||
217 | 124 | if ( ! empty($parent->namedQueries)) { |
|
218 | 1 | $this->addInheritedNamedQueries($class, $parent); |
|
219 | } |
||
220 | |||
221 | 124 | if ( ! empty($parent->namedNativeQueries)) { |
|
222 | 8 | $this->addInheritedNamedNativeQueries($class, $parent); |
|
223 | } |
||
224 | |||
225 | 124 | if ( ! empty($parent->sqlResultSetMappings)) { |
|
226 | 8 | $this->addInheritedSqlResultSetMappings($class, $parent); |
|
227 | } |
||
228 | |||
229 | 124 | if ( ! empty($parent->entityListeners) && empty($class->entityListeners)) { |
|
230 | 15 | $class->entityListeners = $parent->entityListeners; |
|
231 | } |
||
232 | } |
||
233 | |||
234 | 421 | $class->setParentClasses($nonSuperclassParents); |
|
235 | |||
236 | 421 | if ($class->isRootEntity() && ! $class->isInheritanceTypeNone() && ! $class->discriminatorMap) { |
|
237 | 1 | $this->addDefaultDiscriminatorMap($class); |
|
238 | } |
||
239 | |||
240 | 421 | if ($this->evm->hasListeners(Events::loadClassMetadata)) { |
|
241 | 6 | $eventArgs = new LoadClassMetadataEventArgs($class, $this->em); |
|
242 | 6 | $this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs); |
|
243 | } |
||
244 | |||
245 | 420 | $this->validateRuntimeMetadata($class, $parent); |
|
246 | 419 | } |
|
247 | |||
248 | /** |
||
249 | * Validate runtime metadata is correctly defined. |
||
250 | * |
||
251 | * @param ClassMetadata $class |
||
252 | * @param ClassMetadataInterface|null $parent |
||
253 | * |
||
254 | * @return void |
||
255 | * |
||
256 | * @throws MappingException |
||
257 | */ |
||
258 | 420 | protected function validateRuntimeMetadata($class, $parent) |
|
259 | { |
||
260 | 420 | if ( ! $class->reflClass ) { |
|
261 | // only validate if there is a reflection class instance |
||
262 | 8 | return; |
|
263 | } |
||
264 | |||
265 | 412 | $class->validateIdentifier(); |
|
266 | 412 | $class->validateAssociations(); |
|
267 | 412 | $class->validateLifecycleCallbacks($this->getReflectionService()); |
|
268 | |||
269 | // verify inheritance |
||
270 | 412 | if ( ! $class->isMappedSuperclass && !$class->isInheritanceTypeNone()) { |
|
271 | 71 | if ( ! $parent) { |
|
272 | 67 | if (count($class->discriminatorMap) == 0) { |
|
273 | throw MappingException::missingDiscriminatorMap($class->name); |
||
274 | } |
||
275 | 67 | if ( ! $class->discriminatorColumn) { |
|
276 | 71 | throw MappingException::missingDiscriminatorColumn($class->name); |
|
277 | } |
||
278 | } |
||
279 | 377 | } else if ($class->isMappedSuperclass && $class->name == $class->rootEntityName && (count($class->discriminatorMap) || $class->discriminatorColumn)) { |
|
280 | // second condition is necessary for mapped superclasses in the middle of an inheritance hierarchy |
||
281 | 1 | throw MappingException::noInheritanceOnMappedSuperClass($class->name); |
|
282 | } |
||
283 | 411 | } |
|
284 | |||
285 | /** |
||
286 | * {@inheritDoc} |
||
287 | */ |
||
288 | 428 | protected function newClassMetadataInstance($className) |
|
289 | { |
||
290 | 428 | return new ClassMetadata($className, $this->em->getConfiguration()->getNamingStrategy()); |
|
291 | } |
||
292 | |||
293 | /** |
||
294 | * Populates the discriminator value of the given metadata (if not set) by iterating over discriminator |
||
295 | * map classes and looking for a fitting one. |
||
296 | * |
||
297 | * @param ClassMetadata $metadata |
||
298 | * |
||
299 | * @return void |
||
300 | * |
||
301 | * @throws MappingException |
||
302 | */ |
||
303 | 412 | private function resolveDiscriminatorValue(ClassMetadata $metadata) |
|
304 | { |
||
305 | 412 | if ($metadata->discriminatorValue |
|
306 | 398 | || ! $metadata->discriminatorMap |
|
307 | 43 | || $metadata->isMappedSuperclass |
|
308 | 42 | || ! $metadata->reflClass |
|
309 | 412 | || $metadata->reflClass->isAbstract() |
|
310 | ) { |
||
311 | 412 | return; |
|
312 | } |
||
313 | |||
314 | // minor optimization: avoid loading related metadata when not needed |
||
315 | 5 | foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) { |
|
316 | 5 | if ($discriminatorClass === $metadata->name) { |
|
317 | 3 | $metadata->discriminatorValue = $discriminatorValue; |
|
318 | |||
319 | 5 | return; |
|
320 | } |
||
321 | } |
||
322 | |||
323 | // iterate over discriminator mappings and resolve actual referenced classes according to existing metadata |
||
324 | 2 | foreach ($metadata->discriminatorMap as $discriminatorValue => $discriminatorClass) { |
|
325 | 2 | if ($metadata->name === $this->getMetadataFor($discriminatorClass)->getName()) { |
|
326 | 1 | $metadata->discriminatorValue = $discriminatorValue; |
|
327 | |||
328 | 2 | return; |
|
329 | } |
||
330 | } |
||
331 | |||
332 | 1 | throw MappingException::mappedClassNotPartOfDiscriminatorMap($metadata->name, $metadata->rootEntityName); |
|
333 | } |
||
334 | |||
335 | /** |
||
336 | * Adds a default discriminator map if no one is given |
||
337 | * |
||
338 | * If an entity is of any inheritance type and does not contain a |
||
339 | * discriminator map, then the map is generated automatically. This process |
||
340 | * is expensive computation wise. |
||
341 | * |
||
342 | * The automatically generated discriminator map contains the lowercase short name of |
||
343 | * each class as key. |
||
344 | * |
||
345 | * @param \Doctrine\ORM\Mapping\ClassMetadata $class |
||
346 | * |
||
347 | * @throws MappingException |
||
348 | */ |
||
349 | 1 | private function addDefaultDiscriminatorMap(ClassMetadata $class) |
|
350 | { |
||
351 | 1 | $allClasses = $this->driver->getAllClassNames(); |
|
352 | 1 | $fqcn = $class->getName(); |
|
353 | 1 | $map = array($this->getShortName($class->name) => $fqcn); |
|
354 | |||
355 | 1 | $duplicates = array(); |
|
356 | 1 | foreach ($allClasses as $subClassCandidate) { |
|
357 | 1 | if (is_subclass_of($subClassCandidate, $fqcn)) { |
|
358 | 1 | $shortName = $this->getShortName($subClassCandidate); |
|
359 | |||
360 | 1 | if (isset($map[$shortName])) { |
|
361 | $duplicates[] = $shortName; |
||
362 | } |
||
363 | |||
364 | 1 | $map[$shortName] = $subClassCandidate; |
|
365 | } |
||
366 | } |
||
367 | |||
368 | 1 | if ($duplicates) { |
|
369 | throw MappingException::duplicateDiscriminatorEntry($class->name, $duplicates, $map); |
||
370 | } |
||
371 | |||
372 | 1 | $class->setDiscriminatorMap($map); |
|
373 | 1 | } |
|
374 | |||
375 | /** |
||
376 | * Gets the lower-case short name of a class. |
||
377 | * |
||
378 | * @param string $className |
||
379 | * |
||
380 | * @return string |
||
381 | */ |
||
382 | 1 | private function getShortName($className) |
|
392 | |||
393 | /** |
||
394 | * Adds inherited fields to the subclass mapping. |
||
395 | * |
||
396 | * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass |
||
397 | * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass |
||
398 | * |
||
399 | * @return void |
||
400 | */ |
||
401 | 125 | private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
416 | |||
417 | /** |
||
418 | * Adds inherited association mappings to the subclass mapping. |
||
419 | * |
||
420 | * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass |
||
421 | * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass |
||
422 | * |
||
423 | * @return void |
||
424 | * |
||
425 | * @throws MappingException |
||
426 | */ |
||
427 | 125 | private function addInheritedRelations(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
447 | |||
448 | 124 | private function addInheritedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
461 | |||
462 | /** |
||
463 | * Adds nested embedded classes metadata to a parent class. |
||
464 | * |
||
465 | * @param ClassMetadata $subClass Sub embedded class metadata to add nested embedded classes metadata from. |
||
466 | * @param ClassMetadata $parentClass Parent class to add nested embedded classes metadata to. |
||
467 | * @param string $prefix Embedded classes' prefix to use for nested embedded classes field names. |
||
468 | */ |
||
469 | 11 | private function addNestedEmbeddedClasses(ClassMetadata $subClass, ClassMetadata $parentClass, $prefix) |
|
489 | |||
490 | /** |
||
491 | * Copy the table indices from the parent class superclass to the child class |
||
492 | * |
||
493 | * @param ClassMetadata $subClass |
||
494 | * @param ClassMetadata $parentClass |
||
495 | * |
||
496 | * @return void |
||
497 | */ |
||
498 | 124 | private function addInheritedIndexes(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
516 | |||
517 | /** |
||
518 | * Adds inherited named queries to the subclass mapping. |
||
519 | * |
||
520 | * @since 2.2 |
||
521 | * |
||
522 | * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass |
||
523 | * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass |
||
524 | * |
||
525 | * @return void |
||
526 | */ |
||
527 | 1 | private function addInheritedNamedQueries(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
538 | |||
539 | /** |
||
540 | * Adds inherited named native queries to the subclass mapping. |
||
541 | * |
||
542 | * @since 2.3 |
||
543 | * |
||
544 | * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass |
||
545 | * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass |
||
546 | * |
||
547 | * @return void |
||
548 | */ |
||
549 | 8 | private function addInheritedNamedNativeQueries(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
563 | |||
564 | /** |
||
565 | * Adds inherited sql result set mappings to the subclass mapping. |
||
566 | * |
||
567 | * @since 2.3 |
||
568 | * |
||
569 | * @param \Doctrine\ORM\Mapping\ClassMetadata $subClass |
||
570 | * @param \Doctrine\ORM\Mapping\ClassMetadata $parentClass |
||
571 | * |
||
572 | * @return void |
||
573 | */ |
||
574 | 8 | private function addInheritedSqlResultSetMappings(ClassMetadata $subClass, ClassMetadata $parentClass) |
|
596 | |||
597 | /** |
||
598 | * Completes the ID generator mapping. If "auto" is specified we choose the generator |
||
599 | * most appropriate for the targeted database platform. |
||
600 | * |
||
601 | * @param ClassMetadataInfo $class |
||
602 | * |
||
603 | * @return void |
||
604 | * |
||
605 | * @throws ORMException |
||
606 | */ |
||
607 | 422 | private function completeIdGeneratorMapping(ClassMetadataInfo $class) |
|
709 | |||
710 | /** |
||
711 | * Inherits the ID generator mapping from a parent class. |
||
712 | * |
||
713 | * @param ClassMetadataInfo $class |
||
714 | * @param ClassMetadataInfo $parent |
||
715 | */ |
||
716 | 84 | private function inheritIdGeneratorMapping(ClassMetadataInfo $class, ClassMetadataInfo $parent) |
|
717 | { |
||
718 | 84 | if ($parent->isIdGeneratorSequence()) { |
|
719 | 3 | $class->setSequenceGeneratorDefinition($parent->sequenceGeneratorDefinition); |
|
720 | 81 | } elseif ($parent->isIdGeneratorTable()) { |
|
721 | $class->tableGeneratorDefinition = $parent->tableGeneratorDefinition; |
||
722 | } |
||
723 | |||
724 | 84 | if ($parent->generatorType) { |
|
725 | 84 | $class->setIdGeneratorType($parent->generatorType); |
|
726 | } |
||
727 | |||
728 | 84 | if ($parent->idGenerator) { |
|
729 | 84 | $class->setIdGenerator($parent->idGenerator); |
|
730 | } |
||
731 | 84 | } |
|
732 | |||
733 | /** |
||
734 | * {@inheritDoc} |
||
735 | */ |
||
736 | 2016 | protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService) |
|
741 | |||
742 | /** |
||
743 | * {@inheritDoc} |
||
744 | */ |
||
745 | 433 | protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService) |
|
750 | |||
751 | /** |
||
752 | * {@inheritDoc} |
||
753 | */ |
||
754 | 4 | protected function getFqcnFromAlias($namespaceAlias, $simpleClassName) |
|
758 | |||
759 | /** |
||
760 | * {@inheritDoc} |
||
761 | */ |
||
762 | 238 | protected function getDriver() |
|
766 | |||
767 | /** |
||
768 | * {@inheritDoc} |
||
769 | */ |
||
770 | 419 | protected function isEntity(ClassMetadataInterface $class) |
|
774 | |||
775 | /** |
||
776 | * @return Platforms\AbstractPlatform |
||
777 | */ |
||
778 | 323 | private function getTargetPlatform() |
|
786 | } |
||
787 |
Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: