LAG\AdminBundle\Application\Configuration\ApplicationConfiguration

Complexity

Total Complexity

15

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	4	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	configureOptions()	0	56	1
C	setRoutingOptions()	0	39	7
B	setTranslationOptions()	0	28	6
B	setFieldsOptions()	0	36	1

<?php

namespace LAG\AdminBundle\Application\Configuration;

use LAG\AdminBundle\Configuration\Configuration;
use LAG\AdminBundle\Configuration\ConfigurationInterface;
use LAG\AdminBundle\Field\Field;
use LAG\AdminBundle\Field\Field\StringField;
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Application configuration class. Allow easy configuration manipulation within an Admin.
 */
class ApplicationConfiguration extends Configuration implements ConfigurationInterface
{
    /**
     * Configure configuration allowed parameters.
     *
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        // enable or disable extra configuration listener
        $resolver->setDefault('enable_extra_configuration', true);
        $resolver->setAllowedTypes('enable_extra_configuration', 'boolean');

        // application title
        $resolver->setDefault('title', 'AdminBundle application');
        $resolver->setAllowedTypes('title', 'string');

        // application description
        $resolver->setDefault('description', '');
        $resolver->setAllowedTypes('description', 'string');

        // application locale (en by default)
        $resolver->setDefault('locale', 'en');
        $resolver->setAllowedTypes('locale', 'string');

        // main base template
        // as bundles are not loaded when reading the configuration, the kernel locateResources will always failed.
        // So we must not check resource existence here.
        $resolver->setDefault('base_template', 'LAGAdminBundle::admin.layout.html.twig');
        $resolver->setAllowedTypes('base_template', 'string');

        // form block template
        $resolver->setDefault('block_template', 'LAGAdminBundle:Form:fields.html.twig');
        $resolver->setAllowedTypes('block_template', 'string');

        // use bootstrap or not
        $resolver->setDefault('bootstrap', true);
        $resolver->setAllowedTypes('bootstrap', 'boolean');

        // general date format
        $resolver->setDefault('date_format', 'Y/m/d');
        $resolver->setAllowedTypes('date_format', 'string');

        // string length before truncation (0 means no truncation)
        $resolver->setDefault('string_length', 0);
        $resolver->setAllowedTypes('string_length', 'integer');

        $resolver->setDefault('string_length_truncate', '...');
        $resolver->setAllowedTypes('string_length_truncate', 'string');

        // routing configuration (route name pattern and url name pattern)
        $this->setRoutingOptions($resolver);

        // translation configuration
        $this->setTranslationOptions($resolver);

        // maximum number of elements displayed
        $resolver->setDefault('max_per_page', 25);
        $resolver->setAllowedTypes('max_per_page', 'integer');

        // admin field type mapping
        $this->setFieldsOptions($resolver);
    }

    /**
     * @param OptionsResolver $resolver
     */
    protected function setRoutingOptions(OptionsResolver $resolver)
    {
        $resolver->setDefault('routing', [
            'url_pattern' => '/{admin}/{action}',
            'name_pattern' => 'lag.admin.{admin}.{action}',
        ]);
        $resolver->setAllowedTypes('routing', 'array');
        $resolver->setNormalizer('routing', function(Options $options, $value) {

            if (!array_key_exists('url_pattern', $value)) {
                $value['url_pattern'] = '/{admin}/{action}';
            }
            if (!array_key_exists('name_pattern', $value)) {
                $value['name_pattern'] = 'lag.admin.{admin}.{action}';
            }

            // url pattern should contain {admin} and {action} token
            $urlPattern = $value['url_pattern'];

            if (strstr($urlPattern, '{admin}') === false) {
                throw new InvalidOptionsException('Admin routing configuration url pattern should contains {admin} placeholder');
            }
            if (strstr($urlPattern, '{action}') === false) {
                throw new InvalidOptionsException('Admin routing configuration url pattern should contains the {action} placeholder');
            }

            // name pattern should contain {admin} token
            $namePattern = $value['name_pattern'];

            if (strstr($namePattern, '{admin}') === false) {
                throw new InvalidOptionsException('Admin routing configuration pattern name should contains the {admin} placeholder');
            }
            if (strstr($namePattern, '{action}') === false) {
                throw new InvalidOptionsException('Admin routing configuration pattern name should contains the {action} placeholder');
            }

            return $value;
        });
    }

    /**
     * @param OptionsResolver $resolver
     */
    protected function setTranslationOptions(OptionsResolver $resolver)
    {
        $resolver->setDefault('translation', [
            'enabled' => true,
            'pattern' => 'lag.admin.{key}'
        ]);
        $resolver->setAllowedTypes('translation', 'array');
        $resolver->setNormalizer('translation', function(Options $options, $value) {

            if (!array_key_exists('enabled', $value)) {
                throw new InvalidOptionsException('Admin translation enabled parameter should be defined');
            }

            if (!is_bool($value['enabled'])) {
                throw new InvalidOptionsException('Admin translation enabled parameter should be a boolean');
            }

            if (!array_key_exists('pattern', $value)) {
                $value['pattern'] = '{admin}.{key}';
            }

            if ($value['enabled'] && strstr($value['pattern'], '{key}') === false) {
                throw new InvalidOptionsException('Admin translation pattern should contains the {key} placeholder');
            }

            return $value;
        });
    }

    /**
     * @param OptionsResolver $resolver
     */
    protected function setFieldsOptions(OptionsResolver $resolver)
    {
        $defaultMapping = [
            Field::TYPE_STRING => StringField::class,
            Field::TYPE_ARRAY => Field\ArrayField::class,
            Field::TYPE_LINK => Field\Link::class,
            Field::TYPE_DATE => Field\Date::class,
            Field::TYPE_COUNT => Field\Count::class,
            Field::TYPE_ACTION => Field\Action::class,
            Field::TYPE_COLLECTION => Field\Collection::class,
            Field::TYPE_BOOLEAN => Field\Boolean::class,
        ];

        $resolver->setDefault('fields_mapping', $defaultMapping);
        $resolver->setAllowedTypes('fields_mapping', 'array');
        $resolver->setNormalizer('fields_mapping', function(Options $options, $value) use ($defaultMapping) {
            // merge with default mapping to allow override
            $value = array_merge($defaultMapping, $value);

            return $value;
        });

        // fields templates mapping
        $defaultMapping = [
            Field::TYPE_LINK => 'LAGAdminBundle:Render:link.html.twig',
        ];

        $resolver->setDefault('fields_template_mapping', $defaultMapping);
        $resolver->setAllowedTypes('fields_template_mapping', 'array');
        $resolver->setNormalizer('fields_template_mapping', function(Options $options, $value) use ($defaultMapping) {
            // merge with default mapping to allow override
            $value = array_merge($defaultMapping, $value);

            return $value;
        });
    }
}