FormContractor::getDefaultOptions() - Code Metrics - Inspection of "simply allow SF4 installation" - sonata-project/SonataDoctrinePhpcrAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#521)

by Maximilian

created 2018-06-23 23:47 UTC

FormContractor::getDefaultOptions() C

↳ Parent: FormContractor

Complexity

Conditions	15
Paths	19

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	5.9166
c	0
b	0
f	0
cc	15
nc	19
nop	2

How to fix Long Method Complexity

<?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\DoctrinePHPCRAdminBundle\Builder;

use Doctrine\ODM\PHPCR\Mapping\ClassMetadata;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Builder\FormContractorInterface;
use Symfony\Component\Form\FormFactoryInterface;

class FormContractor implements FormContractorInterface
{
    /**
     * @var FormFactoryInterface
     */
    protected $formFactory;

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

    /**
     * The method defines the correct default settings for the provided FieldDescription.
     *
     * {@inheritdoc}
     *
     * @throws \RuntimeException if the $fieldDescription does not specify a type
     */
    public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
    {
        $metadata = null;
        if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
            /** @var \Doctrine\ODM\PHPCR\Mapping\ClassMetadata $metadata */
            $metadata = $admin->getModelManager()->getMetadata($admin->getClass());

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

            // set the default association mapping
            if ($metadata->hasAssociation($fieldDescription->getName())) {
                $fieldDescription->setAssociationMapping($metadata->getAssociation($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'));

        $mappingTypes = [
            ClassMetadata::MANY_TO_ONE,
            ClassMetadata::MANY_TO_MANY,
            'children',
            'child',
            'parent',
            'referrers',
        ];

        if ($metadata && $metadata->hasAssociation($fieldDescription->getName()) && in_array($fieldDescription->getMappingType(), $mappingTypes)) {
            $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}
     *
     * @throws \LogicException if a sonata_type_model field does not have a
     *                         target model configured
     */
    public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription)
    {
        $options = [];
        $options['sonata_field_description'] = $fieldDescription;

        switch ($type) {
            case 'Sonata\DoctrinePHPCRAdminBundle\Form\Type\TreeModelType':
            case 'doctrine_phpcr_odm_tree':
                $options['class'] = $fieldDescription->getTargetEntity();
                $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();

                break;
            case 'Sonata\AdminBundle\Form\Type\ModelType':
            case 'sonata_type_model':
            case 'Sonata\AdminBundle\Form\Type\ModelTypeList':
            case 'sonata_type_model_list':
                if ('child' !== $fieldDescription->getMappingType() && !$fieldDescription->getTargetEntity()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    throw new \LogicException(sprintf(
                        'The field "%s" in class "%s" does not have a target model defined. Please specify the "targetDocument" attribute in the mapping for this class.',
                        $fieldDescription->getName(),
                        $fieldDescription->getAdmin()->getClass()
                    ));
                }

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

                break;
            case 'Sonata\AdminBundle\Form\Type\AdminType':
            case 'sonata_type_admin':
                if (!$fieldDescription->getAssociationAdmin()) {
                    throw $this->getAssociationAdminException($fieldDescription);
                }

                $options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass();
                $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin'));

                break;
            case 'Sonata\CoreBundle\Form\Type\CollectionType':
            case 'sonata_type_collection':
                if (!$fieldDescription->getAssociationAdmin()) {
                    throw $this->getAssociationAdminException($fieldDescription);
                }

                $options['type'] = 'Sonata\AdminBundle\Form\Type\AdminType';
                $options['modifiable'] = true;
                $options['type_options'] = [
                    'sonata_field_description' => $fieldDescription,
                    'data_class' => $fieldDescription->getAssociationAdmin()->getClass(),
                ];

            break;
        }

        return $options;
    }

    /**
     * @param FieldDescriptionInterface $fieldDescription
     *
     * @return \LogicException
     */
    protected function getAssociationAdminException(FieldDescriptionInterface $fieldDescription)
    {
        $msg = sprintf('The current field `%s` is not linked to an admin. Please create one', $fieldDescription->getName());
        if (in_array($fieldDescription->getMappingType(), [ClassMetadata::MANY_TO_ONE, ClassMetadata::MANY_TO_MANY, 'referrers'])) {
            if ($fieldDescription->getTargetEntity()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $msg .= " for the target document: `{$fieldDescription->getTargetEntity()}`";
            }
            $msg .= ', specify the `targetDocument` in the Reference, or the `referringDocument` in the Referrers or use the option `admin_code` to link it.';
        } else {
            $msg .= ' and use the option `admin_code` to link it.';
        }

        return new \LogicException($msg);
    }
}


1			<?php
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\DoctrinePHPCRAdminBundle\Builder;
13
14			use Doctrine\ODM\PHPCR\Mapping\ClassMetadata;
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			* @var FormFactoryInterface
24			*/
25			protected $formFactory;
26
27			/**
28			* @param FormFactoryInterface $formFactory
29			*/
30			public function __construct(FormFactoryInterface $formFactory)
31			{
32			$this->formFactory = $formFactory;
33			}
34
35			/**
36			* The method defines the correct default settings for the provided FieldDescription.
37			*
38			* {@inheritdoc}
39			*
40			* @throws \RuntimeException if the $fieldDescription does not specify a type
41			*/
42			public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
43			{
44			$metadata = null;
45			if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
46			/** @var \Doctrine\ODM\PHPCR\Mapping\ClassMetadata $metadata */
47			$metadata = $admin->getModelManager()->getMetadata($admin->getClass());
48
49			// set the default field mapping
50			if (isset($metadata->mappings[$fieldDescription->getName()])) {
51			$fieldDescription->setFieldMapping($metadata->mappings[$fieldDescription->getName()]);
52			}
53
54			// set the default association mapping
55			if ($metadata->hasAssociation($fieldDescription->getName())) {
56			$fieldDescription->setAssociationMapping($metadata->getAssociation($fieldDescription->getName()));
57			}
58			}
59
60			if (!$fieldDescription->getType()) {
61			throw new \RuntimeException(sprintf(
62			'Please define a type for field `%s` in `%s`',
63			$fieldDescription->getName(),
64			get_class($admin)
65			));
66			}
67
68			$fieldDescription->setAdmin($admin);
69			$fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard'));
70
71			$mappingTypes = [
72			ClassMetadata::MANY_TO_ONE,
73			ClassMetadata::MANY_TO_MANY,
74			'children',
75			'child',
76			'parent',
77			'referrers',
78			];
79
80			if ($metadata && $metadata->hasAssociation($fieldDescription->getName()) && in_array($fieldDescription->getMappingType(), $mappingTypes)) {
81			$admin->attachAdminClass($fieldDescription);
82			}
83			}
84
85			/**
86			* @return FormFactoryInterface
87			*/
88			public function getFormFactory()
89			{
90			return $this->formFactory;
91			}
92
93			/**
94			* {@inheritdoc}
95			*/
96			public function getFormBuilder($name, array $options = [])
97			{
98			return $this->getFormFactory()->createNamedBuilder(
99			$name,
100			'Symfony\Component\Form\Extension\Core\Type\FormType',
101			null,
102			$options);
103			}
104
105			/**
106			* {@inheritdoc}
107			*
108			* @throws \LogicException if a sonata_type_model field does not have a
109			* target model configured
110			*/
111			public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription)
112			{
113			$options = [];
114			$options['sonata_field_description'] = $fieldDescription;
115
116			switch ($type) {
117			case 'Sonata\DoctrinePHPCRAdminBundle\Form\Type\TreeModelType':
118			case 'doctrine_phpcr_odm_tree':
119			$options['class'] = $fieldDescription->getTargetEntity();
120			$options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();
121
122			break;
123			case 'Sonata\AdminBundle\Form\Type\ModelType':
124			case 'sonata_type_model':
125			case 'Sonata\AdminBundle\Form\Type\ModelTypeList':
126			case 'sonata_type_model_list':
127			if ('child' !== $fieldDescription->getMappingType() && !$fieldDescription->getTargetEntity()) {
			0 ignored issues – show Bug Best Practice introduced 2017-08-08 08:41 UTC by Report Bug Copy Issue Report The expression `$fieldDescription->getTargetEntity()` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
128			throw new \LogicException(sprintf(
129			'The field "%s" in class "%s" does not have a target model defined. Please specify the "targetDocument" attribute in the mapping for this class.',
130			$fieldDescription->getName(),
131			$fieldDescription->getAdmin()->getClass()
132			));
133			}
134
135			$options['class'] = $fieldDescription->getTargetEntity();
136			$options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();
137
138			break;
139			case 'Sonata\AdminBundle\Form\Type\AdminType':
140			case 'sonata_type_admin':
141			if (!$fieldDescription->getAssociationAdmin()) {
142			throw $this->getAssociationAdminException($fieldDescription);
143			}
144
145			$options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass();
146			$fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin'));
147
148			break;
149			case 'Sonata\CoreBundle\Form\Type\CollectionType':
150			case 'sonata_type_collection':
151			if (!$fieldDescription->getAssociationAdmin()) {
152			throw $this->getAssociationAdminException($fieldDescription);
153			}
154
155			$options['type'] = 'Sonata\AdminBundle\Form\Type\AdminType';
156			$options['modifiable'] = true;
157			$options['type_options'] = [
158			'sonata_field_description' => $fieldDescription,
159			'data_class' => $fieldDescription->getAssociationAdmin()->getClass(),
160			];
161
162			break;
163			}
164
165			return $options;
166			}
167
168			/**
169			* @param FieldDescriptionInterface $fieldDescription
170			*
171			* @return \LogicException
172			*/
173			protected function getAssociationAdminException(FieldDescriptionInterface $fieldDescription)
174			{
175			$msg = sprintf('The current field `%s` is not linked to an admin. Please create one', $fieldDescription->getName());
176			if (in_array($fieldDescription->getMappingType(), [ClassMetadata::MANY_TO_ONE, ClassMetadata::MANY_TO_MANY, 'referrers'])) {
177			if ($fieldDescription->getTargetEntity()) {
			0 ignored issues – show Bug Best Practice introduced 2015-12-06 00:13 UTC by Report Bug Copy Issue Report The expression `$fieldDescription->getTargetEntity()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
178			$msg .= " for the target document: `{$fieldDescription->getTargetEntity()}`";
179			}
180			$msg .= ', specify the `targetDocument` in the Reference, or the `referringDocument` in the Referrers or use the option `admin_code` to link it.';
181			} else {
182			$msg .= ' and use the option `admin_code` to link it.';
183			}
184
185			return new \LogicException($msg);
186			}
187			}
188

sonata-project / SonataDoctrinePhpcrAdminBundle

Pull Request — 2.x (#521)

FormContractor::getDefaultOptions() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like