LAG\AdminBundle\Admin\Configuration\AdminConfiguration

Complexity

Total Complexity

42

Size/Duplication

Total Lines	301
Duplicated Lines	0 %

Importance

Changes

0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	getAction()	0	3	1
A	getEditTemplate()	0	3	1
A	getMaxPerPage()	0	3	1
A	getListTemplate()	0	3	1
A	getEntityClass()	0	3	1
A	hasAction()	0	3	1
B	configureOptions()	0	100	4
A	getDataProvider()	0	3	1
A	getPager()	0	7	2
A	getTitle()	0	3	1
A	getListActions()	0	3	1
A	getBatch()	0	3	1
A	isPaginationEnabled()	0	5	1
A	getItemActions()	0	3	1
A	getRoutesPattern()	0	3	1
A	getRoutesPatternNormalizer()	0	12	3
A	getCreateTemplate()	0	3	1
A	getActionClass()	0	3	1
A	getActions()	0	3	1
A	getDateFormat()	0	3	1
A	getPermissions()	0	9	2
A	getDataPersister()	0	3	1
A	getAdminClass()	0	3	1
A	getActionNormalizer()	0	33	6
A	getController()	0	3	1
A	getPageParameter()	0	3	1
A	getName()	0	3	1
A	getDeleteTemplate()	0	3	1
A	getActionRouteParameters()	0	9	2

<?php

declare(strict_types=1);

namespace LAG\AdminBundle\Admin\Configuration;

use Closure;
use JK\Configuration\Configuration;
use LAG\AdminBundle\Admin\Action;
use LAG\AdminBundle\Admin\Admin;
use LAG\AdminBundle\Admin\Configuration\Normalizer\LinkNormalizer;
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('title', null)
            ->setAllowedTypes('title', ['string', 'null'])
            ->addNormalizer('title', function (Options $options, $value) {
                if ($value === null) {
                    $value = u($options->offsetGet('name'))->title()->toString();
                }

                return $value;
            })

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

            ->setDefault('list_actions', [
                'edit' => [],
                'delete' => [],
            ])
            ->setAllowedTypes('list_actions', 'array')
            ->setNormalizer('list_actions', function (Options $options, $value) {
                foreach ($value as $actionName => $actionConfiguration) {
                    $value[$actionName] = LinkNormalizer::normalize(
                        $actionConfiguration,
                        $options->offsetGet('name'),
                        $actionName
                    );
                }

                return $value;
            })

            ->setDefault('item_actions', [
                'create' => [],
            ])
            ->setAllowedTypes('item_actions', 'array')
            ->setNormalizer('item_actions', function (Options $options, $value) {
                foreach ($value as $actionName => $actionConfiguration) {
                    $value[$actionName] = LinkNormalizer::normalize(
                        $actionConfiguration,
                        $options->offsetGet('name'),
                        $actionName
                    );
                }

                return $value;
            })

            ->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')
        ;
    }

    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 getTitle(): string
    {
        return $this->getString('title');
    }

    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 getListActions(): array
    {
        return $this->get('list_actions');
    }

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

    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');
    }

    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];
                    }
                }
                $action['admin_name'] = $options->offsetGet('name');
                $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;
        };
    }
}