DataTransformerResolver::resolve() - 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-27 08:43 UTC

DataTransformerResolver::resolve() B

↳ Parent: DataTransformerResolver

Complexity

Conditions	7
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	43
rs	8.2986
c	0
b	0
f	0
cc	7
nc	6
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\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,
                $this->getOutputTimezone($fieldDescription),
                'Y-m-d'
            );

            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 getOutputTimezone(FieldDescriptionInterface $fieldDescription): ?string
    {
        $outputTimezone = $fieldDescription->getOption('timezone');

        if (!$outputTimezone) {
            return null;
        }

        if ($outputTimezone instanceof \DateTimeZone) {
            return $outputTimezone->getName();
        }

        return $outputTimezone;
    }

    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\ModelToIdTransformer;
18			use Sonata\AdminBundle\Model\ModelManagerInterface;
19			use Sonata\AdminBundle\Templating\TemplateRegistry;
20			use Symfony\Component\Form\DataTransformerInterface;
21			use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToStringTransformer;
22
23			/**
24			* @author Peter Gribanov <[email protected]>
25			*/
26			final class DataTransformerResolver implements DataTransformerResolverInterface
27			{
28			/**
29			* @var array<string, DataTransformerInterface>
30			*/
31			private $globalCustomTransformers = [];
32
33			/**
34			* @param array<string, DataTransformerInterface> $customGlobalTransformers
35			*/
36			public function __construct(array $customGlobalTransformers = [])
37			{
38			foreach ($customGlobalTransformers as $fieldType => $dataTransformer) {
39			$this->addCustomGlobalTransformer($fieldType, $dataTransformer);
40			}
41			}
42
43			public function addCustomGlobalTransformer(string $fieldType, DataTransformerInterface $dataTransformer): void
44			{
45			$this->globalCustomTransformers[$fieldType] = $dataTransformer;
46			}
47
48			public function resolve(
49			FieldDescriptionInterface $fieldDescription,
50			ModelManagerInterface $modelManager
51			): ?DataTransformerInterface {
52			$dataTransformer = $fieldDescription->getOption('data_transformer');
53
54			// allow override predefined transformers for 'date', 'boolean' and 'choice' field types
55			if ($dataTransformer instanceof DataTransformerInterface) {
56			return $dataTransformer;
57			}
58
59			$fieldType = (string) $fieldDescription->getType();
60
61			// allow override predefined transformers on a global level
62			if (\array_key_exists($fieldType, $this->globalCustomTransformers)) {
63			return $this->globalCustomTransformers[$fieldType];
64			}
65
66			// Handle date type has setter expect a DateTime object
67			if (TemplateRegistry::TYPE_DATE === $fieldType) {
68			$this->globalCustomTransformers[$fieldType] = new DateTimeToStringTransformer(
69			null,
70			$this->getOutputTimezone($fieldDescription),
71			'Y-m-d'
72			);
73
74			return $this->globalCustomTransformers[$fieldType];
75			}
76
77			// Handle entity choice association type, transforming the value into entity
78			if (TemplateRegistry::TYPE_CHOICE === $fieldType) {
79			$className = $fieldDescription->getOption('class');
80
81			if (null !== $className &&
82			// NEXT_MAJOR: Replace this call with "$className === $fieldDescription->getTargetModel()".
83			$this->hasFieldDescriptionAssociationWithClass($fieldDescription, $className)
84			) {
85			return new ModelToIdTransformer($modelManager, $className);
86			}
87			}
88
89			return null;
90			}
91
92			private function getOutputTimezone(FieldDescriptionInterface $fieldDescription): ?string
93			{
94			$outputTimezone = $fieldDescription->getOption('timezone');
95
96			if (!$outputTimezone) {
97			return null;
98			}
99
100			if ($outputTimezone instanceof \DateTimeZone) {
101			return $outputTimezone->getName();
102			}
103
104			return $outputTimezone;
105			}
106
107			private function hasFieldDescriptionAssociationWithClass(
108			FieldDescriptionInterface $fieldDescription,
109			string $class
110			): bool {
111			return (
112			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...
113			) \|\| $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...
114			}
115			}
116

sonata-project / SonataAdminBundle

Pull Request — 3.x (#5937)

DataTransformerResolver::resolve() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like