AdminConfiguration::getRoutesPatternNormalizer() - Code Metrics - Inspection of "Feature/improve admin translation in template" - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#259)

by Arnaud

created 2021-05-13 10:07 UTC

AdminConfiguration::getRoutesPatternNormalizer() A

↳ Parent: AdminConfiguration

Complexity

Conditions	3
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	12
ccs	6
cts	6
cp	1
crap	3
rs	10

<?php

namespace LAG\AdminBundle\Configuration;

use Closure;
use JK\Configuration\Configuration;
use LAG\AdminBundle\Admin\Action;
use LAG\AdminBundle\Admin\Admin;
use LAG\AdminBundle\Controller\AdminAction;
use LAG\AdminBundle\Exception\Exception;
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
use function Symfony\Component\String\u;

/**
 * Ease Admin configuration manipulation.
 */
class AdminConfiguration extends Configuration
{
    protected function configureOptions(OptionsResolver $resolver): void
    {
        $resolver
            ->setRequired('entity')
            ->setAllowedTypes('entity', 'string')
            ->setRequired('name')
            ->setAllowedTypes('name', 'string')

            ->setDefault('actions', [
                'list' => [],
                'create' => [],
                'edit' => [],
                'delete' => [],
            ])
            ->setAllowedTypes('actions', 'array')
            ->setNormalizer('actions', $this->getActionNormalizer())

            ->setDefault('controller', AdminAction::class)
            ->setAllowedTypes('controller', 'string')

            ->setDefault('batch', [])
            ->setAllowedTypes('batch', 'array')

            ->setDefault('admin_class', Admin::class)
            ->setAllowedTypes('admin_class', 'string')
            ->setDefault('action_class', Action::class)
            ->setAllowedTypes('action_class', 'string')

            ->setDefault('routes_pattern', 'lag_admin.{admin}.{action}')
            ->setAllowedTypes('routes_pattern', 'string')
            ->setNormalizer('routes_pattern', $this->getRoutesPatternNormalizer())

            ->setDefault('pager', 'pagerfanta')
            ->setAllowedValues('pager', ['pagerfanta', false])
            ->setDefault('max_per_page', 25)
            ->setAllowedTypes('max_per_page', 'integer')
            ->setDefault('page_parameter', 'page')
            ->setAllowedTypes('page_parameter', 'string')

            ->setDefault('permissions', 'ROLE_ADMIN')
            ->setAllowedTypes('permissions', 'string')

            ->setDefault('date_format', 'Y-m-d')
            ->setAllowedTypes('date_format', 'string')

            ->setDefault('data_provider', 'doctrine')
            ->setAllowedTypes('data_provider', 'string')
            ->setDefault('data_persister', 'doctrine')
            ->setAllowedTypes('data_persister', 'string')

            ->setDefault('create_template', '@LAGAdmin/crud/create.html.twig')
            ->setAllowedTypes('create_template', 'string')
            ->setDefault('edit_template', '@LAGAdmin/crud/edit.html.twig')
            ->setAllowedTypes('edit_template', 'string')
            ->setDefault('list_template', '@LAGAdmin/crud/list.html.twig')
            ->setAllowedTypes('list_template', 'string')
            ->setDefault('delete_template', '@LAGAdmin/crud/delete.html.twig')
            ->setAllowedTypes('delete_template', 'string')

            ->setDefault('menus', [])
            ->setAllowedTypes('menus', 'array')
        ;
    }

    public function getName(): string
    {
        return $this->getString('name');
    }

    public function getAdminClass(): string
    {
        return $this->getString('admin_class');
    }

    public function getActionClass(): string
    {
        return $this->getString('action_class');
    }

    public function getActions(): array
    {
        return $this->get('actions');
    }

    public function hasAction(string $actionName): bool
    {
        return \array_key_exists($actionName, $this->getActions());
    }

    public function getAction(string $actionName): array
    {
        return $this->getActions()[$actionName];
    }

    public function getEntityClass(): string
    {
        return $this->getString('entity');
    }

    public function getController(): string
    {
        return $this->getString('controller');
    }

    public function getBatch(): array
    {
        return $this->get('batch');
    }

    public function getRoutesPattern(): string
    {
        return $this->getString('routes_pattern');
    }

    public function isPaginationEnabled(): bool
    {
        $pager = $this->get('pager');

        return !($pager === false);
    }

    public function getPager(): string
    {
        if (!$this->isPaginationEnabled()) {
            throw new Exception(sprintf('The pagination is not enabled for the admin "%s"', $this->getString('name')));
        }

        return $this->get('pager');
    }

    public function getMaxPerPage(): int
    {
        return $this->getInt('max_per_page');
    }

    public function getPageParameter(): string
    {
        return $this->get('page_parameter');
    }

    public function getPermissions(): array
    {
        $roles = explode(',', $this->get('permissions'));

        foreach ($roles as $index => $role) {
            $roles[$index] = trim($role);
        }

        return $roles;
    }

    public function getDateFormat(): string
    {
        return $this->getString('date_format');
    }

    public function getActionRouteParameters(string $actionName): array
    {
        $actionConfiguration = $this->getAction($actionName);

        if (empty($actionConfiguration['route_parameters'])) {
            return [];
        }

        return $actionConfiguration['route_parameters'];
    }

    public function getDataProvider(): string
    {
        return $this->getString('data_provider');
    }

    public function getDataPersister(): string
    {
        return $this->getString('data_persister');
    }

    public function getCreateTemplate(): string
    {
        return $this->getString('create_template');
    }

    public function getEditTemplate(): string
    {
        return $this->getString('edit_template');
    }

    public function getListTemplate(): string
    {
        return $this->getString('list_template');
    }

    public function getDeleteTemplate(): string
    {
        return $this->getString('delete_template');
    }

    public function getMenus(): array
    {
        return $this->get('menus');
    }

    private function getActionNormalizer(): Closure
    {
        return function (Options $options, $actions) {
            $normalizedActions = [];
//            $addBatchAction = false;

            foreach ($actions as $name => $action) {
                // action configuration is an array by default
                if (null === $action) {
                    $action = [];
                }

                if (!\array_key_exists('route_parameters', $action)) {
                    if ($name === 'edit' || $name === 'delete') {
                        $action['route_parameters'] = ['id' => null];
                    }
                }
                $normalizedActions[$name] = $action;

                // in list action, if no batch was configured or disabled, we add a batch action
//                if ('list' == $name && (!\array_key_exists('batch', $action) || null === $action['batch'])) {
//                    $addBatchAction = true;
//                }
            }

            // add empty default batch action
//            if ($addBatchAction) {
//             TODO enable mass action
//            $normalizedActions['batch'] = [];
//            }

            return $normalizedActions;
        };
    }

    private function getRoutesPatternNormalizer(): Closure
    {
        return function (Options $options, $value) {
            if (!u($value)->containsAny('{action}')) {
                throw new InvalidOptionsException(sprintf('The "%s" parameters in admin "%s" should contains the "%s" parameters', 'routes_pattern', $options->offsetGet('name'), '{action}'));
            }

            if (!u($value)->containsAny('{admin}')) {
                throw new InvalidOptionsException(sprintf('The "%s" parameters in admin "%s" should contains the "%s" parameters', 'routes_pattern', $options->offsetGet('name'), '{admin}'));
            }

            return $value;
        };
    }
}


