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.
Class for Database record validation

\unknown_type
$_adapter= 'null'
Database adapter to use. If null isValid() will use Zend_Db::getInstance instead
null
Details
array
$_messageTemplates= 'array'
Validation failure message template definitions
array
Details
\Zend_Db_Select
$_select= ''
Select object to use. can be set, or will be auto-generated

__construct(
array|\Zend_Config $options
)
:
void
Provides basic configuration for use with Zend_Validate_Db Validators Setting $exclude allows a single record to be excluded from matching.
Exclude can either be a String containing a where clause, or an array with field
and value
keys
to define the where clause added to the sql.
A database adapter may optionally be supplied to avoid using the registered default adapter.
The following option keys are supported: 'table' => The database table to validate against 'schema' => The schema keys 'field' => The field to check for a match 'exclude' => An optional where clause or field/value pair to exclude from the query 'adapter' => An optional database adapter to use
Name | Type | Description |
---|---|---|
$options | array|\Zend_Config | Options to use for this validator |

__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 |

_query(
String $value
)
:
Array
Run query and returns matches, or null if no matches are found.
Name | Type | Description |
---|---|---|
$value | String |
Type | Description |
---|---|
Array | when matches are found. |

_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_Adapternull |

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

getSelect(
)
:
\Zend_Db_Select
Gets the select object to be used by the validator.
If no select object was supplied to the constructor, then it will auto-generate one from the given table, schema, field, and adapter options.
Type | Description |
---|---|
\Zend_Db_Select | The Select object which will be used |

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

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
)
:
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 |

setAdapter(
\Zend_Db_Adapter_Abstract $adapter
)
:
\Zend_Validate_Db_Abstract
Sets a new database adapter
Name | Type | Description |
---|---|---|
$adapter | \Zend_Db_Adapter_Abstract |
Type | Description |
---|---|
\Zend_Validate_Db_Abstract |

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()
setExclude(
string|array $exclude
)
:
\Zend_Validate_Db_Abstract
Sets a new exclude clause
Name | Type | Description |
---|---|---|
$exclude | string|array |
Type | Description |
---|---|
\Zend_Validate_Db_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
)
:
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()
setObscureValue(
bool $flag
)
:
\Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::setObscureValue()
setSelect(
\Zend_Db_Select $select
)
:
\Zend_Validate_Db_Abstract
Sets the select object to be used by the validator
Name | Type | Description |
---|---|---|
$select | \Zend_Db_Select |
Type | Description |
---|---|
\Zend_Validate_Db_Abstract |

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

translatorIsDisabled(
)
:
bool
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()Type | Description |
---|---|
bool |