Complex classes like ModelManager 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 ModelManager, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
31 | class ModelManager implements ModelManagerInterface |
||
32 | { |
||
33 | public const ID_SEPARATOR = '-'; |
||
34 | |||
35 | /** |
||
36 | * @var ManagerRegistry |
||
37 | */ |
||
38 | protected $registry; |
||
39 | |||
40 | /** |
||
41 | * @var PropertyAccessorInterface |
||
42 | */ |
||
43 | private $propertyAccessor; |
||
44 | |||
45 | /** |
||
46 | * NEXT_MAJOR: Make $propertyAccessor mandatory. |
||
47 | */ |
||
48 | public function __construct(ManagerRegistry $registry, ?PropertyAccessorInterface $propertyAccessor = null) |
||
49 | { |
||
50 | $this->registry = $registry; |
||
51 | |||
52 | // NEXT_MAJOR: Remove this block. |
||
53 | if (!$propertyAccessor instanceof PropertyAccessorInterface) { |
||
54 | @trigger_error(sprintf( |
||
|
|||
55 | 'Not passing an object implementing "%s" as argument 2 for "%s()" is deprecated since' |
||
56 | .' sonata-project/doctrine-mongodb-admin-bundle 3.x and will throw a %s error in 4.0.', |
||
57 | PropertyAccessorInterface::class, |
||
58 | __METHOD__, |
||
59 | \TypeError::class |
||
60 | ), E_USER_DEPRECATED); |
||
61 | |||
62 | $propertyAccessor = PropertyAccess::createPropertyAccessor(); |
||
63 | } |
||
64 | |||
65 | $this->propertyAccessor = $propertyAccessor; |
||
66 | } |
||
67 | |||
68 | public function getMetadata($class) |
||
69 | { |
||
70 | return $this->getDocumentManager($class)->getMetadataFactory()->getMetadataFor($class); |
||
71 | } |
||
72 | |||
73 | /** |
||
74 | * Returns the model's metadata holding the fully qualified property, and the last |
||
75 | * property name. |
||
76 | * |
||
77 | * @param string $baseClass The base class of the model holding the fully qualified property |
||
78 | * @param string $propertyFullName The name of the fully qualified property (dot ('.') separated |
||
79 | * property string) |
||
80 | * |
||
81 | * @return array( |
||
82 | * \Doctrine\ODM\MongoDB\Mapping\ClassMetadata $parentMetadata, |
||
83 | * string $lastPropertyName, |
||
84 | * array $parentAssociationMappings |
||
85 | * ) |
||
86 | */ |
||
87 | public function getParentMetadataForProperty($baseClass, $propertyFullName) |
||
88 | { |
||
89 | $nameElements = explode('.', $propertyFullName); |
||
90 | $lastPropertyName = array_pop($nameElements); |
||
91 | $class = $baseClass; |
||
92 | $parentAssociationMappings = []; |
||
93 | |||
94 | foreach ($nameElements as $nameElement) { |
||
95 | $metadata = $this->getMetadata($class); |
||
96 | $parentAssociationMappings[] = $metadata->associationMappings[$nameElement]; |
||
97 | $class = $metadata->getAssociationTargetClass($nameElement); |
||
98 | } |
||
99 | |||
100 | return [$this->getMetadata($class), $lastPropertyName, $parentAssociationMappings]; |
||
101 | } |
||
102 | |||
103 | public function hasMetadata($class) |
||
104 | { |
||
105 | return $this->getDocumentManager($class)->getMetadataFactory()->hasMetadataFor($class); |
||
106 | } |
||
107 | |||
108 | public function getNewFieldDescriptionInstance($class, $name, array $options = []) |
||
109 | { |
||
110 | if (!\is_string($name)) { |
||
111 | throw new \RuntimeException('The name argument must be a string'); |
||
112 | } |
||
113 | |||
114 | if (!isset($options['route']['name'])) { |
||
115 | $options['route']['name'] = 'edit'; |
||
116 | } |
||
117 | |||
118 | if (!isset($options['route']['parameters'])) { |
||
119 | $options['route']['parameters'] = []; |
||
120 | } |
||
121 | |||
122 | [$metadata, $propertyName, $parentAssociationMappings] = $this->getParentMetadataForProperty($class, $name); |
||
123 | |||
124 | $fieldDescription = new FieldDescription(); |
||
125 | $fieldDescription->setName($name); |
||
126 | $fieldDescription->setOptions($options); |
||
127 | $fieldDescription->setParentAssociationMappings($parentAssociationMappings); |
||
128 | |||
129 | /* @var ClassMetadata */ |
||
130 | if (isset($metadata->associationMappings[$propertyName])) { |
||
131 | $fieldDescription->setAssociationMapping($metadata->associationMappings[$propertyName]); |
||
132 | } |
||
133 | |||
134 | if (isset($metadata->fieldMappings[$propertyName])) { |
||
135 | $fieldDescription->setFieldMapping($metadata->fieldMappings[$propertyName]); |
||
136 | } |
||
137 | |||
138 | return $fieldDescription; |
||
139 | } |
||
140 | |||
141 | public function create($object): void |
||
142 | { |
||
143 | $documentManager = $this->getDocumentManager($object); |
||
144 | $documentManager->persist($object); |
||
145 | $documentManager->flush(); |
||
146 | } |
||
147 | |||
148 | public function update($object): void |
||
149 | { |
||
150 | $documentManager = $this->getDocumentManager($object); |
||
151 | $documentManager->persist($object); |
||
152 | $documentManager->flush(); |
||
153 | } |
||
154 | |||
155 | public function delete($object): void |
||
156 | { |
||
157 | $documentManager = $this->getDocumentManager($object); |
||
158 | $documentManager->remove($object); |
||
159 | $documentManager->flush(); |
||
160 | } |
||
161 | |||
162 | public function find($class, $id) |
||
163 | { |
||
164 | if (!isset($id)) { |
||
165 | return null; |
||
166 | } |
||
167 | |||
168 | $documentManager = $this->getDocumentManager($class); |
||
169 | |||
170 | if (is_numeric($id)) { |
||
171 | $value = $documentManager->getRepository($class)->find((int) $id); |
||
172 | |||
173 | if (!empty($value)) { |
||
174 | return $value; |
||
175 | } |
||
176 | } |
||
177 | |||
178 | return $documentManager->getRepository($class)->find($id); |
||
179 | } |
||
180 | |||
181 | public function findBy($class, array $criteria = []) |
||
182 | { |
||
183 | return $this->getDocumentManager($class)->getRepository($class)->findBy($criteria); |
||
184 | } |
||
185 | |||
186 | public function findOneBy($class, array $criteria = []) |
||
187 | { |
||
188 | return $this->getDocumentManager($class)->getRepository($class)->findOneBy($criteria); |
||
189 | } |
||
190 | |||
191 | /** |
||
192 | * @param object|string $class |
||
193 | * |
||
194 | * @throw \RuntimeException |
||
195 | * |
||
196 | * @return \Doctrine\ODM\MongoDB\DocumentManager |
||
197 | */ |
||
198 | public function getDocumentManager($class) |
||
199 | { |
||
200 | if (\is_object($class)) { |
||
201 | $class = \get_class($class); |
||
202 | } |
||
203 | |||
204 | $dm = $this->registry->getManagerForClass($class); |
||
205 | |||
206 | if (!$dm) { |
||
207 | throw new \RuntimeException(sprintf('No document manager defined for class %s', $class)); |
||
208 | } |
||
209 | |||
210 | return $dm; |
||
211 | } |
||
212 | |||
213 | /** |
||
214 | * NEXT_MAJOR: Remove this method. |
||
215 | * |
||
216 | * @deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x and will be removed in version 4.0 |
||
217 | */ |
||
218 | public function getParentFieldDescription($parentAssociationMapping, $class) |
||
219 | { |
||
220 | @trigger_error(sprintf( |
||
221 | 'Method "%s()" is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x' |
||
222 | .' and will be removed in 4.0', |
||
223 | __METHOD__ |
||
224 | ), E_USER_DEPRECATED); |
||
225 | |||
226 | $fieldName = $parentAssociationMapping['fieldName']; |
||
227 | |||
228 | $metadata = $this->getMetadata($class); |
||
229 | |||
230 | $associatingMapping = $metadata->associationMappings[$parentAssociationMapping]; |
||
231 | |||
232 | $fieldDescription = $this->getNewFieldDescriptionInstance($class, $fieldName); |
||
233 | $fieldDescription->setName($parentAssociationMapping); |
||
234 | $fieldDescription->setAssociationMapping($associatingMapping); |
||
235 | |||
236 | return $fieldDescription; |
||
237 | } |
||
238 | |||
239 | public function createQuery($class, $alias = 'o') |
||
240 | { |
||
241 | $repository = $this->getDocumentManager($class)->getRepository($class); |
||
242 | |||
243 | return new ProxyQuery($repository->createQueryBuilder()); |
||
244 | } |
||
245 | |||
246 | public function executeQuery($query) |
||
247 | { |
||
248 | if ($query instanceof Builder) { |
||
249 | return $query->getQuery()->execute(); |
||
250 | } |
||
251 | |||
252 | return $query->execute(); |
||
253 | } |
||
254 | |||
255 | public function getModelIdentifier($class) |
||
259 | |||
260 | public function getIdentifierValues($document) |
||
264 | |||
265 | public function getIdentifierFieldNames($class) |
||
266 | { |
||
267 | return [$this->getMetadata($class)->getIdentifier()]; |
||
268 | } |
||
269 | |||
270 | public function getNormalizedIdentifier($document) |
||
271 | { |
||
272 | if (null === $document) { |
||
273 | return null; |
||
274 | } |
||
275 | |||
276 | if (!\is_object($document)) { |
||
277 | throw new \RuntimeException('Invalid argument, object or null required'); |
||
278 | } |
||
279 | |||
280 | // the document is not managed |
||
289 | |||
290 | public function getUrlSafeIdentifier($document) |
||
294 | |||
295 | public function addIdentifiersToQuery($class, ProxyQueryInterface $queryProxy, array $idx): void |
||
300 | |||
301 | public function batchDelete($class, ProxyQueryInterface $queryProxy): void |
||
321 | |||
322 | public function getDataSourceIterator(DatagridInterface $datagrid, array $fields, $firstResult = null, $maxResult = null) |
||
332 | |||
333 | public function getExportFields($class) |
||
339 | |||
340 | public function getModelInstance($class) |
||
359 | |||
360 | public function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid) |
||
378 | |||
379 | public function getPaginationParameters(DatagridInterface $datagrid, $page) |
||
390 | |||
391 | public function getDefaultSortValues($class) |
||
398 | |||
399 | public function getDefaultPerPageOptions(string $class): array |
||
403 | |||
404 | public function modelTransform($class, $instance) |
||
408 | |||
409 | public function modelReverseTransform($class, array $array = []) |
||
422 | |||
423 | public function getModelCollectionInstance($class) |
||
427 | |||
428 | public function collectionClear(&$collection) |
||
432 | |||
433 | public function collectionHasElement(&$collection, &$element) |
||
437 | |||
438 | public function collectionAddElement(&$collection, &$element) |
||
442 | |||
443 | public function collectionRemoveElement(&$collection, &$element) |
||
447 | |||
448 | /** |
||
449 | * NEXT_MAJOR: Remove this method. |
||
450 | * |
||
451 | * @deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'. |
||
452 | * |
||
453 | * @param string $property |
||
454 | * |
||
455 | * @return mixed |
||
456 | */ |
||
457 | protected function camelize($property) |
||
466 | |||
467 | /** |
||
468 | * NEXT_MAJOR: Remove CommonClassMetadata and add ClassMetadata as type hint when dropping doctrine/mongodb-odm 1.3.x. |
||
469 | * |
||
470 | * @param ClassMetadata|CommonClassMetadata $metadata |
||
471 | */ |
||
472 | private function getFieldName($metadata, string $name): string |
||
484 | |||
485 | private function isFieldAlreadySorted(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid): bool |
||
496 | } |
||
497 |
If you suppress an error, we recommend checking for the error condition explicitly: