Class StringToLower

Summary

Fully Qualified Name: Zend\Filter\StringToLower
Extends: AbstractUnicode

Description

Methods

Name Description Defined By
__construct() Constructor StringToLower
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Zend\Filter\FilterInterface StringToLower
getEncoding() Returns the set encoding AbstractUnicode
getOptions() Retrieve options representing object state AbstractFilter
hasPcreUnicodeSupport() AbstractFilter
setEncoding() Set the input encoding for the given string AbstractUnicode
setOptions() AbstractFilter

Method Details

__construct()

Constructor

Parameter Name Type Description
$encodingOrOptions string|array|\Traversable OPTIONAL

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

Defined by Zend\Filter\FilterInterface

Returns the string $value, converting characters to lowercase as necessary

If the value provided is non-scalar, the value will remain unfiltered

Parameter Name Type Description
$value string

Returns: string|mixed

getEncoding()

Returns the set encoding

Returns: string

getOptions()

Retrieve options representing object state

Returns: array

hasPcreUnicodeSupport()

Returns: bool

setEncoding()

Set the input encoding for the given string

Parameter Name Type Description
$encoding string|null

Returns: self

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

Top