FieldFactory::create() - Code Metrics - Inspection of "Major update :" - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 0.3-dev ( 291149...449c2f )

by Arnaud

created 2016-02-06 22:51 UTC

FieldFactory::create() C

↳ Parent: FieldFactory

Complexity

Conditions	8
Paths	12

Size

Total Lines	67
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	67
rs	6.6523
cc	8
eloc	34
nc	12
nop	2

How to fix Long Method

<?php

namespace LAG\AdminBundle\Field\Factory;

use Exception;
use LAG\AdminBundle\Admin\Configuration\ApplicationConfiguration;
use LAG\AdminBundle\Field\Field;
use LAG\AdminBundle\Field\FieldInterface;
use LAG\AdminBundle\Field\TwigFieldInterface;
use LAG\AdminBundle\Field\TranslatableFieldInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Translation\TranslatorInterface;
use Twig_Environment;

/**
 * Field factory. Instances fields with its renderer.
 */
class FieldFactory
{
    /**
     * Application configuration
     *
     * @var ApplicationConfiguration
     */
    protected $configuration;

    /**
     * Field class mapping array, indexed by field type.
     *
     * @var array
     */
    protected $fieldsMapping = [];

    /**
     * Translator for field values.
     *
     * @var TranslatorInterface
     */
    protected $translator;

    /**
     * Twig engine.
     *
     * @var Twig_Environment
     */
    protected $twig;

    /**
     * FieldFactory constructor.
     *
     * @param ApplicationConfiguration $configuration
     * @param TranslatorInterface $translator
     * @param Twig_Environment $twig
     */
    public function __construct(
        ApplicationConfiguration $configuration,
        TranslatorInterface $translator,
        Twig_Environment $twig
    ) {
        $this->configuration = $configuration;
        $this->fieldsMapping = $configuration->getFieldsMapping(); // shortcut to field mapping array
        $this->translator = $translator;
        $this->twig = $twig;
    }

    /**
     * Create a new field with its renderer.
     *
     * @param $fieldName
     * @param array $configuration
     *
     * @return Field
     *
     * @throws Exception
     */
    public function create($fieldName, array $configuration = [])
    {
        $resolver = new OptionsResolver();
        $resolver->setDefaults([
            'type' => 'string',
            'options' => [],
        ]);
        // set allowed fields type from tagged services
        $resolver->setAllowedValues('type', array_keys($this->fieldsMapping));
        $resolver->setAllowedTypes('type', 'string');
        $resolver->setAllowedTypes('options', 'array');

        // resolve options
        $configuration = $resolver->resolve($configuration);

        // for collection of fields, we resolve the configuration of each item
        if ($configuration['type'] == 'collection') {
            $items = [];

            foreach ($configuration['options'] as $itemFieldName => $itemFieldConfiguration) {

                // configuration should be an array
                if (!$itemFieldConfiguration) {
                    $itemFieldConfiguration = [];
                }
                // type should exists
                if (!array_key_exists('type', $configuration)) {
                    throw new Exception("Missing type configuration for field {$itemFieldName}");
                }
                // create collection item
                $items[] = $this->create($itemFieldName, $itemFieldConfiguration);
            }
            // add created item to the field options
            $configuration['options'] = [
                'fields' => $items,
            ];
        }
        // instanciate field
        $fieldClass = $this->getFieldMapping($configuration['type']);
        $field = new $fieldClass();

        if (!($field instanceof FieldInterface)) {
            throw new Exception("Field class {$fieldClass} must implements " . FieldInterface::class);
        }
        $field->setName($fieldName);
        $field->setConfiguration($this->configuration);

        if ($field instanceof TranslatableFieldInterface) {
            $field->setTranslator($this->translator);
        }
        if ($field instanceof TwigFieldInterface) {
            $field->setTwig($this->twig);
        }
        // clear revolver from previous default configuration
        $resolver->clear();

        // configure field default options
        $field->configureOptions($resolver);
        // resolve options
        $options = $resolver->resolve($configuration['options']);

        // set options and value
        $field->setOptions($options);


        return $field;
    }

    /**
     * Return field class according to the field type. If the type is not present in the field mapping array, an
     * exception will be thrown.
     *
     * @param $type
     * @return string
     * @throws Exception
     */
    public function getFieldMapping($type)
    {
        if (!array_key_exists($type, $this->fieldsMapping)) {
            throw new Exception("Field type {$type} not found in field mapping. Check your configuration");
        }

        return $this->fieldsMapping[$type];
    }
}


