Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Zend_Validate_Abstract Class Reference

Public Member Functions

 getMessages ()
 Returns array of validation failure messages.
 
 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.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Static Public Member Functions

static setDefaultTranslator ($translator=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 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)
 
 _setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 

Protected Attributes

 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Static Protected Attributes

static $_defaultTranslator
 
static $_messageLength = -1
 

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
Zend_Validate_Exception
See Also
Zend_Validate_Exception
_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$value
Returns
string
_error (   $messageKey,
  $value = null 
)
protected
Parameters
string$messageKey
string$valueOPTIONAL
Returns
void
_setValue (   $value)
protected

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

Parameters
mixed$value
Returns
void
static getDefaultTranslator ( )
static

Get default translation object for all validate objects.

Returns
Zend_Translate_Adapter|null
getErrors ( )

Returns array of validation failure message codes.

Returns
array
Deprecated:
Since 1.5.0
static getMessageLength ( )
static

Returns the maximum allowed message length.

Returns
integer
getMessages ( )

Returns array of validation failure messages.

Returns
array

Implements Zend_Validate_Interface.

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
getObscureValue ( )

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

Returns
bool
getTranslator ( )

Return translation object.

Returns
Zend_Translate_Adapter|null
static hasDefaultTranslator ( )
static

Is there a default translation object set?

Returns
boolean
hasTranslator ( )

Does this validator have its own specific translator?

Returns
bool
static setDefaultTranslator (   $translator = null)
static

Set default translation object for all validate objects.

Parameters
Zend_Translate | Zend_Translate_Adapter | null$translator
Returns
void
setDisableTranslator (   $flag)

Indicate whether or not translation should be disabled.

Parameters
bool$flag
Returns
Zend_Validate_Abstract
setMessage (   $messageString,
  $messageKey = null 
)

Sets the validation failure message template for a particular key.

Parameters
string$messageString
string$messageKeyOPTIONAL
Returns
Zend_Validate_Abstract Provides a fluent interface
Exceptions
Zend_Validate_Exception
static setMessageLength (   $length = -1)
static

Sets the maximum allowed message length.

Parameters
integer$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
Zend_Validate_Abstract
setObscureValue (   $flag)

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

Parameters
bool$flag
Returns
Zend_Validate_Abstract
setTranslator (   $translator = null)

Set translation object.

Parameters
Zend_Translate | Zend_Translate_Adapter | null$translator
Returns
Zend_Validate_Abstract
translatorIsDisabled ( )

Is translation disabled?

Returns
bool

Member Data Documentation

$_defaultTranslator
staticprotected
$_errors = array()
protected
$_messageLength = -1
staticprotected
$_messages = array()
protected
$_messageTemplates = array()
protected
$_messageVariables = array()
protected
$_obscureValue = false
protected
$_translator
protected
$_translatorDisabled = false
protected
$_value
protected