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

Configuration::getPersistenceNode()   C

Complexity

Conditions 7
Paths 1

Size

Total Lines 102
Code Lines 95

Duplication

Lines 2
Ratio 1.96 %

Code Coverage

Tests 95
CRAP Score 7.0004

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 2
loc 102
ccs 95
cts 97
cp 0.9794
rs 6.4589
cc 7
eloc 95
nc 1
nop 0
crap 7.0004

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