Completed
Push — master ( 3cdfc2...4aa078 )
by Maksim
03:09
created

FOSElasticaExtension::getConfiguration()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 2
crap 1
1
<?php
2
3
/*
4
 * This file is part of the FOSElasticaBundle package.
5
 *
6
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace FOS\ElasticaBundle\DependencyInjection;
13
14
use Symfony\Component\Config\FileLocator;
15
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
16
use Symfony\Component\DependencyInjection\ContainerBuilder;
17
use Symfony\Component\DependencyInjection\DefinitionDecorator;
18
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
19
use Symfony\Component\DependencyInjection\Reference;
20
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
21
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 12
    public function load(array $configs, ContainerBuilder $container)
47
    {
48 12
        $configuration = $this->getConfiguration($configs, $container);
49 12
        $config = $this->processConfiguration($configuration, $configs);
50
51 12
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
52
53 12
        if (empty($config['clients']) || empty($config['indexes'])) {
54
            // No Clients or indexes are defined
55
            return;
56
        }
57
58 12
        foreach (['config', 'index', 'persister', 'provider', 'source', 'transformer', 'event_listener'] as $basename) {
59 12
            $loader->load(sprintf('%s.xml', $basename));
60
        }
61
62 12
        if (empty($config['default_client'])) {
63 12
            $keys = array_keys($config['clients']);
64 12
            $config['default_client'] = reset($keys);
65
        }
66
67 12
        if (empty($config['default_index'])) {
68 12
            $keys = array_keys($config['indexes']);
69 12
            $config['default_index'] = reset($keys);
70
        }
71
72 12
        if (isset($config['serializer'])) {
73 1
            $loader->load('serializer.xml');
74
75 1
            $this->loadSerializer($config['serializer'], $container);
76
        }
77
78 12
        $this->loadClients($config['clients'], $container);
79 12
        $container->setAlias('fos_elastica.client', sprintf('fos_elastica.client.%s', $config['default_client']));
80
81 12
        $this->loadIndexes($config['indexes'], $container);
82 12
        $container->setAlias('fos_elastica.index', sprintf('fos_elastica.index.%s', $config['default_index']));
83 12
        $container->setParameter('fos_elastica.default_index', $config['default_index']);
84
85 12
        $container->getDefinition('fos_elastica.config_source.container')->replaceArgument(0, $this->indexConfigs);
86
87 12
        $this->loadIndexManager($container);
88
89 12
        $this->createDefaultManagerAlias($config['default_manager'], $container);
90 12
    }
91
92
    /**
93
     * @param array            $config
94
     * @param ContainerBuilder $container
95
     *
96
     * @return Configuration
97
     */
98 12
    public function getConfiguration(array $config, ContainerBuilder $container)
99
    {
100 12
        return new Configuration($container->getParameter('kernel.debug'));
101
    }
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 12
    private function loadClients(array $clients, ContainerBuilder $container)
112
    {
113 12
        foreach ($clients as $name => $clientConfig) {
114 12
            $clientId = sprintf('fos_elastica.client.%s', $name);
115
116 12
            $clientDef = new DefinitionDecorator('fos_elastica.client_prototype');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
117 12
            $clientDef->replaceArgument(0, $clientConfig);
118
119 12
            $logger = $clientConfig['connections'][0]['logger'];
120 12
            if (false !== $logger) {
121 12
                $clientDef->addMethodCall('setLogger', [new Reference($logger)]);
122
            }
123
124 12
            $clientDef->addTag('fos_elastica.client');
125
126 12
            $container->setDefinition($clientId, $clientDef);
127
128 12
            $this->clients[$name] = [
129 12
                'id' => $clientId,
130 12
                'reference' => new Reference($clientId),
131
            ];
132
        }
133 12
    }
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 12
    private function loadIndexes(array $indexes, ContainerBuilder $container)
