Class StaticFilter

Summary

Fully Qualified Name: Laminas\Filter\StaticFilter

Description

Methods

Name Description Defined By
execute() Returns a value filtered through a specified filter class, without requiring separate instantiation of the filter object. StaticFilter
getPluginManager() Get plugin manager for loading filter classes StaticFilter
setPluginManager() Set plugin manager for resolving filter classes StaticFilter

Method Details

execute()

Returns a value filtered through a specified filter class, without requiring separate instantiation of the filter object.

The first argument of this method is a data input value, that you would have filtered. The second argument is a string, which corresponds to the basename of the filter class, relative to the Laminas\Filter namespace. This method automatically loads the class, creates an instance, and applies the filter() method to the data input. You can also pass an array of constructor arguments, if they are needed for the filter class.

Parameter Name Type Description
$value mixed
$classBaseName string
$args array OPTIONAL

Returns: mixed

getPluginManager()

Get plugin manager for loading filter classes

Returns: \FilterPluginManager

setPluginManager()

Set plugin manager for resolving filter classes

Parameter Name Type Description
$manager \FilterPluginManager

Returns: void

Top