ListBuilder::fixFieldDescription() - Code Metrics - Inspection of "DevKit updates (#369)" - sonata-project/SonataDoctrineMongoDBAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.x ( 7b8913...94af5b )

unknown

created 2020-06-30 02:50 UTC

ListBuilder::fixFieldDescription() F

↳ Parent: ListBuilder

Complexity

Conditions	15
Paths	490

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	63
rs	2.4583
c	0
b	0
f	0
cc	15
nc	490
nop	2

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * 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\DoctrineMongoDBAdminBundle\Builder;

use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionCollection;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Builder\ListBuilderInterface;
use Sonata\AdminBundle\Guesser\TypeGuesserInterface;

class ListBuilder implements ListBuilderInterface
{
    protected $guesser;

    protected $templates = [];

    public function __construct(TypeGuesserInterface $guesser, array $templates = [])
    {
        $this->guesser = $guesser;
        $this->templates = $templates;
    }

    /**
     * {@inheritdoc}
     */
    public function getBaseList(array $options = [])
    {
        return new FieldDescriptionCollection();
    }

    /**
     * {@inheritdoc}
     */
    public function buildField($type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin)
    {
        if (null === $type) {
            $guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName(), $admin->getModelManager());
            $fieldDescription->setType($guessType->getType());
        } else {
            $fieldDescription->setType($type);
        }

