BaseGroupedMapper::shouldApply() - Code Metrics - Inspection of "Remove deprecated code" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6210)

by Jordi Sala

created 2020-08-01 07:58 UTC

BaseGroupedMapper::shouldApply() A

↳ Parent: BaseGroupedMapper

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	0

<?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\Mapper;

/**
 * This class is used to simulate the Form API.
 *
 * @author Thomas Rabaix <[email protected]>
 */
abstract class BaseGroupedMapper extends BaseMapper
{
    /**
     * @var string|null
     */
    protected $currentGroup;

    /**
     * @var string|null
     */
    protected $currentTab;

    /**
     * @var bool[]
     */
    protected $apply = [];

    /**
     * Add new group or tab (if parameter "tab=true" is available in options).
     *
     * @throws \LogicException
     */
    public function with(string $name, array $options = []): self
    {
        if (!$this->shouldApply()) {
            return $this;
        }

        /*
         * The current implementation should work with the following workflow:
         *
         *     $formMapper
         *        ->with('group1')
         *            ->add('username')
         *            ->add('password')
         *        ->end()
         *        ->with('tab1', ['tab' => true])
         *            ->with('group1')
         *                ->add('username')
         *                ->add('password')
         *            ->end()
         *            ->with('group2', ['collapsed' => true])
         *                ->add('enabled')
         *                ->add('createdAt')
         *            ->end()
         *        ->end();
         *
         */
        $defaultOptions = [
            'collapsed' => false,
            'class' => false,
            'description' => false,
            'label' => $this->admin->getLabelTranslatorStrategy()->getLabel($name, $this->getName(), 'group'),
            'translation_domain' => null,
            'name' => $name,
            'box_class' => 'box box-primary',
            'empty_message' => 'message_form_group_empty',
            'empty_message_translation_domain' => 'SonataAdminBundle',
        ];

        $code = $name;

        // Open
        if (\array_key_exists('tab', $options) && $options['tab']) {
            $tabs = $this->getTabs();

            if ($this->currentTab) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                if (isset($tabs[$this->currentTab]['auto_created']) && true === $tabs[$this->currentTab]['auto_created']) {
                    throw new \LogicException('New tab was added automatically when you have added field or group. You should close current tab before adding new one OR add tabs before adding groups and fields.');
                }

                throw new \LogicException(sprintf(
                    'You should close previous tab "%s" with end() before adding new tab "%s".',
                    $this->currentTab,
                    $name
                ));
            }

            if ($this->currentGroup) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new \LogicException(sprintf('You should open tab before adding new group "%s".', $name));
            }

            if (!isset($tabs[$name])) {
                $tabs[$name] = [];
            }

            $tabs[$code] = array_merge($defaultOptions, [
                'auto_created' => false,
                'groups' => [],
            ], $tabs[$code], $options);

