Completed
Pull Request — master (#1326)
by
unknown
02:05
created

Configuration::getIdNode()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 13
Code Lines 8

Duplication

Lines 13
Ratio 100 %

Code Coverage

Tests 7
CRAP Score 1

Importance

Changes 0
Metric Value
dl 13
loc 13
c 0
b 0
f 0
ccs 7
cts 7
cp 1
rs 9.4285
cc 1
eloc 8
nc 1
nop 0
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 23
    public function __construct($debug)
35
    {
36 23
        $this->debug = $debug;
37 23
    }
38
39
    /**
40
     * Generates the configuration tree.
41
     *
42
     * @return TreeBuilder
43
     */
44 23
    public function getConfigTreeBuilder()
45
    {
46 23
        $treeBuilder = new TreeBuilder();
47 23
        $rootNode = $treeBuilder->root('fos_elastica', 'array');
48
49 23
        $this->addClientsSection($rootNode);
50 23
        $this->addIndexesSection($rootNode);
51
52
        $rootNode
53 23
            ->children()
54 23
                ->scalarNode('default_client')
55 23
                    ->info('Defaults to the first client defined')
56 23
                ->end()
57 23
                ->scalarNode('default_index')
58 23
                    ->info('Defaults to the first index defined')
59 23
                ->end()
60 23
                ->scalarNode('default_manager')->defaultValue('orm')->end()
61 23
                ->arrayNode('serializer')
62 23
                    ->treatNullLike([])
63 23
                    ->children()
64 23
                        ->scalarNode('callback_class')->defaultValue('FOS\ElasticaBundle\Serializer\Callback')->end()
65 23
                        ->scalarNode('serializer')->defaultValue('serializer')->end()
66 23
                    ->end()
67 23
                ->end()
68 23
            ->end()
69
        ;
70
71 23
        return $treeBuilder;
72
    }
73
74
    /**
75
     * Returns the array node used for "dynamic_templates".
76
     */
77 23
    public function getDynamicTemplateNode()
78
    {
79 23
        $builder = new TreeBuilder();
80 23
        $node = $builder->root('dynamic_templates');
81
82
        $node
83 23
            ->prototype('array')
84 23
                ->prototype('array')
85 23
                    ->children()
86 23
                        ->scalarNode('match')->end()
87 23
                        ->scalarNode('unmatch')->end()
88 23
                        ->scalarNode('match_mapping_type')->end()
89 23
                        ->scalarNode('path_match')->end()
90 23
                        ->scalarNode('path_unmatch')->end()
91 23
                        ->scalarNode('match_pattern')->end()
92 23
                        ->arrayNode('mapping')
93 23
                            ->prototype('variable')
94 23
                                ->treatNullLike([])
95 23
                            ->end()
96 23
                        ->end()
97 23
                    ->end()
98 23
                ->end()
99 23
            ->end()
100
        ;
101
102 23
        return $node;
103
    }
104
105
    /**
106
     * Returns the array node used for "types".
107
     */
108 23
    protected function getTypesNode()
109
    {
110 23
        $builder = new TreeBuilder();
111 23
        $node = $builder->root('types');
112
113
        $node
114 23
            ->useAttributeAsKey('name')
115 23
            ->prototype('array')
116 23
                ->treatNullLike([])
117 23
                ->beforeNormalization()
118 23
                ->ifNull()
119 23
                    ->thenEmptyArray()
120 23
                ->end()
121
                // Support multiple dynamic_template formats to match the old bundle style
122
                // and the way ElasticSearch expects them
123 23
                ->beforeNormalization()
124 23
                ->ifTrue(function ($v) {
125 14
                    return isset($v['dynamic_templates']);
126 23
                })
127 23
                ->then(function ($v) {
128
                    $dt = [];
129
                    foreach ($v['dynamic_templates'] as $key => $type) {
130
                        if (is_int($key)) {
131
                            $dt[] = $type;
132
                        } else {
133
                            $dt[][$key] = $type;
134
                        }
135
                    }
136
137
                    $v['dynamic_templates'] = $dt;
138
139
                    return $v;
140 23
                })
141 23
                ->end()
142 23
                ->children()
143 23
                    ->booleanNode('date_detection')->end()
144 23
                    ->arrayNode('dynamic_date_formats')->prototype('scalar')->end()->end()
145 23
                    ->scalarNode('analyzer')->end()
146 23
                    ->booleanNode('numeric_detection')->end()
147 23
                    ->scalarNode('dynamic')->end()
148 23
                    ->variableNode('indexable_callback')->end()
149 23
                    ->append($this->getPersistenceNode())
150 23
                    ->append($this->getSerializerNode())
151 23
                ->end()
152 23
                ->append($this->getIdNode())
153 23
                ->append($this->getPropertiesNode())
154 23
                ->append($this->getDynamicTemplateNode())
155 23
                ->append($this->getSourceNode())
156 23
                ->append($this->getRoutingNode())
157 23
                ->append($this->getParentNode())
158 23
                ->append($this->getAllNode())
159 23
            ->end()
160
        ;
161
162 23
        return $node;
163
    }
164
165
    /**
166
     * Returns the array node used for "properties".
167
     */
168 23
    protected function getPropertiesNode()
169
    {
170 23
        $builder = new TreeBuilder();
171 23
        $node = $builder->root('properties');
172
173
        $node
174 23
            ->useAttributeAsKey('name')
175 23
            ->prototype('variable')
176 23
                ->treatNullLike([]);
177
178 23
        return $node;
179
    }
180
181
    /**
182
     * Returns the array node used for "_id".
183
     */
184 23 View Code Duplication
    protected function getIdNode()
185
    {
186 23
        $builder = new TreeBuilder();
187 23
        $node = $builder->root('_id');
188
189
        $node
190 23
            ->children()
191 23
            ->scalarNode('path')->end()
192 23
            ->end()
193
        ;
194
195 23
        return $node;
196
    }
197
198
    /**
199
     * Returns the array node used for "_source".
200
     */
201 23
    protected function getSourceNode()
202
    {
203 23
        $builder = new TreeBuilder();
204 23
        $node = $builder->root('_source');
205
206
        $node
207 23
            ->children()
208 23
                ->arrayNode('excludes')
209 23
                    ->useAttributeAsKey('name')
210 23
                    ->prototype('scalar')->end()
211 23
                ->end()
212 23
                ->arrayNode('includes')
213 23
                    ->useAttributeAsKey('name')
214 23
                    ->prototype('scalar')->end()
215 23
                ->end()
216 23
                ->scalarNode('compress')->end()
217 23
                ->scalarNode('compress_threshold')->end()
218 23
                ->scalarNode('enabled')->defaultTrue()->end()
219 23
            ->end()
220
        ;
221
222 23
        return $node;
223
    }
224
225
    /**
226
     * Returns the array node used for "_routing".
227
     */
228 23 View Code Duplication
    protected function getRoutingNode()
229
    {
230 23
        $builder = new TreeBuilder();
231 23
        $node = $builder->root('_routing');
232
233
        $node
234 23
            ->children()
235 23
                ->scalarNode('required')->end()
236 23
                ->scalarNode('path')->end()
237 23
            ->end()
238
        ;
239
240 23
        return $node;
241
    }
242
243
    /**
244
     * Returns the array node used for "_parent".
245
     */
246 23
    protected function getParentNode()
247
    {
248 23
        $builder = new TreeBuilder();
249 23
        $node = $builder->root('_parent');
250
251
        $node
252 23
            ->children()
253 23
                ->scalarNode('type')->end()
254 23
                ->scalarNode('property')->defaultValue(null)->end()
255 23
                ->scalarNode('identifier')->defaultValue('id')->end()
256 23
            ->end()
257
        ;
258
259 23
        return $node;
260
    }
261
262
    /**
263
     * Returns the array node used for "_all".
264
     */
265 23
    protected function getAllNode()
266
    {
267 23
        $builder = new TreeBuilder();
268 23
        $node = $builder->root('_all');
269
270
        $node
271 23
            ->children()
272 23
            ->scalarNode('enabled')->defaultValue(true)->end()
273 23
            ->scalarNode('analyzer')->end()
274 23
            ->end()
275
        ;
276
277 23
        return $node;
278
    }
279
280
    /**
281
     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
282
     */
283 23
    protected function getPersistenceNode()
284
    {
285 23
        $builder = new TreeBuilder();
286 23
        $node = $builder->root('persistence');
287
288
        $node
289 23
            ->validate()
290 23 View Code Duplication
                ->ifTrue(function ($v) {
291
                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['listener']);
292 23
                })
293 23
                    ->thenInvalid('Propel doesn\'t support listeners')
294 23 View Code Duplication
                ->ifTrue(function ($v) {
295
                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['repository']);
296 23
                })
