Allowing extra, undefined options in a config array when using Symfony2's Configuration class

Question

I'm trying to define a Configuration object. I have successfully defined an array prototype node (like security.firewalls). My prototye array has an required element but I want to allow arbitrary parameters to be added to each array if needed.

My question is, how can I allow extra, undefined elements to be added to each prototype array?

Here's my config:

acme_widget:
    handlers:
        handler_one:
            service: handler.one.service
        handler_two:
            service: handler.two.service
            extra_array:
                - Extra 1
                - Extra 2
            extra_scalar: Extra 3

Here's my class builder:

    /**
     * Generates the configuration tree.
     *
     * @return TreeBuilder
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder;
        $rootNode = $treeBuilder->root('acme_widget');

        $rootNode
            ->children()
                ->arrayNode('handlers')
                    ->useAttributeAsKey('service')
                    ->prototype('array')
                        ->children()
                            ->scalarNode('service')->isRequired()->end()
                            ->booleanNode('enabled')->defaultTrue()->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;

        return $treeBuilder;
    }

I'm getting "InvalidConfigurationException: Unrecognized options".

An alternative is to call ->ignoreExtraKeys(false) on the ->prototype('array'). — apfelbox
– apfelbox, Commented Dec 20, 2016 at 14:54

AdrienBrault · Accepted Answer · 2012-09-23 10:07:36Z

22

I would just add a variable (can contain anything) node "extra":

->scalarNode('service')->isRequired()->end()
->booleanNode('enabled')->defaultTrue()->end()
->variableNode('extra')->end()

Your config would then look like:

acme_widget:
    handlers:
        handler_one:
            service: handler.one.service
        handler_two:
            service: handler.two.service
            extra:
                array:
                    - Extra 1
                    - Extra 2
                scalar: Extra 3

answered Sep 23, 2012 at 10:07

AdrienBrault

7,7454 gold badges33 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Radu Murzea Over a year ago

variableNode() is exactly what I was looking for, thanks. Too bad it's missing from symfony docs :(

Collectives™ on Stack Overflow

Allowing extra, undefined options in a config array when using Symfony2's Configuration class

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related