sauls/options-resolver

Symfony options resolver with multi dimensional array support

v1.0.2 2020-08-20 18:14 UTC

Requires

• php: >=7.4
• sauls/collections: ^1.0
• symfony/options-resolver: ^4.0 || ^5.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpunit/phpunit: ^9.0

MIT

• Saulius Vaičeliūnas

README

Symfony OptionsResolver with multi dimensional array support

Requirements

PHP >= 7.2

Installation

Using composer

$ composer require sauls/options-resolver

Apppend the composer.json file manually

{
    "require": {
        "sauls/options-resolver": "^1.0"
    }
}

Usage

Standard usage can be found at Symfony OptionsResolver official documentation.

The associative array support is added by using a dot notation array indexes.

Defining options

To define the associative options, use dot notated array indexes.

$resolver->setDefined['nested.name', 'nested.value', 'nested.deep.type'];

Adding allowed types

Allowed types are added using dot notation index.

$resolver->addAllowedType('nested.name', ['string']);
$resolver->addAllowedType('nested.value', ['int']);

Adding allowed values

Allowed values are added using dot notation index.

$resolver->addAllowedValues('nested.deep.type', ['one', 'two', 'three']);

Default option values

Default options can be added as dot notation index or associative array.

$resolver->setDefaults(
    [
        'nested.name' => 'Hello world!',
        'nested.value' => 100,
        'nested.deep.type' => 'one',
    ]
);

// Or

$resolver->setDefaults(
    [
        'nested' => [
            'name' => 'Hello world!',
            'value' => 100,
            'deep' => [
                'type' => 'one',
            ],
        ],
    ]
);

Resolving options

Passing array to resolve options can contain either the dot notation indexes or associative array.

$resolver->resolve(
    [
        'nested.name' => 'Resolve me!',
        'nested.value' => 500,
        'nested.deep.type' => 'two',
    ]
);

// Or

$resolver->resolve(
    [
        'nested' => [
            'name' => 'Resolve me!',
            'value' => 500,
            'deep' => [
                'type' => 'two',
            ],
        ]
    ]
);

Exceptions

All exceptions will return what is wrong with your associative option using dot notation. For example:

The option "nested.deep.type" with value "four" is invalid. Accepted values are: "one", "two", "three".

The option "nested.value" with value "wrong" is expected to be of type "int", but is of type "string".

The required option "nested.value" is missing.

The option "nested.deep.nmae" does not exist. Defined options are: "nested.deep.name", "nested.name", "nested.type", "nested.value", "text", "type".