146
    {
147 12
        $indexableCallbacks = [];
148
149 12
        foreach ($indexes as $name => $index) {
150 12
            $indexId = sprintf('fos_elastica.index.%s', $name);
151 12
            $indexName = isset($index['index_name']) ? $index['index_name'] : $name;
152
153 12
            $indexDef = new DefinitionDecorator('fos_elastica.index_prototype');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
154 12
            $indexDef->setFactory([new Reference('fos_elastica.client'), 'getIndex']);
155 12
            $indexDef->replaceArgument(0, $indexName);
156 12
            $indexDef->addTag('fos_elastica.index', [
157 12
                'name' => $name,
158
            ]);
159
160 12
            if (isset($index['client'])) {
161 2
                $client = $this->getClient($index['client']);
162
163 2
                $indexDef->setFactory([$client, 'getIndex']);
164
            }
165
166 12
            $container->setDefinition($indexId, $indexDef);
167 12
            $reference = new Reference($indexId);
168
169 12
            $this->indexConfigs[$name] = [
170 12
                'elasticsearch_name' => $indexName,
171 12
                'reference' => $reference,
172 12
                'name' => $name,
173 12
                'settings' => $index['settings'],
174 12
                'type_prototype' => isset($index['type_prototype']) ? $index['type_prototype'] : [],
175 12
                'use_alias' => $index['use_alias'],
176
            ];
177
178 12
            if ($index['finder']) {
179
                $this->loadIndexFinder($container, $name, $reference);
180
            }
181
182 12
            $this->loadTypes((array) $index['types'], $container, $this->indexConfigs[$name], $indexableCallbacks);
183
        }
184
185 12
        $indexable = $container->getDefinition('fos_elastica.indexable');
186 12
        $indexable->replaceArgument(0, $indexableCallbacks);
187 12
    }
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)
199
    {
200
        /* Note: transformer services may conflict with "collection.index", if
201
         * an index and type names were "collection" and an index, respectively.
202
         */
203
        $transformerId = sprintf('fos_elastica.elastica_to_model_transformer.collection.%s', $name);
204
        $transformerDef = new DefinitionDecorator('fos_elastica.elastica_to_model_transformer.collection');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
205
        $container->setDefinition($transformerId, $transformerDef);
206
207
        $finderId = sprintf('fos_elastica.finder.%s', $name);
208
        $finderDef = new DefinitionDecorator('fos_elastica.finder');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
209
        $finderDef->replaceArgument(0, $index);
210
        $finderDef->replaceArgument(1, new Reference($transformerId));
211
212
        $container->setDefinition($finderId, $finderDef);
213
    }
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 12
    private function loadTypes(array $types, ContainerBuilder $container, array $indexConfig, array &$indexableCallbacks)
224
    {
225 12
        foreach ($types as $name => $type) {
226 12
            $indexName = $indexConfig['name'];
227
228 12
            $typeId = sprintf('%s.%s', $indexConfig['reference'], $name);
229 12
            $typeDef = new DefinitionDecorator('fos_elastica.type_prototype');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
230 12
            $typeDef->setFactory([$indexConfig['reference'], 'getType']);
231 12
            $typeDef->replaceArgument(0, $name);
232
233 12
            $container->setDefinition($typeId, $typeDef);
234
235
            $typeConfig = [
236 12
                'name' => $name,
237
                'mapping' => [], // An array containing anything that gets sent directly to ElasticSearch
238
                'config' => [],
239
            ];
240
241
            foreach ([
242 12
                'dynamic_templates',
243
                'properties',
244
                '_all',
245
                '_id',
246
                '_parent',
247
                '_routing',
248
                '_source',
249
            ] as $field) {
250 12
                if (isset($type[$field])) {
251 12
                    $typeConfig['mapping'][$field] = $type[$field];
252
                }
253
            }
254
255
            foreach ([
256 12
                'persistence',
257
                'serializer',
258
                'analyzer',
259
                'search_analyzer',
260
                'dynamic',
261
                'date_detection',
262
                'dynamic_date_formats',
263
                'numeric_detection',
264
            ] as $field) {
265 12
                $typeConfig['config'][$field] = array_key_exists($field, $type) ?
266 12
                    $type[$field] :
267 12
                    null;
268
            }
269
270 12
            $this->indexConfigs[$indexName]['types'][$name] = $typeConfig;
271
272 12
            if (isset($type['persistence'])) {
273 11
                $this->loadTypePersistenceIntegration($type['persistence'], $container, new Reference($typeId), $indexName, $name);
274
275 11
                $typeConfig['persistence'] = $type['persistence'];
276
            }
277
278 12
            if (isset($type['_parent'])) {
279
                // _parent mapping cannot contain `property` and `identifier`, so removing them after building `persistence`
280 2
                unset($indexConfig['types'][$name]['mapping']['_parent']['property'], $indexConfig['types'][$name]['mapping']['_parent']['identifier']);
281
            }
282
283 12
            if (isset($type['indexable_callback'])) {
284 1
                $indexableCallbacks[sprintf('%s/%s', $indexName, $name)] = $type['indexable_callback'];
285
            }
286
287 12
            if ($container->hasDefinition('fos_elastica.serializer_callback_prototype')) {
288 1
                $typeSerializerId = sprintf('%s.serializer.callback', $typeId);
289 1
                $typeSerializerDef = new DefinitionDecorator('fos_elastica.serializer_callback_prototype');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
290
291 1
                if (isset($type['serializer']['groups'])) {
292 1
                    $typeSerializerDef->addMethodCall('setGroups', [$type['serializer']['groups']]);
293
                }
294
295 1
                if (isset($type['serializer']['serialize_null'])) {
296 1
                    $typeSerializerDef->addMethodCall('setSerializeNull', [$type['serializer']['serialize_null']]);
297
                }
298
299 1
                if (isset($type['serializer']['version'])) {
300 1
                    $typeSerializerDef->addMethodCall('setVersion', [$type['serializer']['version']]);
301
                }
302
303 1
                $typeDef->addMethodCall('setSerializer', [[new Reference($typeSerializerId), 'serialize']]);
304 12
                $container->setDefinition($typeSerializerId, $typeSerializerDef);
305
            }
306
        }
307 12
    }
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 11
    private function loadTypePersistenceIntegration(array $typeConfig, ContainerBuilder $container, Reference $typeRef, $indexName, $typeName)