1		<?php
2
3		namespace LAG\AdminBundle\Configuration;
4
5		use Closure;
6		use JK\Configuration\Configuration;
7		use LAG\AdminBundle\Admin\Action;
8		use LAG\AdminBundle\Admin\Admin;
9		use LAG\AdminBundle\Controller\AdminAction;
10		use LAG\AdminBundle\Exception\Exception;
11		use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
12		use Symfony\Component\OptionsResolver\Options;
13		use Symfony\Component\OptionsResolver\OptionsResolver;
14		use function Symfony\Component\String\u;
15
16		/**
17		* Ease Admin configuration manipulation.
18		*/
19		class AdminConfiguration extends Configuration
20		{
21	12	protected function configureOptions(OptionsResolver $resolver): void
22		{
23		$resolver
24	12	->setRequired('entity')
25	12	->setAllowedTypes('entity', 'string')
26	12	->setRequired('name')
27	12	->setAllowedTypes('name', 'string')
28
29	12	->setDefault('actions', [
30	12	'list' => [],
31		'create' => [],
32		'edit' => [],
33		'delete' => [],
34		])
35	12	->setAllowedTypes('actions', 'array')
36	12	->setNormalizer('actions', $this->getActionNormalizer())
37
38	12	->setDefault('controller', AdminAction::class)
39	12	->setAllowedTypes('controller', 'string')
40
41	12	->setDefault('batch', [])
42	12	->setAllowedTypes('batch', 'array')
43
44	12	->setDefault('admin_class', Admin::class)
45	12	->setAllowedTypes('admin_class', 'string')
46	12	->setDefault('action_class', Action::class)
47	12	->setAllowedTypes('action_class', 'string')
48
49	12	->setDefault('routes_pattern', 'lag_admin.{admin}.{action}')
50	12	->setAllowedTypes('routes_pattern', 'string')
51	12	->setNormalizer('routes_pattern', $this->getRoutesPatternNormalizer())
52
53	12	->setDefault('pager', 'pagerfanta')
54	12	->setAllowedValues('pager', ['pagerfanta', false])
55	12	->setDefault('max_per_page', 25)
56	12	->setAllowedTypes('max_per_page', 'integer')
57	12	->setDefault('page_parameter', 'page')
58	12	->setAllowedTypes('page_parameter', 'string')
59
60	12	->setDefault('permissions', 'ROLE_ADMIN')
61	12	->setAllowedTypes('permissions', 'string')
62
63	12	->setDefault('date_format', 'Y-m-d')
64	12	->setAllowedTypes('date_format', 'string')
65
66	12	->setDefault('data_provider', 'doctrine')
67	12	->setAllowedTypes('data_provider', 'string')
68	12	->setDefault('data_persister', 'doctrine')
69	12	->setAllowedTypes('data_persister', 'string')
70
71	12	->setDefault('create_template', '@LAGAdmin/crud/create.html.twig')
72	12	->setAllowedTypes('create_template', 'string')
73	12	->setDefault('edit_template', '@LAGAdmin/crud/edit.html.twig')
74	12	->setAllowedTypes('edit_template', 'string')
75	12	->setDefault('list_template', '@LAGAdmin/crud/list.html.twig')
76	12	->setAllowedTypes('list_template', 'string')
77	12	->setDefault('delete_template', '@LAGAdmin/crud/delete.html.twig')
78	12	->setAllowedTypes('delete_template', 'string')
79
80	12	->setDefault('menus', [])
81	12	->setAllowedTypes('menus', 'array')
82		;
83	12	}
84
85	9	public function getName(): string
86	9	{
87	9	return $this->getString('name');
88	9	}
89	9
90	9	public function getAdminClass(): string
91		{
92	12	return $this->getString('admin_class');
93		}
94	12
95		public function getActionClass(): string
96	1	{
97		return $this->getString('action_class');
98	1	}
99
100		public function getActions(): array
101	2	{
102		return $this->get('actions');
103	2	}
104
105		public function hasAction(string $actionName): bool
106	1	{
107		return \array_key_exists($actionName, $this->getActions());
108	1	}
109
110		public function getAction(string $actionName): array
111	2	{
112		return $this->getActions()[$actionName];
113	2	}
114
115		public function getEntityClass(): string
116	1	{
117		return $this->getString('entity');
118	1	}
119
120		public function getController(): string
121	2	{
122		return $this->getString('controller');
123	2	}
124
125		public function getBatch(): array
126	1	{
127		return $this->get('batch');
128	1	}
129
130		public function getRoutesPattern(): string
131	1	{
132		return $this->getString('routes_pattern');
133	1	}
134
135		public function isPaginationEnabled(): bool
136	1	{
137		$pager = $this->get('pager');
138	1
139		return !($pager === false);
140		}
141	1
142		public function getPager(): string
143	1	{
144		if (!$this->isPaginationEnabled()) {
145		throw new Exception(sprintf('The pagination is not enabled for the admin "%s"', $this->getString('name')));
146	2	}
147
148	2	return $this->get('pager');
149		}
150	2
151		public function getMaxPerPage(): int
152		{
153	2	return $this->getInt('max_per_page');
154		}
155	2
156	1	public function getPageParameter(): string
157		{
158		return $this->get('page_parameter');
159	1	}
160
161		public function getPermissions(): array
162	1	{
163		$roles = explode(',', $this->get('permissions'));
164	1
165		foreach ($roles as $index => $role) {
166		$roles[$index] = trim($role);
167	1	}
168
169	1	return $roles;
170		}
171
172	1	public function getDateFormat(): string
173		{
174	1	return $this->getString('date_format');
175		}
176	1
177	1	public function getActionRouteParameters(string $actionName): array
178		{
179		$actionConfiguration = $this->getAction($actionName);
180	1
181		if (empty($actionConfiguration['route_parameters'])) {
182		return [];
183	1	}
184
185	1	return $actionConfiguration['route_parameters'];
186		}
187
188	1	public function getDataProvider(): string
189		{
190	1	return $this->getString('data_provider');
191		}
192	1
193	1	public function getDataPersister(): string
194		{
195		return $this->getString('data_persister');
196	1	}
197
198		public function getCreateTemplate(): string
199	3	{
200		return $this->getString('create_template');
201	3	}
202
203		public function getEditTemplate(): string
204	1	{
205		return $this->getString('edit_template');
206	1	}
207
208		public function getListTemplate(): string
209	1	{
210		return $this->getString('list_template');
211	1	}
212
213		public function getDeleteTemplate(): string
214	1	{
215		return $this->getString('delete_template');
216	1	}
217
218		public function getMenus(): array
219	1	{
220		return $this->get('menus');
221	1	}
222
223		private function getActionNormalizer(): Closure
224	1	{
225		return function (Options $options, $actions) {
226	1	$normalizedActions = [];
227		// $addBatchAction = false;
228
229	1	foreach ($actions as $name => $action) {
230		// action configuration is an array by default
231	1	if (null === $action) {
232		$action = [];
233		}
234	3
235		if (!\array_key_exists('route_parameters', $action)) {
236	3	if ($name === 'edit' \|\| $name === 'delete') {
237		$action['route_parameters'] = ['id' => null];
238		}
239	2	}
240		$normalizedActions[$name] = $action;
241	2
242	1	// in list action, if no batch was configured or disabled, we add a batch action
243		// if ('list' == $name && (!\array_key_exists('batch', $action) \|\| null === $action['batch'])) {
244		// $addBatchAction = true;
245	1	// }
246		}
247
248	2	// add empty default batch action
249		// if ($addBatchAction) {
250	2	// TODO enable mass action
251	1	// $normalizedActions['batch'] = [];
252		// }
253
254	1	return $normalizedActions;
255		};
256		}
257	12
258		private function getRoutesPatternNormalizer(): Closure
259	12	{
260	11	return function (Options $options, $value) {
261		if (!u($value)->containsAny('{action}')) {
262		throw new InvalidOptionsException(sprintf('The "%s" parameters in admin "%s" should contains the "%s" parameters', 'routes_pattern', $options->offsetGet('name'), '{action}'));
263	11	}
264
265	11	if (!u($value)->containsAny('{admin}')) {
266	1	throw new InvalidOptionsException(sprintf('The "%s" parameters in admin "%s" should contains the "%s" parameters', 'routes_pattern', $options->offsetGet('name'), '{admin}'));
267		}
268
269	11	return $value;
270	11	};
271	10	}
272		}
273

larriereguichet / AdminBundle

Pull Request — master (#259)

AdminConfiguration::getRoutesPatternNormalizer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like