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 |
||
| 22 | class FOSElasticaExtension extends Extension |
||
| 23 | { |
||
| 24 | /** |
||
| 25 | * Definition of elastica clients as configured by this extension. |
||
| 26 | * |
||
| 27 | * @var array |
||
| 28 | */ |
||
| 29 | private $clients = []; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * An array of indexes as configured by the extension. |
||
| 33 | * |
||
| 34 | * @var array |
||
| 35 | */ |
||
| 36 | private $indexConfigs = []; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * If we've encountered a type mapped to a specific persistence driver, it will be loaded |
||
| 40 | * here. |
||
| 41 | * |
||
| 42 | * @var array |
||
| 43 | */ |
||
| 44 | private $loadedDrivers = []; |
||
| 45 | |||
| 46 | 16 | public function load(array $configs, ContainerBuilder $container) |
|
| 47 | { |
||
| 48 | 16 | $configuration = $this->getConfiguration($configs, $container); |
|
| 49 | 16 | $config = $this->processConfiguration($configuration, $configs); |
|
| 50 | |||
| 51 | 16 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
|
| 52 | |||
| 53 | 16 | if (empty($config['clients']) || empty($config['indexes'])) { |
|
| 54 | // No Clients or indexes are defined |
||
| 55 | return; |
||
| 56 | } |
||
| 57 | |||
| 58 | 16 | foreach (['config', 'index', 'persister', 'provider', 'source', 'transformer', 'event_listener', 'commands'] as $basename) { |
|
| 59 | 16 | $loader->load(sprintf('%s.xml', $basename)); |
|
| 60 | } |
||
| 61 | |||
| 62 | 16 | if (empty($config['default_client'])) { |
|
| 63 | 16 | $keys = array_keys($config['clients']); |
|
| 64 | 16 | $config['default_client'] = reset($keys); |
|
| 65 | } |
||
| 66 | |||
| 67 | 16 | if (empty($config['default_index'])) { |
|
| 68 | 16 | $keys = array_keys($config['indexes']); |
|
| 69 | 16 | $config['default_index'] = reset($keys); |
|
| 70 | } |
||
| 71 | |||
| 72 | 16 | if (isset($config['serializer'])) { |
|
| 73 | $loader->load('serializer.xml'); |
||
| 74 | |||
| 75 | $this->loadSerializer($config['serializer'], $container); |
||
| 76 | } |
||
| 77 | |||
| 78 | 16 | $this->loadClients($config['clients'], $container); |
|
| 79 | $container->setAlias('fos_elastica.client', sprintf('fos_elastica.client.%s', $config['default_client'])); |
||
| 80 | |||
| 81 | $this->loadIndexes($config['indexes'], $container); |
||
| 82 | $container->setAlias('fos_elastica.index', sprintf('fos_elastica.index.%s', $config['default_index'])); |
||
| 83 | $container->setParameter('fos_elastica.default_index', $config['default_index']); |
||
| 84 | |||
| 85 | $container->getDefinition('fos_elastica.config_source.container')->replaceArgument(0, $this->indexConfigs); |
||
| 86 | |||
| 87 | $this->loadIndexManager($container); |
||
| 88 | |||
| 89 | $this->createDefaultManagerAlias($config['default_manager'], $container); |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @param array $config |
||
| 94 | * @param ContainerBuilder $container |
||
| 95 | * |
||
| 96 | * @return Configuration |
||
| 97 | */ |
||
| 98 | 16 | public function getConfiguration(array $config, ContainerBuilder $container) |
|
| 102 | |||
| 103 | /** |
||
| 104 | * Loads the configured clients. |
||
| 105 | * |
||
| 106 | * @param array $clients An array of clients configurations |
||
| 107 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 108 | * |
||
| 109 | * @return array |
||
| 110 | */ |
||
| 111 | 16 | private function loadClients(array $clients, ContainerBuilder $container) |
|
| 112 | { |
||
| 113 | 16 | foreach ($clients as $name => $clientConfig) { |
|
| 114 | 16 | $clientId = sprintf('fos_elastica.client.%s', $name); |
|
| 115 | |||
| 116 | 16 | $clientDef = new DefinitionDecorator('fos_elastica.client_prototype'); |
|
| 117 | $clientDef->replaceArgument(0, $clientConfig); |
||
| 118 | |||
| 119 | $logger = $clientConfig['connections'][0]['logger']; |
||
| 120 | if (false !== $logger) { |
||
| 121 | $clientDef->addMethodCall('setLogger', [new Reference($logger)]); |
||
| 122 | } |
||
| 123 | |||
| 124 | $clientDef->addTag('fos_elastica.client'); |
||
| 125 | |||
| 126 | $container->setDefinition($clientId, $clientDef); |
||
| 127 | |||
| 128 | $this->clients[$name] = [ |
||
| 129 | 'id' => $clientId, |
||
| 130 | 'reference' => new Reference($clientId), |
||
| 131 | ]; |
||
| 132 | } |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Loads the configured indexes. |
||
| 137 | * |
||
| 138 | * @param array $indexes An array of indexes configurations |
||
| 139 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 140 | * |
||
| 141 | * @throws \InvalidArgumentException |
||
| 142 | * |
||
| 143 | * @return array |
||
| 144 | */ |
||
| 145 | private function loadIndexes(array $indexes, ContainerBuilder $container) |
||
| 146 | { |
||
| 147 | $indexableCallbacks = []; |
||
| 148 | |||
| 149 | foreach ($indexes as $name => $index) { |
||
| 150 | $indexId = sprintf('fos_elastica.index.%s', $name); |
||
| 151 | $indexName = isset($index['index_name']) ? $index['index_name'] : $name; |
||
| 152 | |||
| 153 | $indexDef = new DefinitionDecorator('fos_elastica.index_prototype'); |
||
| 154 | $indexDef->setFactory([new Reference('fos_elastica.client'), 'getIndex']); |
||
| 155 | $indexDef->replaceArgument(0, $indexName); |
||
| 156 | $indexDef->addTag('fos_elastica.index', [ |
||
| 157 | 'name' => $name, |
||
| 158 | ]); |
||
| 159 | |||
| 160 | if (isset($index['client'])) { |
||
| 161 | $client = $this->getClient($index['client']); |
||
| 162 | |||
| 163 | $indexDef->setFactory([$client, 'getIndex']); |
||
| 164 | } |
||
| 165 | |||
| 166 | $container->setDefinition($indexId, $indexDef); |
||
| 167 | $reference = new Reference($indexId); |
||
| 168 | |||
| 169 | $this->indexConfigs[$name] = [ |
||
| 170 | 'elasticsearch_name' => $indexName, |
||
| 171 | 'reference' => $reference, |
||
| 172 | 'name' => $name, |
||
| 173 | 'settings' => $index['settings'], |
||
| 174 | 'type_prototype' => isset($index['type_prototype']) ? $index['type_prototype'] : [], |
||
| 175 | 'use_alias' => $index['use_alias'], |
||
| 176 | ]; |
||
| 177 | |||
| 178 | if ($index['finder']) { |
||
| 179 | $this->loadIndexFinder($container, $name, $reference); |
||
| 180 | } |
||
| 181 | |||
| 182 | $this->loadTypes((array) $index['types'], $container, $this->indexConfigs[$name], $indexableCallbacks); |
||
| 183 | } |
||
| 184 | |||
| 185 | $indexable = $container->getDefinition('fos_elastica.indexable'); |
||
| 186 | $indexable->replaceArgument(0, $indexableCallbacks); |
||
| 187 | } |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Loads the configured index finders. |
||
| 191 | * |
||
| 192 | * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container |
||
| 193 | * @param string $name The index name |
||
| 194 | * @param Reference $index Reference to the related index |
||
| 195 | * |
||
| 196 | * @return string |
||
| 197 | */ |
||
| 198 | private function loadIndexFinder(ContainerBuilder $container, $name, Reference $index) |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Loads the configured types. |
||
| 217 | * |
||
| 218 | * @param array $types |
||
| 219 | * @param ContainerBuilder $container |
||
| 220 | * @param array $indexConfig |
||
| 221 | * @param array $indexableCallbacks |
||
| 222 | */ |
||
| 223 | private function loadTypes(array $types, ContainerBuilder $container, array $indexConfig, array &$indexableCallbacks) |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Loads the optional provider and finder for a type. |
||
| 311 | * |
||
| 312 | * @param array $typeConfig |
||
| 313 | * @param ContainerBuilder $container |
||
| 314 | * @param Reference $typeRef |
||
| 315 | * @param string $indexName |
||
| 316 | * @param string $typeName |
||
| 317 | */ |
||
| 318 | private function loadTypePersistenceIntegration(array $typeConfig, ContainerBuilder $container, Reference $typeRef, $indexName, $typeName) |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Creates and loads an ElasticaToModelTransformer. |
||
| 341 | * |
||
| 342 | * @param array $typeConfig |
||
| 343 | * @param ContainerBuilder $container |
||
| 344 | * @param string $indexName |
||
| 345 | * @param string $typeName |
||
| 346 | * |
||
| 347 | * @return string |
||
| 348 | */ |
||
| 349 | private function loadElasticaToModelTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
||
| 374 | |||
| 375 | /** |
||
| 376 | * Creates and loads a ModelToElasticaTransformer for an index/type. |
||
| 377 | * |
||
| 378 | * @param array $typeConfig |
||
| 379 | * @param ContainerBuilder $container |
||
| 380 | * @param string $indexName |
||
| 381 | * @param string $typeName |
||
| 382 | * |
||
| 383 | * @return string |
||
| 384 | */ |
||
| 385 | private function loadModelToElasticaTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
||
| 404 | |||
| 405 | /** |
||
| 406 | * Creates and loads an object persister for a type. |
||
| 407 | * |
||
| 408 | * @param array $typeConfig |
||
| 409 | * @param Reference $typeRef |
||
| 410 | * @param ContainerBuilder $container |
||
| 411 | * @param string $indexName |
||
| 412 | * @param string $typeName |
||
| 413 | * @param string $transformerId |
||
| 414 | * |
||
| 415 | * @return string |
||
| 416 | */ |
||
| 417 | private function loadObjectPersister(array $typeConfig, Reference $typeRef, ContainerBuilder $container, $indexName, $typeName, $transformerId) |
||
| 455 | |||
| 456 | /** |
||
| 457 | * Loads a pager provider for a type. |
||
| 458 | * |
||
| 459 | * @param array $typeConfig |
||
| 460 | * @param ContainerBuilder $container |
||
| 461 | * @param string $indexName |
||
| 462 | * @param string $typeName |
||
| 463 | * |
||
| 464 | * @return string |
||
| 465 | */ |
||
| 466 | private function loadTypePagerProvider(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
||
| 516 | |||
| 517 | /** |
||
| 518 | * Loads doctrine listeners to handle indexing of new or updated objects. |
||
| 519 | * |
||
| 520 | * @param array $typeConfig |
||
| 521 | * @param ContainerBuilder $container |
||
| 522 | * @param string $objectPersisterId |
||
| 523 | * @param string $indexName |
||
| 524 | * @param string $typeName |
||
| 525 | * |
||
| 526 | * @return string |
||
| 527 | */ |
||
| 528 | private function loadTypeListener(array $typeConfig, ContainerBuilder $container, $objectPersisterId, $indexName, $typeName) |
||
| 589 | |||
| 590 | /** |
||
| 591 | * Map Elastica to Doctrine events for the current driver. |
||
| 592 | */ |
||
| 593 | private function getDoctrineEvents(array $typeConfig) |
||
| 625 | |||
| 626 | /** |
||
| 627 | * Loads a Type specific Finder. |
||
| 628 | * |
||
| 629 | * @param array $typeConfig |
||
| 630 | * @param ContainerBuilder $container |
||
| 631 | * @param string $elasticaToModelId |
||
| 632 | * @param Reference $typeRef |
||
| 633 | * @param string $indexName |
||
| 634 | * @param string $typeName |
||
| 635 | * |
||
| 636 | * @return string |
||
| 637 | */ |
||
| 638 | private function loadTypeFinder(array $typeConfig, ContainerBuilder $container, $elasticaToModelId, Reference $typeRef, $indexName, $typeName) |
||
| 665 | |||
| 666 | /** |
||
| 667 | * Loads the index manager. |
||
| 668 | * |
||
| 669 | * @param ContainerBuilder $container |
||
| 670 | **/ |
||
| 671 | private function loadIndexManager(ContainerBuilder $container) |
||
| 680 | |||
| 681 | /** |
||
| 682 | * Makes sure a specific driver has been loaded. |
||
| 683 | * |
||
| 684 | * @param ContainerBuilder $container |
||
| 685 | * @param string $driver |
||
| 686 | */ |
||
| 687 | private function loadDriver(ContainerBuilder $container, $driver) |
||
| 697 | |||
| 698 | /** |
||
| 699 | * Loads and configures the serializer prototype. |
||
| 700 | * |
||
| 701 | * @param array $config |
||
| 702 | * @param ContainerBuilder $container |
||
| 703 | */ |
||
| 704 | private function loadSerializer($config, ContainerBuilder $container) |
||
| 715 | |||
| 716 | /** |
||
| 717 | * Creates a default manager alias for defined default manager or the first loaded driver. |
||
| 718 | * |
||
| 719 | * @param string $defaultManager |
||
| 720 | * @param ContainerBuilder $container |
||
| 721 | */ |
||
| 722 | private function createDefaultManagerAlias($defaultManager, ContainerBuilder $container) |
||
| 738 | |||
| 739 | /** |
||
| 740 | * Returns a reference to a client given its configured name. |
||
| 741 | * |
||
| 742 | * @param string $clientName |
||
| 743 | * |
||
| 744 | * @return Reference |
||
| 745 | * |
||
| 746 | * @throws \InvalidArgumentException |
||
| 747 | */ |
||
| 748 | private function getClient($clientName) |
||
| 756 | } |
||
| 757 |
Loading history...