Completed
Push — master ( 99d0b0...d08da8 )
by Maksim
18s
created

Configuration::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
ccs 3
cts 3
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 1
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\Definition\Builder\ArrayNodeDefinition;
15
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
16
use Symfony\Component\Config\Definition\ConfigurationInterface;
17
18
class Configuration implements ConfigurationInterface
19
{
20
    /**
21
     * Stores supported database drivers.
22
     *
23
     * @var array
24
     */
25
    private $supportedDrivers = ['orm', 'mongodb', 'propel', 'phpcr'];
26
27
    /**
28
     * If the kernel is running in debug mode.
29
     *
30
     * @var bool
31
     */
32
    private $debug;
33
34 32
    public function __construct($debug)
35
    {
36 32
        $this->debug = $debug;
37 32
    }
38
39
    /**
40
     * Generates the configuration tree.
41
     *
42
     * @return TreeBuilder
43
     */
44 32
    public function getConfigTreeBuilder()
45
    {
46 32
        $treeBuilder = new TreeBuilder();
47 32
        $rootNode = $treeBuilder->root('fos_elastica', 'array');
48
49 32
        $this->addClientsSection($rootNode);
50 32
        $this->addIndexesSection($rootNode);
51
52
        $rootNode
53 32
            ->children()
54 32
                ->scalarNode('default_client')
55 32
                    ->info('Defaults to the first client defined')
56 32
                ->end()
57 32
                ->scalarNode('default_index')
58 32
                    ->info('Defaults to the first index defined')
59 32
                ->end()
60 32
                ->scalarNode('default_manager')->defaultValue('orm')->end()
61 32
                ->arrayNode('serializer')
62 32
                    ->treatNullLike([])
63 32
                    ->children()
64 32
                        ->scalarNode('callback_class')->defaultValue('FOS\ElasticaBundle\Serializer\Callback')->end()
65 32
                        ->scalarNode('serializer')->defaultValue('serializer')->end()
66 32
                    ->end()
67 32
                ->end()
68 32
            ->end()
69
        ;
70
71 32
        return $treeBuilder;
72
    }
73
74
    /**
75
     * Returns the array node used for "dynamic_templates".
76
     */
77 32
    public function getDynamicTemplateNode()
78
    {
79 32
        $builder = new TreeBuilder();
80 32
        $node = $builder->root('dynamic_templates');
81
82
        $node
83 32
            ->prototype('array')
84 32
                ->prototype('array')
85 32
                    ->children()
86 32
                        ->scalarNode('match')->end()
87 32
                        ->scalarNode('unmatch')->end()
88 32
                        ->scalarNode('match_mapping_type')->end()
89 32
                        ->scalarNode('path_match')->end()
90 32
                        ->scalarNode('path_unmatch')->end()
91 32
                        ->scalarNode('match_pattern')->end()
92 32
                        ->arrayNode('mapping')
93 32
                            ->prototype('variable')
94 32
                                ->treatNullLike([])
95 32
                            ->end()
96 32
                        ->end()
97 32
                    ->end()
98 32
                ->end()
99 32
            ->end()
100
        ;
101
102 32
        return $node;
103
    }
104
105
    /**
106
     * Returns the array node used for "types".
107
     */
108 32
    protected function getTypesNode()
109
    {
110 32
        $builder = new TreeBuilder();
111 32
        $node = $builder->root('types');
112
113
        $node
114 32
            ->useAttributeAsKey('name')
115 32
            ->prototype('array')
116 32
                ->treatNullLike([])
117 32
                ->beforeNormalization()
118 32
                ->ifNull()
119 32
                    ->thenEmptyArray()
120 32
                ->end()
121
                // Support multiple dynamic_template formats to match the old bundle style
122
                // and the way ElasticSearch expects them
123 32
                ->beforeNormalization()
124 32
                ->ifTrue(function ($v) {
125 23
                    return isset($v['dynamic_templates']);
126 32
                })
127 32
                ->then(function ($v) {
128 3
                    $dt = [];
129 3
                    foreach ($v['dynamic_templates'] as $key => $type) {
130 3
                        if (is_int($key)) {
131 3
                            $dt[] = $type;
132
                        } else {
133 3
                            $dt[][$key] = $type;
134
                        }
135
                    }
136
137 3
                    $v['dynamic_templates'] = $dt;
138
139 3
                    return $v;
140 32
                })
141 32
                ->end()
142 32
                ->children()
143 32
                    ->booleanNode('date_detection')->end()
144 32
                    ->arrayNode('dynamic_date_formats')->prototype('scalar')->end()->end()
145 32
                    ->scalarNode('analyzer')->end()
146 32
                    ->booleanNode('numeric_detection')->end()
147 32
                    ->scalarNode('dynamic')->end()
148 32
                    ->variableNode('indexable_callback')->end()
149 32
                    ->append($this->getPersistenceNode())
150 32
                    ->append($this->getSerializerNode())
151 32
                ->end()
152 32
                ->append($this->getIdNode())
153 32
                ->append($this->getPropertiesNode())
154 32
                ->append($this->getDynamicTemplateNode())
155 32
                ->append($this->getSourceNode())
156 32
                ->append($this->getRoutingNode())
157 32
                ->append($this->getParentNode())
158 32
                ->append($this->getAllNode())
159 32
            ->end()
160
        ;
161
162 32
        return $node;
163
    }
164
165
    /**
166
     * Returns the array node used for "properties".
167
     */
168 32
    protected function getPropertiesNode()
169
    {
170 32
        $builder = new TreeBuilder();
171 32
        $node = $builder->root('properties');
172
173
        $node
174 32
            ->useAttributeAsKey('name')
175 32
            ->prototype('variable')
176 32
                ->treatNullLike([]);
177
178 32
        return $node;
179
    }
180
181
    /**
182
     * Returns the array node used for "_id".
183
     */
184 32 View Code Duplication
    protected function getIdNode()
185
    {
186 32
        $builder = new TreeBuilder();
187 32
        $node = $builder->root('_id');
188
189
        $node
190 32
            ->children()
191 32
            ->scalarNode('path')->end()
192 32
            ->end()
193
        ;
194
195 32
        return $node;
196
    }
197
198
    /**
199
     * Returns the array node used for "_source".
200
     */
201 32
    protected function getSourceNode()
202
    {
203 32
        $builder = new TreeBuilder();
204 32
        $node = $builder->root('_source');
205
206
        $node
207 32
            ->children()
208 32
                ->arrayNode('excludes')
209 32
                    ->useAttributeAsKey('name')
210 32
                    ->prototype('scalar')->end()
211 32
                ->end()
212 32
                ->arrayNode('includes')
213 32
                    ->useAttributeAsKey('name')
214 32
                    ->prototype('scalar')->end()
215 32
                ->end()
216 32
                ->scalarNode('compress')->end()
217 32
                ->scalarNode('compress_threshold')->end()
218 32
                ->scalarNode('enabled')->defaultTrue()->end()
219 32
            ->end()
220
        ;
221
222 32
        return $node;
223
    }
224
225
    /**
226
     * Returns the array node used for "_routing".
227
     */
228 32 View Code Duplication
    protected function getRoutingNode()
229
    {
230 32
        $builder = new TreeBuilder();
231 32
        $node = $builder->root('_routing');
232
233
        $node
234 32
            ->children()
235 32
                ->scalarNode('required')->end()
236 32
                ->scalarNode('path')->end()
237 32
            ->end()
238
        ;
239
240 32
        return $node;
241
    }
242
243
    /**
244
     * Returns the array node used for "_parent".
245
     */
246 32
    protected function getParentNode()
247
    {
248 32
        $builder = new TreeBuilder();
249 32
        $node = $builder->root('_parent');
250
251
        $node
252 32
            ->children()
253 32
                ->scalarNode('type')->end()
254 32
                ->scalarNode('property')->defaultValue(null)->end()
255 32
                ->scalarNode('identifier')->defaultValue('id')->end()
256 32
            ->end()
257
        ;
258
259 32
        return $node;
260
    }
261
262
    /**
263
     * Returns the array node used for "_all".
264
     */
265 32
    protected function getAllNode()
266
    {
267 32
        $builder = new TreeBuilder();
268 32
        $node = $builder->root('_all');
269
270
        $node
271 32
            ->children()
272 32
            ->scalarNode('enabled')->defaultValue(true)->end()
273 32
            ->scalarNode('analyzer')->end()
274 32
            ->end()
275
        ;
276
277 32
        return $node;
278
    }
279
280
    /**
281
     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
282
     */
283 32
    protected function getPersistenceNode()
284
    {
285 32
        $builder = new TreeBuilder();
286 32
        $node = $builder->root('persistence');
287
288
        $node
289 32
            ->validate()
290 32 View Code Duplication
                ->ifTrue(function ($v) {
291
                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['listener']);
292 32
                })
293 32
                    ->thenInvalid('Propel doesn\'t support listeners')
294 32 View Code Duplication
                ->ifTrue(function ($v) {
295
                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['repository']);
296 32
                })