            $this->currentTab = $code;
        } else {
            if ($this->currentGroup) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new \LogicException(sprintf(
                    'You should close previous group "%s" with end() before adding new tab "%s".',
                    $this->currentGroup,
                    $name
                ));
            }

            if (!$this->currentTab) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                // no tab define
                $this->with('default', [
                    'tab' => true,
                    'auto_created' => true,
                    'translation_domain' => $options['translation_domain'] ?? null,
                ]); // add new tab automatically
            }

            // if no tab is selected, we go the the main one named '_' ..
            if ('default' !== $this->currentTab) {
                // groups with the same name can be on different tabs, so we prefix them in order to make unique group name
                $code = sprintf('%s.%s', $this->currentTab, $name);
            }

            $groups = $this->getGroups();
            if (!isset($groups[$code])) {
                $groups[$code] = [];
            }

            $groups[$code] = array_merge($defaultOptions, [
                'fields' => [],
            ], $groups[$code], $options);

            $this->currentGroup = $code;
            $this->setGroups($groups);
            $tabs = $this->getTabs();
        }

        if ($this->currentGroup && isset($tabs[$this->currentTab]) && !\in_array($this->currentGroup, $tabs[$this->currentTab]['groups'], true)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $tabs[$this->currentTab]['groups'][] = $this->currentGroup;
        }

        $this->setTabs($tabs);

        return $this;
    }

    /**
     * Only nested add if the condition match true.
     */
    public function ifTrue(bool $bool): self
    {
        $this->apply[] = true === $bool;

        return $this;
    }

    /**
     * Only nested add if the condition match false.
     */
    public function ifFalse(bool $bool): self
    {
        $this->apply[] = false === $bool;

        return $this;
    }

    /**
     * @throws \LogicException
     */
    public function ifEnd(): self
    {
        if (empty($this->apply)) {
            throw new \LogicException('No open ifTrue() or ifFalse(), you cannot use ifEnd()');
        }

        array_pop($this->apply);

        return $this;
    }

    /**
     * Add new tab.
     */
    public function tab(string $name, array $options = []): self
    {
        return $this->with($name, array_merge($options, ['tab' => true]));
    }

    /**
     * Close the current group or tab.
     *
     * @throws \LogicException
     */
    public function end(): self
    {
        if (!$this->shouldApply()) {
            return $this;
        }

        if (null !== $this->currentGroup) {
            $this->currentGroup = null;
        } elseif (null !== $this->currentTab) {
            $this->currentTab = null;
        } else {
            throw new \LogicException('No open tabs or groups, you cannot use end()');
        }

        return $this;
    }

    /**
     * Returns a boolean indicating if there is an open tab at the moment.
     */
    public function hasOpenTab(): bool
    {
        return null !== $this->currentTab;
    }

    abstract protected function getGroups(): array;

    abstract protected function getTabs(): array;

    abstract protected function setGroups(array $groups): void;

    abstract protected function setTabs(array $tabs): void;

    abstract protected function getName(): string;

    /**
     * Add the field name to the current group.
     */
    protected function addFieldToCurrentGroup(string $fieldName): array
    {
        // Note this line must happen before the next line.
        // See https://github.com/sonata-project/SonataAdminBundle/pull/1351
        $currentGroup = $this->getCurrentGroupName();
        $groups = $this->getGroups();
        $groups[$currentGroup]['fields'][$fieldName] = $fieldName;
        $this->setGroups($groups);

        return $groups[$currentGroup];
    }

    /**
     * Return the name of the currently selected group. The method also makes
     * sure a valid group name is currently selected.
     *
     * Note that this can have the side effect to change the 'group' value
     * returned by the getGroup function
     */
    protected function getCurrentGroupName(): string
    {
        if (!$this->currentGroup) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->with($this->admin->getLabel() ?: 'default', ['auto_created' => true]);
        }

        return $this->currentGroup;
    }

    /**
     * Check if all apply conditions are respected.
     */
    final protected function shouldApply(): bool
    {
        return !\in_array(false, $this->apply, true);
    }
}


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\Mapper;
15
16			/**
17			* This class is used to simulate the Form API.
18			*
19			* @author Thomas Rabaix <[email protected]>
20			*/
21			abstract class BaseGroupedMapper extends BaseMapper
22			{
23			/**
24			* @var string\|null
25			*/
26			protected $currentGroup;
27
28			/**
29			* @var string\|null
30			*/
31			protected $currentTab;
32
33			/**
34			* @var bool[]
35			*/
36			protected $apply = [];
37
38			/**
39			* Add new group or tab (if parameter "tab=true" is available in options).
40			*
41			* @throws \LogicException
42			*/
43			public function with(string $name, array $options = []): self
44			{
45			if (!$this->shouldApply()) {
46			return $this;
47			}
48
49			/*
50			* The current implementation should work with the following workflow:
51			*
52			* $formMapper
53			* ->with('group1')
54			* ->add('username')
55			* ->add('password')
56			* ->end()
57			* ->with('tab1', ['tab' => true])
58			* ->with('group1')
59			* ->add('username')
60			* ->add('password')
61			* ->end()
62			* ->with('group2', ['collapsed' => true])
63			* ->add('enabled')
64			* ->add('createdAt')
65			* ->end()
66			* ->end();
67			*
68			*/
69			$defaultOptions = [
70			'collapsed' => false,
71			'class' => false,
72			'description' => false,
73			'label' => $this->admin->getLabelTranslatorStrategy()->getLabel($name, $this->getName(), 'group'),
74			'translation_domain' => null,
75			'name' => $name,
76			'box_class' => 'box box-primary',
77			'empty_message' => 'message_form_group_empty',
78			'empty_message_translation_domain' => 'SonataAdminBundle',
79			];
80
81			$code = $name;
82
83			// Open
84			if (\array_key_exists('tab', $options) && $options['tab']) {
85			$tabs = $this->getTabs();
86
87			if ($this->currentTab) {
			0 ignored issues – show Bug Best Practice introduced 2020-07-18 09:26 UTC by Report Bug Copy Issue Report The expression `$this->currentTab` of type `string\|null` is loosely compared to `true`; 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...
88			if (isset($tabs[$this->currentTab]['auto_created']) && true === $tabs[$this->currentTab]['auto_created']) {
89			throw new \LogicException('New tab was added automatically when you have added field or group. You should close current tab before adding new one OR add tabs before adding groups and fields.');
90			}
91
92			throw new \LogicException(sprintf(
93			'You should close previous tab "%s" with end() before adding new tab "%s".',
94			$this->currentTab,
95			$name
96			));
97			}
98
99			if ($this->currentGroup) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-25 10:57 UTC by Report Bug Copy Issue Report The expression `$this->currentGroup` of type `string\|null` is loosely compared to `true`; 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...
100			throw new \LogicException(sprintf('You should open tab before adding new group "%s".', $name));
101			}
102
103			if (!isset($tabs[$name])) {
104			$tabs[$name] = [];
105			}
106
107			$tabs[$code] = array_merge($defaultOptions, [
108			'auto_created' => false,
109			'groups' => [],
110			], $tabs[$code], $options);
111
112			$this->currentTab = $code;
113			} else {
114			if ($this->currentGroup) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-25 10:57 UTC by Report Bug Copy Issue Report The expression `$this->currentGroup` of type `string\|null` is loosely compared to `true`; 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...
115			throw new \LogicException(sprintf(
116			'You should close previous group "%s" with end() before adding new tab "%s".',
117			$this->currentGroup,
118			$name
119			));
120			}
121
122			if (!$this->currentTab) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-25 10:57 UTC by Report Bug Copy Issue Report The expression `$this->currentTab` 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...
123			// no tab define
124			$this->with('default', [
125			'tab' => true,
126			'auto_created' => true,
127			'translation_domain' => $options['translation_domain'] ?? null,
128			]); // add new tab automatically
129			}
130
131			// if no tab is selected, we go the the main one named '_' ..
132			if ('default' !== $this->currentTab) {
133			// groups with the same name can be on different tabs, so we prefix them in order to make unique group name
134			$code = sprintf('%s.%s', $this->currentTab, $name);
135			}
136
137			$groups = $this->getGroups();
138			if (!isset($groups[$code])) {
139			$groups[$code] = [];
140			}
141
142			$groups[$code] = array_merge($defaultOptions, [
143			'fields' => [],
144			], $groups[$code], $options);
145
146			$this->currentGroup = $code;
147			$this->setGroups($groups);
148			$tabs = $this->getTabs();
149			}
150
151			if ($this->currentGroup && isset($tabs[$this->currentTab]) && !\in_array($this->currentGroup, $tabs[$this->currentTab]['groups'], true)) {
			0 ignored issues – show Bug Best Practice introduced 2017-05-15 14:24 UTC by Report Bug Copy Issue Report The expression `$this->currentGroup` of type `string\|null` is loosely compared to `true`; 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...
152			$tabs[$this->currentTab]['groups'][] = $this->currentGroup;
153			}
154
155			$this->setTabs($tabs);
156
157			return $this;
158			}
159
160			/**
161			* Only nested add if the condition match true.
162			*/
163			public function ifTrue(bool $bool): self
164			{
165			$this->apply[] = true === $bool;
166
167			return $this;
168			}
169
170			/**
171			* Only nested add if the condition match false.
172			*/
173			public function ifFalse(bool $bool): self
174			{
175			$this->apply[] = false === $bool;
176
177			return $this;
178			}
179
180			/**
181			* @throws \LogicException
182			*/
183			public function ifEnd(): self
184			{
185			if (empty($this->apply)) {
186			throw new \LogicException('No open ifTrue() or ifFalse(), you cannot use ifEnd()');
187			}
188
189			array_pop($this->apply);
190
191			return $this;
192			}
193
194			/**
195			* Add new tab.
196			*/
197			public function tab(string $name, array $options = []): self
198			{
199			return $this->with($name, array_merge($options, ['tab' => true]));
200			}
201
202			/**
203			* Close the current group or tab.
204			*
205			* @throws \LogicException
206			*/
207			public function end(): self
208			{
209			if (!$this->shouldApply()) {
210			return $this;
211			}
212
213			if (null !== $this->currentGroup) {
214			$this->currentGroup = null;
215			} elseif (null !== $this->currentTab) {
216			$this->currentTab = null;
217			} else {
218			throw new \LogicException('No open tabs or groups, you cannot use end()');
219			}
220
221			return $this;
222			}
223
224			/**
225			* Returns a boolean indicating if there is an open tab at the moment.
226			*/
227			public function hasOpenTab(): bool
228			{
229			return null !== $this->currentTab;
230			}
231
232			abstract protected function getGroups(): array;
233
234			abstract protected function getTabs(): array;
235
236			abstract protected function setGroups(array $groups): void;
237
238			abstract protected function setTabs(array $tabs): void;
239
240			abstract protected function getName(): string;
241
242			/**
243			* Add the field name to the current group.
244			*/
245			protected function addFieldToCurrentGroup(string $fieldName): array
246			{
247			// Note this line must happen before the next line.
248			// See https://github.com/sonata-project/SonataAdminBundle/pull/1351
249			$currentGroup = $this->getCurrentGroupName();
250			$groups = $this->getGroups();
251			$groups[$currentGroup]['fields'][$fieldName] = $fieldName;
252			$this->setGroups($groups);
253
254			return $groups[$currentGroup];
255			}
256
257			/**
258			* Return the name of the currently selected group. The method also makes
259			* sure a valid group name is currently selected.
260			*
261			* Note that this can have the side effect to change the 'group' value
262			* returned by the getGroup function
263			*/
264			protected function getCurrentGroupName(): string
265			{
266			if (!$this->currentGroup) {
			0 ignored issues – show Bug Best Practice introduced 2020-06-25 10:57 UTC by Report Bug Copy Issue Report The expression `$this->currentGroup` 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...
267			$this->with($this->admin->getLabel() ?: 'default', ['auto_created' => true]);
268			}
269
270			return $this->currentGroup;
271			}
272
273			/**
274			* Check if all apply conditions are respected.
275			*/
276			final protected function shouldApply(): bool
277			{
278			return !\in_array(false, $this->apply, true);
279			}
280			}
281

sonata-project / SonataAdminBundle

Pull Request — master (#6210)

BaseGroupedMapper::shouldApply() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like