[OptionsResolver] handle nested options by Doctrs · Pull Request #27251 · symfony/symfony

Doctrs · 2018-05-13T16:15:20Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#4833, #15524
License	MIT
Doc PR	symfony/symfony-docs#9819

Summary

Handle nested options resolving

    $configuration = [
        'host' => '127.0.0.1',
        'mysql' => [
            'option' => [
                'first_option' => false,
            ],
        ],
    ];

    $resolver->setDefaults([
        'host' => 'localhost',
        'user' => function(Options $option){
            return $option['mysql']['host'] === 'mysql_host';
        },
        'port' => 1234,
        'mysql' => new OptionResolverNested([
            'host' => 'mysql_host',
            'port' => 5678,
            'option' => new OptionResolverNested([
                'first_option' => true,
                'second_option' => function(ResolveData $root){
                    return $root['port'] === 1234;
                },
            ]),
        ]),
    ]);

Work with all methods

    $resolver->setRequired([
        ['mysql', 'ports'], // mysql => ports
        ['mysql', 'option', 'first_option'], // mysql => option => first_option
        'host' // host in root
    ]);

    $resolver->isRequired(['mysql', 'ports']); // true
    $resolver->isRequired(['mysql', 'ports', 'any_non_required_option']); // false
    $resolver->isMissing(['mysql', 'ports']); // true

If called get%ANY%Options we get an array of values are string or arrays

    $resolver->getRequiredOptions();

    // OUTPUT

    array (size=3)
      0 => 
        array (size=3)
          0 => string 'mysql' (length=5)
          1 => string 'option' (length=6)
          2 => string 'first_option' (length=12)
      1 => 
        array (size=2)
          0 => string 'mysql' (length=5)
          1 => string 'ports' (length=5)
      2 => string 'host' (length=4)

Keys with array values are not defined, because they are not defined as value. They are defined as nested OptionResolver

    $resolver->setDefined([
        ['mysql', 'any_data']
    ]);
    var_dump($resolver->isDefined('host')); // true
    var_dump($resolver->isDefined('mysql')); // false
    var_dump($resolver->isDefined(['mysql', 'any_data'])); // true

All other methods also work with options as an array.
when we need any value in lazy load, we can use $option['mysql']['host'][....] for access to children variables and function(ResolveData $root) for access to parent data. Array $root contains all resolve data. This step is performed last

Work in progress

Fix lazy load. Sometimes it works unexpectedly
Fix allowValues and allowTypes. When variables are redefined it try to compare with old and new values.
Tests
Code style

Sorry for my English ;)

linaori · 2018-05-15T07:15:06Z

This looks very interesting!

Doctrs · 2018-05-19T09:10:07Z

Deprecations: no

Doctrs · 2018-05-19T15:23:34Z

My work finished
Last changes

To access parent options you should use function(ResolveData $root). Array $root contains all resolve data. This step is performed last
offsetGet no longer accepts string[][]. To get access to children options use array access ($data['var']['any_var'])
Tests coverage 100%

Need review ;)

nicolas-grekas

Thanks for working on this.
What's the plan compared to #27291?

nicolas-grekas · 2018-06-19T12:09:22Z

src/Symfony/Component/OptionsResolver/CHANGELOG.md


+4.2.0
+-----
+ * added `OptionResolverNested` and support for nesting options


missing blank line before

nicolas-grekas · 2018-06-19T12:19:30Z