297 32
                    ->thenInvalid('Propel doesn\'t support the "repository" parameter')
298 32
                ->ifTrue(function ($v) {
299 19
                    return isset($v['driver']) && 'orm' !== $v['driver'] && !empty($v['elastica_to_model_transformer']['hints']);
300 32
                })
301 32
                    ->thenInvalid('Hints are only supported by the "orm" driver')
302 32
            ->end()
303 32
            ->children()
304 32
                ->scalarNode('driver')
305 32
                    ->defaultValue('orm')
306 32
                    ->validate()
307 32
                    ->ifNotInArray($this->supportedDrivers)
308 32
                        ->thenInvalid('The driver %s is not supported. Please choose one of '.json_encode($this->supportedDrivers))
309 32
                    ->end()
310 32
                ->end()
311 32
                ->scalarNode('model')->defaultValue(null)->end()
312 32
                ->scalarNode('repository')->end()
313 32
                ->scalarNode('identifier')->defaultValue('id')->end()
314 32
                ->arrayNode('provider')
315 32
                    ->addDefaultsIfNotSet()
316 32
                    ->children()
317 32
                        ->scalarNode('batch_size')->defaultValue(100)->end()
318 32
                        ->scalarNode('clear_object_manager')->defaultTrue()->end()
319 32
                        ->scalarNode('debug_logging')
