FriendsOfSymfony /
FOSElasticaBundle
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like FOSElasticaExtension 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 FOSElasticaExtension, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 26 | class FOSElasticaExtension extends Extension |
||
| 27 | { |
||
| 28 | /** |
||
| 29 | * Definition of elastica clients as configured by this extension. |
||
| 30 | * |
||
| 31 | * @var array |
||
| 32 | */ |
||
| 33 | private $clients = []; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * An array of indexes as configured by the extension. |
||
| 37 | * |
||
| 38 | * @var array |
||
| 39 | */ |
||
| 40 | private $indexConfigs = []; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * If we've encountered a type mapped to a specific persistence driver, it will be loaded |
||
| 44 | * here. |
||
| 45 | * |
||
| 46 | * @var array |
||
| 47 | */ |
||
| 48 | private $loadedDrivers = []; |
||
| 49 | |||
| 50 | 18 | public function load(array $configs, ContainerBuilder $container) |
|
| 100 | |||
| 101 | /** |
||
| 102 | * @param array $config |
||
| 103 | * @param ContainerBuilder $container |
||
| 104 | * |
||
| 105 | * @return Configuration |
||
| 106 | */ |
||
| 107 | 18 | public function getConfiguration(array $config, ContainerBuilder $container) |
|
| 111 | |||
| 112 | /** |
||
| 113 | * Loads the configured clients. |
||
| 114 | * |
||
| 115 | * @param array $clients An array of clients configurations |
||
| 116 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 117 | * |
||
| 118 | * @return array |
||
| 119 | */ |
||
| 120 | 18 | private function loadClients(array $clients, ContainerBuilder $container) |
|
| 143 | |||
| 144 | /** |
||
| 145 | * Loads the configured indexes. |
||
| 146 | * |
||
| 147 | * @param array $indexes An array of indexes configurations |
||
| 148 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 149 | * |
||
| 150 | * @throws \InvalidArgumentException |
||
| 151 | * |
||
| 152 | * @return array |
||
| 153 | */ |
||
| 154 | 18 | private function loadIndexes(array $indexes, ContainerBuilder $container) |
|
| 197 | |||
| 198 | /** |
||
| 199 | * Loads the configured index finders. |
||
| 200 | * |
||
| 201 | * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container |
||
| 202 | * @param string $name The index name |
||
| 203 | * @param Reference $index Reference to the related index |
||
| 204 | * |
||
| 205 | * @return string |
||
| 206 | */ |
||
| 207 | private function loadIndexFinder(ContainerBuilder $container, $name, Reference $index) |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Loads the configured types. |
||
| 226 | * |
||
| 227 | * @param array $types |
||
| 228 | * @param ContainerBuilder $container |
||
| 229 | * @param array $indexConfig |
||
| 230 | * @param array $indexableCallbacks |
||
| 231 | */ |
||
| 232 | 18 | private function loadTypes(array $types, ContainerBuilder $container, array $indexConfig, array &$indexableCallbacks) |
|
| 317 | |||
| 318 | 4 | private function buildCallback($indexCallback, $typeName) |
|
| 343 | |||
| 344 | 4 | private function transformServiceReference($classOrService) |
|
| 348 | |||
| 349 | /** |
||
| 350 | * Loads the optional provider and finder for a type. |
||
| 351 | * |
||
| 352 | * @param array $typeConfig |
||
| 353 | * @param ContainerBuilder $container |
||
| 354 | * @param Reference $typeRef |
||
| 355 | * @param string $indexName |
||
| 356 | * @param string $typeName |
||
| 357 | */ |
||
| 358 | 15 | private function loadTypePersistenceIntegration(array $typeConfig, ContainerBuilder $container, Reference $typeRef, $indexName, $typeName) |
|
| 378 | |||
| 379 | /** |
||
| 380 | * Creates and loads an ElasticaToModelTransformer. |
||
| 381 | * |
||
| 382 | * @param array $typeConfig |
||
| 383 | * @param ContainerBuilder $container |
||
| 384 | * @param string $indexName |
||
| 385 | * @param string $typeName |
||
| 386 | * |
||
| 387 | * @return string |
||
| 388 | */ |
||
| 389 | 15 | private function loadElasticaToModelTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
|
| 411 | |||
| 412 | /** |
||
| 413 | * Creates and loads a ModelToElasticaTransformer for an index/type. |
||
| 414 | * |
||
| 415 | * @param array $typeConfig |
||
| 416 | * @param ContainerBuilder $container |
||
| 417 | * @param string $indexName |
||
| 418 | * @param string $typeName |
||
| 419 | * |
||
| 420 | * @return string |
||
| 421 | */ |
||
| 422 | 15 | private function loadModelToElasticaTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
|
| 441 | |||
| 442 | /** |
||
| 443 | * Creates and loads an object persister for a type. |
||
| 444 | * |
||
| 445 | * @param array $typeConfig |
||
| 446 | * @param Reference $typeRef |
||
| 447 | * @param ContainerBuilder $container |
||
| 448 | * @param string $indexName |
||
| 449 | * @param string $typeName |
||
| 450 | * @param string $transformerId |
||
| 451 | * |
||
| 452 | * @return string |
||
| 453 | */ |
||
| 454 | 15 | private function loadObjectPersister(array $typeConfig, Reference $typeRef, ContainerBuilder $container, $indexName, $typeName, $transformerId) |
|
| 455 | { |
||
| 456 | 15 | if (isset($typeConfig['persister']['service'])) { |
|
| 457 | 1 | return $typeConfig['persister']['service']; |
|
| 458 | } |
||
| 459 | |||
| 460 | $arguments = [ |
||
| 461 | 14 | $typeRef, |
|
| 462 | 14 | new Reference($transformerId), |
|
| 463 | 14 | $typeConfig['model'], |
|
| 464 | ]; |
||
| 465 | |||
| 466 | 14 | if ($container->hasDefinition('fos_elastica.serializer_callback_prototype')) { |
|
| 467 | 1 | $abstractId = 'fos_elastica.object_serializer_persister'; |
|
| 468 | 1 | $callbackId = sprintf('%s.%s.serializer.callback', $this->indexConfigs[$indexName]['reference'], $typeName); |
|
| 469 | 1 | $arguments[] = [new Reference($callbackId), 'serialize']; |
|
| 470 | } else { |
||
| 471 | 13 | $abstractId = 'fos_elastica.object_persister'; |
|
| 472 | 13 | $mapping = $this->indexConfigs[$indexName]['types'][$typeName]['mapping']; |
|
| 473 | 13 | $argument = $mapping['properties']; |
|
| 474 | 13 | if (isset($mapping['_parent'])) { |
|
| 475 | 1 | $argument['_parent'] = $mapping['_parent']; |
|
| 476 | } |
||
| 477 | 13 | $arguments[] = $argument; |
|
| 478 | } |
||
| 479 | |||
| 480 | 14 | $arguments[] = array_intersect_key($typeConfig['persister'], array_flip(['refresh'])); |
|
| 481 | 14 | ||
| 482 | 14 | $serviceId = sprintf('fos_elastica.object_persister.%s.%s', $indexName, $typeName); |
|
| 483 | 14 | $serviceDef = new ChildDefinition($abstractId); |
|
| 484 | foreach ($arguments as $i => $argument) { |
||
| 485 | $serviceDef->replaceArgument($i, $argument); |
||
| 486 | 14 | } |
|
| 487 | |||
| 488 | 14 | $serviceDef->addTag('fos_elastica.persister', ['index' => $indexName, 'type' => $typeName]); |
|
| 489 | |||
| 490 | 14 | $container->setDefinition($serviceId, $serviceDef); |
|
| 491 | |||
| 492 | return $serviceId; |
||
| 493 | } |
||
| 494 | |||
| 495 | /** |
||
| 496 | * Loads a pager provider for a type. |
||
| 497 | * |
||
| 498 | * @param array $typeConfig |
||
| 499 | * @param ContainerBuilder $container |
||
| 500 | * @param string $indexName |
||
| 501 | * @param string $typeName |
||
| 502 | * |
||
| 503 | 15 | * @return string |
|
| 504 | */ |
||
| 505 | 15 | private function loadTypePagerProvider(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
|
| 506 | { |
||
| 507 | if (isset($typeConfig['provider']['service'])) { |
||
| 508 | return $typeConfig['provider']['service']; |
||
| 509 | 15 | } |
|
| 510 | 15 | ||
| 511 | $baseConfig = $typeConfig['provider']; |
||
| 512 | 15 | unset($baseConfig['service']); |
|
| 513 | |||
| 514 | 15 | $driver = $typeConfig['driver']; |
|
| 515 | 15 | ||
| 516 | 14 | switch ($driver) { |
|
| 517 | 14 | case 'orm': |
|
| 518 | 14 | $providerDef = new ChildDefinition('fos_elastica.pager_provider.prototype.'.$driver); |
|
| 519 | $providerDef->replaceArgument(2, $typeConfig['model']); |
||
| 520 | 14 | $providerDef->replaceArgument(3, $baseConfig); |
|
| 521 | 1 | ||
| 522 | break; |
||
| 523 | View Code Duplication | case 'mongodb': |
|
| 524 | $providerDef = new ChildDefinition('fos_elastica.pager_provider.prototype.'.$driver); |
||
| 525 | $providerDef->replaceArgument(2, $typeConfig['model']); |
||
| 526 | $providerDef->replaceArgument(3, $baseConfig); |
||
| 527 | 1 | ||
| 528 | 1 | break; |
|
| 529 | 1 | View Code Duplication | case 'phpcr': |
| 530 | 1 | $providerDef = new ChildDefinition('fos_elastica.pager_provider.prototype.'.$driver); |
|
| 531 | $providerDef->replaceArgument(2, $typeConfig['model']); |
||
| 532 | 1 | $providerDef->replaceArgument(3, $baseConfig); |
|
| 533 | |||
| 534 | break; |
||
| 535 | default: |
||
| 536 | throw new \LogicException(sprintf('The pager provider for driver "%s" does not exist.', $driver)); |
||
| 537 | } |
||
| 538 | |||
| 539 | /* Note: provider services may conflict with "prototype.driver", if the |
||
| 540 | 15 | * index and type names were "prototype" and a driver, respectively. |
|
| 541 | 15 | */ |
|
| 542 | $providerId = sprintf('fos_elastica.pager_provider.%s.%s', $indexName, $typeName); |
||
| 543 | 15 | $providerDef->addTag('fos_elastica.pager_provider', ['index' => $indexName, 'type' => $typeName]); |
|
| 544 | |||
| 545 | 15 | $container->setDefinition($providerId, $providerDef); |
|
| 546 | |||
| 547 | return $providerId; |
||
| 548 | } |
||
| 549 | |||
| 550 | /** |
||
| 551 | * Loads doctrine listeners to handle indexing of new or updated objects. |
||
| 552 | * |
||
| 553 | * @param array $typeConfig |
||
| 554 | * @param ContainerBuilder $container |
||
| 555 | * @param string $objectPersisterId |
||
| 556 | * @param string $indexName |
||
| 557 | * @param string $typeName |
||
| 558 | * |
||
| 559 | 14 | * @return string |
|
| 560 | */ |
||
| 561 | 14 | private function loadTypeListener(array $typeConfig, ContainerBuilder $container, $objectPersisterId, $indexName, $typeName) |
|
| 562 | { |
||
| 563 | if (isset($typeConfig['listener']['service'])) { |
||
| 564 | return $typeConfig['listener']['service']; |
||
| 565 | } |
||
| 566 | |||
| 567 | /* Note: listener services may conflict with "prototype.driver", if the |
||
| 568 | 14 | * index and type names were "prototype" and a driver, respectively. |
|
| 569 | 14 | */ |
|
| 570 | 14 | $abstractListenerId = sprintf('fos_elastica.listener.prototype.%s', $typeConfig['driver']); |
|
| 571 | 14 | $listenerId = sprintf('fos_elastica.listener.%s.%s', $indexName, $typeName); |
|
| 572 | 14 | $listenerDef = new ChildDefinition($abstractListenerId); |
|
| 573 | $listenerDef->replaceArgument(0, new Reference($objectPersisterId)); |
||
| 574 | 14 | $listenerDef->replaceArgument(3, $typeConfig['listener']['logger'] ? |
|
| 575 | new Reference($typeConfig['listener']['logger']) : |
||
| 576 | null |
||
| 577 | 14 | ); |
|
| 578 | 14 | $listenerConfig = [ |
|
| 579 | 14 | 'identifier' => $typeConfig['identifier'], |
|
| 580 | 'indexName' => $indexName, |
||
| 581 | 'typeName' => $typeName, |
||
| 582 | 14 | ]; |
|
| 583 | 14 | ||
| 584 | 14 | $tagName = null; |
|
| 585 | 13 | switch ($typeConfig['driver']) { |
|
| 586 | 13 | case 'orm': |
|
| 587 | 1 | $tagName = 'doctrine.event_listener'; |
|
| 588 | 1 | break; |
|
| 589 | 1 | case 'phpcr': |
|
| 590 | $tagName = 'doctrine_phpcr.event_listener'; |
||
| 591 | break; |
||
| 592 | case 'mongodb': |
||
| 593 | $tagName = 'doctrine_mongodb.odm.event_listener'; |
||
| 594 | break; |
||
| 595 | 14 | } |
|
| 596 | |||
| 597 | if ($typeConfig['listener']['defer']) { |
||
| 598 | $listenerDef->setPublic(true); |
||
| 599 | $listenerDef->addTag( |
||
| 600 | 'kernel.event_listener', |
||
| 601 | ['event' => 'kernel.terminate', 'method' => 'onTerminate'] |
||
| 602 | ); |
||
| 603 | $listenerDef->addTag( |
||
| 604 | 'kernel.event_listener', |
||
| 605 | ['event' => 'console.terminate', 'method' => 'onTerminate'] |
||
| 606 | ); |
||
| 607 | $listenerConfig['defer'] = true; |
||
| 608 | 14 | } |
|
| 609 | |||
| 610 | 14 | $listenerDef->replaceArgument(2, $listenerConfig); |
|
| 611 | 14 | ||
| 612 | 14 | if (null !== $tagName) { |
|
| 613 | foreach ($this->getDoctrineEvents($typeConfig) as $event) { |
||
| 614 | $listenerDef->addTag($tagName, ['event' => $event]); |
||
| 615 | } |
||
| 616 | 14 | } |
|
| 617 | |||
| 618 | 14 | $container->setDefinition($listenerId, $listenerDef); |
|
| 619 | |||
| 620 | return $listenerId; |
||
| 621 | } |
||
| 622 | |||
| 623 | /** |
||
| 624 | 14 | * Map Elastica to Doctrine events for the current driver. |
|
| 625 | */ |
||
| 626 | 14 | private function getDoctrineEvents(array $typeConfig) |
|
| 627 | 14 | { |
|
| 628 | 13 | switch ($typeConfig['driver']) { |
|
| 629 | 13 | case 'orm': |
|
| 630 | 1 | $eventsClass = '\Doctrine\ORM\Events'; |
|
| 631 | 1 | break; |
|
| 632 | 1 | case 'phpcr': |
|
| 633 | $eventsClass = '\Doctrine\ODM\PHPCR\Event'; |
||
| 634 | break; |
||
| 635 | case 'mongodb': |
||
| 636 | $eventsClass = '\Doctrine\ODM\MongoDB\Events'; |
||
| 637 | break; |
||
| 638 | default: |
||
| 639 | throw new \InvalidArgumentException(sprintf('Cannot determine events for driver "%s"', $typeConfig['driver'])); |
||
| 640 | 14 | } |
|
| 641 | |||
| 642 | 14 | $events = []; |
|
| 643 | 14 | $eventMapping = [ |
|
| 644 | 14 | 'insert' => [constant($eventsClass.'::postPersist')], |
|
| 645 | 14 | 'update' => [constant($eventsClass.'::postUpdate')], |
|
| 646 | 'delete' => [constant($eventsClass.'::preRemove')], |
||
| 647 | 'flush' => [constant($eventsClass.'::postFlush')], |
||
| 648 | 14 | ]; |
|
| 649 | 14 | ||
| 650 | 14 | foreach ($eventMapping as $event => $doctrineEvents) { |
|
| 651 | if (isset($typeConfig['listener'][$event]) && $typeConfig['listener'][$event]) { |
||
| 652 | $events = array_merge($events, $doctrineEvents); |
||
| 653 | } |
||
| 654 | 14 | } |
|
| 655 | |||
| 656 | return $events; |
||
| 657 | } |
||
| 658 | |||
| 659 | /** |
||
| 660 | * Loads a Type specific Finder. |
||
| 661 | * |
||
| 662 | * @param array $typeConfig |
||
| 663 | * @param ContainerBuilder $container |
||
| 664 | * @param string $elasticaToModelId |
||
| 665 | * @param Reference $typeRef |
||
| 666 | * @param string $indexName |
||
| 667 | * @param string $typeName |
||
| 668 | * |
||
| 669 | 15 | * @return string |
|
| 670 | */ |
||
| 671 | 15 | private function loadTypeFinder(array $typeConfig, ContainerBuilder $container, $elasticaToModelId, Reference $typeRef, $indexName, $typeName) |
|
| 672 | { |
||
| 673 | if (isset($typeConfig['finder']['service'])) { |
||
| 674 | 15 | $finderId = $typeConfig['finder']['service']; |
|
| 675 | 15 | } else { |
|
| 676 | 15 | $finderId = sprintf('fos_elastica.finder.%s.%s', $indexName, $typeName); |
|
| 677 | 15 | $finderDef = new ChildDefinition('fos_elastica.finder'); |
|
| 678 | 15 | $finderDef->replaceArgument(0, $typeRef); |
|
| 679 | $finderDef->replaceArgument(1, new Reference($elasticaToModelId)); |
||
| 680 | $container->setDefinition($finderId, $finderDef); |
||
| 681 | 15 | } |
|
| 682 | 15 | ||
| 683 | 15 | $indexTypeName = "$indexName/$typeName"; |
|
| 684 | 4 | $arguments = [$indexTypeName, new Reference($finderId)]; |
|
| 685 | if (isset($typeConfig['repository'])) { |
||
| 686 | $arguments[] = $typeConfig['repository']; |
||
| 687 | 15 | } |
|
| 688 | 15 | ||
| 689 | $container->getDefinition('fos_elastica.repository_manager') |
||
| 690 | 15 | ->addMethodCall('addType', $arguments); |
|
| 691 | 15 | ||
| 692 | 15 | $managerId = sprintf('fos_elastica.manager.%s', $typeConfig['driver']); |
|
| 693 | $container->getDefinition($managerId) |
||
| 694 | 15 | ->addMethodCall('addEntity', [$typeConfig['model'], $indexTypeName]); |
|
| 695 | |||
| 696 | return $finderId; |
||
| 697 | } |
||
| 698 | |||
| 699 | /** |
||
| 700 | * Loads the index manager. |
||
| 701 | * |
||
| 702 | * @param ContainerBuilder $container |
||
| 703 | **/ |
||
| 704 | 18 | private function loadIndexManager(ContainerBuilder $container) |
|
| 713 | |||
| 714 | /** |
||
| 715 | * Makes sure a specific driver has been loaded. |
||
| 716 | * |
||
| 717 | * @param ContainerBuilder $container |
||
| 718 | 15 | * @param string $driver |
|
| 719 | */ |
||
| 720 | 15 | private function loadDriver(ContainerBuilder $container, $driver) |
|
| 730 | |||
| 731 | /** |
||
| 732 | * Loads and configures the serializer prototype. |
||
| 733 | * |
||
| 734 | * @param array $config |
||
| 735 | 1 | * @param ContainerBuilder $container |
|
| 736 | */ |
||
| 737 | 1 | private function loadSerializer($config, ContainerBuilder $container) |
|
| 748 | |||
| 749 | /** |
||
| 750 | * Creates a default manager alias for defined default manager or the first loaded driver. |
||
| 751 | * |
||
| 752 | * @param string $defaultManager |
||
| 753 | 18 | * @param ContainerBuilder $container |
|
| 754 | */ |
||
| 755 | 18 | private function createDefaultManagerAlias($defaultManager, ContainerBuilder $container) |
|
| 774 | |||
| 775 | /** |
||
| 776 | * Returns a reference to a client given its configured name. |
||
| 777 | * |
||
| 778 | * @param string $clientName |
||
| 779 | * |
||
| 780 | * @return Reference |
||
| 781 | * |
||
| 782 | 2 | * @throws \InvalidArgumentException |
|
| 783 | */ |
||
| 784 | 2 | private function getClient($clientName) |
|
| 792 | } |
||
| 793 |
Loading history...