How to use InputFilterManager to construct custom InputFilters in Zf2

Question

ZF2 documentation says following on defult services documentation;

InputFilterManager, mapping to Zend\Mvc\Service\InputFilterManagerFactory. This creates and returns an instance of Zend\InputFilter\InputFilterPluginManager, which can be used to manage and persist input filter instances.

I have a custom zf2 inputfilter class and i'm adding filters and validators inside init() method like following;

namespace Application\Filter;
use Zend\InputFilter\InputFilter;

class GlassFilter extends InputFilter
{
    public function init()
    {
        $this->add(array(
                'name' => 'glassname',
                'required' => true,
                'filters' => array(
                    array('name' => 'StringToUpper'),
                ),
                'validators' => array(
                    array( 'name' => 'StringLength', 'options' => array('min' => 3),
                ),
        ));
}

Also i added following key to my module.config.php

'filters' => array(
    'invokables' => array(
        'glassfilter' => '\Application\Filter\GlassFilter',
    ),
),

My question is, how can i construct my GlassFilter using InputFilterManager? Is this a correct approach? I found this thread but i want to understand relation between custom InputFilters and InputFilterManager.

If im not mistaken, as long as you register it, it should be as simple as array('name' => 'glassfilter') under the 'filters'-key — Sam
– Sam, Commented May 17, 2013 at 11:05

smottt · Accepted Answer · 2017-08-11 12:47:21Z

30

Ok, after spending 3 bloody hours (thanks to incredible(!) documentation) I figured it out. I'm writing my solution as an answer, hopefully it will help others who want to write their custom inputfilters.

You should register your custom inputfilter in module.config.php by input_filters top key, not filter, filters, filter_manger, filtermanager etc..
Extend default Zend\InputFilter\InputFilter when writing your own GlassFilter.
Write your filters inside the init() method of GlassFilter, not in the __constructor(). It will be called automatically after construction.
Then get it anywhere via inputfiltermanager, not servicemanager directly.

Config example:

'input_filters' => array(
    'invokables' => array(
        'glassfilter' => '\Application\Filter\GlassFilter',
     ),
),

Usage example:

$glassfilter = $serviceLocator->get('InputFilterManager')->get('glassfilter');

edited Aug 11, 2017 at 12:47

smottt

3,33011 gold badges41 silver badges47 bronze badges

answered May 17, 2013 at 11:31

edigu

10.2k5 gold badges62 silver badges84 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

AlexP Over a year ago

+1 Thank you for number 4! As for 1 you can also alternatively use the Zend\ModuleManager\Feature\FilterProviderInterface / getFilterConfig() in Module.php.

kabirbaidhya Over a year ago

Thanks for detail explanation. In my case the init() function was not being triggered. This made it work.

Collectives™ on Stack Overflow

How to use InputFilterManager to construct custom InputFilters in Zf2

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related