Making configuration node support both string and array in Symfony 2 configuration?

Question

Can my configuration node source support both string and array values?

Sourcing from string:

# Valid configuration 1
my_bundle:
    source: %kernel.root_dir%/../Resources/config/source.json

Sourcing from array:

# Valid configuration 2
my_bundle:
    source:
        operations: []
        commands: []

The extension class would be able to distinguish between them:

if (is_array($config['source']) {
    // Bootstrap from array
} else {
    // Bootstrap from file
}

I might use something like this:

$rootNode->children()
    ->variableNode('source')
        ->validate()
            ->ifTrue(function ($v) { return !is_string($v) && !is_array($v); })
            ->thenInvalid('Configuration value must be either string or array.')
        ->end()
    ->end()
->end();

But how ca I add constraints on the structure of source (operations, commands, etc...) to the variable node (that should only be enforced when its value is of type array)?

Benjamin Lazarecki · Accepted Answer · 2013-04-14 18:35:25Z

21

+300

I think you can use the config normalization by refactoring your extension.

In your extension change your code to check if a path is set

if ($config['path'] !== null) {
    // Bootstrap from file.
} else {
    // Bootstrap from array.
}

And allow the user to use a string for config.

$rootNode
    ->children()
        ->arrayNode('source')
            ->beforeNormalization()
            ->ifString()
                ->then(function($value) { return array('path' => $value); })
            ->end()
            ->children()
                ->scalarNode('foo')
                // ...
            ->end()
        ->end()
    ->end()
;

Like this you can allow the user to use a string or an array which can be validate.

See the symfony documentation for normalisation

Hope it's helpful. Best regard.

answered Apr 14, 2013 at 18:35

Benjamin Lazarecki

2,9701 gold badge22 silver badges27 bronze badges

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

1 Comment

gremo Over a year ago

Not bad. I should handle the case when path and operations and commands are setted. +1 for me

Aerendir · Accepted Answer · 2017-10-17 12:16:51Z

7

It is possible to use a variable node type in combination with some custom validation logic:

<?php
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException;

public function getConfigTreeBuilder()
{
    $treeBuilder = new TreeBuilder();
    $rootNode = $treeBuilder->root('my_bundle');

    $rootNode
        ->children()
            ->variableNode('source')
                ->validate()
                    ->ifTrue(function ($v) {
                        return false === is_string($v) && false === is_array($v);
                    })
                    ->thenInvalid('Here you message about why it is invalid')
                ->end()
            ->end()
        ->end();
    ;

    return $treeBuilder;
}

This will succesfully process:

my_bundle:
    source: foo

# and

my_bundle:
    source: [foo, bar]

but it won't process:

my_bundle:
    source: 1

# or

my_bundle
    source: ~

Of course, you won't get the nice validation rules a normal configuration node will provide you and you won't be able to use those validation rules on the array (or string) passed but you will be able to validate the passed data in the closure used.

edited Oct 17, 2017 at 12:16

Aerendir

6,46813 gold badges64 silver badges121 bronze badges

answered Apr 13, 2013 at 18:07

Ramon Kleiss

1,74915 silver badges26 bronze badges

2 Comments

gremo Over a year ago

Yes, I've already used something like this. But this time the array node is very complex.

Ramon Kleiss Over a year ago

I'm not sure if it's possible. Can't you use another structure like the one used by the JMSDiExtraBundle?

Collectives™ on Stack Overflow

Making configuration node support both string and array in Symfony 2 configuration?

2 Answers 2

1 Comment

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related