sonata-project /
SonataDoctrinePhpcrAdminBundle
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 |
||
| 29 | class ModelManager implements ModelManagerInterface |
||
| 30 | { |
||
| 31 | /** |
||
| 32 | * @var DocumentManager |
||
| 33 | */ |
||
| 34 | protected $dm; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @param DocumentManager $dm |
||
| 38 | */ |
||
| 39 | public function __construct(DocumentManager $dm) |
||
| 40 | { |
||
| 41 | $this->dm = $dm; |
||
| 42 | } |
||
| 43 | |||
| 44 | /** |
||
| 45 | * Returns the related model's metadata |
||
| 46 | * |
||
| 47 | * @param string $class |
||
| 48 | * |
||
| 49 | * @return ClassMetadata |
||
| 50 | */ |
||
| 51 | public function getMetadata($class) |
||
| 52 | { |
||
| 53 | return $this->dm->getMetadataFactory()->getMetadataFor($class); |
||
| 54 | } |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Returns true is the model has some metadata. |
||
| 58 | * |
||
| 59 | * @param string $class |
||
| 60 | * |
||
| 61 | * @return boolean |
||
| 62 | */ |
||
| 63 | public function hasMetadata($class) |
||
| 64 | { |
||
| 65 | return $this->dm->getMetadataFactory()->hasMetadataFor($class); |
||
| 66 | } |
||
| 67 | |||
| 68 | /** |
||
| 69 | * {@inheritDoc} |
||
| 70 | * |
||
| 71 | * @throws ModelManagerException if the document manager throws any exception |
||
| 72 | */ |
||
| 73 | public function create($object) |
||
| 74 | { |
||
| 75 | try { |
||
| 76 | $this->dm->persist($object); |
||
| 77 | $this->dm->flush(); |
||
| 78 | } catch (\Exception $e) { |
||
| 79 | throw new ModelManagerException('', 0, $e); |
||
| 80 | } |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * {@inheritDoc} |
||
| 85 | * |
||
| 86 | * @throws ModelManagerException if the document manager throws any exception |
||
| 87 | */ |
||
| 88 | public function update($object) |
||
| 89 | { |
||
| 90 | try { |
||
| 91 | $this->dm->persist($object); |
||
| 92 | $this->dm->flush(); |
||
| 93 | } catch (\Exception $e) { |
||
| 94 | throw new ModelManagerException('', 0, $e); |
||
| 95 | } |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * {@inheritDoc} |
||
| 100 | * |
||
| 101 | * @throws ModelManagerException if the document manager throws any exception |
||
| 102 | */ |
||
| 103 | public function delete($object) |
||
| 104 | { |
||
| 105 | try { |
||
| 106 | $this->dm->remove($object); |
||
| 107 | $this->dm->flush(); |
||
| 108 | } catch (\Exception $e) { |
||
| 109 | throw new ModelManagerException('', 0, $e); |
||
| 110 | } |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Find one object from the given class repository. |
||
| 115 | * |
||
| 116 | * {@inheritDoc} |
||
| 117 | */ |
||
| 118 | public function find($class, $id) |
||
| 119 | { |
||
| 120 | if (!isset($id)) { |
||
| 121 | return null; |
||
| 122 | } |
||
| 123 | |||
| 124 | if (null === $class) { |
||
| 125 | return $this->dm->find(null, $id); |
||
| 126 | } |
||
| 127 | |||
| 128 | return $this->dm->getRepository($class)->find($id); |
||
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * {@inheritDoc} |
||
| 133 | * |
||
| 134 | * @return FieldDescription |
||
| 135 | * |
||
| 136 | * @throws \RunTimeException if $name is not a string. |
||
| 137 | */ |
||
| 138 | public function getNewFieldDescriptionInstance($class, $name, array $options = array()) |
||
| 139 | { |
||
| 140 | if (!is_string($name)) { |
||
| 141 | throw new \RunTimeException('The name argument must be a string'); |
||
| 142 | } |
||
| 143 | |||
| 144 | $metadata = $this->getMetadata($class); |
||
| 145 | |||
| 146 | $fieldDescription = new FieldDescription; |
||
| 147 | $fieldDescription->setName($name); |
||
| 148 | $fieldDescription->setOptions($options); |
||
| 149 | |||
| 150 | if (isset($metadata->associationMappings[$name])) { |
||
|
|
|||
| 151 | $fieldDescription->setAssociationMapping($metadata->associationMappings[$name]); |
||
| 152 | } |
||
| 153 | |||
| 154 | if (isset($metadata->fieldMappings[$name])) { |
||
| 155 | $fieldDescription->setFieldMapping($metadata->fieldMappings[$name]); |
||
| 156 | } |
||
| 157 | |||
| 158 | return $fieldDescription; |
||
| 159 | } |
||
| 160 | |||
| 161 | /** |
||
| 162 | * {@inheritDoc} |
||
| 163 | */ |
||
| 164 | public function findBy($class, array $criteria = array()) |
||
| 165 | { |
||
| 166 | return $this->dm->getRepository($class)->findBy($criteria); |
||
| 167 | } |
||
| 168 | |||
| 169 | /** |
||
| 170 | * {@inheritDoc} |
||
| 171 | */ |
||
| 172 | public function findOneBy($class, array $criteria = array()) |
||
| 173 | { |
||
| 174 | return $this->dm->getRepository($class)->findOneBy($criteria); |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @return DocumentManager The PHPCR-ODM document manager responsible for |
||
| 179 | * this model. |
||
| 180 | */ |
||
| 181 | public function getDocumentManager() |
||
| 185 | |||
| 186 | /** |
||
| 187 | * {@inheritDoc} |
||
| 188 | * |
||
| 189 | * @return FieldDescriptionInterface |
||
| 190 | */ |
||
| 191 | public function getParentFieldDescription($parentAssociationMapping, $class) |
||
| 192 | { |
||
| 193 | $fieldName = $parentAssociationMapping['fieldName']; |
||
| 194 | |||
| 195 | $metadata = $this->getMetadata($class); |
||
| 196 | |||
| 197 | $associatingMapping = $metadata->associationMappings[$parentAssociationMapping]; |
||
| 198 | |||
| 199 | $fieldDescription = $this->getNewFieldDescriptionInstance($class, $fieldName); |
||
| 200 | $fieldDescription->setName($parentAssociationMapping); |
||
| 201 | $fieldDescription->setAssociationMapping($associatingMapping); |
||
| 202 | |||
| 203 | return $fieldDescription; |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * @param string $class the fully qualified class name to search for |
||
| 208 | * @param string $alias alias to use for this class when accessing fields, |
||
| 209 | * defaults to 'a'. |
||
| 210 | * |
||
| 211 | * @return ProxyQueryInterface |
||
| 212 | * |
||
| 213 | * @throws \InvalidArgumentException if alias is not a string or an empty string |
||
| 214 | */ |
||
| 215 | public function createQuery($class, $alias = 'a') |
||
| 216 | { |
||
| 217 | $qb = $this->getDocumentManager()->createQueryBuilder(); |
||
| 218 | $qb->from()->document($class, $alias); |
||
| 219 | |||
| 220 | return new ProxyQuery($qb, $alias); |
||
| 221 | } |
||
| 222 | |||
| 223 | /** |
||
| 224 | * @param ProxyQuery $query |
||
| 225 | * |
||
| 226 | * @return mixed |
||
| 227 | */ |
||
| 228 | public function executeQuery($query) |
||
| 229 | { |
||
| 230 | return $query->execute(); |
||
| 231 | } |
||
| 232 | |||
| 233 | /** |
||
| 234 | * {@inheritDoc} |
||
| 235 | */ |
||
| 236 | public function getModelIdentifier($classname) |
||
| 237 | { |
||
| 238 | return $this->getMetadata($classname)->identifier; |
||
| 239 | } |
||
| 240 | |||
| 241 | /** |
||
| 242 | * Transforms the document into the PHPCR path. |
||
| 243 | * |
||
| 244 | * Note: This is returning an array because Doctrine ORM for example can |
||
| 245 | * have multiple identifiers, e.g. if the primary key is composed of |
||
| 246 | * several columns. We only ever have one, but return that wrapped into an |
||
| 247 | * array to adhere to the interface. |
||
| 248 | * |
||
| 249 | * {@inheritDoc} |
||
| 250 | */ |
||
| 251 | public function getIdentifierValues($document) |
||
| 252 | { |
||
| 253 | $class = $this->getMetadata(ClassUtils::getClass($document)); |
||
| 254 | $path = $class->reflFields[$class->identifier]->getValue($document); |
||
| 255 | |||
| 256 | return array($path); |
||
| 257 | } |
||
| 258 | |||
| 259 | /** |
||
| 260 | * {@inheritDoc} |
||
| 261 | */ |
||
| 262 | public function getIdentifierFieldNames($class) |
||
| 266 | |||
| 267 | /** |
||
| 268 | * This is just taking the id out of the array again. |
||
| 269 | * |
||
| 270 | * {@inheritDoc} |
||
| 271 | * |
||
| 272 | * @throws \InvalidArgumentException if $document is not an object or null |
||
| 273 | */ |
||
| 274 | public function getNormalizedIdentifier($document) |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Currently only the leading slash is removed. |
||
| 292 | * |
||
| 293 | * TODO: do we also have to encode certain characters like spaces or does that happen automatically? |
||
| 294 | * |
||
| 295 | * @param object $document |
||
| 296 | * |
||
| 297 | * @return null|string |
||
| 298 | */ |
||
| 299 | public function getUrlsafeIdentifier($document) |
||
| 300 | { |
||
| 301 | $id = $this->getNormalizedIdentifier($document); |
||
| 302 | if (null !== $id) { |
||
| 303 | return substr($id, 1); |
||
| 304 | } |
||
| 305 | |||
| 306 | return null; |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * {@inheritDoc} |
||
| 311 | */ |
||
| 312 | public function addIdentifiersToQuery($class, ProxyQueryInterface $queryProxy, array $idx) |
||
| 324 | |||
| 325 | /** |
||
| 326 | * Add leading slash to construct valid phpcr document id. |
||
| 327 | * |
||
| 328 | * The phpcr-odm QueryBuilder uses absolute paths and expects id´s to start with a forward slash |
||
| 329 | * because SonataAdmin uses object id´s for constructing URL´s it has to use id´s without the |
||
| 330 | * leading slash. |
||
| 331 | * |
||
| 332 | * @param string $id |
||
| 333 | * |
||
| 334 | * @return string |
||
| 335 | */ |
||
| 336 | public function getBackendId($id) |
||
| 337 | { |
||
| 338 | return substr($id, 0, 1) === '/' ? $id : '/'.$id; |
||
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * {@inheritDoc} |
||
| 343 | * |
||
| 344 | * @throws ModelManagerException if anything goes wrong during query execution. |
||
| 345 | */ |
||
| 346 | public function batchDelete($class, ProxyQueryInterface $queryProxy) |
||
| 347 | { |
||
| 348 | try { |
||
| 349 | $i = 0; |
||
| 350 | $res = $queryProxy->execute(); |
||
| 351 | foreach ($res as $object) { |
||
| 352 | $this->dm->remove($object); |
||
| 353 | |||
| 354 | if ((++$i % 20) == 0) { |
||
| 355 | $this->dm->flush(); |
||
| 356 | $this->dm->clear(); |
||
| 357 | } |
||
| 358 | } |
||
| 359 | |||
| 360 | $this->dm->flush(); |
||
| 361 | $this->dm->clear(); |
||
| 362 | } catch (\Exception $e) { |
||
| 363 | throw new ModelManagerException('', 0, $e); |
||
| 364 | } |
||
| 365 | } |
||
| 366 | |||
| 367 | /** |
||
| 368 | * {@inheritDoc} |
||
| 369 | * |
||
| 370 | * @return object |
||
| 371 | */ |
||
| 372 | public function getModelInstance($class) |
||
| 373 | { |
||
| 374 | return new $class; |
||
| 375 | } |
||
| 376 | |||
| 377 | /** |
||
| 378 | * {@inheritDoc} |
||
| 379 | */ |
||
| 380 | public function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid) |
||
| 399 | |||
| 400 | /** |
||
| 401 | * {@inheritDoc} |
||
| 402 | */ |
||
| 403 | public function getPaginationParameters(DatagridInterface $datagrid, $page) |
||
| 404 | { |
||
| 405 | $values = $datagrid->getValues(); |
||
| 406 | |||
| 407 | $values['_sort_by'] = $values['_sort_by']->getName(); |
||
| 408 | $values['_page'] = $page; |
||
| 409 | |||
| 410 | return array('filter' => $values); |
||
| 411 | } |
||
| 412 | |||
| 413 | /** |
||
| 414 | * {@inheritDoc} |
||
| 415 | */ |
||
| 416 | public function getDefaultSortValues($class) |
||
| 424 | |||
| 425 | /** |
||
| 426 | * {@inheritDoc} |
||
| 427 | * |
||
| 428 | * @return object |
||
| 429 | */ |
||
| 430 | public function modelTransform($class, $instance) |
||
| 431 | { |
||
| 432 | return $instance; |
||
| 433 | } |
||
| 434 | |||
| 435 | /** |
||
| 436 | * {@inheritDoc} |
||
| 437 | * |
||
| 438 | * @return object |
||
| 439 | * |
||
| 440 | * @throws NoSuchPropertyException if the class has no magic setter and |
||
| 441 | * public property for a field in array. |
||
| 442 | */ |
||
| 443 | public function modelReverseTransform($class, array $array = array()) |
||
| 489 | |||
| 490 | /** |
||
| 491 | * Method taken from PropertyPath. |
||
| 492 | * |
||
| 493 | * TODO: remove when doing https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle/issues/187 |
||
| 494 | * |
||
| 495 | * @param string $property |
||
| 496 | * |
||
| 497 | * @return string |
||
| 498 | * |
||
| 499 | * @deprecated |
||
| 500 | */ |
||
| 501 | protected function camelize($property) |
||
| 502 | { |
||
| 503 | return preg_replace(array('/(^|_)+(.)/e', '/\.(.)/e'), array("strtoupper('\\2')", "'_'.strtoupper('\\1')"), $property); |
||
| 504 | } |
||
| 505 | |||
| 506 | /** |
||
| 507 | * {@inheritDoc} |
||
| 508 | */ |
||
| 509 | public function getModelCollectionInstance($class) |
||
| 513 | |||
| 514 | /** |
||
| 515 | * {@inheritDoc} |
||
| 516 | */ |
||
| 517 | public function collectionClear(&$collection) |
||
| 521 | |||
| 522 | /** |
||
| 523 | * {@inheritDoc} |
||
| 524 | */ |
||
| 525 | public function collectionHasElement(&$collection, &$element) |
||
| 529 | |||
| 530 | /** |
||
| 531 | * {@inheritDoc} |
||
| 532 | */ |
||
| 533 | public function collectionAddElement(&$collection, &$element) |
||
| 537 | |||
| 538 | /** |
||
| 539 | * {@inheritDoc} |
||
| 540 | */ |
||
| 541 | public function collectionRemoveElement(&$collection, &$element) |
||
| 545 | |||
| 546 | /** |
||
| 547 | * {@inheritDoc} |
||
| 548 | */ |
||
| 549 | public function getDataSourceIterator(DatagridInterface $datagrid, array $fields, $firstResult = null, $maxResult = null) |
||
| 553 | |||
| 554 | /** |
||
| 555 | * {@inheritDoc} |
||
| 556 | * |
||
| 557 | * Not really implemented. |
||
| 558 | */ |
||
| 559 | public function getExportFields($class) |
||
| 563 | } |
||
| 564 |
Loading history...
An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.
If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.