FriendsOfSymfony /
FOSElasticaBundle
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 |
||
| 14 | class FOSElasticaExtension extends Extension |
||
| 15 | { |
||
| 16 | /** |
||
| 17 | * Definition of elastica clients as configured by this extension. |
||
| 18 | * |
||
| 19 | * @var array |
||
| 20 | */ |
||
| 21 | private $clients = array(); |
||
| 22 | |||
| 23 | /** |
||
| 24 | * An array of indexes as configured by the extension. |
||
| 25 | * |
||
| 26 | * @var array |
||
| 27 | */ |
||
| 28 | private $indexConfigs = array(); |
||
| 29 | |||
| 30 | /** |
||
| 31 | * If we've encountered a type mapped to a specific persistence driver, it will be loaded |
||
| 32 | * here. |
||
| 33 | * |
||
| 34 | * @var array |
||
| 35 | */ |
||
| 36 | private $loadedDrivers = array(); |
||
| 37 | |||
| 38 | 14 | public function load(array $configs, ContainerBuilder $container) |
|
| 39 | { |
||
| 40 | 14 | $configuration = $this->getConfiguration($configs, $container); |
|
| 41 | 14 | $config = $this->processConfiguration($configuration, $configs); |
|
| 42 | |||
| 43 | 14 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
|
| 44 | |||
| 45 | 14 | if (empty($config['clients']) || empty($config['indexes'])) { |
|
| 46 | // No Clients or indexes are defined |
||
| 47 | return; |
||
| 48 | } |
||
| 49 | |||
| 50 | 14 | foreach (array('config', 'index', 'persister', 'provider', 'source', 'transformer') as $basename) { |
|
| 51 | 14 | $loader->load(sprintf('%s.xml', $basename)); |
|
| 52 | } |
||
| 53 | |||
| 54 | 14 | if (empty($config['default_client'])) { |
|
| 55 | 14 | $keys = array_keys($config['clients']); |
|
| 56 | 14 | $config['default_client'] = reset($keys); |
|
| 57 | } |
||
| 58 | |||
| 59 | 14 | if (empty($config['default_index'])) { |
|
| 60 | 14 | $keys = array_keys($config['indexes']); |
|
| 61 | 14 | $config['default_index'] = reset($keys); |
|
| 62 | } |
||
| 63 | |||
| 64 | 14 | if (isset($config['serializer'])) { |
|
| 65 | 3 | $loader->load('serializer.xml'); |
|
| 66 | |||
| 67 | 3 | $this->loadSerializer($config['serializer'], $container); |
|
| 68 | } |
||
| 69 | |||
| 70 | 14 | $this->loadClients($config['clients'], $container); |
|
| 71 | 14 | $container->setAlias('fos_elastica.client', sprintf('fos_elastica.client.%s', $config['default_client'])); |
|
| 72 | |||
| 73 | 14 | $this->loadIndexes($config['indexes'], $container); |
|
| 74 | 14 | $container->setAlias('fos_elastica.index', sprintf('fos_elastica.index.%s', $config['default_index'])); |
|
| 75 | |||
| 76 | 14 | $container->getDefinition('fos_elastica.config_source.container')->replaceArgument(0, $this->indexConfigs); |
|
| 77 | |||
| 78 | 14 | $this->loadIndexManager($container); |
|
| 79 | |||
| 80 | 14 | $this->createDefaultManagerAlias($config['default_manager'], $container); |
|
| 81 | 14 | } |
|
| 82 | |||
| 83 | /** |
||
| 84 | * @param array $config |
||
| 85 | * @param ContainerBuilder $container |
||
| 86 | * |
||
| 87 | * @return Configuration |
||
| 88 | */ |
||
| 89 | 14 | public function getConfiguration(array $config, ContainerBuilder $container) |
|
| 90 | { |
||
| 91 | 14 | return new Configuration($container->getParameter('kernel.debug')); |
|
| 92 | } |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Loads the configured clients. |
||
| 96 | * |
||
| 97 | * @param array $clients An array of clients configurations |
||
| 98 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 99 | * |
||
| 100 | * @return array |
||
| 101 | */ |
||
| 102 | 14 | private function loadClients(array $clients, ContainerBuilder $container) |
|
| 103 | { |
||
| 104 | 14 | foreach ($clients as $name => $clientConfig) { |
|
| 105 | 14 | $clientId = sprintf('fos_elastica.client.%s', $name); |
|
| 106 | |||
| 107 | 14 | $clientDef = new DefinitionDecorator('fos_elastica.client_prototype'); |
|
| 108 | 14 | $clientDef->replaceArgument(0, $clientConfig); |
|
| 109 | |||
| 110 | 14 | $logger = $clientConfig['connections'][0]['logger']; |
|
| 111 | 14 | if (false !== $logger) { |
|
| 112 | 14 | $clientDef->addMethodCall('setLogger', array(new Reference($logger))); |
|
| 113 | } |
||
| 114 | |||
| 115 | 14 | $clientDef->addTag('fos_elastica.client'); |
|
| 116 | |||
| 117 | 14 | $container->setDefinition($clientId, $clientDef); |
|
| 118 | |||
| 119 | 14 | $this->clients[$name] = array( |
|
| 120 | 14 | 'id' => $clientId, |
|
| 121 | 14 | 'reference' => new Reference($clientId), |
|
| 122 | ); |
||
| 123 | } |
||
| 124 | 14 | } |
|
| 125 | |||
| 126 | /** |
||
| 127 | * Loads the configured indexes. |
||
| 128 | * |
||
| 129 | * @param array $indexes An array of indexes configurations |
||
| 130 | * @param ContainerBuilder $container A ContainerBuilder instance |
||
| 131 | * |
||
| 132 | * @throws \InvalidArgumentException |
||
| 133 | * |
||
| 134 | * @return array |
||
| 135 | */ |
||
| 136 | 14 | private function loadIndexes(array $indexes, ContainerBuilder $container) |
|
| 137 | { |
||
| 138 | 14 | $indexableCallbacks = array(); |
|
| 139 | |||
| 140 | 14 | foreach ($indexes as $name => $index) { |
|
| 141 | 14 | $indexId = sprintf('fos_elastica.index.%s', $name); |
|
| 142 | 14 | $indexName = isset($index['index_name']) ? $index['index_name'] : $name; |
|
| 143 | |||
| 144 | 14 | $indexDef = new DefinitionDecorator('fos_elastica.index_prototype'); |
|
| 145 | 14 | $indexDef->setFactory(array(new Reference('fos_elastica.client'), 'getIndex')); |
|
| 146 | 14 | $indexDef->replaceArgument(0, $indexName); |
|
| 147 | 14 | $indexDef->addTag('fos_elastica.index', array( |
|
| 148 | 14 | 'name' => $name, |
|
| 149 | )); |
||
| 150 | |||
| 151 | 14 | if (isset($index['client'])) { |
|
| 152 | 2 | $client = $this->getClient($index['client']); |
|
| 153 | |||
| 154 | 2 | $indexDef->setFactory(array($client, 'getIndex')); |
|
| 155 | } |
||
| 156 | |||
| 157 | 14 | $container->setDefinition($indexId, $indexDef); |
|
| 158 | 14 | $reference = new Reference($indexId); |
|
| 159 | |||
| 160 | 14 | $this->indexConfigs[$name] = array( |
|
| 161 | 14 | 'elasticsearch_name' => $indexName, |
|
| 162 | 14 | 'reference' => $reference, |
|
| 163 | 14 | 'name' => $name, |
|
| 164 | 14 | 'settings' => $index['settings'], |
|
| 165 | 14 | 'type_prototype' => isset($index['type_prototype']) ? $index['type_prototype'] : array(), |
|
| 166 | 14 | 'use_alias' => $index['use_alias'], |
|
| 167 | ); |
||
| 168 | |||
| 169 | 14 | if ($index['finder']) { |
|
| 170 | $this->loadIndexFinder($container, $name, $reference); |
||
| 171 | } |
||
| 172 | |||
| 173 | 14 | $this->loadTypes((array) $index['types'], $container, $this->indexConfigs[$name], $indexableCallbacks); |
|
| 174 | } |
||
| 175 | |||
| 176 | 14 | $indexable = $container->getDefinition('fos_elastica.indexable'); |
|
| 177 | 14 | $indexable->replaceArgument(0, $indexableCallbacks); |
|
| 178 | 14 | } |
|
| 179 | |||
| 180 | /** |
||
| 181 | * Loads the configured index finders. |
||
| 182 | * |
||
| 183 | * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container |
||
| 184 | * @param string $name The index name |
||
| 185 | * @param Reference $index Reference to the related index |
||
| 186 | * |
||
| 187 | * @return string |
||
| 188 | */ |
||
| 189 | private function loadIndexFinder(ContainerBuilder $container, $name, Reference $index) |
||
| 190 | { |
||
| 191 | /* Note: transformer services may conflict with "collection.index", if |
||
| 192 | * an index and type names were "collection" and an index, respectively. |
||
| 193 | */ |
||
| 194 | $transformerId = sprintf('fos_elastica.elastica_to_model_transformer.collection.%s', $name); |
||
| 195 | $transformerDef = new DefinitionDecorator('fos_elastica.elastica_to_model_transformer.collection'); |
||
| 196 | $container->setDefinition($transformerId, $transformerDef); |
||
| 197 | |||
| 198 | $finderId = sprintf('fos_elastica.finder.%s', $name); |
||
| 199 | $finderDef = new DefinitionDecorator('fos_elastica.finder'); |
||
| 200 | $finderDef->replaceArgument(0, $index); |
||
| 201 | $finderDef->replaceArgument(1, new Reference($transformerId)); |
||
| 202 | |||
| 203 | $container->setDefinition($finderId, $finderDef); |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Loads the configured types. |
||
| 208 | * |
||
| 209 | * @param array $types |
||
| 210 | * @param ContainerBuilder $container |
||
| 211 | * @param array $indexConfig |
||
| 212 | * @param array $indexableCallbacks |
||
| 213 | */ |
||
| 214 | 14 | private function loadTypes(array $types, ContainerBuilder $container, array $indexConfig, array &$indexableCallbacks) |
|
| 215 | { |
||
| 216 | 14 | foreach ($types as $name => $type) { |
|
| 217 | 14 | $indexName = $indexConfig['name']; |
|
| 218 | |||
| 219 | 14 | $typeId = sprintf('%s.%s', $indexConfig['reference'], $name); |
|
| 220 | 14 | $typeDef = new DefinitionDecorator('fos_elastica.type_prototype'); |
|
| 221 | 14 | $typeDef->setFactory(array($indexConfig['reference'], 'getType')); |
|
| 222 | 14 | $typeDef->replaceArgument(0, $name); |
|
| 223 | |||
| 224 | 14 | $container->setDefinition($typeId, $typeDef); |
|
| 225 | |||
| 226 | $typeConfig = array( |
||
| 227 | 14 | 'name' => $name, |
|
| 228 | 'mapping' => array(), // An array containing anything that gets sent directly to ElasticSearch |
||
| 229 | 'config' => array(), |
||
| 230 | ); |
||
| 231 | |||
| 232 | foreach (array( |
||
| 233 | 14 | 'dynamic_templates', |
|
| 234 | 'properties', |
||
| 235 | '_all', |
||
| 236 | '_boost', |
||
| 237 | '_id', |
||
| 238 | '_parent', |
||
| 239 | '_routing', |
||
| 240 | '_source', |
||
| 241 | '_timestamp', |
||
| 242 | '_ttl', |
||
| 243 | ) as $field) { |
||
| 244 | 14 | if (isset($type[$field])) { |
|
| 245 | 14 | $typeConfig['mapping'][$field] = $type[$field]; |
|
| 246 | } |
||
| 247 | } |
||
| 248 | |||
| 249 | foreach (array( |
||
| 250 | 14 | 'persistence', |
|
| 251 | 'serializer', |
||
| 252 | 'analyzer', |
||
| 253 | 'search_analyzer', |
||
| 254 | 'dynamic', |
||
| 255 | 'date_detection', |
||
| 256 | 'dynamic_date_formats', |
||
| 257 | 'numeric_detection', |
||
| 258 | ) as $field) { |
||
| 259 | 14 | $typeConfig['config'][$field] = array_key_exists($field, $type) ? |
|
| 260 | 14 | $type[$field] : |
|
| 261 | 14 | null; |
|
| 262 | } |
||
| 263 | |||
| 264 | 14 | $this->indexConfigs[$indexName]['types'][$name] = $typeConfig; |
|
| 265 | |||
| 266 | 14 | if (isset($type['persistence'])) { |
|
| 267 | 10 | $this->loadTypePersistenceIntegration($type['persistence'], $container, new Reference($typeId), $indexName, $name); |
|
| 268 | |||
| 269 | 10 | $typeConfig['persistence'] = $type['persistence']; |
|
| 270 | } |
||
| 271 | |||
| 272 | 14 | if (isset($type['_parent'])) { |
|
| 273 | // _parent mapping cannot contain `property` and `identifier`, so removing them after building `persistence` |
||
| 274 | 5 | unset($indexConfig['types'][$name]['mapping']['_parent']['property'], $indexConfig['types'][$name]['mapping']['_parent']['identifier']); |
|
| 275 | } |
||
| 276 | |||
| 277 | 14 | if (isset($type['indexable_callback'])) { |
|
| 278 | 5 | $indexableCallbacks[sprintf('%s/%s', $indexName, $name)] = $type['indexable_callback']; |
|
| 279 | } |
||
| 280 | |||
| 281 | 14 | if ($container->hasDefinition('fos_elastica.serializer_callback_prototype')) { |
|
| 282 | 3 | $typeSerializerId = sprintf('%s.serializer.callback', $typeId); |
|
| 283 | 3 | $typeSerializerDef = new DefinitionDecorator('fos_elastica.serializer_callback_prototype'); |
|
| 284 | |||
| 285 | 3 | if (isset($type['serializer']['groups'])) { |
|
| 286 | 3 | $typeSerializerDef->addMethodCall('setGroups', array($type['serializer']['groups'])); |
|
| 287 | } |
||
| 288 | |||
| 289 | 3 | if (isset($type['serializer']['serialize_null'])) { |
|
| 290 | 3 | $typeSerializerDef->addMethodCall('setSerializeNull', array($type['serializer']['serialize_null'])); |
|
| 291 | } |
||
| 292 | |||
| 293 | 3 | if (isset($type['serializer']['version'])) { |
|
| 294 | 3 | $typeSerializerDef->addMethodCall('setVersion', array($type['serializer']['version'])); |
|
| 295 | } |
||
| 296 | |||
| 297 | 3 | $typeDef->addMethodCall('setSerializer', array(array(new Reference($typeSerializerId), 'serialize'))); |
|
| 298 | 14 | $container->setDefinition($typeSerializerId, $typeSerializerDef); |
|
| 299 | } |
||
| 300 | } |
||
| 301 | 14 | } |
|
| 302 | |||
| 303 | /** |
||
| 304 | * Loads the optional provider and finder for a type. |
||
| 305 | * |
||
| 306 | * @param array $typeConfig |
||
| 307 | * @param ContainerBuilder $container |
||
| 308 | * @param Reference $typeRef |
||
| 309 | * @param string $indexName |
||
| 310 | * @param string $typeName |
||
| 311 | */ |
||
| 312 | 10 | private function loadTypePersistenceIntegration(array $typeConfig, ContainerBuilder $container, Reference $typeRef, $indexName, $typeName) |
|
| 313 | { |
||
| 314 | 10 | if (isset($typeConfig['driver'])) { |
|
| 315 | 10 | $this->loadDriver($container, $typeConfig['driver']); |
|
| 316 | } |
||
| 317 | |||
| 318 | 10 | $elasticaToModelTransformerId = $this->loadElasticaToModelTransformer($typeConfig, $container, $indexName, $typeName); |
|
| 319 | 10 | $modelToElasticaTransformerId = $this->loadModelToElasticaTransformer($typeConfig, $container, $indexName, $typeName); |
|
| 320 | 10 | $objectPersisterId = $this->loadObjectPersister($typeConfig, $typeRef, $container, $indexName, $typeName, $modelToElasticaTransformerId); |
|
| 321 | |||
| 322 | 10 | if (isset($typeConfig['provider'])) { |
|
| 323 | 10 | $this->loadTypeProvider($typeConfig, $container, $objectPersisterId, $indexName, $typeName); |
|
| 324 | } |
||
| 325 | 10 | if (isset($typeConfig['finder'])) { |
|
| 326 | 10 | $this->loadTypeFinder($typeConfig, $container, $elasticaToModelTransformerId, $typeRef, $indexName, $typeName); |
|
| 327 | } |
||
| 328 | 10 | if (isset($typeConfig['listener'])) { |
|
| 329 | 10 | $this->loadTypeListener($typeConfig, $container, $objectPersisterId, $indexName, $typeName); |
|
| 330 | } |
||
| 331 | 10 | } |
|
| 332 | |||
| 333 | /** |
||
| 334 | * Creates and loads an ElasticaToModelTransformer. |
||
| 335 | * |
||
| 336 | * @param array $typeConfig |
||
| 337 | * @param ContainerBuilder $container |
||
| 338 | * @param string $indexName |
||
| 339 | * @param string $typeName |
||
| 340 | * |
||
| 341 | * @return string |
||
| 342 | */ |
||
| 343 | 10 | private function loadElasticaToModelTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
|
| 344 | { |
||
| 345 | 10 | if (isset($typeConfig['elastica_to_model_transformer']['service'])) { |
|
| 346 | 1 | return $typeConfig['elastica_to_model_transformer']['service']; |
|
| 347 | } |
||
| 348 | |||
| 349 | /* Note: transformer services may conflict with "prototype.driver", if |
||
| 350 | * the index and type names were "prototype" and a driver, respectively. |
||
| 351 | */ |
||
| 352 | 9 | $abstractId = sprintf('fos_elastica.elastica_to_model_transformer.prototype.%s', $typeConfig['driver']); |
|
| 353 | 9 | $serviceId = sprintf('fos_elastica.elastica_to_model_transformer.%s.%s', $indexName, $typeName); |
|
| 354 | 9 | $serviceDef = new DefinitionDecorator($abstractId); |
|
| 355 | 9 | $serviceDef->addTag('fos_elastica.elastica_to_model_transformer', array('type' => $typeName, 'index' => $indexName)); |
|
| 356 | |||
| 357 | // Doctrine has a mandatory service as first argument |
||
| 358 | 9 | $argPos = ('propel' === $typeConfig['driver']) ? 0 : 1; |
|
| 359 | |||
| 360 | 9 | $serviceDef->replaceArgument($argPos, $typeConfig['model']); |
|
| 361 | 9 | $serviceDef->replaceArgument($argPos + 1, array_merge($typeConfig['elastica_to_model_transformer'], array( |
|
| 362 | 9 | 'identifier' => $typeConfig['identifier'], |
|
| 363 | ))); |
||
| 364 | 9 | $container->setDefinition($serviceId, $serviceDef); |
|
| 365 | |||
| 366 | 9 | return $serviceId; |
|
| 367 | } |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Creates and loads a ModelToElasticaTransformer for an index/type. |
||
| 371 | * |
||
| 372 | * @param array $typeConfig |
||
| 373 | * @param ContainerBuilder $container |
||
| 374 | * @param string $indexName |
||
| 375 | * @param string $typeName |
||
| 376 | * |
||
| 377 | * @return string |
||
| 378 | */ |
||
| 379 | 10 | private function loadModelToElasticaTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName) |
|
| 380 | { |
||
| 381 | 10 | if (isset($typeConfig['model_to_elastica_transformer']['service'])) { |
|
| 382 | return $typeConfig['model_to_elastica_transformer']['service']; |
||
| 383 | } |
||
| 384 | |||
| 385 | 10 | $abstractId = $container->hasDefinition('fos_elastica.serializer_callback_prototype') ? |
|
| 386 | 3 | 'fos_elastica.model_to_elastica_identifier_transformer' : |
|
| 387 | 10 | 'fos_elastica.model_to_elastica_transformer'; |
|
| 388 | |||
| 389 | 10 | $serviceId = sprintf('fos_elastica.model_to_elastica_transformer.%s.%s', $indexName, $typeName); |
|
| 390 | 10 | $serviceDef = new DefinitionDecorator($abstractId); |
|
| 391 | 10 | $serviceDef->replaceArgument(0, array( |
|
| 392 | 10 | 'identifier' => $typeConfig['identifier'], |
|
| 393 | )); |
||
| 394 | 10 | $container->setDefinition($serviceId, $serviceDef); |
|
| 395 | |||
| 396 | 10 | return $serviceId; |
|
| 397 | } |
||
| 398 | |||
| 399 | /** |
||
| 400 | * Creates and loads an object persister for a type. |
||
| 401 | * |
||
| 402 | * @param array $typeConfig |
||
| 403 | * @param Reference $typeRef |
||
| 404 | * @param ContainerBuilder $container |
||
| 405 | * @param string $indexName |
||
| 406 | * @param string $typeName |
||
| 407 | * @param string $transformerId |
||
| 408 | * |
||
| 409 | * @return string |
||
| 410 | */ |
||
| 411 | 10 | private function loadObjectPersister(array $typeConfig, Reference $typeRef, ContainerBuilder $container, $indexName, $typeName, $transformerId) |
|
| 412 | { |
||
| 413 | 10 | if (isset($typeConfig['persister']['service'])) { |
|
| 414 | 1 | return $typeConfig['persister']['service']; |
|
| 415 | } |
||
| 416 | |||
| 417 | $arguments = array( |
||
| 418 | 9 | $typeRef, |
|
| 419 | 9 | new Reference($transformerId), |
|
| 420 | 9 | $typeConfig['model'], |
|
| 421 | ); |
||
| 422 | |||
| 423 | 9 | if ($container->hasDefinition('fos_elastica.serializer_callback_prototype')) { |
|
| 424 | 3 | $abstractId = 'fos_elastica.object_serializer_persister'; |
|
| 425 | 3 | $callbackId = sprintf('%s.%s.serializer.callback', $this->indexConfigs[$indexName]['reference'], $typeName); |
|
| 426 | 3 | $arguments[] = array(new Reference($callbackId), 'serialize'); |
|
| 427 | } else { |
||
| 428 | 6 | $abstractId = 'fos_elastica.object_persister'; |
|
| 429 | 6 | $mapping = $this->indexConfigs[$indexName]['types'][$typeName]['mapping']; |
|
| 430 | 6 | $argument = $mapping['properties']; |
|
| 431 | 6 | if (isset($mapping['_parent'])) { |
|
| 432 | 1 | $argument['_parent'] = $mapping['_parent']; |
|
| 433 | } |
||
| 434 | 6 | $arguments[] = $argument; |
|
| 435 | } |
||
| 436 | |||
| 437 | 9 | $serviceId = sprintf('fos_elastica.object_persister.%s.%s', $indexName, $typeName); |
|
| 438 | 9 | $serviceDef = new DefinitionDecorator($abstractId); |
|
| 439 | 9 | foreach ($arguments as $i => $argument) { |
|
| 440 | 9 | $serviceDef->replaceArgument($i, $argument); |
|
| 441 | } |
||
| 442 | |||
| 443 | 9 | $container->setDefinition($serviceId, $serviceDef); |
|
| 444 | |||
| 445 | 9 | return $serviceId; |
|
| 446 | } |
||
| 447 | |||
| 448 | /** |
||
| 449 | * Loads a provider for a type. |
||
| 450 | * |
||
| 451 | * @param array $typeConfig |
||
| 452 | * @param ContainerBuilder $container |
||
| 453 | * @param string $objectPersisterId |
||
| 454 | * @param string $indexName |
||
| 455 | * @param string $typeName |
||
| 456 | * |
||
| 457 | * @return string |
||
| 458 | */ |
||
| 459 | 10 | private function loadTypeProvider(array $typeConfig, ContainerBuilder $container, $objectPersisterId, $indexName, $typeName) |
|
| 460 | { |
||
| 461 | 10 | if (isset($typeConfig['provider']['service'])) { |
|
| 462 | return $typeConfig['provider']['service']; |
||
| 463 | } |
||
| 464 | |||
| 465 | /* Note: provider services may conflict with "prototype.driver", if the |
||
| 466 | * index and type names were "prototype" and a driver, respectively. |
||
| 467 | */ |
||
| 468 | 10 | $providerId = sprintf('fos_elastica.provider.%s.%s', $indexName, $typeName); |
|
| 469 | 10 | $providerDef = new DefinitionDecorator('fos_elastica.provider.prototype.'.$typeConfig['driver']); |
|
| 470 | 10 | $providerDef->addTag('fos_elastica.provider', array('index' => $indexName, 'type' => $typeName)); |
|
| 471 | 10 | $providerDef->replaceArgument(0, new Reference($objectPersisterId)); |
|
| 472 | 10 | $providerDef->replaceArgument(2, $typeConfig['model']); |
|
| 473 | // Propel provider can simply ignore Doctrine-specific options |
||
| 474 | 10 | $providerDef->replaceArgument(3, array_merge(array_diff_key($typeConfig['provider'], array('service' => 1)), array( |
|
| 475 | 10 | 'indexName' => $indexName, |
|
| 476 | 10 | 'typeName' => $typeName, |
|
| 477 | ))); |
||
| 478 | 10 | $container->setDefinition($providerId, $providerDef); |
|
| 479 | |||
| 480 | 10 | return $providerId; |
|
| 481 | } |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Loads doctrine listeners to handle indexing of new or updated objects. |
||
| 485 | * |
||
| 486 | * @param array $typeConfig |
||
| 487 | * @param ContainerBuilder $container |
||
| 488 | * @param string $objectPersisterId |
||
| 489 | * @param string $indexName |
||
| 490 | * @param string $typeName |
||
| 491 | * |
||
| 492 | * @return string |
||
| 493 | */ |
||
| 494 | 10 | private function loadTypeListener(array $typeConfig, ContainerBuilder $container, $objectPersisterId, $indexName, $typeName) |
|
| 495 | { |
||
| 496 | 10 | if (isset($typeConfig['listener']['service'])) { |
|
| 497 | return $typeConfig['listener']['service']; |
||
| 498 | } |
||
| 499 | |||
| 500 | /* Note: listener services may conflict with "prototype.driver", if the |
||
| 501 | * index and type names were "prototype" and a driver, respectively. |
||
| 502 | */ |
||
| 503 | 10 | $abstractListenerId = sprintf('fos_elastica.listener.prototype.%s', $typeConfig['driver']); |
|
| 504 | 10 | $listenerId = sprintf('fos_elastica.listener.%s.%s', $indexName, $typeName); |
|
| 505 | 10 | $listenerDef = new DefinitionDecorator($abstractListenerId); |
|
| 506 | 10 | $listenerDef->replaceArgument(0, new Reference($objectPersisterId)); |
|
| 507 | 10 | $listenerDef->replaceArgument(2, array( |
|
| 508 | 10 | 'identifier' => $typeConfig['identifier'], |
|
| 509 | 10 | 'indexName' => $indexName, |
|
| 510 | 10 | 'typeName' => $typeName, |
|
| 511 | )); |
||
| 512 | 10 | $listenerDef->replaceArgument(3, $typeConfig['listener']['logger'] ? |
|
| 513 | new Reference($typeConfig['listener']['logger']) : |
||
| 514 | 10 | null |
|
| 515 | ); |
||
| 516 | |||
| 517 | 10 | $tagName = null; |
|
| 518 | 10 | switch ($typeConfig['driver']) { |
|
| 519 | 10 | case 'orm': |
|
| 520 | 10 | $tagName = 'doctrine.event_listener'; |
|
| 521 | 10 | break; |
|
| 522 | case 'phpcr': |
||
| 523 | $tagName = 'doctrine_phpcr.event_listener'; |
||
| 524 | break; |
||
| 525 | case 'mongodb': |
||
| 526 | $tagName = 'doctrine_mongodb.odm.event_listener'; |
||
| 527 | break; |
||
| 528 | } |
||
| 529 | |||
| 530 | 10 | if (null !== $tagName) { |
|
| 531 | 10 | foreach ($this->getDoctrineEvents($typeConfig) as $event) { |
|
| 532 | 10 | $listenerDef->addTag($tagName, array('event' => $event)); |
|
| 533 | } |
||
| 534 | } |
||
| 535 | |||
| 536 | 10 | $container->setDefinition($listenerId, $listenerDef); |
|
| 537 | |||
| 538 | 10 | return $listenerId; |
|
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Map Elastica to Doctrine events for the current driver. |
||
| 543 | */ |
||
| 544 | 10 | private function getDoctrineEvents(array $typeConfig) |
|
| 545 | { |
||
| 546 | 10 | switch ($typeConfig['driver']) { |
|
| 547 | 10 | case 'orm': |
|
| 548 | 10 | $eventsClass = '\Doctrine\ORM\Events'; |
|
| 549 | 10 | break; |
|
| 550 | case 'phpcr': |
||
| 551 | $eventsClass = '\Doctrine\ODM\PHPCR\Event'; |
||
| 552 | break; |
||
| 553 | case 'mongodb': |
||
| 554 | $eventsClass = '\Doctrine\ODM\MongoDB\Events'; |
||
| 555 | break; |
||
| 556 | default: |
||
| 557 | throw new InvalidArgumentException(sprintf('Cannot determine events for driver "%s"', $typeConfig['driver'])); |
||
| 558 | } |
||
| 559 | |||
| 560 | 10 | $events = array(); |
|
| 561 | $eventMapping = array( |
||
| 562 | 10 | 'insert' => array(constant($eventsClass.'::postPersist')), |
|
| 563 | 10 | 'update' => array(constant($eventsClass.'::postUpdate')), |
|
| 564 | 10 | 'delete' => array(constant($eventsClass.'::preRemove')), |
|
| 565 | 10 | 'flush' => array(constant($eventsClass.'::postFlush')), |
|
| 566 | ); |
||
| 567 | |||
| 568 | 10 | foreach ($eventMapping as $event => $doctrineEvents) { |
|
| 569 | 10 | if (isset($typeConfig['listener'][$event]) && $typeConfig['listener'][$event]) { |
|
| 570 | 10 | $events = array_merge($events, $doctrineEvents); |
|
| 571 | } |
||
| 572 | } |
||
| 573 | |||
| 574 | 10 | return $events; |
|
| 575 | } |
||
| 576 | |||
| 577 | /** |
||
| 578 | * Loads a Type specific Finder. |
||
| 579 | * |
||
| 580 | * @param array $typeConfig |
||
| 581 | * @param ContainerBuilder $container |
||
| 582 | * @param string $elasticaToModelId |
||
| 583 | * @param Reference $typeRef |
||
| 584 | * @param string $indexName |
||
| 585 | * @param string $typeName |
||
| 586 | * |
||
| 587 | * @return string |
||
| 588 | */ |
||
| 589 | 10 | private function loadTypeFinder(array $typeConfig, ContainerBuilder $container, $elasticaToModelId, Reference $typeRef, $indexName, $typeName) |
|
| 590 | { |
||
| 591 | 10 | if (isset($typeConfig['finder']['service'])) { |
|
| 592 | $finderId = $typeConfig['finder']['service']; |
||
| 593 | } else { |
||
| 594 | 10 | $finderId = sprintf('fos_elastica.finder.%s.%s', $indexName, $typeName); |
|
| 595 | 10 | $finderDef = new DefinitionDecorator('fos_elastica.finder'); |
|
| 596 | 10 | $finderDef->replaceArgument(0, $typeRef); |
|
| 597 | 10 | $finderDef->replaceArgument(1, new Reference($elasticaToModelId)); |
|
| 598 | 10 | $container->setDefinition($finderId, $finderDef); |
|
| 599 | } |
||
| 600 | |||
| 601 | 10 | $indexTypeName = "$indexName/$typeName"; |
|
| 602 | 10 | $arguments = [$indexTypeName, new Reference($finderId)]; |
|
| 603 | 10 | if (isset($typeConfig['repository'])) { |
|
| 604 | 5 | $arguments[] = $typeConfig['repository']; |
|
| 605 | } |
||
| 606 | |||
| 607 | 10 | $container->getDefinition('fos_elastica.repository_manager') |
|
| 608 | 10 | ->addMethodCall('addType', $arguments); |
|
| 609 | |||
| 610 | 10 | $managerId = sprintf('fos_elastica.manager.%s', $typeConfig['driver']); |
|
| 611 | 10 | $container->getDefinition($managerId) |
|
| 612 | 10 | ->addMethodCall('addEntity', [$typeConfig['model'], $indexTypeName]); |
|
| 613 | |||
| 614 | 10 | return $finderId; |
|
| 615 | } |
||
| 616 | |||
| 617 | /** |
||
| 618 | * Loads the index manager. |
||
| 619 | * |
||
| 620 | * @param ContainerBuilder $container |
||
| 621 | **/ |
||
| 622 | private function loadIndexManager(ContainerBuilder $container) |
||
| 623 | { |
||
| 624 | 14 | $indexRefs = array_map(function ($index) { |
|
| 625 | 14 | return $index['reference']; |
|
| 626 | 14 | }, $this->indexConfigs); |
|
| 627 | |||
| 628 | 14 | $managerDef = $container->getDefinition('fos_elastica.index_manager'); |
|
| 629 | 14 | $managerDef->replaceArgument(0, $indexRefs); |
|
| 630 | 14 | } |
|
| 631 | |||
| 632 | /** |
||
| 633 | * Makes sure a specific driver has been loaded. |
||
| 634 | * |
||
| 635 | * @param ContainerBuilder $container |
||
| 636 | * @param string $driver |
||
| 637 | */ |
||
| 638 | 10 | private function loadDriver(ContainerBuilder $container, $driver) |
|
| 639 | { |
||
| 640 | 10 | if (in_array($driver, $this->loadedDrivers)) { |
|
| 641 | 9 | return; |
|
| 642 | } |
||
| 643 | |||
| 644 | 10 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
|
| 645 | 10 | $loader->load($driver.'.xml'); |
|
| 646 | 10 | $this->loadedDrivers[] = $driver; |
|
| 647 | 10 | } |
|
| 648 | |||
| 649 | /** |
||
| 650 | * Loads and configures the serializer prototype. |
||
| 651 | * |
||
| 652 | * @param array $config |
||
| 653 | * @param ContainerBuilder $container |
||
| 654 | */ |
||
| 655 | 3 | private function loadSerializer($config, ContainerBuilder $container) |
|
| 656 | { |
||
| 657 | 3 | $container->setAlias('fos_elastica.serializer', $config['serializer']); |
|
| 658 | |||
| 659 | 3 | $serializer = $container->getDefinition('fos_elastica.serializer_callback_prototype'); |
|
| 660 | 3 | $serializer->setClass($config['callback_class']); |
|
| 661 | |||
| 662 | 3 | if (is_subclass_of($config['callback_class'], ContainerAwareInterface::class)) { |
|
|
Bug
introduced
by
|
|||
| 663 | $serializer->addMethodCall('setContainer', array(new Reference('service_container'))); |
||
| 664 | } |
||
| 665 | 3 | } |
|
| 666 | |||
| 667 | /** |
||
| 668 | * Creates a default manager alias for defined default manager or the first loaded driver. |
||
| 669 | * |
||
| 670 | * @param string $defaultManager |
||
| 671 | * @param ContainerBuilder $container |
||
| 672 | */ |
||
| 673 | 14 | private function createDefaultManagerAlias($defaultManager, ContainerBuilder $container) |
|
| 689 | |||
| 690 | /** |
||
| 691 | * Returns a reference to a client given its configured name. |
||
| 692 | * |
||
| 693 | * @param string $clientName |
||
| 694 | * |
||
| 695 | * @return Reference |
||
| 696 | * |
||
| 697 | * @throws \InvalidArgumentException |
||
| 698 | */ |
||
| 699 | 2 | private function getClient($clientName) |
|
| 707 | } |
||
| 708 |
Loading history...