297 23
                    ->thenInvalid('Propel doesn\'t support the "repository" parameter')
298 23
                ->ifTrue(function ($v) {
299 13
                    return isset($v['driver']) && 'orm' !== $v['driver'] && !empty($v['elastica_to_model_transformer']['hints']);
300 23
                })
301 23
                    ->thenInvalid('Hints are only supported by the "orm" driver')
302 23
            ->end()
303 23
            ->children()
304 23
                ->scalarNode('driver')
305 23
                    ->defaultValue('orm')
306 23
                    ->validate()
307 23
                    ->ifNotInArray($this->supportedDrivers)
308 23
                        ->thenInvalid('The driver %s is not supported. Please choose one of '.json_encode($this->supportedDrivers))
309 23
                    ->end()
310 23
                ->end()
311 23
                ->scalarNode('model')->defaultValue(null)->end()
312 23
                ->scalarNode('repository')->end()
313 23
                ->scalarNode('identifier')->defaultValue('id')->end()
314 23
                ->arrayNode('provider')
315 23
                    ->addDefaultsIfNotSet()
316 23
                    ->children()
317 23
                        ->scalarNode('batch_size')->defaultValue(100)->end()
318 23
                        ->scalarNode('clear_object_manager')->defaultTrue()->end()
319 23
                        ->scalarNode('debug_logging')
