Tell me more ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.
up vote 9 down vote favorite

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)?

share|improve this question

2 Answers

up vote 4 down vote accepted
+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.

share|improve this answer
Not bad. I should handle the case when path and operations and commands are setted. +1 for me – Gremo Apr 15 at 11:27
up vote 2 down vote

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()
                ->always(function ($v) {
                    if (!is_string($v) || !is_array($v)) {
                        throw new InvalidTypeException();
                    }
                    return $v;
                })
                ->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.

share|improve this answer
Yes, I've already used something like this. But this time the array node is very complex. – Gremo Apr 14 at 8:40
I'm not sure if it's possible. Can't you use another structure like the one used by the JMSDiExtraBundle? – Ramon Kleiss Apr 14 at 12:48

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.