Methods
Abstract constructor for all validators
A validator should accept following parameters:
- nothing f.e.
__construct(array | \Traversable $options)
Inherited
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)
| inherited_from |
\Zend\Validator\AbstractValidator::__construct() |
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
| inherited_from |
\Zend\Validator\AbstractValidator::__get() |
Parameters
$property
string
Exceptions
Returns
mixed
Invoke as command
__invoke(mixed $value) : bool
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::__invoke() |
Parameters
$value
mixed
Returns
bool
Get default translation text domain for all validate objects
getDefaultTranslatorTextDomain() : string
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getDefaultTranslatorTextDomain() |
Returns
string
Returns the haystack option
getHaystack() : mixed
Returns the maximum allowed message length
getMessageLength() : int
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getMessageLength() |
Returns
int
Returns the message templates from the validator
getMessageTemplates() : array
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getMessageTemplates() |
Returns
array
Returns an array of the names of variables that are used in constructing validation failure messages
getMessageVariables() : array
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getMessageVariables() |
Returns
array
Returns array of validation failure messages
getMessages() : array
Inherited
The array keys are validation failure message identifiers,
and the array values are the corresponding human-readable message strings.
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\AbstractValidator::getMessages() |
Returns
array
Returns an option
getOption(string $option) : mixed
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getOption() |
Parameters
$option
stringOption to be returned
Exceptions
Returns
mixedReturned option
Returns all available options
getOptions() : array
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getOptions() |
Returns
arrayArray with all available options
Returns the recursive option
getRecursive() : bool
Returns the strict option
getStrict() : bool | int
Return the translation text domain
getTranslatorTextDomain() : string
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getTranslatorTextDomain() |
Returns
string
Is there a default translation object set?
hasDefaultTranslator() : bool
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::hasDefaultTranslator() |
Returns
bool
Does this validator have its own specific translator?
hasTranslator() : bool
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::hasTranslator() |
Returns
bool
Is translation enabled?
isTranslatorEnabled() : bool
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::isTranslatorEnabled() |
Returns
bool
Returns true if and only if $value is contained in the haystack option.
isValid(mixed $value) : bool
If the strict
option is true, then the type of $value is also checked.
Parameters
$value
mixedSee {@link http://php.net/manual/function.in-array.php#104501}
Exceptions
Returns
bool
Retrieve flag indicating whether or not value should be obfuscated in
messages
isValueObscured() : bool
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::isValueObscured() |
Returns
bool
Set default translation object for all validate objects
setDefaultTranslator(\Zend\Validator\Translator\TranslatorInterface $translator, string $textDomain) : void
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setDefaultTranslator() |
Parameters
$textDomain
string(optional)
Exceptions
Set default translation text domain for all validate objects
setDefaultTranslatorTextDomain(string $textDomain) : void
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setDefaultTranslatorTextDomain() |
Parameters
$textDomain
string
Sets the validation failure message template for a particular key
setMessage(string $messageString, string $messageKey) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setMessage() |
Parameters
$messageString
string
$messageKey
stringOPTIONAL
Exceptions
Returns
Sets the maximum allowed message length
setMessageLength(int $length)
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setMessageLength() |
Parameters
$length
int
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
| inherited_from |
\Zend\Validator\AbstractValidator::setMessages() |
Parameters
$messages
array
Returns
Sets one or multiple options
setOptions(array | \Traversable $options) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setOptions() |
Parameters
$options
array\TraversableOptions to set
Exceptions
Returns
Sets the recursive option
setRecursive(bool $recursive) : \Zend\Validator\InArray
Parameters
$recursive
bool
Returns
Sets the strict option mode
InArray::CHECK_STRICT | InArray::CHECK_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILITY | InArray::CHECK_NOT_STRICT
setStrict(int $strict) : \Zend\Validator\InArray
Parameters
$strict
int
Exceptions
Returns
Set translation object
setTranslator(\Zend\Validator\Translator\TranslatorInterface $translator, string $textDomain) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setTranslator() |
Parameters
$textDomain
string(optional)
Exceptions
Returns
Indicate whether or not translation should be enabled
setTranslatorEnabled(bool $flag) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setTranslatorEnabled() |
Parameters
$flag
bool
Returns
Set translation text domain
setTranslatorTextDomain(string $textDomain) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setTranslatorTextDomain() |
Parameters
$textDomain
string
Returns
Set flag indicating whether or not value should be obfuscated in messages
setValueObscured(bool $flag) : \Zend\Validator\AbstractValidator
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setValueObscured() |
Parameters
$flag
bool
Returns
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.
| inherited_from |
\Zend\Validator\AbstractValidator::createMessage() |
Parameters
$messageKey
string
$value
stringarrayobject
Returns
string
error()
error(string $messageKey, string $value) : void
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::error() |
Parameters
$messageKey
string
Returns the validation value
getValue() : mixed
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::getValue() |
Returns
mixedValue to be validated
Sets the value to be validated and clears the messages and errors arrays
setValue(mixed $value) : void
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::setValue() |
Parameters
$value
mixed
Translate a validation message
translateMessage(string $messageKey, string $message) : string
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::translateMessage() |
Parameters
$messageKey
string
$message
string
Returns
string
Properties
$abstractOptions
$abstractOptions
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::$$abstractOptions |
Default text domain to be used with translator
$defaultTranslatorTextDomain : string
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::$$defaultTranslatorTextDomain |
Haystack of possible values
$haystack : array
Limits the maximum returned length of a error message
$messageLength : int
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::$$messageLength |
$messageTemplates
$messageTemplates : array
Whether a recursive search should be done
$recursive : bool
Type of strict check to be used.
$strict : int
Due to "foo" == 0 === TRUE with in_array when strict = false,
an option has been added to prevent this. When $strict = 0/false, the most
secure non-strict check is implemented. if $strict = -1, the default in_array non-strict
behaviour is used
The value to be validated
$value : mixed
Inherited
| inherited_from |
\Zend\Validator\AbstractValidator::$$value |
Constants
Standard non-strict check where "asdf" == 0 returns TRUE
This will be wanted when comparing "0" against int 0
COMPARE_NOT_STRICT
Non strict check but prevents "asdf" == 0 returning TRUE causing false/positive.
COMPARE_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILITY
This is the most secure option for non-strict checks and replaces strict = false
This will only be effective when the input is a string
standard in_array strict checking value and type
COMPARE_STRICT
NOT_IN_ARRAY
NOT_IN_ARRAY