Class Alnum

Summary

Fully Qualified Name: Zend\I18n\Filter\Alnum
Extends: AbstractLocale

Description

Methods

Name Description Defined By
__construct() Sets default option values for this instance Alnum
__invoke() Invoke filter as a command AbstractFilter
filter() Defined by Zend\Filter\FilterInterface Alnum
getAllowWhiteSpace() Whether white space is allowed Alnum
getLocale() Returns the locale option AbstractLocale
getOptions() Retrieve options representing object state AbstractFilter
hasPcreUnicodeSupport() AbstractFilter
setAllowWhiteSpace() Sets the allowWhiteSpace option Alnum
setLocale() Sets the locale option AbstractLocale
setOptions() AbstractFilter

Method Details

__construct()

Sets default option values for this instance

Parameter Name Type Description
$allowWhiteSpaceOrOptions array|\Traversable|bool|null
$locale string|null

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 $value as string with all non-alphanumeric characters removed

Parameter Name Type Description
$value string|array

Returns: string|array

getAllowWhiteSpace()

Whether white space is allowed

Returns: bool

getLocale()

Returns the locale option

Returns: string

getOptions()

Retrieve options representing object state

Returns: array

hasPcreUnicodeSupport()

Returns: bool

setAllowWhiteSpace()

Sets the allowWhiteSpace option

Parameter Name Type Description
$flag bool

Returns: \Alnum Provides a fluent interface

setLocale()

Sets the locale option

Parameter Name Type Description
$locale string|null

Returns: \AbstractLocale

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

Top