320 32
                            ->defaultValue($this->debug)
321 32
                            ->treatNullLike(true)
322 32
                        ->end()
323 32
                        ->scalarNode('query_builder_method')->defaultValue('createQueryBuilder')->end()
324 32
                        ->scalarNode('service')->end()
325 32
                    ->end()
326 32
                ->end()
327 32
                ->arrayNode('listener')
328 32
                    ->addDefaultsIfNotSet()
329 32
                    ->children()
330 32
                        ->booleanNode('enabled')->defaultTrue()->end()
331 32
                        ->scalarNode('insert')->defaultTrue()->end()
332 32
                        ->scalarNode('update')->defaultTrue()->end()
333 32
                        ->scalarNode('delete')->defaultTrue()->end()
334 32
                        ->scalarNode('flush')->defaultTrue()->end()
335 32
                        ->booleanNode('defer')->defaultFalse()->end()
336 32
                        ->scalarNode('logger')
337 32
                            ->defaultFalse()
338 32
                            ->treatNullLike('fos_elastica.logger')
339 32
                            ->treatTrueLike('fos_elastica.logger')
340 32
                        ->end()
341 32
                        ->scalarNode('service')->end()
342 32
                    ->end()
343 32
                ->end()
344 32
                ->arrayNode('finder')
345 32
                    ->addDefaultsIfNotSet()
346 32
                    ->children()
347 32
                        ->scalarNode('service')->end()
348 32
                    ->end()
349 32
                ->end()
350 32
                ->arrayNode('elastica_to_model_transformer')
