Application Integration

Usage in a laminas-mvc Application

The following example shows one potential use case of laminas-inputfilter within a laminas-mvc based application. The example uses a module, a controller and the input filter plugin manager.

The example is based on the tutorial application which builds an album inventory system.

Before starting, make sure laminas-inputfilter is installed and configured.

Create Input Filter

Create an input filter as separate class using the init method, e.g. module/Album/src/InputFilter/QueryInputFilter.php:

namespace Album\InputFilter;

use Laminas\Filter\ToInt;
use Laminas\I18n\Validator\IsInt;
use Laminas\InputFilter\InputFilter;

final class QueryInputFilter extends InputFilter
{
    public function init(): void
    {
        // Page
        $this->add(
            [
                'name'              => 'page',
                'allow_empty'       => true,
                'validators'        => [
                    [
                        'name' => IsInt::class,                        
                    ],                    
                ],
                'filters'           => [
                    [
                        'name' => ToInt::class,
                    ],
                ],
                'fallback_value'    => 1,
            ]
        );

        // …
    }
}

Create Controller

Create a controller class and inject the input filter plugin manager via the constructor, e.g. module/Album/Controller/AlbumController.php:

namespace Album\Controller;

use Album\InputFilter\QueryInputFilter;
use Laminas\InputFilter\InputFilterPluginManager;
use Laminas\Mvc\Controller\AbstractActionController;

use function assert;

final class AlbumController extends AbstractActionController
{
    public function __construct(
        public readonly InputFilterPluginManager $inputFilterPluginManager
    ) {}

    public function indexAction()
    {
        $inputFilter = $this->inputFilterPluginManager->get(QueryInputFilter::class);
        assert($inputFilter instanceof QueryInputFilter);

        $inputFilter->setData($this->getRequest()->getQuery());
        $inputFilter->isValid();
        $filteredParams = $inputFilter->getValues();

        // …
    }
}

Register Input Filter and Controller

If no separate factory is required for the input filter, then the input filter plugin manager will be instantiating the input filter class without prior registration. Otherwise, the input filter must be registered.

To register the controller for the application, extend the configuration of the module. Add the following lines to the module configuration file, e.g. module/Album/config/module.config.php:

namespace Album;

use Laminas\ServiceManager\AbstractFactory\ReflectionBasedAbstractFactory;

return [
    'controllers' => [
        'factories' => [
            // Add this line
            Controller\AlbumController::class => ReflectionBasedAbstractFactory::class,
        ],
    ],
    // …
];

The example uses the reflection factory from laminas-servicemanager to resolve the constructor dependencies for the controller class.