Completed
Pull Request — master (#1315)
by Mathieu
03:54
created

Configuration::addClientsSection()   B

Complexity

Conditions 4
Paths 1

Size

Total Lines 92
Code Lines 79

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 81
CRAP Score 4.0007

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 92
ccs 81
cts 84
cp 0.9643
rs 8.3275
cc 4
eloc 79
nc 1
nop 1
crap 4.0007

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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