Completed
Pull Request — master (#1326)
by
unknown
03:42
created

Configuration::addClientsSection()   B

Complexity

Conditions 4
Paths 1

Size

Total Lines 92
Code Lines 79

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 84
CRAP Score 4

Importance

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

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