Public Member Functions | |
| __construct ($token=null) | |
| Sets validator options. | |
| getToken () | |
| Retrieve token. | |
| setToken ($token) | |
| Set token against which to compare. | |
| getStrict () | |
| Returns the strict parameter. | |
| setStrict ($strict) | |
| Sets the strict parameter. | |
| getLiteral () | |
| Returns the literal parameter. | |
| setLiteral ($literal) | |
| Sets the literal parameter. | |
| isValid ($value, $context=null) | |
| Returns true if and only if a token has been set and the provided value matches that token. | |
 Public Member Functions inherited from AbstractValidator | |
| __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. | |
Public Attributes | |
| const | NOT_SAME = 'notSame' |
| Error codes string. | |
| const | MISSING_TOKEN = 'missingToken' |
Protected Attributes | |
| $messageTemplates | |
| $messageVariables | |
| $tokenString | |
| $token | |
| $strict = true | |
| $literal = false | |
| Protected Attributes inherited from AbstractValidator | |
| $value | |
| $abstractOptions | |
Additional Inherited Members | |
| Static Public Member Functions inherited from AbstractValidator | |
| 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 inherited from AbstractValidator | |
| 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. | |
| Static Protected Attributes inherited from AbstractValidator | |
| static | $defaultTranslator |
| static | $defaultTranslatorTextDomain = 'default' |
| static | $messageLength = -1 |
Constructor & Destructor Documentation
| __construct | ( | $token = null | ) |
Sets validator options.
- Parameters
-
mixed $token
Member Function Documentation
| getLiteral | ( | ) |
Returns the literal parameter.
- Returns
- bool
| getStrict | ( | ) |
Returns the strict parameter.
- Returns
- bool
| getToken | ( | ) |
Retrieve token.
- Returns
- mixed
| isValid | ( | $value, | |
$context = null |
|||
| ) |
Returns true if and only if a token has been set and the provided value matches that token.
- Parameters
-
mixed $value array | ArrayAccess $context
- Exceptions
-
Exception\InvalidArgumentException If context is not array or ArrayObject
- Returns
- bool
| setLiteral | ( | $literal | ) |
| setStrict | ( | $strict | ) |
| setToken | ( | $token | ) |
Member Data Documentation
|
protected |
|
protected |
Initial value:
= [
self::NOT_SAME => "The two given tokens do not match"
|
protected |
Initial value:
= [
'token' => 'tokenString'
]
|
protected |
|
protected |
|
protected |
| const MISSING_TOKEN = 'missingToken' |
| const NOT_SAME = 'notSame' |
Error codes string.
