AdminExtractor::setBreadcrumbsBuilder() - Code Metrics - Inspection of "Symfony 5.0 compatibility" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6093)

by Mathieu

created 2020-07-31 17:04 UTC

AdminExtractor::setBreadcrumbsBuilder() A

↳ Parent: AdminExtractor

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	1

<?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\Translator\Extractor\JMSTranslatorBundle;

use JMS\TranslationBundle\Model\FileSource;
use JMS\TranslationBundle\Model\Message;
use JMS\TranslationBundle\Model\MessageCatalogue;
use JMS\TranslationBundle\Translation\ExtractorInterface;
use Psr\Log\LoggerInterface;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\BreadcrumbsBuilderInterface;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface;
use Sonata\AdminBundle\Translator\LabelTranslatorStrategyInterface;
use Symfony\Contracts\Translation\TranslatorInterface;

/**
 * NEXT_MAJOR: Remove this class and the jms/translation-bundle dev dependency.
 *
 * @deprecated since sonata-project/admin-bundle 3.72. Use `translation:update` Symfony command instead.
 */
final class AdminExtractor implements ExtractorInterface, TranslatorInterface, SecurityHandlerInterface, LabelTranslatorStrategyInterface
{
    /**
     * @var LoggerInterface|null
     */
    private $logger;

    /**
     * @var Pool
     */
    private $adminPool;

    /**
     * @var MessageCatalogue|bool
     */
    private $catalogue;

    /**
     * @var TranslatorInterface|null
     */
    private $translator;

    /**
     * @var LabelTranslatorStrategyInterface|bool
     */
    private $labelStrategy;

    /**
     * @var string|bool
     */
    private $domain;

    /**
     * @var BreadcrumbsBuilderInterface
     */
    private $breadcrumbsBuilder;

    public function __construct(
        Pool $adminPool,
        ?TranslatorInterface $translator,
        ?LoggerInterface $logger = null
    ) {
        $this->logger = $logger;
        $this->adminPool = $adminPool;
        $this->translator = $translator;

        // state variable
        $this->catalogue = false;
        $this->labelStrategy = false;
        $this->domain = false;
    }

    public function setLogger(LoggerInterface $logger): void
    {
        $this->logger = $logger;
    }

    /**
     * NEXT_MAJOR : use a constructor argument instead.
     */
    public function setBreadcrumbsBuilder(BreadcrumbsBuilderInterface $breadcrumbsBuilder): void
    {
        $this->breadcrumbsBuilder = $breadcrumbsBuilder;
    }

    /**
     * Extract messages to MessageCatalogue.
     *
     * @throws \Exception|\RuntimeException
     *
     * @return MessageCatalogue
     */
    public function extract()
    {
        if ($this->catalogue) {
            throw new \RuntimeException('Invalid state');
        }

        $this->catalogue = new MessageCatalogue();

        foreach ($this->adminPool->getAdminGroups() as $name => $group) {
            $this->trans($name, [], $group['label_catalogue']);
        }

        foreach ($this->adminPool->getAdminServiceIds() as $id) {
            $admin = $this->getAdmin($id);

            $label = $admin->getLabel();
            if (!empty($label)) {
                $this->trans($label, [], $admin->getTranslationDomain());
            }

            $this->labelStrategy = $admin->getLabelTranslatorStrategy();
            $this->domain = $admin->getTranslationDomain();

            $admin->setTranslator($this);
            $admin->setSecurityHandler($this);
            $admin->setLabelTranslatorStrategy($this);

            // call the different public method
            $methods = [
                'getShow',
                'getDatagrid',
                'getList',
                'getForm',
            ];

            $actions = [
                'list',
                'edit',
                'create',
                'update',
                'batch',
                'delete',
            ];

            if ($this->logger) {
                $this->logger->info(sprintf(
                    'Retrieving message from admin:%s - class: %s',
                    $admin->getCode(),
                    \get_class($admin)
                ));
            }

            foreach ($methods as $method) {
                try {
                    $admin->$method();
                } catch (\Exception $e) {
                    if ($this->logger) {
                        $this->logger->error(sprintf(
                            'ERROR : admin:%s - Raise an exception : %s',
                            $admin->getCode(),
                            $e->getMessage()
                        ));
                    }

                    throw $e;
                }
            }

            foreach ($actions as $action) {
                try {
                    $this->breadcrumbsBuilder->getBreadcrumbs($admin, $action);
                } catch (\Exception $e) {
                    if ($this->logger) {
                        $this->logger->error(
                            sprintf(
                                'ERROR : admin:%s - Raises an exception : %s',
                                $admin->getCode(),
                                $e->getMessage()
                            ),
                            ['exception' => $e]
                        );
                    }

                    throw $e;
                }
            }
        }

        $catalogue = $this->catalogue;
        $this->catalogue = false;

        return $catalogue;
    }

