Zend_Validate_Db_Abstract Class Reference

Inheritance diagram for Zend_Validate_Db_Abstract:

Public Member Functions
	__construct ($options)
	getAdapter ()
	setAdapter ($adapter)
	getExclude ()
	setExclude ($exclude)
	getField ()
	setField ($field)
	getTable ()
	setTable ($table)
	getSchema ()
	setSchema ($schema)
	setSelect ($select)
	getSelect ()
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)

Data Fields
const	ERROR_NO_RECORD_FOUND = 'noRecordFound'
const	ERROR_RECORD_FOUND = 'recordFound'

Protected Member Functions
	_query ($value)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

Protected Attributes
	$_messageTemplates
	$_schema = null
	$_table = ''
	$_field = ''
	$_exclude = null
	$_adapter = null
	$_select
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 36 of file Abstract.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

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

array | Zend_Config

$options

Options to use for this validator

Exceptions

Zend_Validate_Exception

Definition at line 102 of file Abstract.php.

    {
        if ($options instanceof Zend_Db_Select) {
            $this->setSelect($options);
            return;
        }
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (func_num_args() > 1) {
            $options       = func_get_args();
            $temp['table'] = array_shift($options);
            $temp['field'] = array_shift($options);
            if (!empty($options)) {
                $temp['exclude'] = array_shift($options);
            }

            if (!empty($options)) {
                $temp['adapter'] = array_shift($options);
            }

            $options = $temp;
        }

        if (!array_key_exists('table', $options) && !array_key_exists('schema', $options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Table or Schema option missing!');
        }

        if (!array_key_exists('field', $options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Field option missing!');
        }

        if (array_key_exists('adapter', $options)) {
            $this->setAdapter($options['adapter']);
        }

        if (array_key_exists('exclude', $options)) {
            $this->setExclude($options['exclude']);
        }

        $this->setField($options['field']);
        if (array_key_exists('table', $options)) {
            $this->setTable($options['table']);
        }

        if (array_key_exists('schema', $options)) {
            $this->setSchema($options['schema']);
        }
    }

Member Function Documentation

_query()

_query (   $value )

protected

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

Parameters

String

$value

Returns

Array when matches are found.

Run query

Definition at line 341 of file Abstract.php.

    {
        $select = $this->getSelect();
        $result = $select->getAdapter()->fetchRow(
            $select,
            array('value' => $value), // this should work whether db supports positional or named params
            Zend_Db::FETCH_ASSOC
            );

        return $result;
    }

getAdapter()

getAdapter

(

)

Returns the set adapter

Exceptions

Zend_Validate_Exception

Returns

Zend_Db_Adapter

Check for an adapter being defined. if not, fetch the default adapter.

Definition at line 159 of file Abstract.php.

    {
        if ($this->_adapter === null) {
            $this->_adapter = Zend_Db_Table_Abstract::getDefaultAdapter();
            if (null === $this->_adapter) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception('No database adapter present');
            }
        }
        return $this->_adapter;
    }

getExclude()

getExclude

(

)

Returns the set exclude clause

Returns

string|array

Definition at line 197 of file Abstract.php.

    {
        return $this->_exclude;
    }

getField()

getField

(

)

Returns the set field

Returns

string|array

Definition at line 219 of file Abstract.php.

    {
        return $this->_field;
    }

getSchema()

getSchema

(

)

Returns the set schema

Returns

string

Definition at line 263 of file Abstract.php.

    {
        return $this->_schema;
    }

getSelect()

getSelect

(

)

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

Zend_Db_Select The Select object which will be used

Build select object

Definition at line 305 of file Abstract.php.

    {
        if (null === $this->_select) {
            $db = $this->getAdapter();
            $select = new Zend_Db_Select($db);
            $select->from($this->_table, array($this->_field), $this->_schema);
            if ($db->supportsParameters('named')) {
                $select->where($db->quoteIdentifier($this->_field, true).' = :value'); // named
            } else {
                $select->where($db->quoteIdentifier($this->_field, true).' = ?'); // positional
            }
            if ($this->_exclude !== null) {
                if (is_array($this->_exclude)) {
                    $select->where(
                          $db->quoteIdentifier($this->_exclude['field'], true) .
                            ' != ?', $this->_exclude['value']
                    );
                } else {
                    $select->where($this->_exclude);
                }
            }
            $select->limit(1);
            $this->_select = $select;
        }
        return $this->_select;
    }

getTable()

getTable

(

)

Returns the set table

Returns

string

Definition at line 241 of file Abstract.php.

    {
        return $this->_table;
    }

setAdapter()

setAdapter

(

$adapter

)

Sets a new database adapter

Parameters

Zend_Db_Adapter_Abstract

$adapter

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_Db_Abstract

Definition at line 181 of file Abstract.php.

    {
        if (!($adapter instanceof Zend_Db_Adapter_Abstract)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Adapter option must be a database adapter!');
        }

        $this->_adapter = $adapter;
        return $this;
    }

setExclude()

setExclude

(

$exclude

)

Sets a new exclude clause

Parameters

string | array

$exclude

Returns

Zend_Validate_Db_Abstract

Definition at line 208 of file Abstract.php.

    {
        $this->_exclude = $exclude;
        return $this;
    }

setField()

setField

(

$field

)

Sets a new field

Parameters

string

$field

Returns

Zend_Validate_Db_Abstract

Definition at line 230 of file Abstract.php.

    {
        $this->_field = (string) $field;
        return $this;
    }

setSchema()

setSchema

(

$schema

)

Sets a new schema

Parameters

string

$schema

Returns

Zend_Validate_Db_Abstract

Definition at line 274 of file Abstract.php.

    {
        $this->_schema = $schema;
        return $this;
    }

setSelect()

setSelect

(

$select

)

Sets the select object to be used by the validator

Parameters

Zend_Db_Select

$select

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_Db_Abstract

Definition at line 287 of file Abstract.php.

    {
        if (!$select instanceof Zend_Db_Select) {
            throw new Zend_Validate_Exception('Select option must be a valid ' .
                                              'Zend_Db_Select object');
        }
        $this->_select = $select;
        return $this;
    }

setTable()

setTable

(

$table

)

Sets a new table

Parameters

string

$table

Returns

Zend_Validate_Db_Abstract

Definition at line 252 of file Abstract.php.

    {
        $this->_table = (string) $table;
        return $this;
    }

Field Documentation

$_adapter

$_adapter = null

protected

Definition at line 77 of file Abstract.php.

$_exclude

$_exclude = null

protected

Definition at line 70 of file Abstract.php.

$_field

$_field = ''

protected

Definition at line 65 of file Abstract.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::ERROR_NO_RECORD_FOUND => "No record matching '%value%' was found",
        self::ERROR_RECORD_FOUND    => "A record matching '%value%' was found",
    )

Definition at line 47 of file Abstract.php.

$_schema

$_schema = null

protected

Definition at line 55 of file Abstract.php.

$_select

$_select

protected

Definition at line 83 of file Abstract.php.

$_table

$_table = ''

protected

Definition at line 60 of file Abstract.php.

ERROR_NO_RECORD_FOUND

const ERROR_NO_RECORD_FOUND = 'noRecordFound'

Error constants

Definition at line 41 of file Abstract.php.

ERROR_RECORD_FOUND

const ERROR_RECORD_FOUND = 'recordFound'

Definition at line 42 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/Db/Abstract.php