DataTransformerResolver::addCustomGlobalTransformer() - Code Metrics - Inspection of "Data Transformers in list fields editable" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#5937)

by Peter

created 2020-07-22 08:56 UTC

addCustomGlobalTransformer() A

↳ Parent: DataTransformerResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?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\AdminBundle\Form;

use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Form\DataTransformer\BooleanToStringTransformer;
use Sonata\AdminBundle\Form\DataTransformer\ModelToIdTransformer;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Sonata\AdminBundle\Templating\TemplateRegistry;
use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToStringTransformer;

/**
 * @author Peter Gribanov <[email protected]>
 */
final class DataTransformerResolver implements DataTransformerResolverInterface
{
    /**
     * @var array<string, DataTransformerInterface>
     */
    private $globalCustomTransformers = [];

    /**
     * @param array<string, DataTransformerInterface> $customGlobalTransformers
     */
    public function __construct(array $customGlobalTransformers = [])
    {
        foreach ($customGlobalTransformers as $fieldType => $dataTransformer) {
            $this->addCustomGlobalTransformer($fieldType, $dataTransformer);
        }
    }

    public function addCustomGlobalTransformer(string $fieldType, DataTransformerInterface $dataTransformer): void
    {
        $this->globalCustomTransformers[$fieldType] = $dataTransformer;
    }

    public function resolve(
        FieldDescriptionInterface $fieldDescription,
        ModelManagerInterface $modelManager
    ): ?DataTransformerInterface {
        $dataTransformer = $fieldDescription->getOption('data_transformer');

        // allow override predefined transformers for 'date', 'boolean' and 'choice' field types
        if ($dataTransformer instanceof DataTransformerInterface) {
            return $dataTransformer;
        }

        $fieldType = (string) $fieldDescription->getType();

        // allow override predefined transformers on a global level
        if (\array_key_exists($fieldType, $this->globalCustomTransformers)) {
            return $this->globalCustomTransformers[$fieldType];
        }

        // Handle date type has setter expect a DateTime object
        if (TemplateRegistry::TYPE_DATE === $fieldType) {
            $this->globalCustomTransformers[$fieldType] = new DateTimeToStringTransformer(null, null, 'Y-m-d');

            return $this->globalCustomTransformers[$fieldType];
        }

        // Handle datetime type has setter expect a DateTime object
        if (TemplateRegistry::TYPE_DATETIME === $fieldType) {
            $this->globalCustomTransformers[$fieldType] = new DateTimeToStringTransformer(null, null, 'Y-m-d H:i:s');

            return $this->globalCustomTransformers[$fieldType];
        }

        // Handle boolean type transforming the value into a boolean
        if (TemplateRegistry::TYPE_BOOLEAN === $fieldType) {
            $this->globalCustomTransformers[$fieldType] = new BooleanToStringTransformer('1');

            return $this->globalCustomTransformers[$fieldType];
        }

        // Handle entity choice association type, transforming the value into entity
        if (TemplateRegistry::TYPE_CHOICE === $fieldType) {
            $className = $fieldDescription->getOption('class');

            if (null !== $className &&
                // NEXT_MAJOR: Replace this call with "$className === $fieldDescription->getTargetModel()".
                $this->hasFieldDescriptionAssociationWithClass($fieldDescription, $className)
            ) {
                return new ModelToIdTransformer($modelManager, $className);
            }
        }

        return null;
    }

