ShowBuilder::fixFieldDescription() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/3.x'" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 75c36b...4386d7 )

by Grégoire

created 2020-07-02 16:27 UTC

ShowBuilder::fixFieldDescription() B

↳ Parent: ShowBuilder

Complexity

Conditions	10
Paths	55

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	40
rs	7.6666
c	0
b	0
f	0
cc	10
nc	55
nop	2

How to fix 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\DoctrineORMAdminBundle\Builder;

use Doctrine\ORM\Mapping\ClassMetadata;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionCollection;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Builder\ShowBuilderInterface;
use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;

class ShowBuilder implements ShowBuilderInterface
{
    /**
     * @var TypeGuesserInterface
     */
    protected $guesser;

    /**
     * @var string[]
     */
    protected $templates;

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

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

    public function addField(FieldDescriptionCollection $list, $type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin): void
    {
        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);
        $admin->addShowFieldDescription($fieldDescription->getName(), $fieldDescription);

        $list->add($fieldDescription);
    }

    public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription): void
    {
        $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]);
            }

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

        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
            $fieldDescription->setTemplate($this->getTemplate($fieldDescription->getType()));
        }

        switch ($fieldDescription->getMappingType()) {
            case ClassMetadata::MANY_TO_ONE:
            case ClassMetadata::ONE_TO_ONE:
            case ClassMetadata::ONE_TO_MANY:
            case ClassMetadata::MANY_TO_MANY:
                $admin->attachAdminClass($fieldDescription);

                break;
        }
    }

    /**
     * @param string $type
     *
     * @return string|null
     */
    private function getTemplate($type)
    {
        if (!isset($this->templates[$type])) {
            // NEXT_MAJOR: Remove the check for deprecated type and always return null.
            if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
                return $this->getTemplate(TypeGuesser::DEPRECATED_TYPES[$type]);
            }

            return null;
        }

        // NEXT_MAJOR: Remove the deprecation.
        if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
            @trigger_error(sprintf(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                'Overriding %s show template is deprecated since sonata-project/doctrine-orm-admin-bundle 3.19.'
                .' You should override %s show template instead.',
                $type,
                TypeGuesser::DEPRECATED_TYPES[$type]
            ), E_USER_DEPRECATED);
        }

        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\DoctrineORMAdminBundle\Builder;
15
16			use Doctrine\ORM\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\ShowBuilderInterface;
21			use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
22			use Sonata\DoctrineORMAdminBundle\Guesser\TypeGuesser;
23
24			class ShowBuilder implements ShowBuilderInterface
25			{
26			/**
27			* @var TypeGuesserInterface
28			*/
29			protected $guesser;
30
31			/**
32			* @var string[]
33			*/
34			protected $templates;
35
36			/**
37			* @param string[] $templates
38			*/
39			public function __construct(TypeGuesserInterface $guesser, array $templates)
40			{
41			$this->guesser = $guesser;
42			$this->templates = $templates;
43			}
44
45			public function getBaseList(array $options = [])
46			{
47			return new FieldDescriptionCollection();
48			}
49
50			public function addField(FieldDescriptionCollection $list, $type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin): void
51			{
52			if (null === $type) {
53			$guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName(), $admin->getModelManager());
54			$fieldDescription->setType($guessType->getType());
55			} else {
56			$fieldDescription->setType($type);
57			}
58
59			$this->fixFieldDescription($admin, $fieldDescription);
60			$admin->addShowFieldDescription($fieldDescription->getName(), $fieldDescription);
61
62			$list->add($fieldDescription);
63			}
64
65			public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription): void
66			{
67			$fieldDescription->setAdmin($admin);
68
69			if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
70			list($metadata, $lastPropertyName, $parentAssociationMappings) = $admin->getModelManager()->getParentMetadataForProperty($admin->getClass(), $fieldDescription->getName());
71			$fieldDescription->setParentAssociationMappings($parentAssociationMappings);
72
73			// set the default field mapping
74			if (isset($metadata->fieldMappings[$lastPropertyName])) {
75			$fieldDescription->setFieldMapping($metadata->fieldMappings[$lastPropertyName]);
76			}
77
78			// set the default association mapping
79			if (isset($metadata->associationMappings[$lastPropertyName])) {
80			$fieldDescription->setAssociationMapping($metadata->associationMappings[$lastPropertyName]);
81			}
82			}
83
84			if (!$fieldDescription->getType()) {
85			throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), \get_class($admin)));
86			}
87
88			$fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName()));
89			$fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName()));
90
91			if (!$fieldDescription->getTemplate()) {
			0 ignored issues – show Bug Best Practice introduced 2020-05-17 22:37 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...
92			$fieldDescription->setTemplate($this->getTemplate($fieldDescription->getType()));
93			}
94
95			switch ($fieldDescription->getMappingType()) {
96			case ClassMetadata::MANY_TO_ONE:
97			case ClassMetadata::ONE_TO_ONE:
98			case ClassMetadata::ONE_TO_MANY:
99			case ClassMetadata::MANY_TO_MANY:
100			$admin->attachAdminClass($fieldDescription);
101
102			break;
103			}
104			}
105
106			/**
107			* @param string $type
108			*
109			* @return string\|null
110			*/
111			private function getTemplate($type)
112			{
113			if (!isset($this->templates[$type])) {
114			// NEXT_MAJOR: Remove the check for deprecated type and always return null.
115			if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
116			return $this->getTemplate(TypeGuesser::DEPRECATED_TYPES[$type]);
117			}
118
119			return null;
120			}
121
122			// NEXT_MAJOR: Remove the deprecation.
123			if (isset(TypeGuesser::DEPRECATED_TYPES[$type])) {
124			@trigger_error(sprintf(
			0 ignored issues – show Security Best Practice introduced 2020-06-06 12:01 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
125			'Overriding %s show template is deprecated since sonata-project/doctrine-orm-admin-bundle 3.19.'
126			.' You should override %s show template instead.',
127			$type,
128			TypeGuesser::DEPRECATED_TYPES[$type]
129			), E_USER_DEPRECATED);
130			}
131
132			return $this->templates[$type];
133			}
134			}
135

sonata-project / SonataDoctrineORMAdminBundle

Push — master ( 75c36b...4386d7 )

ShowBuilder::fixFieldDescription() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like