351 32
                    ->addDefaultsIfNotSet()
352 32
                    ->children()
353 32
                        ->arrayNode('hints')
354 32
                            ->prototype('array')
355 32
                                ->children()
356 32
                                    ->scalarNode('name')->end()
357 32
                                    ->scalarNode('value')->end()
358 32
                                ->end()
359 32
                            ->end()
360 32
                        ->end()
361 32
                        ->booleanNode('hydrate')->defaultTrue()->end()
362 32
                        ->booleanNode('ignore_missing')
363 32
                            ->defaultFalse()
364 32
                            ->info('Silently ignore results returned from Elasticsearch without corresponding persistent object.')
365 32
                        ->end()
366 32
                        ->scalarNode('query_builder_method')->defaultValue('createQueryBuilder')->end()
367 32
                        ->scalarNode('service')->end()
368 32
                    ->end()
369 32
                ->end()
370 32
                ->arrayNode('model_to_elastica_transformer')
371 32
                    ->addDefaultsIfNotSet()
372 32
                    ->children()
373 32
                        ->scalarNode('service')->end()
374 32
                    ->end()
375 32
                ->end()
376 32
                ->arrayNode('persister')
377 32
                    ->addDefaultsIfNotSet()
378 32
                    ->children()
379 32
                        ->scalarNode('service')->end()
380 32
                    ->end()
381 32
                ->end()
382 32
            ->end();
383
384 32
        return $node;
385
    }
386
387
    /**
388
     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
389
     */
390 32
    protected function getSerializerNode()
391
    {
392 32
        $builder = new TreeBuilder();
393 32
        $node = $builder->root('serializer');
394
395
        $node
0 ignored issues
show
Bug introduced by
The method scalarNode() does not seem to exist on object<Symfony\Component...odeDefinitionInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
396 32
            ->addDefaultsIfNotSet()
397 32
            ->children()
398 32
                ->arrayNode('groups')
399 32
                    ->treatNullLike([])
400 32
                    ->prototype('scalar')->end()
401 32
                ->end()
402 32
                ->scalarNode('version')->end()
403 32
                ->booleanNode('serialize_null')
404 32
                    ->defaultFalse()
405 32
                ->end()
406 32
            ->end();
407
408 32
        return $node;
409
    }
410
411
    /**
412
     * Adds the configuration for the "clients" key.
413
     */
414 32
    private function addClientsSection(ArrayNodeDefinition $rootNode)