320 23
                            ->defaultValue($this->debug)
321 23
                            ->treatNullLike(true)
322 23
                        ->end()
323 23
                        ->scalarNode('query_builder_method')->defaultValue('createQueryBuilder')->end()
324 23
                        ->scalarNode('service')->end()
325 23
                        ->booleanNode('pager_provider')
326 23
                            ->defaultFalse()
327 23
                            ->info('If true, a pager provider will also be registered.')
328 23
                        ->end()
329 23
                    ->end()
330 23
                ->end()
331 23
                ->arrayNode('listener')
332 23
                    ->addDefaultsIfNotSet()
333 23
                    ->children()
334 23
                        ->scalarNode('insert')->defaultTrue()->end()
335 23
                        ->scalarNode('update')->defaultTrue()->end()
336 23
                        ->scalarNode('delete')->defaultTrue()->end()
337 23
                        ->scalarNode('flush')->defaultTrue()->end()
338 23
                        ->booleanNode('defer')->defaultFalse()->end()
339 23
                        ->scalarNode('logger')
340 23
                            ->defaultFalse()
341 23
                            ->treatNullLike('fos_elastica.logger')
342 23
                            ->treatTrueLike('fos_elastica.logger')
343 23
                        ->end()
344 23
                        ->scalarNode('service')->end()
345 23
                    ->end()
346 23
                ->end()
347 23
                ->arrayNode('finder')
348 23
                    ->addDefaultsIfNotSet()
349 23
                    ->children()
350 23
                        ->scalarNode('service')->end()
351 23
                    ->end()
352 23
                ->end()
353 23
                ->arrayNode('elastica_to_model_transformer')
354 23
                    ->addDefaultsIfNotSet()