319
    {
320 11
        if (isset($typeConfig['driver'])) {
321 11
            $this->loadDriver($container, $typeConfig['driver']);
322
        }
323
324 11
        $elasticaToModelTransformerId = $this->loadElasticaToModelTransformer($typeConfig, $container, $indexName, $typeName);
325 11
        $modelToElasticaTransformerId = $this->loadModelToElasticaTransformer($typeConfig, $container, $indexName, $typeName);
326 11
        $objectPersisterId = $this->loadObjectPersister($typeConfig, $typeRef, $container, $indexName, $typeName, $modelToElasticaTransformerId);
327
328 11
        if (isset($typeConfig['provider'])) {
329 11
            $this->loadTypePagerProvider($typeConfig, $container, $indexName, $typeName);
330
        }
331 11
        if (isset($typeConfig['finder'])) {
332 11
            $this->loadTypeFinder($typeConfig, $container, $elasticaToModelTransformerId, $typeRef, $indexName, $typeName);
333
        }
334 11
        if (isset($typeConfig['listener'])) {
335 11
            $this->loadTypeListener($typeConfig, $container, $objectPersisterId, $indexName, $typeName);
336
        }
337 11
    }
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 11
    private function loadElasticaToModelTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName)
350
    {
351 11
        if (isset($typeConfig['elastica_to_model_transformer']['service'])) {
352 1
            return $typeConfig['elastica_to_model_transformer']['service'];
353
        }
354
355
        /* Note: transformer services may conflict with "prototype.driver", if
356
         * the index and type names were "prototype" and a driver, respectively.
357
         */
358 10
        $abstractId = sprintf('fos_elastica.elastica_to_model_transformer.prototype.%s', $typeConfig['driver']);
359 10
        $serviceId = sprintf('fos_elastica.elastica_to_model_transformer.%s.%s', $indexName, $typeName);
360 10
        $serviceDef = new DefinitionDecorator($abstractId);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
361 10
        $serviceDef->addTag('fos_elastica.elastica_to_model_transformer', ['type' => $typeName, 'index' => $indexName]);
362
363
        // Doctrine has a mandatory service as first argument
364 10
        $argPos = ('propel' === $typeConfig['driver']) ? 0 : 1;
365
366 10
        $serviceDef->replaceArgument($argPos, $typeConfig['model']);
367 10
        $serviceDef->replaceArgument($argPos + 1, array_merge($typeConfig['elastica_to_model_transformer'], [
368 10
            'identifier' => $typeConfig['identifier'],
369
        ]));
370 10
        $container->setDefinition($serviceId, $serviceDef);
371
372 10
        return $serviceId;
373
    }
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 11
    private function loadModelToElasticaTransformer(array $typeConfig, ContainerBuilder $container, $indexName, $typeName)
