Class StringTrim

Summary

Fully Qualified Name: Laminas\Filter\StringTrim
Extends: AbstractFilter

Description

Methods

Name Description Defined By
__construct() Sets filter options StringTrim
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Laminas\Filter\FilterInterface StringTrim
getCharList() Returns the charList option StringTrim
getOptions() Retrieve options representing object state AbstractFilter
hasPcreUnicodeSupport() AbstractFilter
setCharList() Sets the charList option StringTrim
setOptions() AbstractFilter

Method Details

__construct()

Sets filter options

Parameter Name Type Description
$charlistOrOptions string|array|\Traversable

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

Defined by Laminas\Filter\FilterInterface

Returns the string $value with characters stripped from the beginning and end

Parameter Name Type Description
$value string

Returns: string

getCharList()

Returns the charList option

Returns: string|null

getOptions()

Retrieve options representing object state

Returns: array

hasPcreUnicodeSupport()

Returns: bool

setCharList()

Sets the charList option

Parameter Name Type Description
$charList string

Returns: self Provides a fluent interface

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

Top