package Default
inherited_from \Zend\I18n\Filter\AbstractLocale

 Methods

Sets default option values for this instance

__construct(array|\Traversable|boolean|null $allowWhiteSpaceOrOptions = null, string|null $locale = null
inherited_from \Zend\I18n\Filter\AbstractLocale::__construct()

Parameters

$allowWhiteSpaceOrOptions

array\Traversablebooleannull

$locale

stringnull

__construct()

__construct() 
Inherited

Exceptions

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

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to \filter()

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

Parameters

$value

stringarray

Returns

stringarray

Whether white space is allowed

getAllowWhiteSpace() : boolean

Returns

boolean

Returns the locale option

getLocale() : string
Inherited

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

Sets the allowWhiteSpace option

setAllowWhiteSpace(boolean $flag = true) : \Zend\I18n\Filter\Alnum

Parameters

$flag

boolean

Returns

\Zend\I18n\Filter\AlnumProvides a fluent interface

Sets the locale option

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

Parameters

$locale

stringnull

Returns

\Zend\I18n\Filter\AbstractLocale

setOptions()

setOptions(array|\Traversable $options) : \Zend\I18n\Filter\Alnum
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\I18n\Filter\Alnum

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

$options

$options : array

Default

array('locale' => null, 'allow_white_space' => false)
 

Filter options

$options : array

Default

array()