Skip to content

Symfony Config: two new methods for configuration definition tree manipulation to better reuse #27534

Closed
@cejen

Description

@cejen

Description
I can't find any way to make some parts of configuration definition reuseable. The best approach by me is to add two methods which can provides configuration tree manipulation (similar to DOM manipulation). But any other approach is welcome.

  1. \\Symfony\\Component\\Config\\Definition\\TreeBuilder::findNode(string $path):NodeDefinition - this method find node on given path (e.g. $node = $treeBuilder->findNode('node_name\node_name\node_name')
  2. \\Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::addNode(NodeDefinition $node): NodeDefinition - this method adds given node under.

Example

class EventDispatcherConfig implements ConfigurationInterface {

    private function addSerializerDefinition(NodeDefinition $node, $comment)
    {
        $node->addNode(
            (new ArrayNodeDefinition('serializer', $node))
                ->info($comment')
                ->children()
                    ->scalarNode('service')
                        ->isRequired()
                        ->cannotBeEmpty()
                    ->end()
                    ->enumNode('format')
                        ->isRequired()
                        ->cannotBeEmpty()
                        ->values(['json', 'xml'])
                    ->end()
                    ->arrayNode('groups')
                        ->scalarPrototype()
                        ->end()
                    ->end()
                    ->scalarNode('version')
                    ->end()
                ->end()
            ->end()
        );
    }

    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('A');
        ...
        // Now i can add repetitive definitions into
        $this->addSerializerDefinition($treeBuilder->findNode('A.B', 
            'Default serializer used to serialize enqueued events (used when route definition does not contain serializer definition'));
        $this->addSerializerDefinition($treeBuilder->findNode('A.C.D.E', 
            'Serializer used to serialize enqueued events'));
    }
}

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions