Hotfix/8 nested input filter config

[alex-patterson-webdev]

Q	A
Documentation	no
Bugfix	yes
BC Break	maybe
New Feature	no
RFC	no

Description

This pull request aids to address the problem defined in issue #8

I have added the ability to nest the input specification of nested input filters, when calling Factory::createInputFilter()

Currently, when nesting input filter configuration, the type key sits at the same level as the names of the required inputs. This can cause issue if the input you wish to add also has the name type,

$spec = [
    'baz' => [
        'type' => InputFilter::class,
        'foo' => [
            'name' => 'foo',
            'required' => false,
            'validators' => [
                [
                   'name' => Validator\NotEmpty::class,
                ],
            ],
        ],
    ],
];

$factory->createInputFilter($spec);

This PR allows the optional inputs key that nests the relevant inputs. If we have an input with the name type if will no longer conflict.

$spec = [
    'baz' => [
        'type' => InputFilter::class,
        'inputs' => [
            'type' => [
                'name' => 'foo',
                'required' => false,
                'validators' => [
                    [
                        'name' => Validator\NotEmpty::class,
                    ],
                ],
            ],
        ],
    ],
];

$factory->createInputFilter($spec);

BC Consideration

There is a possibility that existing code has an input already named inputs so we could consider changing this to something more unique

[froschdesign]

@alex-patterson-webdev

This can cause issue if the input you wish to add also has the name type

Maybe I have missed something, but you do not need to specify a key:

$spec = [
    'group' => [
        'type' => Laminas\InputFilter\InputFilter::class,
        [
            'name'       => 'type',
            'required'   => false,
            'validators' => [
                [
                    'name' => Laminas\Validator\NotEmpty::class,
                ],
            ],
        ],
    ],
];

$inputFilter = (new Laminas\InputFilter\Factory())->createInputFilter($spec);

var_dump($inputFilter->get('group')->get('type')->getName()); // 'type'

In this case the input filter uses the value of the name property of the input:

laminas-inputfilter/src/BaseInputFilter.php

Lines 95 to 97 in 22ae90c

	if ($input instanceof InputInterface && (empty($name) || is_int($name))) {
	$name = $input->getName();
	}

[froschdesign]

I personally find the naming in this example very confusing:

$spec = [
    'baz' => [
        'type' => InputFilter::class,
        'inputs' => [
            'type' => [
                'name' => 'foo',
                'required' => false,
                'validators' => [
                    [
                        'name' => Validator\NotEmpty::class,
                    ],
                ],
            ],
        ],
    ],
];

Because this means:

var_dump($inputFilter->get('baz')->get('type')->getName()); // foo

[alex-patterson-webdev]

@froschdesign Thanks, I came across this issue today and google took me to issue #8. I had just assumed it wasn't possible.

It seems you are correct that the inputs can be specified with numeric keys; providing they have a name. The section of code is in fact near where I added my changes so I perhaps should have noticed. Anyway, this is great and a better solution. Thanks for your time.