Zend Framework  3.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
AbstractValidator Class Reference

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
 

Constructor & Destructor Documentation

__construct (   $options = null)

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)
Parameters
array | Traversable$options

Member Function Documentation

__get (   $property)

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

Parameters
string$property
Returns
mixed
Exceptions
Exception\InvalidArgumentException
__invoke (   $value)

Invoke as command.

Parameters
mixed$value
Returns
bool
createMessage (   $messageKey,
  $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.

Parameters
string$messageKey
string | array | object$value
Returns
string
error (   $messageKey,
  $value = null 
)
protected
Parameters
string$messageKey
string$valueOPTIONAL
Returns
void
static getDefaultTranslator ( )
static

Get default translation object for all validate objects.

Returns
Translator|null
static getDefaultTranslatorTextDomain ( )
static

Get default translation text domain for all validate objects.

Returns
string
static getMessageLength ( )
static

Returns the maximum allowed message length.

Returns
int
getMessages ( )

Returns array of validation failure messages.

Returns
array

Implements ValidatorInterface.

getMessageTemplates ( )

Returns the message templates from the validator.

Returns
array
getMessageVariables ( )

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

Returns
array
getOption (   $option)

Returns an option.

Parameters
string$optionOption to be returned
Returns
mixed Returned option
Exceptions
Exception\InvalidArgumentException
getOptions ( )

Returns all available options.

Returns
array Array with all available options
getTranslator ( )

Return translation object.

Returns
Translator|null

Implements TranslatorAwareInterface.

getTranslatorTextDomain ( )

Return the translation text domain.

Returns
string

Implements TranslatorAwareInterface.

getValue ( )
protected

Returns the validation value.

Returns
mixed Value to be validated
static hasDefaultTranslator ( )
static

Is there a default translation object set?

Returns
bool
hasTranslator ( )

Does this validator have its own specific translator?

Returns
bool

Implements TranslatorAwareInterface.

isTranslatorEnabled ( )

Is translation enabled?

Returns
bool

Implements TranslatorAwareInterface.

isValueObscured ( )

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

Returns
bool
static setDefaultTranslator ( Translator\TranslatorInterface  $translator = null,
  $textDomain = null 
)
static

Set default translation object for all validate objects.

Parameters
Translator\TranslatorInterface | null$translator
string$textDomain(optional)
Returns
void
Exceptions
Exception\InvalidArgumentException
static setDefaultTranslatorTextDomain (   $textDomain = 'default')
static

Set default translation text domain for all validate objects.

Parameters
string$textDomain
Returns
void
setMessage (   $messageString,
  $messageKey = null 
)

Sets the validation failure message template for a particular key.

Parameters
string$messageString
string$messageKeyOPTIONAL
Returns
AbstractValidator Provides a fluent interface
Exceptions
Exception\InvalidArgumentException
static setMessageLength (   $length = -1)
static

Sets the maximum allowed message length.

Parameters
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.

Parameters
array$messages
Returns
AbstractValidator
setOptions (   $options = [])

Sets one or multiple options.

Parameters
array | Traversable$optionsOptions to set
Exceptions
Exception\InvalidArgumentExceptionIf $options is not an array or Traversable
Returns
AbstractValidator Provides fluid interface
setTranslator ( Translator\TranslatorInterface  $translator = null,
  $textDomain = null 
)

Set translation object.

Parameters
Translator\TranslatorInterface | null$translator
string$textDomain(optional)
Returns
AbstractValidator
Exceptions
Exception\InvalidArgumentException
setTranslatorEnabled (   $flag = true)

Indicate whether or not translation should be enabled.

Parameters
bool$flag
Returns
AbstractValidator

Implements TranslatorAwareInterface.

setTranslatorTextDomain (   $textDomain = 'default')

Set translation text domain.

Parameters
string$textDomain
Returns
AbstractValidator

Implements TranslatorAwareInterface.

setValue (   $value)
protected

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

Parameters
mixed$value
Returns
void
setValueObscured (   $flag)

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

Parameters
bool$flag
Returns
AbstractValidator
translateMessage (   $messageKey,
  $message 
)
protected

Translate a validation message.

Parameters
string$messageKey
string$message
Returns
string

Member Data Documentation

$abstractOptions
protected
Initial value:
= [
'messages' => []
$defaultTranslator
staticprotected
$defaultTranslatorTextDomain = 'default'
staticprotected
$messageLength = -1
staticprotected
$value
protected