Zend Framework
Back to top  

 Methods

Constructor

__construct(string | array | \Traversable $encodingOrOptions) 

Parameters

$encodingOrOptions

stringarray\Traversable

OPTIONAL

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

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

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Returns the result of filtering $value

filter(string | mixed $value) : string | mixed

Returns the string $value, converting words to have an uppercase first character as necessary

If the value provided is not a string, the value will remain unfiltered

Parameters

$value

stringmixed

Exceptions

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

Returns

stringmixed

Returns the set encoding

getEncoding() : string
Inherited

inherited_from \Zend\Filter\AbstractUnicode::getEncoding()

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

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

Returns

array

hasPcreUnicodeSupport() 

hasPcreUnicodeSupport() : bool
Inherited

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

Returns

bool

Set the input encoding for the given string

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

inherited_from \Zend\Filter\AbstractUnicode::setEncoding()

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()
inherited_from \Zend\Filter\AbstractUnicode::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()
inherited_from \Zend\Filter\AbstractUnicode::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Filter options

$options : array