355 23
                    ->children()
356 23
                        ->arrayNode('hints')
357 23
                            ->prototype('array')
358 23
                                ->children()
359 23
                                    ->scalarNode('name')->end()
360 23
                                    ->scalarNode('value')->end()
361 23
                                ->end()
362 23
                            ->end()
363 23
                        ->end()
364 23
                        ->booleanNode('hydrate')->defaultTrue()->end()
365 23
                        ->booleanNode('ignore_missing')
366 23
                            ->defaultFalse()
367 23
                            ->info('Silently ignore results returned from Elasticsearch without corresponding persistent object.')
368 23
                        ->end()
369 23
                        ->scalarNode('query_builder_method')->defaultValue('createQueryBuilder')->end()
370 23
                        ->scalarNode('service')->end()
371 23
                    ->end()
372 23
                ->end()
373 23
                ->arrayNode('model_to_elastica_transformer')
374 23
                    ->addDefaultsIfNotSet()
375 23
                    ->children()
376 23
                        ->scalarNode('service')->end()
377 23
                    ->end()
378 23
                ->end()
379 23
                ->arrayNode('persister')
380 23
                    ->addDefaultsIfNotSet()
381 23
                    ->children()
382 23
                        ->scalarNode('service')->end()
383 23
                    ->end()
384 23
                ->end()
385 23
            ->end();
386
387 23
        return $node;
388
    }
389
390
    /**
391
     * @return ArrayNodeDefinition|\Symfony\Component\Config\Definition\Builder\NodeDefinition
392
     */
393 23
    protected function getSerializerNode()
394
    {
395 23
        $builder = new TreeBuilder();
396 23
        $node = $builder->root('serializer');
397
398
        $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...
399 23
            ->addDefaultsIfNotSet()
400 23
            ->children()
401 23
                ->arrayNode('groups')
402 23
                    ->treatNullLike([])
403 23
                    ->prototype('scalar')->end()
404 23
                ->end()
405 23
                ->scalarNode('version')->end()
406 23
                ->booleanNode('serialize_null')
407 23
                    ->defaultFalse()
408 23
                ->end()
409 23
            ->end();
410
411 23
        return $node;
412
    }
413
414
    /**
415
     * Adds the configuration for the "clients" key.
416
     */
417 23
    private function addClientsSection(ArrayNodeDefinition $rootNode)
