Zend Framework » \Zend\I18n\Filter\Alpha

Methods

Sets default option values for this instance

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

Inherited

inherited_from	\Zend\I18n\Filter\Alnum::__construct()

Parameters

$allowWhiteSpaceOrOptions

array\Traversableboolnull

$locale

stringnull

Exceptions

`\Zend\I18n\Exception\ExtensionNotLoadedException`	if ext/intl is not present

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()
inherited_from	\Zend\I18n\Filter\Alnum::__invoke()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Defined by Zend\Filter\FilterInterface

filter(string | array $value) : string | array

Returns the string $value, removing all but alphabetic characters

Parameters

$value

stringarray

Exceptions

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

Returns

stringarray

Whether white space is allowed

getAllowWhiteSpace() : bool

Inherited

inherited_from	\Zend\I18n\Filter\Alnum::getAllowWhiteSpace()

Returns

bool

Returns the locale option

getLocale() : string

Inherited

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

Returns

string

Retrieve options representing object state

getOptions() : array

Inherited

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

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool

Inherited

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

Returns

bool

Sets the allowWhiteSpace option

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

Inherited

inherited_from	\Zend\I18n\Filter\Alnum::setAllowWhiteSpace()

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()
inherited_from	\Zend\I18n\Filter\Alnum::setLocale()

Parameters

$locale

stringnull

Returns

\Zend\I18n\Filter\AbstractLocale

setOptions()

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

Inherited

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

Parameters

$options

array\Traversable

Exceptions

`\Zend\Filter\Exception\InvalidArgumentException`

Returns

\Zend\Filter\self

isOptions()

isOptions(mixed $options) : bool

Inherited

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

Parameters

$options

mixed

Returns

bool

Properties

Filter options

$options : array

Inherited

inherited_from	\Zend\I18n\Filter\Alnum::$$options