        $this->fixFieldDescription($admin, $fieldDescription);
    }

    /**
     * {@inheritdoc}
     */
    public function addField(FieldDescriptionCollection $list, $type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin)
    {
        $this->buildField($type, $fieldDescription, $admin);
        $admin->addListFieldDescription($fieldDescription->getName(), $fieldDescription);

        $list->add($fieldDescription);
    }

    /**
     * {@inheritdoc}
     */
    public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
    {
        if ('_action' === $fieldDescription->getName() || 'actions' === $fieldDescription->getType()) {
            $this->buildActionFieldDescription($fieldDescription);
        }

        $fieldDescription->setAdmin($admin);

        if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
            list($metadata, $lastPropertyName, $parentAssociationMappings) = $admin->getModelManager()->getParentMetadataForProperty($admin->getClass(), $fieldDescription->getName());
            $fieldDescription->setParentAssociationMappings($parentAssociationMappings);

            // set the default field mapping
            if (isset($metadata->fieldMappings[$lastPropertyName])) {
                $fieldDescription->setFieldMapping($metadata->fieldMappings[$lastPropertyName]);
                if (false !== $fieldDescription->getOption('sortable')) {
                    $fieldDescription->setOption('sortable', $fieldDescription->getOption('sortable', true));
                    $fieldDescription->setOption('sort_parent_association_mappings', $fieldDescription->getOption('sort_parent_association_mappings', $fieldDescription->getParentAssociationMappings()));
                    $fieldDescription->setOption('sort_field_mapping', $fieldDescription->getOption('sort_field_mapping', $fieldDescription->getFieldMapping()));
                }
            }

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

            $fieldDescription->setOption('_sort_order', $fieldDescription->getOption('_sort_order', 'ASC'));
        }

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

        $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName()));
        $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName()));

        if (!$fieldDescription->getTemplate()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if ('id' === $fieldDescription->getType()) {
                $fieldDescription->setType('string');
            }

            if ('int' === $fieldDescription->getType()) {
                $fieldDescription->setType('integer');
            }

            $template = $this->getTemplate($fieldDescription->getType());

            if (null === $template) {
                if (ClassMetadata::ONE === $fieldDescription->getMappingType()) {
                    $template = '@SonataAdmin/CRUD/Association/list_many_to_one.html.twig';
                } elseif (ClassMetadata::MANY === $fieldDescription->getMappingType()) {
                    $template = '@SonataAdmin/CRUD/Association/list_many_to_many.html.twig';
                }
            }

            $fieldDescription->setTemplate($template);
        }

        if (\in_array($fieldDescription->getMappingType(), [ClassMetadata::ONE, ClassMetadata::MANY], true)) {
            $admin->attachAdminClass($fieldDescription);
        }
    }

    /**
     * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
     */
    public function buildActionFieldDescription(FieldDescriptionInterface $fieldDescription)
    {
        if (null === $fieldDescription->getTemplate()) {
            $fieldDescription->setTemplate('@SonataAdmin/CRUD/list__action.html.twig');
        }

        if (null === $fieldDescription->getType()) {
            $fieldDescription->setType('actions');
        }

        if (null === $fieldDescription->getOption('name')) {
            $fieldDescription->setOption('name', 'Action');
        }

        if (null === $fieldDescription->getOption('code')) {
            $fieldDescription->setOption('code', 'Action');
        }

        if (null !== $fieldDescription->getOption('actions')) {
            $actions = $fieldDescription->getOption('actions');
            foreach ($actions as $k => $action) {
                if (!isset($action['template'])) {
                    $actions[$k]['template'] = sprintf('@SonataAdmin/CRUD/list__action_%s.html.twig', $k);
                }
            }

            $fieldDescription->setOption('actions', $actions);
        }

        return $fieldDescription;
    }

    /**
     * @param string $type
     *
     * @return string
     */
    private function getTemplate($type)
    {
        if (!isset($this->templates[$type])) {
            return;
        }

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


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\DoctrineMongoDBAdminBundle\Builder;
15
16			use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
17			use Sonata\AdminBundle\Admin\AdminInterface;
18			use Sonata\AdminBundle\Admin\FieldDescriptionCollection;
19			use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
20			use Sonata\AdminBundle\Builder\ListBuilderInterface;
21			use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
22
23			class ListBuilder implements ListBuilderInterface
24			{
25			protected $guesser;
26
27			protected $templates = [];
28
29			public function __construct(TypeGuesserInterface $guesser, array $templates = [])
30			{
31			$this->guesser = $guesser;
32			$this->templates = $templates;
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function getBaseList(array $options = [])
39			{
40			return new FieldDescriptionCollection();
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46			public function buildField($type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin)
47			{
48			if (null === $type) {
49			$guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName(), $admin->getModelManager());
50			$fieldDescription->setType($guessType->getType());
51			} else {
52			$fieldDescription->setType($type);
53			}
54
55			$this->fixFieldDescription($admin, $fieldDescription);
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function addField(FieldDescriptionCollection $list, $type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin)
62			{
63			$this->buildField($type, $fieldDescription, $admin);
64			$admin->addListFieldDescription($fieldDescription->getName(), $fieldDescription);
65
66			$list->add($fieldDescription);
67			}
68
69			/**
70			* {@inheritdoc}
71			*/
72			public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
73			{
74			if ('_action' === $fieldDescription->getName() \|\| 'actions' === $fieldDescription->getType()) {
75			$this->buildActionFieldDescription($fieldDescription);
76			}
77
78			$fieldDescription->setAdmin($admin);
79
80			if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
81			list($metadata, $lastPropertyName, $parentAssociationMappings) = $admin->getModelManager()->getParentMetadataForProperty($admin->getClass(), $fieldDescription->getName());
82			$fieldDescription->setParentAssociationMappings($parentAssociationMappings);
83
84			// set the default field mapping
85			if (isset($metadata->fieldMappings[$lastPropertyName])) {
86			$fieldDescription->setFieldMapping($metadata->fieldMappings[$lastPropertyName]);
87			if (false !== $fieldDescription->getOption('sortable')) {
88			$fieldDescription->setOption('sortable', $fieldDescription->getOption('sortable', true));
89			$fieldDescription->setOption('sort_parent_association_mappings', $fieldDescription->getOption('sort_parent_association_mappings', $fieldDescription->getParentAssociationMappings()));
90			$fieldDescription->setOption('sort_field_mapping', $fieldDescription->getOption('sort_field_mapping', $fieldDescription->getFieldMapping()));
91			}
92			}
93
94			// set the default association mapping
95			if (isset($metadata->associationMappings[$lastPropertyName])) {
96			$fieldDescription->setAssociationMapping($metadata->associationMappings[$lastPropertyName]);
97			}
98
99			$fieldDescription->setOption('_sort_order', $fieldDescription->getOption('_sort_order', 'ASC'));
100			}
101
102			if (!$fieldDescription->getType()) {
103			throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), \get_class($admin)));
104			}
105
106			$fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName()));
107			$fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName()));
108
109			if (!$fieldDescription->getTemplate()) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-20 11:36 UTC by Report Bug Copy Issue Report The expression `$fieldDescription->getTemplate()` 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...
110			if ('id' === $fieldDescription->getType()) {
111			$fieldDescription->setType('string');
112			}
113
114			if ('int' === $fieldDescription->getType()) {
115			$fieldDescription->setType('integer');
116			}
117
118			$template = $this->getTemplate($fieldDescription->getType());
119
120			if (null === $template) {
121			if (ClassMetadata::ONE === $fieldDescription->getMappingType()) {
122			$template = '@SonataAdmin/CRUD/Association/list_many_to_one.html.twig';
123			} elseif (ClassMetadata::MANY === $fieldDescription->getMappingType()) {
124			$template = '@SonataAdmin/CRUD/Association/list_many_to_many.html.twig';
125			}
126			}
127
128			$fieldDescription->setTemplate($template);
129			}
130
131			if (\in_array($fieldDescription->getMappingType(), [ClassMetadata::ONE, ClassMetadata::MANY], true)) {
132			$admin->attachAdminClass($fieldDescription);
133			}
134			}
135
136			/**
137			* @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
138			*/
139			public function buildActionFieldDescription(FieldDescriptionInterface $fieldDescription)
140			{
141			if (null === $fieldDescription->getTemplate()) {
142			$fieldDescription->setTemplate('@SonataAdmin/CRUD/list__action.html.twig');
143			}
144
145			if (null === $fieldDescription->getType()) {
146			$fieldDescription->setType('actions');
147			}
148
149			if (null === $fieldDescription->getOption('name')) {
150			$fieldDescription->setOption('name', 'Action');
151			}
152
153			if (null === $fieldDescription->getOption('code')) {
154			$fieldDescription->setOption('code', 'Action');
155			}
156
157			if (null !== $fieldDescription->getOption('actions')) {
158			$actions = $fieldDescription->getOption('actions');
159			foreach ($actions as $k => $action) {
160			if (!isset($action['template'])) {
161			$actions[$k]['template'] = sprintf('@SonataAdmin/CRUD/list__action_%s.html.twig', $k);
162			}
163			}
164
165			$fieldDescription->setOption('actions', $actions);
166			}
167
168			return $fieldDescription;
169			}
170
171			/**
172			* @param string $type
173			*
174			* @return string
175			*/
176			private function getTemplate($type)
177			{
178			if (!isset($this->templates[$type])) {
179			return;
180			}
181
182			return $this->templates[$type];
183			}
184			}
185

sonata-project / SonataDoctrineMongoDBAdminBundle

Push — 3.x ( 7b8913...94af5b )

ListBuilder::fixFieldDescription() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like