mtymek/blast-input-filter

Configuration-based setup of zend-validator, zend-filter and zend-inputfilter for Expressive applications.

Blast\InputFilter

, _(*1)

Configuration-based setup of zend-validator, zend-filter and zend-inputfilter for Zend Expressive applications., _(*2)

This package provides factories that allow to define custom filters and validators using configuration:, _(*3)

return [
    'filters' => [
        'factories' => [
            'Foo' => FooFilterFactory::class,
        ],
    ],
    'validators' => [
        'factories' => [
            'Bar' => BarValidatorFactory::class,
        ],
    ],
];

Later on they can be used directly when building an input filter:, _(*4)

$filter = $factory->createInputFilter(
    [
        [
            'name' => 'name',
            'filters' => [
                ['name' => 'Foo'],
            ],
            'validators' => [
                ['name' => 'Bar'],
            ],
        ],        
    ]
);

return $filter;

Installation

This package supports installation with composer:, _(*5)

$ composer require mtymek/blast-input-filter

Usage

Define your custom filters and validators

blast-inputfilter allows to set-up respective plugin managers using filters and validators keys:, _(*6)

return [
    'filters' => [
        'factories' => [
            'Foo' => FooFilterFactory::class,
        ],
    ],
    'validators' => [
        'factories' => [
            'Bar' => BarValidatorFactory::class,
        ],
    ],
];

This works exaclty like when using zend-mvc, only without performance penalty of ZF's module manager., _(*7)

Create input filter

There are couple of ways of creating input filter and injecting it with elements. One of them is to use __construct method to create all inputs and specify validators:, _(*8)

namespace App\InputFilter;

use Zend\InputFilter\InputFilter;

class ContactInputFilter extends InputFilter
{
    public function __construct()
    {
        $this->add(
            [
                'name' => 'name',
                'filters' => [
                    ['name' => 'Foo'],
                ],
                'validators' => [
                    ['name' => 'Bar'],
                ],
            ]
        );

        $this->add(
            [
                'name' => 'content',
                'filters' => [
                    ['name' => 'StringTrim'],
                ],
            ]
        );
    }
}

Create factory for your filter

In order for custom filters and validators to work, you need to pull Zend\InputFilter\Factory from service container and inject it into your input filter:, _(*9)

namespace App\InputFilter;

use Interop\Container\ContainerInterface;
use Zend\InputFilter\Factory;

class ContactInputFilterFactory
{
    public function __invoke(ContainerInterface $container)
    {
        $inputFilter = new ContactForm();
        $inputFilter->setFactory($container->get(Factory::class));
        return $inputFilter;
    }
}

Please note that you can use more generic factory to instantiate more input filters:, _(*10)

namespace App\InputFilter;

use Interop\Container\ContainerInterface;
use Zend\InputFilter\Factory;

class InputFilterFactory
{
    public function __invoke(ContainerInterface $container, $requestedName)
    {
        $inputFilter = new $requestedName();
        $inputFilter->setFactory($container->get(Factory::class));
        return $inputFilter;
    }
}