Khusseini\PimcoreRadBrickBundle\DependencyInjection\Configuration

Complexity

Total Complexity

7

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addDatasourcesSection()	0	32	1
A	getConfigTreeBuilder()	0	12	1
A	addAreabrickSection()	0	15	1
A	addCommonAreabrick()	0	36	1
A	addDatasourcesAreabrick()	0	25	1
A	addGroupsAreabrick()	0	7	1
A	addEditableAreabrick()	0	52	1

<?php

namespace Khusseini\PimcoreRadBrickBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * This is the class that validates and merges configuration from your app/config files.
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        /**
         * @var ArrayNodeDefinition
         */
        $rootNode = $treeBuilder->root('pimcore_rad_brick');

The function Symfony\Component\Config\Definition\Builder\TreeBuilder::root() has been deprecated: since Symfony 4.3, pass the root name to the constructor instead

        $this->addDatasourcesSection($rootNode);
        $this->addAreabrickSection($rootNode);

        return $treeBuilder;
    }

    protected function addCommonAreabrick(NodeBuilder $builder): void
    {
        $builder
            ->scalarNode('class')
            ->info('Use a predefined service instead of a newly created one.')
            ->end();
        $builder
            ->arrayNode('options')
                ->info('Set options for areabrick. (Makes only sense in combination with `class`)')
                ->useAttributeAsKey('name')
                ->scalarPrototype()
                ->end()
            ->end();

The method end() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Config\Definition\Builder\TreeBuilder. Are you sure you never get one of those?

        $builder
            ->scalarNode('label')
            ->info('Specify a label for the admin UI.')
            ->end();
        $builder
            ->scalarNode('icon')
            ->info('Specify an icon for the admin UI.')
            ->end();
        $builder
            ->scalarNode('open')
            ->info('Set HTML prepended to the brick\'s contents.')
            ->defaultValue('')
            ->end();
        $builder
            ->scalarNode('close')
            ->info('Set HTML appended to the brick\'s contents.')
            ->defaultValue('')
            ->end();
        $builder
            ->booleanNode('use_edit')
            ->info('Use a separate edit template.')
            ->defaultValue(false)
            ->end();
    }

    protected function addGroupsAreabrick(NodeBuilder $builder): void
    {
        $builder
            ->variableNode('groups')
            ->info('Define groups for areabrick.')
            ->defaultValue([])
            ->end();
    }

    protected function addDatasourcesAreabrick(NodeBuilder $builder): void
    {
        $builder
            ->arrayNode('datasources')
                ->info('Configure datasources to use  in view template')
                ->useAttributeAsKey('name')
                ->arrayPrototype()
                    ->children()
                        ->scalarNode('id')
                            ->info('Provide the id of the datasource to use')
                        ->end()
                        ->arrayNode('conditions')

The method arrayNode() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of Symfony\Component\Config\Definition\Builder\NodeParentInterface such as Symfony\Component\Config\Definition\Builder\NodeBuilder.

                            ->info('Configure conditions for datasource.')
                            ->scalarPrototype()
                            ->end()
                        ->end()
                        ->arrayNode('args')
                            ->info('Configure arguments to pass to method call')
                            ->useAttributeAsKey('name')
                            ->variablePrototype()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    protected function addEditableAreabrick(NodeBuilder $builder): void
    {
        $builder
            ->arrayNode('editables')
            ->info('Define editables available in templates.')
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->arrayPrototype()
            ->children()
            ->scalarNode('type')
            ->info('Editable type')
            ->isRequired()
            ->cannotBeEmpty()
            ->end()
            ->variableNode('options')

The method variableNode() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of Symfony\Component\Config\Definition\Builder\NodeParentInterface such as Symfony\Component\Config\Definition\Builder\NodeBuilder.

            ->info('Editable options')
            ->defaultValue([])
            ->end()
            ->scalarNode('instances')
            ->info('Provide the number of instances.')
            ->end()
            ->scalarNode('group')
            ->info('Specify the name of the group this editable belongs to.')
            ->end()
            ->arrayNode('map')
            ->info('Map data from other editables')
            ->arrayPrototype()
            ->children()
            ->scalarNode('source')
            ->info('Expression to get the value')
            ->isRequired()
            ->cannotBeEmpty()
            ->end()
            ->scalarNode('target')
            ->info('Path to property to be updated')
            ->isRequired()
            ->cannotBeEmpty()
            ->end()
            ->end()
            ->end()
            ->end()
            ->arrayNode('datasource')
            ->info('Bind editable to a datasource')
            ->children()
            ->scalarNode('name')
            ->info('The name of the datasource')
            ->end()
            ->scalarNode('id')
            ->info('The id to use for each item (uses expression language)')
            ->end()
            ->end()
            ->end();
    }

    protected function addAreabrickSection(ArrayNodeDefinition $node): void
    {
        $prototype = $node
            ->children()
            ->arrayNode('areabricks')
            ->useAttributeAsKey('name')
            ->arrayPrototype()
            ->children();

        $this->addCommonAreabrick($prototype);
        $this->addGroupsAreabrick($prototype);
        $this->addDatasourcesAreabrick($prototype);
        $this->addEditableAreabrick($prototype);

        $prototype->end()->end()->end();
    }

    protected function addDatasourcesSection(ArrayNodeDefinition $node): void
    {
        $node
            ->children()
            ->arrayNode('datasources')
            ->info('Define datasource available in areabricks.')
            ->useAttributeAsKey('name')
            ->arrayPrototype()
            ->children()

            ->scalarNode('service_id')
            ->info('Provide a Symfony service id')
            ->isRequired()
            ->cannotBeEmpty()
            ->end()

            ->scalarNode('method')

The method scalarNode() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of Symfony\Component\Config\Definition\Builder\NodeParentInterface such as Symfony\Component\Config\Definition\Builder\NodeBuilder.

            ->info('Method to be called on service')
            ->isRequired()
            ->cannotBeEmpty()
            ->end()

            ->arrayNode('args')
            ->variablePrototype()
            ->info('Method arguments. Expressions can be used here')
            ->end()
            ->end()

            ->end()
            ->end()
            ->end()
            ->end();
    }
}