415
    {
416
        $rootNode
417 32
            ->fixXmlConfig('client')
418 32
            ->children()
419 32
                ->arrayNode('clients')
420 32
                    ->useAttributeAsKey('id')
421 32
                    ->prototype('array')
422 32
                        ->performNoDeepMerging()
423
                        // Elastica names its properties with camel case, support both
424 32
                        ->beforeNormalization()
425 32
                        ->ifTrue(function ($v) {
426 31
                            return isset($v['connection_strategy']);
427 32
                        })
428 32
                        ->then(function ($v) {
429 3
                            $v['connectionStrategy'] = $v['connection_strategy'];
430 3
                            unset($v['connection_strategy']);
431
432 3
                            return $v;
433 32
                        })
434 32
                        ->end()
435
                        // If there is no connections array key defined, assume a single connection.
436 32
                        ->beforeNormalization()
437 32
                        ->ifTrue(function ($v) {
438 31
                            return is_array($v) && !array_key_exists('connections', $v);
439 32
                        })
440 32
                        ->then(function ($v) {
441
                            return [
442 31
                                'connections' => [$v],
443
                            ];
444 32
                        })
445 32
                        ->end()
446 32
                        ->children()
447 32
                            ->arrayNode('connections')
448 32
                                ->requiresAtLeastOneElement()
449 32
                                ->prototype('array')
450 32
                                    ->fixXmlConfig('header')
451 32
                                    ->children()
452 32
                                        ->scalarNode('url')
453 32
                                            ->validate()
454 32
                                                ->ifTrue(function ($url) {
455 17
                                                    return $url && '/' !== substr($url, -1);
456 32
                                                })
457 32
                                                ->then(function ($url) {
458 17
                                                    return $url.'/';
459 32
                                                })
460 32
                                            ->end()
461 32
                                        ->end()
462 32
                                        ->scalarNode('username')->end()
463 32
                                        ->scalarNode('password')->end()
464 32
                                        ->scalarNode('host')->end()
465 32
                                        ->scalarNode('port')->end()
466 32
                                        ->scalarNode('proxy')->end()
467 32
                                        ->scalarNode('aws_access_key_id')->end()
468 32
                                        ->scalarNode('aws_secret_access_key')->end()
469 32
                                        ->scalarNode('aws_region')->end()
470 32
                                        ->scalarNode('aws_session_token')->end()
471 32
                                        ->booleanNode('ssl')->defaultValue(false)->end()
472 32
                                        ->scalarNode('logger')
473 32
                                            ->defaultValue($this->debug ? 'fos_elastica.logger' : false)
474 32
                                            ->treatNullLike('fos_elastica.logger')
475 32
                                            ->treatTrueLike('fos_elastica.logger')
476 32
                                        ->end()
477 32
                                        ->booleanNode('compression')->defaultValue(false)->end()
478 32
                                        ->arrayNode('headers')
479 32
                                            ->normalizeKeys(false)
480 32
                                            ->useAttributeAsKey('name')
481 32
                                            ->prototype('scalar')->end()
482 32
                                        ->end()
483 32
                                        ->arrayNode('curl')
484 32
                                            ->useAttributeAsKey(CURLOPT_SSL_VERIFYPEER)
485 32
                                            ->prototype('boolean')->end()
486 32
                                        ->end()
487 32
                                        ->scalarNode('transport')->end()
488 32
                                        ->scalarNode('timeout')->end()
489 32
                                        ->scalarNode('connectTimeout')->end()
490 32
                                        ->scalarNode('retryOnConflict')
491 32
                                            ->defaultValue(0)
492 32
                                        ->end()
493 32
                                    ->end()
494 32
                                ->end()
495 32
                            ->end()
496 32
                            ->scalarNode('timeout')->end()
497 32
                            ->scalarNode('connectTimeout')->end()
498 32
                            ->scalarNode('headers')->end()
499 32
                            ->scalarNode('connectionStrategy')->defaultValue('Simple')->end()
500 32
                        ->end()
501 32
                    ->end()
502 32
                ->end()
503 32
            ->end()
504
        ;
505 32
    }
506
507
    /**
508
     * Adds the configuration for the "indexes" key.
509
     */
510 32
    private function addIndexesSection(ArrayNodeDefinition $rootNode)
511
    {
512
        $rootNode
513 32
            ->fixXmlConfig('index')
514 32
            ->children()
515 32
                ->arrayNode('indexes')
516 32
                    ->useAttributeAsKey('name')
517 32
                    ->prototype('array')
518 32
                        ->children()
519 32
                            ->scalarNode('index_name')
520 32
                                ->info('Defaults to the name of the index, but can be modified if the index name is different in ElasticSearch')
521 32
                            ->end()
522 32
                            ->booleanNode('use_alias')->defaultValue(false)->end()
523 32
                            ->scalarNode('client')->end()
524 32
                            ->scalarNode('finder')
525 32
                                ->treatNullLike(true)
526 32
                                ->defaultFalse()
527 32
                            ->end()
528 32
                            ->arrayNode('type_prototype')
529 32
                                ->children()
530 32
                                    ->scalarNode('analyzer')->end()
531 32
                                    ->append($this->getPersistenceNode())
532 32
                                    ->append($this->getSerializerNode())
533 32
                                ->end()
534 32
                            ->end()
535 32
                            ->variableNode('settings')->defaultValue([])->end()
536 32
                        ->end()
537 32
                        ->append($this->getTypesNode())
538 32
                    ->end()
539 32
                ->end()
540 32
            ->end()
541
        ;
542 32
    }
543
}
544