Validate/Db/NoRecordExists.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: NoRecordExists.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Validate_Db_NoRecordExists
- Parent(s)
- \Zend_Validate_Db_Abstract < \Zend_Validate_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Validate_Db_Abstract
Constants

ERROR_NO_RECORD_FOUND
= 'noRecordFound'
- Inherited_from
- \Zend_Validate_Db_Abstract::ERROR_NO_RECORD_FOUND

ERROR_RECORD_FOUND
= 'recordFound'
- Inherited_from
- \Zend_Validate_Db_Abstract::ERROR_RECORD_FOUND
Properties


\unknown_type $_adapter = null
If null isValid() will use Zend_Db::getInstance instead
null
Details- Type
- \unknown_type
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_adapter


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


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


mixed $_exclude = null
null
Details- Type
- mixed
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_exclude


string $_field = ''
''
Details- Type
- string
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_field


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


array $_messageTemplates = array(self::ERROR_NO_RECORD_FOUND => "No record matching '%value%' was found", self::ERROR_RECORD_FOUND => "A record matching '%value%' was found")
array(self::ERROR_NO_RECORD_FOUND => "No record matching '%value%' was found", self::ERROR_RECORD_FOUND => "A record matching '%value%' was found")
Details- Type
- array
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_messageTemplates


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


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


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


string $_schema = null
null
Details- Type
- string
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_schema


\Zend_Db_Select $_select
can be set, or will be auto-generated
- Type
- \Zend_Db_Select
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_select


string $_table = ''
''
Details- Type
- string
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_table


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


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


mixed $_value
- Type
- mixed
- Inherited_from
- \Zend_Validate_Abstract::$$_value
- Inherited_from
- \Zend_Validate_Db_Abstract::$$_value
Methods


__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.
Inherited from: \Zend_Validate_Db_Abstract::__construct()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()\Zend_Validate_Db_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()\Zend_Validate_Db_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.
Inherited from: \Zend_Validate_Db_Abstract::_query()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()\Zend_Validate_Db_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()\Zend_Validate_Db_Abstract::getDefaultTranslator()Type | Description |
---|---|
\Zend_Translate_Adapter | null |


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


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


getMessageTemplates() : array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::getMessageTemplates()\Zend_Validate_Db_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()\Zend_Validate_Db_Abstract::getMessageVariables()Type | Description |
---|---|
array |


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


getSelect() : \Zend_Db_Select
Gets the select object to be used by the validator.
Inherited from: \Zend_Validate_Db_Abstract::getSelect()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()\Zend_Validate_Db_Abstract::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapter | null |


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


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


isValid(mixed $value) : boolean
Returns true if and only if $value meets the validation requirements
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
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()\Zend_Validate_Db_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()\Zend_Validate_Db_Abstract::setDisableTranslator()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setExclude(string | array $exclude) : \Zend_Validate_Db_Abstract
Name | Type | Description |
---|---|---|
$exclude | string | array |
Type | Description |
---|---|
\Zend_Validate_Db_Abstract |


setField(string $field) : \Zend_Validate_Db_Abstract
Name | Type | Description |
---|---|---|
$field | string |
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()\Zend_Validate_Db_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()\Zend_Validate_Db_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()\Zend_Validate_Db_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()\Zend_Validate_Db_Abstract::setObscureValue()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setSchema(string $schema) : \Zend_Validate_Db_Abstract
Name | Type | Description |
---|---|---|
$schema | string |
Type | Description |
---|---|
\Zend_Validate_Db_Abstract |


setSelect(\Zend_Db_Select $select) : \Zend_Validate_Db_Abstract
Sets the select object to be used by the validator
Inherited from: \Zend_Validate_Db_Abstract::setSelect()Name | Type | Description |
---|---|---|
$select | \Zend_Db_Select |
Type | Description |
---|---|
\Zend_Validate_Db_Abstract |


setTable(string $table) : \Zend_Validate_Db_Abstract
Name | Type | Description |
---|---|---|
$table | string |
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()\Zend_Validate_Db_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()\Zend_Validate_Db_Abstract::translatorIsDisabled()Type | Description |
---|---|
bool |