    public function trans($id, array $parameters = [], $domain = null, $locale = null)
    {
        $this->addMessage($id, $domain ?? '');

        return $id;
    }

    public function transChoice($id, $number, array $parameters = [], ?string $domain = null, ?string $locale = null)

    {
        $this->addMessage($id, $domain);

        return $id;
    }

    public function isGranted(AdminInterface $admin, $attributes, $object = null)
    {
        return true;
    }

    public function buildSecurityInformation(AdminInterface $admin): void
    {
    }

    public function createObjectSecurity(AdminInterface $admin, $object): void
    {
    }

    public function deleteObjectSecurity(AdminInterface $admin, $object): void
    {
    }

    public function getBaseRole(AdminInterface $admin): void
    {
    }

    public function getLabel($label, $context = '', $type = '')
    {
        $label = $this->labelStrategy->getLabel($label, $context, $type);

        $this->addMessage($label, $this->domain);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $label;
    }

    private function getAdmin(string $id): AdminInterface
    {
        $admin = $this->adminPool->getContainer()->get($id);
        \assert($admin instanceof AdminInterface);

        return $admin;
    }

    private function addMessage(string $id, string $domain): void
    {
        $message = new Message($id, $domain);

        $trace = debug_backtrace(0);
        if (isset($trace[1]['file'])) {
            $message->addSource(new FileSource($trace[1]['file']));
        }

        $this->catalogue->add($message);
    }
}


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\Translator\Extractor\JMSTranslatorBundle;
15
16			use JMS\TranslationBundle\Model\FileSource;
17			use JMS\TranslationBundle\Model\Message;
18			use JMS\TranslationBundle\Model\MessageCatalogue;
19			use JMS\TranslationBundle\Translation\ExtractorInterface;
20			use Psr\Log\LoggerInterface;
21			use Sonata\AdminBundle\Admin\AdminInterface;
22			use Sonata\AdminBundle\Admin\BreadcrumbsBuilderInterface;
23			use Sonata\AdminBundle\Admin\Pool;
24			use Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface;
25			use Sonata\AdminBundle\Translator\LabelTranslatorStrategyInterface;
26			use Symfony\Contracts\Translation\TranslatorInterface;
27
28			/**
29			* NEXT_MAJOR: Remove this class and the jms/translation-bundle dev dependency.
30			*
31			* @deprecated since sonata-project/admin-bundle 3.72. Use `translation:update` Symfony command instead.
32			*/
33			final class AdminExtractor implements ExtractorInterface, TranslatorInterface, SecurityHandlerInterface, LabelTranslatorStrategyInterface
34			{
35			/**
36			* @var LoggerInterface\|null
37			*/
38			private $logger;
39
40			/**
41			* @var Pool
42			*/
43			private $adminPool;
44
45			/**
46			* @var MessageCatalogue\|bool
47			*/
48			private $catalogue;
49
50			/**
51			* @var TranslatorInterface\|null
52			*/
53			private $translator;
54
55			/**
56			* @var LabelTranslatorStrategyInterface\|bool
57			*/
58			private $labelStrategy;
59
60			/**
61			* @var string\|bool
62			*/
63			private $domain;
64
65			/**
66			* @var BreadcrumbsBuilderInterface
67			*/
68			private $breadcrumbsBuilder;
69
70			public function __construct(
71			Pool $adminPool,
72			?TranslatorInterface $translator,
73			?LoggerInterface $logger = null
74			) {
75			$this->logger = $logger;
76			$this->adminPool = $adminPool;
77			$this->translator = $translator;
78
79			// state variable
80			$this->catalogue = false;
81			$this->labelStrategy = false;
82			$this->domain = false;
83			}
84
85			public function setLogger(LoggerInterface $logger): void
86			{
87			$this->logger = $logger;
88			}
89
90			/**
91			* NEXT_MAJOR : use a constructor argument instead.
92			*/
93			public function setBreadcrumbsBuilder(BreadcrumbsBuilderInterface $breadcrumbsBuilder): void
94			{
95			$this->breadcrumbsBuilder = $breadcrumbsBuilder;
96			}
97
98			/**
99			* Extract messages to MessageCatalogue.
100			*
101			* @throws \Exception\|\RuntimeException
102			*
103			* @return MessageCatalogue
104			*/
105			public function extract()
106			{
107			if ($this->catalogue) {
108			throw new \RuntimeException('Invalid state');
109			}
110
111			$this->catalogue = new MessageCatalogue();
112
113			foreach ($this->adminPool->getAdminGroups() as $name => $group) {
114			$this->trans($name, [], $group['label_catalogue']);
115			}
116
117			foreach ($this->adminPool->getAdminServiceIds() as $id) {
118			$admin = $this->getAdmin($id);
119
120			$label = $admin->getLabel();
121			if (!empty($label)) {
122			$this->trans($label, [], $admin->getTranslationDomain());
123			}
124
125			$this->labelStrategy = $admin->getLabelTranslatorStrategy();
126			$this->domain = $admin->getTranslationDomain();
127
128			$admin->setTranslator($this);
129			$admin->setSecurityHandler($this);
130			$admin->setLabelTranslatorStrategy($this);
131
132			// call the different public method
133			$methods = [
134			'getShow',
135			'getDatagrid',
136			'getList',
137			'getForm',
138			];
139
140			$actions = [
141			'list',
142			'edit',
143			'create',
144			'update',
145			'batch',
146			'delete',
147			];
148
149			if ($this->logger) {
150			$this->logger->info(sprintf(
151			'Retrieving message from admin:%s - class: %s',
152			$admin->getCode(),
153			\get_class($admin)
154			));
155			}
156
157			foreach ($methods as $method) {
158			try {
159			$admin->$method();
160			} catch (\Exception $e) {
161			if ($this->logger) {
162			$this->logger->error(sprintf(
163			'ERROR : admin:%s - Raise an exception : %s',
164			$admin->getCode(),
165			$e->getMessage()
166			));
167			}
168
169			throw $e;
170			}
171			}
172
173			foreach ($actions as $action) {
174			try {
175			$this->breadcrumbsBuilder->getBreadcrumbs($admin, $action);
176			} catch (\Exception $e) {
177			if ($this->logger) {
178			$this->logger->error(
179			sprintf(
180			'ERROR : admin:%s - Raises an exception : %s',
181			$admin->getCode(),
182			$e->getMessage()
183			),
184			['exception' => $e]
185			);
186			}
187
188			throw $e;
189			}
190			}
191			}
192
193			$catalogue = $this->catalogue;
194			$this->catalogue = false;
195
196			return $catalogue;
197			}
198
199			public function trans($id, array $parameters = [], $domain = null, $locale = null)
200			{
201			$this->addMessage($id, $domain ?? '');
202
203			return $id;
204			}
205
206			public function transChoice($id, $number, array $parameters = [], ?string $domain = null, ?string $locale = null)
			0 ignored issues – show Unused Code introduced 2020-05-17 19:10 UTC by Report Bug Copy Issue Report The parameter `$number` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-05-17 19:10 UTC by Report Bug Copy Issue Report The parameter `$parameters` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-05-17 19:10 UTC by Report Bug Copy Issue Report The parameter `$locale` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
207			{
208			$this->addMessage($id, $domain);
209
210			return $id;
211			}
212
213			public function isGranted(AdminInterface $admin, $attributes, $object = null)
214			{
215			return true;
216			}
217
218			public function buildSecurityInformation(AdminInterface $admin): void
219			{
220			}
221
222			public function createObjectSecurity(AdminInterface $admin, $object): void
223			{
224			}
225
226			public function deleteObjectSecurity(AdminInterface $admin, $object): void
227			{
228			}
229
230			public function getBaseRole(AdminInterface $admin): void
231			{
232			}
233
234			public function getLabel($label, $context = '', $type = '')
235			{
236			$label = $this->labelStrategy->getLabel($label, $context, $type);
237
238			$this->addMessage($label, $this->domain);
			0 ignored issues – show Bug introduced 2017-05-15 14:24 UTC by Report Bug Copy Issue Report It seems like `$this->domain` can also be of type `boolean`; however, `Sonata\AdminBundle\Trans...Extractor::addMessage()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
239
240			return $label;
241			}
242
243			private function getAdmin(string $id): AdminInterface
244			{
245			$admin = $this->adminPool->getContainer()->get($id);
246			\assert($admin instanceof AdminInterface);
247
248			return $admin;
249			}
250
251			private function addMessage(string $id, string $domain): void
252			{
253			$message = new Message($id, $domain);
254
255			$trace = debug_backtrace(0);
256			if (isset($trace[1]['file'])) {
257			$message->addSource(new FileSource($trace[1]['file']));
258			}
259
260			$this->catalogue->add($message);
261			}
262			}
263

sonata-project / SonataAdminBundle

Pull Request — master (#6093)

AdminExtractor::setBreadcrumbsBuilder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like