Validate/Db/Abstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Validate_Db_Abstract

Package: Zend\Validate
Class for Database record validation
Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Validate_Db_NoRecordExists
\Zend_Validate_Db_RecordExists
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Validate_Abstract  

Constants

>VConstant  ERROR_NO_RECORD_FOUND = 'noRecordFound'
Error constants
>VConstant  ERROR_RECORD_FOUND = 'recordFound'

Properties

>VPropertyprotected\unknown_type $_adapter = null
Database adapter to use.

If null isValid() will use Zend_Db::getInstance instead

Default valuenullDetails
Type
\unknown_type
>VPropertyprotected\Zend_Translate $_defaultTranslator
staticinherited
Default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator
>VPropertyprotectedarray $_errors = array()
inherited
Array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::$$_errors
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_errors  
>VPropertyprotectedmixed $_exclude = null
Default valuenullDetails
Type
mixed
>VPropertyprotectedstring $_field = ''
Default value''Details
Type
string
>VPropertyprotectedInteger $_messageLength = -1
staticinherited
Limits the maximum returned length of a error message
Inherited from: \Zend_Validate_Abstract::$$_messageLength
Default value-1Details
Type
Integer
Inherited_from
\Zend_Validate_Abstract::$$_messageLength  
>VPropertyprotectedarray $_messageTemplates = array(self::ERROR_NO_RECORD_FOUND => "No record matching '%value%' was found", self::ERROR_RECORD_FOUND => "A record matching '%value%' was found")
Validation failure message template definitions
Default valuearray(self::ERROR_NO_RECORD_FOUND => "No record matching '%value%' was found", self::ERROR_RECORD_FOUND => "A record matching '%value%' was found")Details
Type
array
>VPropertyprotectedarray $_messageVariables = array()
inherited
Additional variables available for validation failure messages
Inherited from: \Zend_Validate_Abstract::$$_messageVariables
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_messageVariables  
>VPropertyprotectedarray $_messages = array()
inherited
Array of validation failure messages
Inherited from: \Zend_Validate_Abstract::$$_messages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_messages  
>VPropertyprotectedbool $_obscureValue = false
inherited
Flag indidcating whether or not value should be obfuscated in error messages
Inherited from: \Zend_Validate_Abstract::$$_obscureValue
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Validate_Abstract::$$_obscureValue  
>VPropertyprotectedstring $_schema = null
Default valuenullDetails
Type
string
>VPropertyprotected\Zend_Db_Select $_select
Select object to use.

can be set, or will be auto-generated

Details
Type
\Zend_Db_Select
>VPropertyprotectedstring $_table = ''
Default value''Details
Type
string
>VPropertyprotected\Zend_Translate $_translator
inherited
Translation object
Inherited from: \Zend_Validate_Abstract::$$_translator
>VPropertyprotectedBoolean $_translatorDisabled = false
inherited
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled
Default valuefalseDetails
Type
Boolean
Inherited_from
\Zend_Validate_Abstract::$$_translatorDisabled  
>VPropertyprotectedmixed $_value
inherited
The value to be validated
Inherited from: \Zend_Validate_Abstract::$$_value
Details
Type
mixed
Inherited_from
\Zend_Validate_Abstract::$$_value  

Methods

methodpublic__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

Parameters
NameTypeDescription
$optionsarray | \Zend_Config

Options to use for this validator

methodpublic__get(string $property) : mixed
inherited

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()
Parameters
NameTypeDescription
$propertystring
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Validate_Exception
methodprotected_createMessage(string $messageKey, string $value) : string
inherited

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.

Parameters
NameTypeDescription
$messageKeystring
$valuestring
Returns
TypeDescription
string
methodprotected_error(string $messageKey, string $value = null) : void
inherited

Inherited from: \Zend_Validate_Abstract::_error()
Parameters
NameTypeDescription
$messageKeystring
$valuestring

OPTIONAL

methodprotected_query(String $value) : Array

Run query and returns matches, or null if no matches are found.

