package Default
inherited_from \Zend\Filter\AbstractUnicode

 Methods

Constructor

__construct(string|array|\Traversable $encodingOrOptions = null

Parameters

$encodingOrOptions

stringarray\Traversable

OPTIONAL

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

{@inheritDoc}

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

Returns

stringmixed

Returns the set encoding

getEncoding() : string
Inherited

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

Set the input encoding for the given string

setEncoding(string|null $encoding = null) : \Zend\Filter\UpperCaseWords
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$encoding

stringnull

Exceptions

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

Returns

\Zend\Filter\UpperCaseWords

setOptions()

setOptions(array|\Traversable $options) : \Zend\Filter\UpperCaseWords
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\UpperCaseWords

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

{@inheritDoc}

$options 

Default

array('encoding' => null)
 

Filter options

$options : array

Default

array()