package Default
inherited_from \Zend\Filter\AbstractFilter

 Methods

__construct()

__construct(callable|array|\Traversable $callbackOrOptions, array $callbackParams = array()

Parameters

$callbackOrOptions

callablearray\Traversable

$callbackParams

array

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to \filter()

Parameters

$value

mixed

Exceptions

\Zend\Filter\Exception\ExceptionInterface If filtering $value is impossible

Returns

mixed

Calls the filter per callback

filter(mixed $value) : mixed

Parameters

$value

mixed

Options for the set callable

Returns

mixedResult from the filter which was called

Returns the set callback

getCallback() : callable

Returns

callable

Get parameters for the callback

getCallbackParams() : array

Returns

array

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

Sets a new callback for this filter

setCallback(callable $callback) : \Zend\Filter\Callback
fluent This method is part of a fluent interface and will return the same instance

Parameters

$callback

callable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\Callback

Sets parameters for the callback

setCallbackParams(array $params) : \Zend\Filter\Callback
fluent This method is part of a fluent interface and will return the same instance

Parameters

$params

array

Returns

\Zend\Filter\Callback

setOptions()

setOptions(array|\Traversable $options) : \Zend\Filter\Callback
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\Callback

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

Filter options

$options : array

Default

array('callback' => null, 'callback_params' => array())
inherited_from \Zend\Filter\AbstractFilter::options
 

Filter options

$options : array

Default

array()