Validate/Identical.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Validate
- Version
- $Id: Identical.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Validate_Identical
- Parent(s)
- \Zend_Validate_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


\Zend_Translate $_defaultTranslator
- Type
- \Zend_Translate
- Inherited_from
- \Zend_Validate_Abstract::$$_defaultTranslator


array $_errors = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Validate_Abstract::$$_errors


Integer $_messageLength = -1
-1
Details- Type
- Integer
- Inherited_from
- \Zend_Validate_Abstract::$$_messageLength


array $_messageTemplates = array(self::NOT_SAME => "The two given tokens do not match", self::MISSING_TOKEN => 'No token was provided to match against')
array(self::NOT_SAME => "The two given tokens do not match", self::MISSING_TOKEN => 'No token was provided to match against')
Details- Type
- array


array $_messageVariables = array('token' => '_tokenString')
array('token' => '_tokenString')
Details- Type
- array


array $_messages = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Validate_Abstract::$$_messages


bool $_obscureValue = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Validate_Abstract::$$_obscureValue


\Zend_Translate $_translator
- Type
- \Zend_Translate
- Inherited_from
- \Zend_Validate_Abstract::$$_translator


Boolean $_translatorDisabled = false
false
Details- Type
- Boolean
- Inherited_from
- \Zend_Validate_Abstract::$$_translatorDisabled
Methods


__construct(mixed $token = null) : void
Sets validator options
Name | Type | Description |
---|---|---|
$token | mixed |


__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.
Inherited from: \Zend_Validate_Abstract::__get()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.
Inherited from: \Zend_Validate_Abstract::_createMessage()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
Inherited from: \Zend_Validate_Abstract::_setValue()Name | Type | Description |
---|---|---|
$value | mixed |


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


getErrors() : array
Returns array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::getErrors()Type | Description |
---|---|
array |


getMessageLength() : integer
Returns the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::getMessageLength()Type | Description |
---|---|
integer |


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


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


getMessages() : array
Returns array of validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessages()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.
Type | Description |
---|---|
array |


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


getTranslator() : \Zend_Translate_Adapter | null
Type | Description |
---|---|
\Zend_Translate_Adapter | null |


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


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


isValid(mixed $value, array $context = null) : boolean
Defined by Zend_Validate_Interface
Returns true if and only if a token has been set and the provided value matches that token.
Name | Type | Description |
---|---|---|
$value | mixed | |
$context | array |
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
Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate | \Zend_Translate_Adapter | null |


setDisableTranslator(bool $flag) : \Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Inherited from: \Zend_Validate_Abstract::setDisableTranslator()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
Inherited from: \Zend_Validate_Abstract::setMessage()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 = -1) : void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::setMessageLength()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.
Inherited from: \Zend_Validate_Abstract::setMessages()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
Inherited from: \Zend_Validate_Abstract::setObscureValue()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setStrict(\Zend_Validate_Identical $strict) : void
Sets the strict parameter
Name | Type | Description |
---|---|---|
$strict | \Zend_Validate_Identical |


setToken(mixed $token) : \Zend_Validate_Identical
Set token against which to compare
Name | Type | Description |
---|---|---|
$token | mixed |
Type | Description |
---|---|
\Zend_Validate_Identical |


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