Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

\Zend_Translate $_defaultTranslator=
''
Default translation object for all validate objects

array $_errors=
'array'
Array of validation failure message codes
array
Details

Integer $_messageLength=
''
Limits the maximum returned length of a error message

array $_messageTemplates=
'array'
Validation failure message template definitions
array
Details

array $_messageVariables=
'array'
Additional variables available for validation failure messages
array
Details

bool $_obscureValue=
'false'
Flag indidcating whether or not value should be obfuscated in error messages
false
Details

Boolean $_translatorDisabled=
'false'
Is translation disabled?
false
Details

__get( string $property ) : mixed
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Validate_Exception |

_createMessage( string $messageKey, string $value ) :
string
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.
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string |
Type | Description |
---|---|
string |

_error( string $messageKey, string $value = null
) : void
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string | OPTIONAL |

_setValue( mixed $value ) : void
Sets the value to be validated and clears the messages and errors arrays
Name | Type | Description |
---|---|---|
$value | mixed |

getDefaultTranslator( ) : \Zend_Translate_Adapter|null
Get default translation object for all validate objects
Type | Description |
---|---|
\Zend_Translate_Adapternull |

getErrors( ) : array
Returns array of validation failure message codes
Type | Description |
---|---|
array |

getMessageLength( ) : integer
Returns the maximum allowed message length
Type | Description |
---|---|
integer |

getMessageTemplates( ) : array
Returns the message templates from the validator
Type | Description |
---|---|
array |

getMessageVariables( ) : array
Returns an array of the names of variables that are used in constructing validation failure messages
Type | Description |
---|---|
array |

getMessages( ) : array
Returns array of validation failure messages
If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
Type | Description |
---|---|
array |

getObscureValue( ) : bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Type | Description |
---|---|
bool |

getTranslator( ) : \Zend_Translate_Adapter|null
Return translation object
Type | Description |
---|---|
\Zend_Translate_Adapternull |

hasDefaultTranslator( ) : boolean
Is there a default translation object set?
Type | Description |
---|---|
boolean |

hasTranslator( ) : bool
Does this validator have its own specific translator?
Type | Description |
---|---|
bool |

isValid( mixed $value ) : boolean
Returns true if and only if $value meets the validation requirements
Inherited from: \Zend_Validate_Interface::isValid()If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.
Name | Type | Description |
---|---|---|
$value | mixed |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |

setDefaultTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) :
void
Set default translation object for all validate objects
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |

setDisableTranslator( bool $flag ) : \Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setMessage( string $messageString,
string $messageKey = null ) : \Zend_Validate_Abstract
Sets the validation failure message template for a particular key
Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Type | Description |
---|---|
\Zend_Validate_Abstract | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception |

setMessageLength( integer $length ) : void
Sets the maximum allowed message length
Name | Type | Description |
---|---|---|
$length | integer |

setMessages( array $messages ) : \Zend_Validate_Abstract
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.
Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setObscureValue( bool $flag ) : \Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Validate_Abstract
Set translation object
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Validate_Abstract |