Methods

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

inherited_from \Zend\Filter\AbstractFilter::__invoke()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Returns the result of filtering $value

filter(mixed $value) : mixed
Inherited

inherited_from \Zend\Filter\FilterInterface::filter()
inherited_from \Zend\Filter\AbstractFilter::filter()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Returns the set encoding

getEncoding() : string

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::getOptions()

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()

Returns

bool

Set the input encoding for the given string

setEncoding(string | null $encoding) : \Zend\Filter\self

Parameters

$encoding

stringnull

Exceptions

\Zend\Filter\Exception\InvalidArgumentException
\Zend\Filter\Exception\ExtensionNotLoadedException

Returns

\Zend\Filter\self

setOptions()

setOptions(array | \Traversable $options) : \Zend\Filter\self
Inherited

inherited_from \Zend\Filter\AbstractFilter::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\self

isOptions()

isOptions(mixed $options) : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Filter options

$options : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::$$options