Zend Framework
3.0
|
Public Member Functions | |
__construct ($options=null) | |
Abstract constructor for all validators A validator should accept following parameters: | |
getOption ($option) | |
Returns an option. | |
getOptions () | |
Returns all available options. | |
setOptions ($options=[]) | |
Sets one or multiple options. | |
getMessages () | |
Returns array of validation failure messages. | |
__invoke ($value) | |
Invoke as command. | |
getMessageVariables () | |
Returns an array of the names of variables that are used in constructing validation failure messages. | |
getMessageTemplates () | |
Returns the message templates from the validator. | |
setMessage ($messageString, $messageKey=null) | |
Sets the validation failure message template for a particular key. | |
setMessages (array $messages) | |
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. | |
__get ($property) | |
Magic function returns the value of the requested property, if and only if it is the value or a message variable. | |
setValueObscured ($flag) | |
Set flag indicating whether or not value should be obfuscated in messages. | |
isValueObscured () | |
Retrieve flag indicating whether or not value should be obfuscated in messages. | |
setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null) | |
Set translation object. | |
getTranslator () | |
Return translation object. | |
hasTranslator () | |
Does this validator have its own specific translator? | |
setTranslatorTextDomain ($textDomain= 'default') | |
Set translation text domain. | |
getTranslatorTextDomain () | |
Return the translation text domain. | |
setTranslatorEnabled ($flag=true) | |
Indicate whether or not translation should be enabled. | |
isTranslatorEnabled () | |
Is translation enabled? | |
Public Member Functions inherited from TranslatorAwareInterface | |
setTranslator (TranslatorInterface $translator=null, $textDomain=null) | |
Sets translator to use in helper. | |
Public Member Functions inherited from ValidatorInterface | |
isValid ($value) | |
Returns true if and only if $value meets the validation requirements. | |
Static Public Member Functions | |
static | setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null) |
Set default translation object for all validate objects. | |
static | getDefaultTranslator () |
Get default translation object for all validate objects. | |
static | hasDefaultTranslator () |
Is there a default translation object set? | |
static | setDefaultTranslatorTextDomain ($textDomain= 'default') |
Set default translation text domain for all validate objects. | |
static | getDefaultTranslatorTextDomain () |
Get default translation text domain for all validate objects. | |
static | getMessageLength () |
Returns the maximum allowed message length. | |
static | setMessageLength ($length=-1) |
Sets the maximum allowed message length. | |
Protected Member Functions | |
createMessage ($messageKey, $value) | |
Constructs and returns a validation failure message with the given message key and value. | |
error ($messageKey, $value=null) | |
getValue () | |
Returns the validation value. | |
setValue ($value) | |
Sets the value to be validated and clears the messages and errors arrays. | |
translateMessage ($messageKey, $message) | |
Translate a validation message. | |
Protected Attributes | |
$value | |
$abstractOptions | |
Static Protected Attributes | |
static | $defaultTranslator |
static | $defaultTranslatorTextDomain = 'default' |
static | $messageLength = -1 |
__construct | ( | $options = null | ) |
Abstract constructor for all validators A validator should accept following parameters:
array | Traversable | $options |
__get | ( | $property | ) |
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
string | $property |
Exception\InvalidArgumentException |
__invoke | ( | $value | ) |
Invoke as command.
mixed | $value |
|
protected |
Constructs and returns a validation failure message with the given message key and value.
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.
string | $messageKey | |
string | array | object | $value |
|
protected |
string | $messageKey | |
string | $value | OPTIONAL |
|
static |
Get default translation object for all validate objects.
|
static |
Get default translation text domain for all validate objects.
|
static |
Returns the maximum allowed message length.
getMessages | ( | ) |
getMessageTemplates | ( | ) |
Returns the message templates from the validator.
getMessageVariables | ( | ) |
Returns an array of the names of variables that are used in constructing validation failure messages.
getOption | ( | $option | ) |
Returns an option.
string | $option | Option to be returned |
Exception\InvalidArgumentException |
getOptions | ( | ) |
Returns all available options.
getTranslator | ( | ) |
getTranslatorTextDomain | ( | ) |
|
protected |
Returns the validation value.
|
static |
Is there a default translation object set?
hasTranslator | ( | ) |
Does this validator have its own specific translator?
Implements TranslatorAwareInterface.
isTranslatorEnabled | ( | ) |
isValueObscured | ( | ) |
Retrieve flag indicating whether or not value should be obfuscated in messages.
|
static |
Set default translation object for all validate objects.
Translator\TranslatorInterface | null | $translator | |
string | $textDomain | (optional) |
Exception\InvalidArgumentException |
|
static |
Set default translation text domain for all validate objects.
string | $textDomain |
setMessage | ( | $messageString, | |
$messageKey = null |
|||
) |
Sets the validation failure message template for a particular key.
string | $messageString | |
string | $messageKey | OPTIONAL |
Exception\InvalidArgumentException |
|
static |
Sets the maximum allowed message length.
int | $length |
setMessages | ( | array | $messages | ) |
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.
array | $messages |
setOptions | ( | $options = [] | ) |
Sets one or multiple options.
array | Traversable | $options | Options to set |
Exception\InvalidArgumentException | If $options is not an array or Traversable |
setTranslator | ( | Translator\TranslatorInterface | $translator = null , |
$textDomain = null |
|||
) |
Set translation object.
Translator\TranslatorInterface | null | $translator | |
string | $textDomain | (optional) |
Exception\InvalidArgumentException |
setTranslatorEnabled | ( | $flag = true | ) |
Indicate whether or not translation should be enabled.
bool | $flag |
Implements TranslatorAwareInterface.
setTranslatorTextDomain | ( | $textDomain = 'default' | ) |
Set translation text domain.
string | $textDomain |
Implements TranslatorAwareInterface.
|
protected |
Sets the value to be validated and clears the messages and errors arrays.
mixed | $value |
setValueObscured | ( | $flag | ) |
Set flag indicating whether or not value should be obfuscated in messages.
bool | $flag |
|
protected |
Translate a validation message.
string | $messageKey | |
string | $message |
|
protected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |