Zend Framework » \Zend\I18n\Validator\Alnum

Constants

package	Default
inherited_from	\Zend\Validator\AbstractValidator

Methods

Sets default option values for this instance

__construct(boolean $allowWhiteSpace = false)

inherited_from	\Zend\Validator\AbstractValidator::__construct()

Parameters

$allowWhiteSpace

boolean

Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance)

__construct(array|\Traversable $options = null)

Inherited

Parameters

$options

array\Traversable

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

__get(string $property) : mixed

Inherited

Parameters

$property

string

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`

Returns

mixed

Invoke as command

__invoke(mixed $value) : boolean

Inherited

Parameters

$value

mixed

Returns

boolean

Returns the allowWhiteSpace option

getAllowWhiteSpace() : boolean

Returns

boolean

Get default translation object for all validate objects

getDefaultTranslator() : \Zend\Validator\Translator\TranslatorInterface | null

InheritedStatic

Returns

\Zend\Validator\Translator\TranslatorInterfacenull

Get default translation text domain for all validate objects

getDefaultTranslatorTextDomain() : string

InheritedStatic

Returns

string

Returns the maximum allowed message length

getMessageLength() : integer

InheritedStatic

Returns

integer

Returns the message templates from the validator

getMessageTemplates() : array

Inherited

Returns

array

Returns an array of the names of variables that are used in constructing validation failure messages

getMessageVariables() : array

Inherited

Returns

array

Returns array of validation failure messages

getMessages() : array

Inherited

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

inherited_from	\Zend\Validator\ValidatorInterface::getMessages()

Returns

array

Returns an option

getOption(string $option) : mixed

Inherited

Parameters

$option

string

Option to be returned

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`

Returns

mixedReturned option

Returns all available options

getOptions() : array

Inherited

Returns

arrayArray with all available options

Return translation object

getTranslator() : \Zend\Validator\Translator\TranslatorInterface | null

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::getTranslator()

Returns

\Zend\Validator\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::getTranslatorTextDomain()

Returns

string

Is there a default translation object set?

hasDefaultTranslator() : boolean

InheritedStatic

Returns

boolean

Does this validator have its own specific translator?

hasTranslator() : boolean

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::hasTranslator()

Returns

boolean

Is translation enabled?

isTranslatorEnabled() : boolean

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::isTranslatorEnabled()

Returns

boolean

Returns true if and only if $value contains only alphabetic and digit characters

isValid(string $value) : boolean

Parameters

$value

string

Returns

boolean

Retrieve flag indicating whether or not value should be obfuscated in messages

isValueObscured() : boolean

Inherited

Returns

boolean

Sets the allowWhiteSpace option

setAllowWhiteSpace(boolean $allowWhiteSpace) : \Zend\I18n\Filter\Alnum

Parameters

$allowWhiteSpace

boolean

Returns

\Zend\I18n\Filter\AlnumProvides a fluent interface

Set default translation object for all validate objects

setDefaultTranslator(\Zend\Validator\Translator\TranslatorInterface|null $translator = null, string $textDomain = null) : void

InheritedStatic

Parameters

$translator

\Zend\Validator\Translator\TranslatorInterfacenull

$textDomain

string

(optional)

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`

Set default translation text domain for all validate objects

setDefaultTranslatorTextDomain(string $textDomain = 'default') : void

InheritedStatic

Parameters

$textDomain

string

Sets the validation failure message template for a particular key

setMessage(string $messageString, string $messageKey = null) : \Zend\Validator\AbstractValidator

Inherited

Parameters

$messageString

string

$messageKey

string

OPTIONAL

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`

Returns

\Zend\Validator\AbstractValidatorProvides a fluent interface

Sets the maximum allowed message length

setMessageLength(integer $length = -1)

InheritedStatic

Parameters

$length

integer

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

setMessages(array $messages) : \Zend\Validator\AbstractValidator

Inherited

Parameters

$messages

array

Returns

\Zend\Validator\AbstractValidator

Sets one or multiple options

setOptions(array|\Traversable $options = array()) : \Zend\Validator\AbstractValidator

Inherited

Parameters

$options

array\Traversable

Options to set

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`	If $options is not an array or Traversable

Returns

\Zend\Validator\AbstractValidatorProvides fluid interface

Set translation object

setTranslator(\Zend\Validator\Translator\TranslatorInterface|null $translator = null, string $textDomain = null) : \Zend\Validator\AbstractValidator

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::setTranslator()

Parameters

$translator

\Zend\Validator\Translator\TranslatorInterfacenull

$textDomain

string

(optional)

Exceptions

`\Zend\Validator\Exception\InvalidArgumentException`

Returns

\Zend\Validator\AbstractValidator

Indicate whether or not translation should be enabled

setTranslatorEnabled(boolean $flag = true) : \Zend\Validator\AbstractValidator

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::setTranslatorEnabled()

Parameters

$flag

boolean

Returns

\Zend\Validator\AbstractValidator

Set translation text domain

setTranslatorTextDomain(string $textDomain = 'default') : \Zend\Validator\AbstractValidator

Inherited

inherited_from	\Zend\Validator\Translator\TranslatorAwareInterface::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\Validator\AbstractValidator

Set flag indicating whether or not value should be obfuscated in messages

setValueObscured(boolean $flag) : \Zend\Validator\AbstractValidator

Inherited

Parameters

$flag

boolean

Returns

\Zend\Validator\AbstractValidator

Constructs and returns a validation failure message with the given message key and value.

createMessage(string $messageKey, string|array|object $value) : string

Inherited

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

$messageKey

string

$value

stringarrayobject

Returns

string

error()

error(string $messageKey, string $value = null) : void

Inherited

Parameters

$messageKey

string

$value

string

OPTIONAL

Returns the validation value

getValue() : mixed

Inherited

Returns

mixedValue to be validated

Sets the value to be validated and clears the messages and errors arrays

setValue(mixed $value) : void

Inherited

Parameters

$value

mixed

Translate a validation message

translateMessage(string $messageKey, string $message) : string

Inherited

Parameters

$messageKey

string

$message

string

Returns

string

Properties

$abstractOptions

$abstractOptions

Default

array('messages' => array(), 'messageTemplates' => array(), 'messageVariables' => array(), 'translator' => null, 'translatorTextDomain' => null, 'translatorEnabled' => true, 'valueObscured' => false)

Default translation object for all validate objects

$defaultTranslator : \Zend\Validator\Translator\TranslatorInterface

Default

Static

Default text domain to be used with translator

$defaultTranslatorTextDomain : string

Default

'default'

Static

Alphanumeric filter used for validation

$filter : \Zend\I18n\Filter\Alnum

Default

null

Static

Limits the maximum returned length of an error message

$messageLength : integer

Default

-1

Static

Validation failure message template definitions

$messageTemplates : array

Default

array(self::INVALID => "Invalid type given. String, integer or float expected", self::NOT_ALNUM => "The input contains characters which are non alphabetic and no digits", self::STRING_EMPTY => "The input is an empty string")

Options for this validator

$options : array

Default

array('allowWhiteSpace' => false)

The value to be validated

$value : mixed

Default

Constants

INVALID

INVALID = 'alnumInvalid'

NOT_ALNUM

NOT_ALNUM = 'notAlnum'

STRING_EMPTY

STRING_EMPTY = 'alnumStringEmpty'