418
    {
419
        $rootNode
420 23
            ->fixXmlConfig('client')
421 23
            ->children()
422 23
                ->arrayNode('clients')
423 23
                    ->useAttributeAsKey('id')
424 23
                    ->prototype('array')
425 23
                        ->performNoDeepMerging()
426
                        // Elastica names its properties with camel case, support both
427 23
                        ->beforeNormalization()
428 23
                        ->ifTrue(function ($v) {
429 22
                            return isset($v['connection_strategy']);
430 23
                        })
431 23
                        ->then(function ($v) {
432
                            $v['connectionStrategy'] = $v['connection_strategy'];
433
                            unset($v['connection_strategy']);
434
435
                            return $v;
436 23
                        })
437 23
                        ->end()
438
                        // If there is no connections array key defined, assume a single connection.
439 23
                        ->beforeNormalization()
440 23
                        ->ifTrue(function ($v) {
441 22
                            return is_array($v) && !array_key_exists('connections', $v);
442 23
                        })
443 23
                        ->then(function ($v) {
444
                            return [
445 22
                                'connections' => [$v],
446
                            ];
447 23
                        })
448 23
                        ->end()
449 23
                        ->children()
450 23
                            ->arrayNode('connections')
451 23
                                ->requiresAtLeastOneElement()
452 23
                                ->prototype('array')
453 23
                                    ->fixXmlConfig('header')
454 23
                                    ->children()
455 23
                                        ->scalarNode('url')
456 23
                                            ->validate()
457 23
                                                ->ifTrue(function ($url) {
458 9
                                                    return $url && '/' !== substr($url, -1);
459 23
                                                })
460 23
                                                ->then(function ($url) {
461 9
                                                    return $url.'/';
462 23
                                                })
463 23
                                            ->end()
464 23
                                        ->end()
465 23
                                        ->scalarNode('username')->end()
466 23
                                        ->scalarNode('password')->end()
467 23
                                        ->scalarNode('host')->end()
468 23
                                        ->scalarNode('port')->end()
469 23
                                        ->scalarNode('proxy')->end()
470 23
                                        ->scalarNode('aws_access_key_id')->end()
471 23
                                        ->scalarNode('aws_secret_access_key')->end()
472 23
                                        ->scalarNode('aws_region')->end()
473 23
                                        ->scalarNode('aws_session_token')->end()
474 23
                                        ->booleanNode('ssl')->defaultValue(false)->end()
475 23
                                        ->scalarNode('logger')
476 23
                                            ->defaultValue($this->debug ? 'fos_elastica.logger' : false)
477 23
                                            ->treatNullLike('fos_elastica.logger')
478 23
                                            ->treatTrueLike('fos_elastica.logger')
479 23
                                        ->end()
480 23
                                        ->booleanNode('compression')->defaultValue(false)->end()
481 23
                                        ->arrayNode('headers')
482 23
                                            ->normalizeKeys(false)
483 23
                                            ->useAttributeAsKey('name')
484 23
                                            ->prototype('scalar')->end()
485 23
                                        ->end()
486 23
                                        ->arrayNode('curl')
487 23
                                            ->useAttributeAsKey(CURLOPT_SSL_VERIFYPEER)
488 23
                                            ->prototype('boolean')->end()
489 23
                                        ->end()
490 23
                                        ->scalarNode('transport')->end()
491 23
                                        ->scalarNode('timeout')->end()
492 23
                                        ->scalarNode('connectTimeout')->end()
493 23
                                        ->scalarNode('retryOnConflict')
494 23
                                            ->defaultValue(0)
495 23
                                        ->end()
496 23
                                    ->end()
497 23
                                ->end()
498 23
                            ->end()
499 23
                            ->scalarNode('timeout')->end()
500 23
                            ->scalarNode('connectTimeout')->end()
501 23
                            ->scalarNode('headers')->end()
502 23
                            ->scalarNode('connectionStrategy')->defaultValue('Simple')->end()
503 23
                        ->end()
504 23
                    ->end()
505 23
                ->end()
506 23
            ->end()
507
        ;
508 23
    }
509
510
    /**
511
     * Adds the configuration for the "indexes" key.
512
     */
513 23
    private function addIndexesSection(ArrayNodeDefinition $rootNode)
514
    {
515
        $rootNode
516 23
            ->fixXmlConfig('index')
517 23
            ->children()
518 23
                ->arrayNode('indexes')
519 23
                    ->useAttributeAsKey('name')
520 23
                    ->prototype('array')
521 23
                        ->children()
522 23
                            ->scalarNode('index_name')
523 23
                                ->info('Defaults to the name of the index, but can be modified if the index name is different in ElasticSearch')
524 23
                            ->end()
525 23
                            ->booleanNode('use_alias')->defaultValue(false)->end()
526 23
                            ->scalarNode('client')->end()
527 23
                            ->scalarNode('finder')
528 23
                                ->treatNullLike(true)
529 23
                                ->defaultFalse()
530 23
                            ->end()
531 23
                            ->arrayNode('type_prototype')
532 23
                                ->children()
533 23
                                    ->scalarNode('analyzer')->end()
534 23
                                    ->append($this->getPersistenceNode())
535 23
                                    ->append($this->getSerializerNode())
536 23
                                ->end()
537 23
                            ->end()
538 23
                            ->variableNode('settings')->defaultValue([])->end()
539 23
                        ->end()
540 23
                        ->append($this->getTypesNode())
541 23
                    ->end()
542 23
                ->end()
543 23
            ->end()
544
        ;
545 23
    }
546
}
547