386
    {
387 11
        if (isset($typeConfig['model_to_elastica_transformer']['service'])) {
388
            return $typeConfig['model_to_elastica_transformer']['service'];
389
        }
390
391 11
        $abstractId = $container->hasDefinition('fos_elastica.serializer_callback_prototype') ?
392 1
            'fos_elastica.model_to_elastica_identifier_transformer' :
393 11
            'fos_elastica.model_to_elastica_transformer';
394
395 11
        $serviceId = sprintf('fos_elastica.model_to_elastica_transformer.%s.%s', $indexName, $typeName);
396 11
        $serviceDef = new DefinitionDecorator($abstractId);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
397 11
        $serviceDef->replaceArgument(0, [
398 11
            'identifier' => $typeConfig['identifier'],
399
        ]);
400 11
        $container->setDefinition($serviceId, $serviceDef);
401
402 11
        return $serviceId;
403
    }
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 11
    private function loadObjectPersister(array $typeConfig, Reference $typeRef, ContainerBuilder $container, $indexName, $typeName, $transformerId)
418
    {
419 11
        if (isset($typeConfig['persister']['service'])) {
420 1
            return $typeConfig['persister']['service'];
421
        }
422
423
        $arguments = [
424 10
            $typeRef,
425 10
            new Reference($transformerId),
426 10
            $typeConfig['model'],
427
        ];
428
429 10
        if ($container->hasDefinition('fos_elastica.serializer_callback_prototype')) {
430 1
            $abstractId = 'fos_elastica.object_serializer_persister';
431 1
            $callbackId = sprintf('%s.%s.serializer.callback', $this->indexConfigs[$indexName]['reference'], $typeName);
432 1
            $arguments[] = [new Reference($callbackId), 'serialize'];
433
        } else {
434 9
            $abstractId = 'fos_elastica.object_persister';
435 9
            $mapping = $this->indexConfigs[$indexName]['types'][$typeName]['mapping'];
436 9
            $argument = $mapping['properties'];
437 9
            if (isset($mapping['_parent'])) {
438 1
                $argument['_parent'] = $mapping['_parent'];
439
            }
440 9
            $arguments[] = $argument;
441
        }
442
443 10
        $serviceId = sprintf('fos_elastica.object_persister.%s.%s', $indexName, $typeName);
444 10
        $serviceDef = new DefinitionDecorator($abstractId);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
445 10
        foreach ($arguments as $i => $argument) {
446 10
            $serviceDef->replaceArgument($i, $argument);
447
        }
448
449 10
        $serviceDef->addTag('fos_elastica.persister', ['index' => $indexName, 'type' => $typeName]);
450
451 10
        $container->setDefinition($serviceId, $serviceDef);
452
453 10
        return $serviceId;
454
    }
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 11
    private function loadTypePagerProvider(array $typeConfig, ContainerBuilder $container, $indexName, $typeName)
467
    {
468 11
        if (isset($typeConfig['provider']['service'])) {
469
            return $typeConfig['provider']['service'];
470
        }
471
472 11
        $baseConfig = $typeConfig['provider'];
473 11
        unset($baseConfig['service']);
474
475 11
        $driver = $typeConfig['driver'];
476
477
        switch ($driver) {
478 11
            case 'orm':
479 6
                $providerDef = new DefinitionDecorator('fos_elastica.pager_provider.prototype.'.$driver);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
480 6
                $providerDef->replaceArgument(2, $typeConfig['model']);
481 6
                $providerDef->replaceArgument(3, $baseConfig);
482
483 6
                break;
484 5 View Code Duplication
            case 'mongodb':
485
                $providerDef = new DefinitionDecorator('fos_elastica.pager_provider.prototype.'.$driver);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
486
                $providerDef->replaceArgument(2, $typeConfig['model']);
487
                $providerDef->replaceArgument(3, $baseConfig);
488
489
                break;
490 5 View Code Duplication
            case 'phpcr':
491 1
                $providerDef = new DefinitionDecorator('fos_elastica.pager_provider.prototype.'.$driver);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
492 1
                $providerDef->replaceArgument(2, $typeConfig['model']);
493 1
                $providerDef->replaceArgument(3, $baseConfig);
494
495 1
                break;
496 4 View Code Duplication
            case 'propel':
497 4
                $providerDef = new DefinitionDecorator('fos_elastica.pager_provider.prototype.'.$driver);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
498 4
                $providerDef->replaceArgument(0, $typeConfig['model']);
499 4
                $providerDef->replaceArgument(1, $baseConfig);
500
501 4
                break;
502
            default:
503
                throw new \LogicException(sprintf('The pager provider for driver "%s" does not exist.', $driver));
504
        }
505
506
        /* Note: provider services may conflict with "prototype.driver", if the
507
         * index and type names were "prototype" and a driver, respectively.
508
         */
509 11
        $providerId = sprintf('fos_elastica.pager_provider.%s.%s', $indexName, $typeName);
510 11
        $providerDef->addTag('fos_elastica.pager_provider', ['index' => $indexName, 'type' => $typeName]);
511
512 11
        $container->setDefinition($providerId, $providerDef);
513
514 11
        return $providerId;
515
    }
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 11
    private function loadTypeListener(array $typeConfig, ContainerBuilder $container, $objectPersisterId, $indexName, $typeName)
