Methods

Sets default option values for this instance

__construct(array | \Traversable | bool | null $allowWhiteSpaceOrOptions, string | null $locale) 

Parameters

$allowWhiteSpaceOrOptions

array\Traversableboolnull

$locale

stringnull

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

inherited_from \Zend\Filter\AbstractFilter::__invoke()
inherited_from \Zend\I18n\Filter\AbstractLocale::__invoke()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Defined by Zend\Filter\FilterInterface

filter(mixed $value) : string

Returns $value as string with all non-alphanumeric characters removed

Parameters

$value

mixed

Exceptions

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

Returns

string

Whether white space is allowed

getAllowWhiteSpace() : bool

Returns

bool

Returns the locale option

getLocale() : string
Inherited

inherited_from \Zend\I18n\Filter\AbstractLocale::getLocale()

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::getOptions()
inherited_from \Zend\I18n\Filter\AbstractLocale::getOptions()

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()
inherited_from \Zend\I18n\Filter\AbstractLocale::hasPcreUnicodeSupport()

Returns

bool

Sets the allowWhiteSpace option

setAllowWhiteSpace(bool $flag) : \Zend\I18n\Filter\Alnum

Parameters

$flag

bool

Returns

\Zend\I18n\Filter\AlnumProvides a fluent interface

Sets the locale option

setLocale(string | null $locale) : \Zend\I18n\Filter\AbstractLocale
Inherited

inherited_from \Zend\I18n\Filter\AbstractLocale::setLocale()

Parameters

$locale

stringnull

Returns

setOptions()

setOptions(array | \Traversable $options) : \Zend\Filter\AbstractFilter
Inherited

inherited_from \Zend\Filter\AbstractFilter::setOptions()
inherited_from \Zend\I18n\Filter\AbstractLocale::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

isOptions()

isOptions(mixed $options) : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::isOptions()
inherited_from \Zend\I18n\Filter\AbstractLocale::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Filter options

$options : array