Parameters
NameTypeDescription
$valueString
Returns
TypeDescription
Arraywhen matches are found.
methodprotected_setValue(mixed $value) : void
inherited

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

Inherited from: \Zend_Validate_Abstract::_setValue()
Parameters
NameTypeDescription
$valuemixed
methodpublicgetAdapter() : \Zend_Db_Adapter

Returns the set adapter

Returns
TypeDescription
\Zend_Db_Adapter
methodpublicgetDefaultTranslator() : \Zend_Translate_Adapter | null
staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublicgetErrors() : array
inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()
Returns
TypeDescription
array
methodpublicgetExclude() : string | array

Returns the set exclude clause

Returns
TypeDescription
string | array
methodpublicgetField() : string | array

Returns the set field

Returns
TypeDescription
string | array
methodpublicgetMessageLength() : integer
staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()
Returns
TypeDescription
integer
methodpublicgetMessageTemplates() : array
inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()
Returns
TypeDescription
array
methodpublicgetMessageVariables() : array
inherited

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessageVariables()
Returns
TypeDescription
array
methodpublicgetMessages() : array
inherited

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.

Returns
TypeDescription
array
methodpublicgetObscureValue() : bool
inherited

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

Inherited from: \Zend_Validate_Abstract::getObscureValue()
Returns
TypeDescription
bool
methodpublicgetSchema() : string

Returns the set schema

Returns
TypeDescription
string
methodpublicgetSelect() : \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.

Returns
TypeDescription
\Zend_Db_SelectThe Select object which will be used
methodpublicgetTable() : string

Returns the set table

Returns
TypeDescription
string
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublichasDefaultTranslator() : boolean
staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
TypeDescription
boolean
methodpublichasTranslator() : bool
inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()
Returns
TypeDescription
bool
methodpublicisValid(mixed $value) : boolean
inherited

Returns true if and only if $value meets the validation requirements

Inherited from: \Zend_Validate_Interface::isValid()\Zend_Validate_Abstract::isValid()

If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicsetAdapter(\Zend_Db_Adapter_Abstract $adapter) : \Zend_Validate_Db_Abstract

Sets a new database adapter

Parameters
NameTypeDescription
$adapter\Zend_Db_Adapter_Abstract
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void
staticinherited

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
methodpublicsetDisableTranslator(bool $flag) : \Zend_Validate_Abstract
inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetExclude(string | array $exclude) : \Zend_Validate_Db_Abstract

Sets a new exclude clause

Parameters
NameTypeDescription
$excludestring | array
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetField(string $field) : \Zend_Validate_Db_Abstract

Sets a new field

Parameters
NameTypeDescription
$fieldstring
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
inherited

Sets the validation failure message template for a particular key

Inherited from: \Zend_Validate_Abstract::setMessage()
Parameters
NameTypeDescription
$messageStringstring
$messageKeystring

OPTIONAL

Returns
TypeDescription
\Zend_Validate_AbstractProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_Exception
methodpublicsetMessageLength(integer $length = -1) : void
staticinherited

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()
Parameters
NameTypeDescription
$lengthinteger
methodpublicsetMessages(array $messages) : \Zend_Validate_Abstract
inherited

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()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetObscureValue(bool $flag) : \Zend_Validate_Abstract
inherited

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

Inherited from: \Zend_Validate_Abstract::setObscureValue()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetSchema(string $schema) : \Zend_Validate_Db_Abstract

Sets a new schema

Parameters
NameTypeDescription
$schemastring
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetSelect(\Zend_Db_Select $select) : \Zend_Validate_Db_Abstract

Sets the select object to be used by the validator

Parameters
NameTypeDescription
$select\Zend_Db_Select
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetTable(string $table) : \Zend_Validate_Db_Abstract

Sets a new table

Parameters
NameTypeDescription
$tablestring
Returns
TypeDescription
\Zend_Validate_Db_Abstract
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract
inherited

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublictranslatorIsDisabled() : bool
inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.