529
    {
530 11
        if (isset($typeConfig['listener']['service'])) {
531
            return $typeConfig['listener']['service'];
532
        }
533
534
        /* Note: listener services may conflict with "prototype.driver", if the
535
         * index and type names were "prototype" and a driver, respectively.
536
         */
537 11
        $abstractListenerId = sprintf('fos_elastica.listener.prototype.%s', $typeConfig['driver']);
538 11
        $listenerId = sprintf('fos_elastica.listener.%s.%s', $indexName, $typeName);
539 11
        $listenerDef = new DefinitionDecorator($abstractListenerId);
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
540 11
        $listenerDef->replaceArgument(0, new Reference($objectPersisterId));
541 11
        $listenerDef->replaceArgument(3, $typeConfig['listener']['logger'] ?
542
            new Reference($typeConfig['listener']['logger']) :
543 11
            null
544
        );
545
        $listenerConfig = [
546 11
            'identifier' => $typeConfig['identifier'],
547 11
            'indexName' => $indexName,
548 11
            'typeName' => $typeName,
549
        ];
550
551 11
        $tagName = null;
552 11
        switch ($typeConfig['driver']) {
553 11
            case 'orm':
554 6
                $tagName = 'doctrine.event_listener';
555 6
                break;
556 5
            case 'phpcr':
557 1
                $tagName = 'doctrine_phpcr.event_listener';
558 1
                break;
559 4
            case 'mongodb':
560
                $tagName = 'doctrine_mongodb.odm.event_listener';
561
                break;
562
        }
563
564 11
        if ($typeConfig['listener']['defer']) {
565
            $listenerDef->setPublic(true);
566
            $listenerDef->addTag(
567
                'kernel.event_listener',
568
                ['event' => 'kernel.terminate', 'method' => 'onTerminate']
569
            );
570
            $listenerDef->addTag(
571
                'kernel.event_listener',
572
                ['event' => 'console.terminate', 'method' => 'onTerminate']
573
            );
574
            $listenerConfig['defer'] = true;
575
        }
576
577 11
        $listenerDef->replaceArgument(2, $listenerConfig);
578
579 11
        if (null !== $tagName) {
580 7
            foreach ($this->getDoctrineEvents($typeConfig) as $event) {
581 7
                $listenerDef->addTag($tagName, ['event' => $event]);
582
            }
583
        }
584
585 11
        $container->setDefinition($listenerId, $listenerDef);
586
587 11
        return $listenerId;
588
    }
589
590
    /**
591
     * Map Elastica to Doctrine events for the current driver.
592
     */
593 7
    private function getDoctrineEvents(array $typeConfig)
594
    {
595 7
        switch ($typeConfig['driver']) {
596 7
            case 'orm':
597 6
                $eventsClass = '\Doctrine\ORM\Events';
598 6
                break;
599 1
            case 'phpcr':
600 1
                $eventsClass = '\Doctrine\ODM\PHPCR\Event';
601 1
                break;
602
            case 'mongodb':
603
                $eventsClass = '\Doctrine\ODM\MongoDB\Events';
604
                break;
605
            default:
606
                throw new \InvalidArgumentException(sprintf('Cannot determine events for driver "%s"', $typeConfig['driver']));
607
        }
608
609 7
        $events = [];
610
        $eventMapping = [
611 7
            'insert' => [constant($eventsClass.'::postPersist')],
612 7
            'update' => [constant($eventsClass.'::postUpdate')],
613 7
            'delete' => [constant($eventsClass.'::preRemove')],
614 7
            'flush' => [constant($eventsClass.'::postFlush')],
615
        ];
616
617 7
        foreach ($eventMapping as $event => $doctrineEvents) {
618 7
            if (isset($typeConfig['listener'][$event]) && $typeConfig['listener'][$event]) {
619 7
                $events = array_merge($events, $doctrineEvents);
620
            }
621
        }
622
623 7
        return $events;
624
    }
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 11
    private function loadTypeFinder(array $typeConfig, ContainerBuilder $container, $elasticaToModelId, Reference $typeRef, $indexName, $typeName)