1			<?php
2
3			namespace LAG\AdminBundle\Field\Factory;
4
5			use Exception;
6			use LAG\AdminBundle\Admin\Configuration\ApplicationConfiguration;
7			use LAG\AdminBundle\Field\Field;
8			use LAG\AdminBundle\Field\FieldInterface;
9			use LAG\AdminBundle\Field\TwigFieldInterface;
10			use LAG\AdminBundle\Field\TranslatableFieldInterface;
11			use Symfony\Component\OptionsResolver\OptionsResolver;
12			use Symfony\Component\Translation\TranslatorInterface;
13			use Twig_Environment;
14
15			/**
16			* Field factory. Instances fields with its renderer.
17			*/
18			class FieldFactory
19			{
20			/**
21			* Application configuration
22			*
23			* @var ApplicationConfiguration
24			*/
25			protected $configuration;
26
27			/**
28			* Field class mapping array, indexed by field type.
29			*
30			* @var array
31			*/
32			protected $fieldsMapping = [];
33
34			/**
35			* Translator for field values.
36			*
37			* @var TranslatorInterface
38			*/
39			protected $translator;
40
41			/**
42			* Twig engine.
43			*
44			* @var Twig_Environment
45			*/
46			protected $twig;
47
48			/**
49			* FieldFactory constructor.
50			*
51			* @param ApplicationConfiguration $configuration
52			* @param TranslatorInterface $translator
53			* @param Twig_Environment $twig
54			*/
55			public function __construct(
56			ApplicationConfiguration $configuration,
57			TranslatorInterface $translator,
58			Twig_Environment $twig
59			) {
60			$this->configuration = $configuration;
61			$this->fieldsMapping = $configuration->getFieldsMapping(); // shortcut to field mapping array
62			$this->translator = $translator;
63			$this->twig = $twig;
64			}
65
66			/**
67			* Create a new field with its renderer.
68			*
69			* @param $fieldName
70			* @param array $configuration
71			*
72			* @return Field
73			*
74			* @throws Exception
75			*/
76			public function create($fieldName, array $configuration = [])
77			{
78			$resolver = new OptionsResolver();
79			$resolver->setDefaults([
80			'type' => 'string',
81			'options' => [],
82			]);
83			// set allowed fields type from tagged services
84			$resolver->setAllowedValues('type', array_keys($this->fieldsMapping));
85			$resolver->setAllowedTypes('type', 'string');
86			$resolver->setAllowedTypes('options', 'array');
87
88			// resolve options
89			$configuration = $resolver->resolve($configuration);
90
91			// for collection of fields, we resolve the configuration of each item
92			if ($configuration['type'] == 'collection') {
93			$items = [];
94
95			foreach ($configuration['options'] as $itemFieldName => $itemFieldConfiguration) {
96
97			// configuration should be an array
98			if (!$itemFieldConfiguration) {
99			$itemFieldConfiguration = [];
100			}
101			// type should exists
102			if (!array_key_exists('type', $configuration)) {
103			throw new Exception("Missing type configuration for field {$itemFieldName}");
104			}
105			// create collection item
106			$items[] = $this->create($itemFieldName, $itemFieldConfiguration);
107			}
108			// add created item to the field options
109			$configuration['options'] = [
110			'fields' => $items,
111			];
112			}
113			// instanciate field
114			$fieldClass = $this->getFieldMapping($configuration['type']);
115			$field = new $fieldClass();
116
117			if (!($field instanceof FieldInterface)) {
118			throw new Exception("Field class {$fieldClass} must implements " . FieldInterface::class);
119			}
120			$field->setName($fieldName);
121			$field->setConfiguration($this->configuration);
122
123			if ($field instanceof TranslatableFieldInterface) {
124			$field->setTranslator($this->translator);
125			}
126			if ($field instanceof TwigFieldInterface) {
127			$field->setTwig($this->twig);
128			}
129			// clear revolver from previous default configuration
130			$resolver->clear();
131
132			// configure field default options
133			$field->configureOptions($resolver);
134			// resolve options
135			$options = $resolver->resolve($configuration['options']);
136
137			// set options and value
138			$field->setOptions($options);
139
140
141			return $field;
142			}
143
144			/**
145			* Return field class according to the field type. If the type is not present in the field mapping array, an
146			* exception will be thrown.
147			*
148			* @param $type
149			* @return string
150			* @throws Exception
151			*/
152			public function getFieldMapping($type)
153			{
154			if (!array_key_exists($type, $this->fieldsMapping)) {
155			throw new Exception("Field type {$type} not found in field mapping. Check your configuration");
156			}
157
158			return $this->fieldsMapping[$type];
159			}
160			}
161

larriereguichet / AdminBundle

Push — 0.3-dev ( 291149...449c2f )

FieldFactory::create() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like