FormContractor::checkFormClass() - Code Metrics - Inspection of "Manual merge" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#738)

by Grégoire

created 2017-10-12 22:20 UTC

FormContractor::checkFormClass() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php


/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\DoctrineORMAdminBundle\Builder;

use Doctrine\ORM\Mapping\ClassMetadataInfo;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Builder\FormContractorInterface;
use Symfony\Component\Form\FormFactoryInterface;

class FormContractor implements FormContractorInterface
{
    /**
     * NEXT_MAJOR: remove this property.
     *
     * @deprecated since version 3.0.4, to be removed in 4.0
     *
     * @var FormFactoryInterface
     */
    protected $fieldFactory;

    /**
     * @var FormFactoryInterface
     */
    protected $formFactory;

    /**
     * @param FormFactoryInterface $formFactory
     */
    public function __construct(FormFactoryInterface $formFactory)
    {
        $this->formFactory = $formFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
    {
        if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
            $metadata = $admin->getModelManager()->getMetadata($admin->getClass());

            // set the default field mapping
            if (isset($metadata->fieldMappings[$fieldDescription->getName()])) {
                $fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]);
            }

            // set the default association mapping
            if (isset($metadata->associationMappings[$fieldDescription->getName()])) {
                $fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]);
            }
        }

        if (!$fieldDescription->getType()) {
            throw new \RuntimeException(sprintf(
                'Please define a type for field `%s` in `%s`',
                $fieldDescription->getName(),
                get_class($admin)
            ));
        }

        $fieldDescription->setAdmin($admin);
        $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard'));

        if ($this->hasAssociation($fieldDescription) || $fieldDescription->getOption('admin_code')) {
            $admin->attachAdminClass($fieldDescription);
        }
    }

    /**
     * @return FormFactoryInterface
     */
    public function getFormFactory()
    {
        return $this->formFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getFormBuilder($name, array $options = [])
    {
        return $this->getFormFactory()->createNamedBuilder(
            $name,
            'Symfony\Component\Form\Extension\Core\Type\FormType',
            null,
            $options
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription)
    {
        $options = [];
        $options['sonata_field_description'] = $fieldDescription;
        if ($this->checkFormClass($type, [
            'Sonata\AdminBundle\Form\Type\ModelType',
            'Sonata\AdminBundle\Form\Type\ModelTypeList',
            'Sonata\AdminBundle\Form\Type\ModelListType',
            'Sonata\AdminBundle\Form\Type\ModelHiddenType',
            'Sonata\AdminBundle\Form\Type\ModelAutocompleteType',
        ])) {
            if ($fieldDescription->getOption('edit') === 'list') {
                throw new \LogicException(
                    'The `sonata_type_model` type does not accept an `edit` option anymore,'
                    .' please review the UPGRADE-2.1.md file from the SonataAdminBundle'
                );
            }

            $options['class'] = $fieldDescription->getTargetEntity();
            $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();

            if ($this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\ModelAutocompleteType'])) {
                if (!$fieldDescription->getAssociationAdmin()) {
                    throw new \RuntimeException(sprintf(
                        'The current field `%s` is not linked to an admin.'
                        .' Please create one for the target entity: `%s`',
                        $fieldDescription->getName(),
                        $fieldDescription->getTargetEntity()
                    ));
                }
            }
<<<<<<< HEAD

        } elseif ($this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\AdminType'])) {
=======
            // NEXT_MAJOR: Check only against FQCNs when dropping support for Symfony <2.8
        } elseif ($this->checkFormType($type, ['sonata_type_admin']) || $this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\AdminType'])) {
>>>>>>> origin/3.x
            if (!$fieldDescription->getAssociationAdmin()) {
                throw new \RuntimeException(sprintf(
                    'The current field `%s` is not linked to an admin.'
                    .' Please create one for the target entity : `%s`',
                    $fieldDescription->getName(),
                    $fieldDescription->getTargetEntity()
                ));
            }

            if (!in_array($fieldDescription->getMappingType(), [ClassMetadataInfo::ONE_TO_ONE, ClassMetadataInfo::MANY_TO_ONE])) {
                throw new \RuntimeException(sprintf(
                    'You are trying to add `sonata_type_admin` field `%s` which is not One-To-One or  Many-To-One.'
                    .' Maybe you want `sonata_type_collection` instead?',
                    $fieldDescription->getName()
                ));
            }

            // set sensitive default value to have a component working fine out of the box
            $options['btn_add'] = false;
            $options['delete'] = false;

            $options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass();
            $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin'));
<<<<<<< HEAD
        } elseif ($this->checkFormClass($type, ['Sonata\CoreBundle\Form\Type\CollectionType'])) {
=======
            // NEXT_MAJOR: Check only against FQCNs when dropping support for Symfony <2.8
        } elseif ($this->checkFormType($type, ['sonata_type_collection']) || $this->checkFormClass($type, ['Sonata\CoreBundle\Form\Type\CollectionType'])) {
>>>>>>> origin/3.x
            if (!$fieldDescription->getAssociationAdmin()) {
                throw new \RuntimeException(sprintf(
                    'The current field `%s` is not linked to an admin.'
                    .' Please create one for the target entity : `%s`',
                    $fieldDescription->getName(),
                    $fieldDescription->getTargetEntity()
                ));
            }

            $options['type'] = 'sonata_type_admin';
            $options['modifiable'] = true;
            $options['type_options'] = [
                'sonata_field_description' => $fieldDescription,
                'data_class' => $fieldDescription->getAssociationAdmin()->getClass(),
            ];
        }

        return $options;
    }

    /**
     * @param FieldDescriptionInterface $fieldDescription
     *
     * @return bool
     */
    private function hasAssociation(FieldDescriptionInterface $fieldDescription)
    {
        return in_array($fieldDescription->getMappingType(), [
            ClassMetadataInfo::ONE_TO_MANY,
            ClassMetadataInfo::MANY_TO_MANY,
            ClassMetadataInfo::MANY_TO_ONE,
            ClassMetadataInfo::ONE_TO_ONE,
        ]);
<<<<<<< HEAD
=======
    }

    /**
     * NEXT_MAJOR: See next major comments above, this method should be removed when dropping support for Symfony <2.8.
     *
     * @param string $type
     * @param array  $types
     *
     * @return bool
     */
    private function checkFormType($type, $types)
    {
        return in_array($type, $types, true);
>>>>>>> origin/3.x
    }

    /**
     * @param string $type
     * @param array  $classes
     *
     * @return array
     */
    private function checkFormClass($type, $classes)
    {
        return array_filter($classes, function ($subclass) use ($type) {
            return is_a($type, $subclass, true);
        });
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-10-12 22:33 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 39 and the first side effect is on line 20. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/*
4			* This file is part of the Sonata Project package.
5			*
6			* (c) Thomas Rabaix <[email protected]>
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 Sonata\DoctrineORMAdminBundle\Builder;
13
14			use Doctrine\ORM\Mapping\ClassMetadataInfo;
15			use Sonata\AdminBundle\Admin\AdminInterface;
16			use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
17			use Sonata\AdminBundle\Builder\FormContractorInterface;
18			use Symfony\Component\Form\FormFactoryInterface;
19
20			class FormContractor implements FormContractorInterface
21			{
22			/**
23			* NEXT_MAJOR: remove this property.
24			*
25			* @deprecated since version 3.0.4, to be removed in 4.0
26			*
27			* @var FormFactoryInterface
28			*/
29			protected $fieldFactory;
30
31			/**
32			* @var FormFactoryInterface
33			*/
34			protected $formFactory;
35
36			/**
37			* @param FormFactoryInterface $formFactory
38			*/
39			public function __construct(FormFactoryInterface $formFactory)
40			{
41			$this->formFactory = $formFactory;
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
48			{
49			if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
50			$metadata = $admin->getModelManager()->getMetadata($admin->getClass());
51
52			// set the default field mapping
53			if (isset($metadata->fieldMappings[$fieldDescription->getName()])) {
54			$fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]);
55			}
56
57			// set the default association mapping
58			if (isset($metadata->associationMappings[$fieldDescription->getName()])) {
59			$fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]);
60			}
61			}
62
63			if (!$fieldDescription->getType()) {
64			throw new \RuntimeException(sprintf(
65			'Please define a type for field `%s` in `%s`',
66			$fieldDescription->getName(),
67			get_class($admin)
68			));
69			}
70
71			$fieldDescription->setAdmin($admin);
72			$fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard'));
73
74			if ($this->hasAssociation($fieldDescription) \|\| $fieldDescription->getOption('admin_code')) {
75			$admin->attachAdminClass($fieldDescription);
76			}
77			}
78
79			/**
80			* @return FormFactoryInterface
81			*/
82			public function getFormFactory()
83			{
84			return $this->formFactory;
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90			public function getFormBuilder($name, array $options = [])
91			{
92			return $this->getFormFactory()->createNamedBuilder(
93			$name,
94			'Symfony\Component\Form\Extension\Core\Type\FormType',
95			null,
96			$options
97			);
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription)
104			{
105			$options = [];
106			$options['sonata_field_description'] = $fieldDescription;
107			if ($this->checkFormClass($type, [
108			'Sonata\AdminBundle\Form\Type\ModelType',
109			'Sonata\AdminBundle\Form\Type\ModelTypeList',
110			'Sonata\AdminBundle\Form\Type\ModelListType',
111			'Sonata\AdminBundle\Form\Type\ModelHiddenType',
112			'Sonata\AdminBundle\Form\Type\ModelAutocompleteType',
113			])) {
114			if ($fieldDescription->getOption('edit') === 'list') {
115			throw new \LogicException(
116			'The `sonata_type_model` type does not accept an `edit` option anymore,'
117			.' please review the UPGRADE-2.1.md file from the SonataAdminBundle'
118			);
119			}
120
121			$options['class'] = $fieldDescription->getTargetEntity();
122			$options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();
123
124			if ($this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\ModelAutocompleteType'])) {
125			if (!$fieldDescription->getAssociationAdmin()) {
126			throw new \RuntimeException(sprintf(
127			'The current field `%s` is not linked to an admin.'
128			.' Please create one for the target entity: `%s`',
129			$fieldDescription->getName(),
130			$fieldDescription->getTargetEntity()
131			));
132			}
133			}
134			<<<<<<< HEAD
			0 ignored issues – show Bug introduced 2017-10-12 22:33 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_SL Loading history...
135			} elseif ($this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\AdminType'])) {
136			=======
137			// NEXT_MAJOR: Check only against FQCNs when dropping support for Symfony <2.8
138			} elseif ($this->checkFormType($type, ['sonata_type_admin']) \|\| $this->checkFormClass($type, ['Sonata\AdminBundle\Form\Type\AdminType'])) {
139			>>>>>>> origin/3.x
140			if (!$fieldDescription->getAssociationAdmin()) {
141			throw new \RuntimeException(sprintf(
142			'The current field `%s` is not linked to an admin.'
143			.' Please create one for the target entity : `%s`',
144			$fieldDescription->getName(),
145			$fieldDescription->getTargetEntity()
146			));
147			}
148
149			if (!in_array($fieldDescription->getMappingType(), [ClassMetadataInfo::ONE_TO_ONE, ClassMetadataInfo::MANY_TO_ONE])) {
150			throw new \RuntimeException(sprintf(
151			'You are trying to add `sonata_type_admin` field `%s` which is not One-To-One or Many-To-One.'
152			.' Maybe you want `sonata_type_collection` instead?',
153			$fieldDescription->getName()
154			));
155			}
156
157			// set sensitive default value to have a component working fine out of the box
158			$options['btn_add'] = false;
159			$options['delete'] = false;
160
161			$options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass();
162			$fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin'));
163			<<<<<<< HEAD
164			} elseif ($this->checkFormClass($type, ['Sonata\CoreBundle\Form\Type\CollectionType'])) {
165			=======
166			// NEXT_MAJOR: Check only against FQCNs when dropping support for Symfony <2.8
167			} elseif ($this->checkFormType($type, ['sonata_type_collection']) \|\| $this->checkFormClass($type, ['Sonata\CoreBundle\Form\Type\CollectionType'])) {
168			>>>>>>> origin/3.x
169			if (!$fieldDescription->getAssociationAdmin()) {
170			throw new \RuntimeException(sprintf(
171			'The current field `%s` is not linked to an admin.'
172			.' Please create one for the target entity : `%s`',
173			$fieldDescription->getName(),
174			$fieldDescription->getTargetEntity()
175			));
176			}
177
178			$options['type'] = 'sonata_type_admin';
179			$options['modifiable'] = true;
180			$options['type_options'] = [
181			'sonata_field_description' => $fieldDescription,
182			'data_class' => $fieldDescription->getAssociationAdmin()->getClass(),
183			];
184			}
185
186			return $options;
187			}
188
189			/**
190			* @param FieldDescriptionInterface $fieldDescription
191			*
192			* @return bool
193			*/
194			private function hasAssociation(FieldDescriptionInterface $fieldDescription)
195			{
196			return in_array($fieldDescription->getMappingType(), [
197			ClassMetadataInfo::ONE_TO_MANY,
198			ClassMetadataInfo::MANY_TO_MANY,
199			ClassMetadataInfo::MANY_TO_ONE,
200			ClassMetadataInfo::ONE_TO_ONE,
201			]);
202			<<<<<<< HEAD
203			=======
204			}
205
206			/**
207			* NEXT_MAJOR: See next major comments above, this method should be removed when dropping support for Symfony <2.8.
208			*
209			* @param string $type
210			* @param array $types
211			*
212			* @return bool
213			*/
214			private function checkFormType($type, $types)
215			{
216			return in_array($type, $types, true);
217			>>>>>>> origin/3.x
218			}
219
220			/**
221			* @param string $type
222			* @param array $classes
223			*
224			* @return array
225			*/
226			private function checkFormClass($type, $classes)
227			{
228			return array_filter($classes, function ($subclass) use ($type) {
229			return is_a($type, $subclass, true);
230			});
231			}
232			}
233

sonata-project / SonataDoctrineORMAdminBundle

Pull Request — master (#738)

FormContractor::checkFormClass() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like