639
    {
640 11
        if (isset($typeConfig['finder']['service'])) {
641
            $finderId = $typeConfig['finder']['service'];
642
        } else {
643 11
            $finderId = sprintf('fos_elastica.finder.%s.%s', $indexName, $typeName);
644 11
            $finderDef = new DefinitionDecorator('fos_elastica.finder');
0 ignored issues
show
Deprecated Code introduced by
The class Symfony\Component\Depend...ion\DefinitionDecorator has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
645 11
            $finderDef->replaceArgument(0, $typeRef);
646 11
            $finderDef->replaceArgument(1, new Reference($elasticaToModelId));
647 11
            $container->setDefinition($finderId, $finderDef);
648
        }
649
650 11
        $indexTypeName = "$indexName/$typeName";
651 11
        $arguments = [$indexTypeName, new Reference($finderId)];
652 11
        if (isset($typeConfig['repository'])) {
653 1
            $arguments[] = $typeConfig['repository'];
654
        }
655
656 11
        $container->getDefinition('fos_elastica.repository_manager')
657 11
            ->addMethodCall('addType', $arguments);
658
659 11
        $managerId = sprintf('fos_elastica.manager.%s', $typeConfig['driver']);
660 11
        $container->getDefinition($managerId)
661 11
            ->addMethodCall('addEntity', [$typeConfig['model'], $indexTypeName]);
662
663 11
        return $finderId;
664
    }
665
666
    /**
667
     * Loads the index manager.
668
     *
669
     * @param ContainerBuilder $container
670
     **/
671
    private function loadIndexManager(ContainerBuilder $container)
672
    {
673 12
        $indexRefs = array_map(function ($index) {
674 12
            return $index['reference'];
675 12
        }, $this->indexConfigs);
676
677 12
        $managerDef = $container->getDefinition('fos_elastica.index_manager');
678 12
        $managerDef->replaceArgument(0, $indexRefs);
679 12
    }
680
681
    /**
682
     * Makes sure a specific driver has been loaded.
683
     *
684
     * @param ContainerBuilder $container
685
     * @param string           $driver
686
     */
687 11
    private function loadDriver(ContainerBuilder $container, $driver)
688
    {
689 11
        if (in_array($driver, $this->loadedDrivers)) {
690 3
            return;
691
        }
692
693 11
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
694 11
        $loader->load($driver.'.xml');
695 11
        $this->loadedDrivers[] = $driver;
696 11
    }
697
698
    /**
699
     * Loads and configures the serializer prototype.
700
     *
701
     * @param array            $config
702
     * @param ContainerBuilder $container
703
     */
704 1
    private function loadSerializer($config, ContainerBuilder $container)
705
    {
706 1
        $container->setAlias('fos_elastica.serializer', $config['serializer']);
707
708 1
        $serializer = $container->getDefinition('fos_elastica.serializer_callback_prototype');
709 1
        $serializer->setClass($config['callback_class']);
710
711 1
        if (is_subclass_of($config['callback_class'], ContainerAwareInterface::class)) {
0 ignored issues
show
Bug introduced by
Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if \Symfony\Component\Depen...erAwareInterface::class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.
Loading history...
712
            $serializer->addMethodCall('setContainer', [new Reference('service_container')]);
713
        }
714 1
    }
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 12
    private function createDefaultManagerAlias($defaultManager, ContainerBuilder $container)
723
    {
724 12
        if (0 == count($this->loadedDrivers)) {
725 1
            return;
726
        }
727
728 11
        if (count($this->loadedDrivers) > 1
729 11
            && in_array($defaultManager, $this->loadedDrivers)
730
        ) {
731
            $defaultManagerService = $defaultManager;
732
        } else {
733 11
            $defaultManagerService = $this->loadedDrivers[0];
734
        }
735
736 11
        $container->setAlias('fos_elastica.manager', sprintf('fos_elastica.manager.%s', $defaultManagerService));
737 11
    }
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 2
    private function getClient($clientName)
749
    {
750 2
        if (!array_key_exists($clientName, $this->clients)) {
751
            throw new \InvalidArgumentException(sprintf('The elastica client with name "%s" is not defined', $clientName));
752
        }
753
754 2
        return $this->clients[$clientName]['reference'];
755
    }
756
}
757