    private function hasFieldDescriptionAssociationWithClass(
        FieldDescriptionInterface $fieldDescription,
        string $class
    ): bool {
        return (
            method_exists($fieldDescription, 'getTargetModel') && $class === $fieldDescription->getTargetModel()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        ) || $class === $fieldDescription->getTargetEntity();

    }
}


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\AdminBundle\Form;
15
16			use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
17			use Sonata\AdminBundle\Form\DataTransformer\BooleanToStringTransformer;
18			use Sonata\AdminBundle\Form\DataTransformer\ModelToIdTransformer;
19			use Sonata\AdminBundle\Model\ModelManagerInterface;
20			use Sonata\AdminBundle\Templating\TemplateRegistry;
21			use Symfony\Component\Form\DataTransformerInterface;
22			use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToStringTransformer;
23
24			/**
25			* @author Peter Gribanov <[email protected]>
26			*/
27			final class DataTransformerResolver implements DataTransformerResolverInterface
28			{
29			/**
30			* @var array<string, DataTransformerInterface>
31			*/
32			private $globalCustomTransformers = [];
33
34			/**
35			* @param array<string, DataTransformerInterface> $customGlobalTransformers
36			*/
37			public function __construct(array $customGlobalTransformers = [])
38			{
39			foreach ($customGlobalTransformers as $fieldType => $dataTransformer) {
40			$this->addCustomGlobalTransformer($fieldType, $dataTransformer);
41			}
42			}
43
44			public function addCustomGlobalTransformer(string $fieldType, DataTransformerInterface $dataTransformer): void
45			{
46			$this->globalCustomTransformers[$fieldType] = $dataTransformer;
47			}
48
49			public function resolve(
50			FieldDescriptionInterface $fieldDescription,
51			ModelManagerInterface $modelManager
52			): ?DataTransformerInterface {
53			$dataTransformer = $fieldDescription->getOption('data_transformer');
54
55			// allow override predefined transformers for 'date', 'boolean' and 'choice' field types
56			if ($dataTransformer instanceof DataTransformerInterface) {
57			return $dataTransformer;
58			}
59
60			$fieldType = (string) $fieldDescription->getType();
61
62			// allow override predefined transformers on a global level
63			if (\array_key_exists($fieldType, $this->globalCustomTransformers)) {
64			return $this->globalCustomTransformers[$fieldType];
65			}
66
67			// Handle date type has setter expect a DateTime object
68			if (TemplateRegistry::TYPE_DATE === $fieldType) {
69			$this->globalCustomTransformers[$fieldType] = new DateTimeToStringTransformer(null, null, 'Y-m-d');
70
71			return $this->globalCustomTransformers[$fieldType];
72			}
73
74			// Handle datetime type has setter expect a DateTime object
75			if (TemplateRegistry::TYPE_DATETIME === $fieldType) {
76			$this->globalCustomTransformers[$fieldType] = new DateTimeToStringTransformer(null, null, 'Y-m-d H:i:s');
77
78			return $this->globalCustomTransformers[$fieldType];
79			}
80
81			// Handle boolean type transforming the value into a boolean
82			if (TemplateRegistry::TYPE_BOOLEAN === $fieldType) {
83			$this->globalCustomTransformers[$fieldType] = new BooleanToStringTransformer('1');
84
85			return $this->globalCustomTransformers[$fieldType];
86			}
87
88			// Handle entity choice association type, transforming the value into entity
89			if (TemplateRegistry::TYPE_CHOICE === $fieldType) {
90			$className = $fieldDescription->getOption('class');
91
92			if (null !== $className &&
93			// NEXT_MAJOR: Replace this call with "$className === $fieldDescription->getTargetModel()".
94			$this->hasFieldDescriptionAssociationWithClass($fieldDescription, $className)
95			) {
96			return new ModelToIdTransformer($modelManager, $className);
97			}
98			}
99
100			return null;
101			}
102
103			private function hasFieldDescriptionAssociationWithClass(
104			FieldDescriptionInterface $fieldDescription,
105			string $class
106			): bool {
107			return (
108			method_exists($fieldDescription, 'getTargetModel') && $class === $fieldDescription->getTargetModel()
			0 ignored issues – show Bug introduced 2020-07-18 06:41 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sonata\AdminBundle\Admin\FieldDescriptionInterface` as the method `getTargetModel()` does only exist in the following implementations of said interface: `Sonata\AdminBundle\Tests...\Admin\FieldDescription`, `Sonata\AdminBundle\Tests...\Admin\FieldDescription`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
109			) \|\| $class === $fieldDescription->getTargetEntity();
			0 ignored issues – show Deprecated Code introduced 2020-07-18 06:41 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Admin...face::getTargetEntity()` has been deprecated with message: since sonata-project/admin-bundle 3.69. Use `getTargetModel()` instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
110			}
111			}
112

sonata-project / SonataAdminBundle

Pull Request — 3.x (#5937)

addCustomGlobalTransformer() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like