Inheritance diagram for Zend_Db_Adapter_Abstract:

Public Member Functions
	__construct ($config)

	getConnection ()

	getConfig ()

	setProfiler ($profiler)

	getProfiler ()

	getStatementClass ()

	setStatementClass ($class)

	query ($sql, $bind=array())

	beginTransaction ()

	commit ()

	rollBack ()

	insert ($table, array $bind)

	update ($table, array $bind, $where='')

	delete ($table, $where='')

	select ()

	getFetchMode ()

	fetchAll ($sql, $bind=array(), $fetchMode=null)

	fetchRow ($sql, $bind=array(), $fetchMode=null)

	fetchAssoc ($sql, $bind=array())

	fetchCol ($sql, $bind=array())

	fetchPairs ($sql, $bind=array())

	fetchOne ($sql, $bind=array())

	quote ($value, $type=null)

	quoteInto ($text, $value, $type=null, $count=null)

	quoteIdentifier ($ident, $auto=false)

	quoteColumnAs ($ident, $alias, $auto=false)

	quoteTableAs ($ident, $alias=null, $auto=false)

	getQuoteIdentifierSymbol ()

	lastSequenceId ($sequenceName)

	nextSequenceId ($sequenceName)

	foldCase ($key)

	__sleep ()

	__wakeup ()

	listTables ()

	describeTable ($tableName, $schemaName=null)

	isConnected ()

	closeConnection ()

	prepare ($sql)

	lastInsertId ($tableName=null, $primaryKey=null)

	setFetchMode ($mode)

	limit ($sql, $count, $offset=0)

	supportsParameters ($type)

	getServerVersion ()

Protected Member Functions
	_checkRequiredOptions (array $config)

	_whereExpr ($where)

	_quote ($value)

	_quoteIdentifierAs ($ident, $alias=null, $auto=false, $as=' AS ')

	_quoteIdentifier ($value, $auto=false)

	_connect ()

	_beginTransaction ()

	_commit ()

	_rollBack ()

Protected Attributes
	$_config = array()

	$_fetchMode = Zend_Db::FETCH_ASSOC

	$_profiler

	$_defaultStmtClass = 'Zend_Db_Statement'

	$_defaultProfilerClass = 'Zend_Db_Profiler'

	$_connection = null

	$_caseFolding = Zend_Db::CASE_NATURAL

	$_autoQuoteIdentifiers = true

	$_numericDataTypes

	$_allowSerialization = true

	$_autoReconnectOnUnserialize = false

Detailed Description

Definition at line 43 of file Abstract.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $config )

Constructor.

$config is an array of key/value pairs or an instance of Zend_Config containing configuration options. These options are common to most adapters:

dbname => (string) The name of the database to user username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to, defaults to localhost

Some options are used on a case-by-case basis by adapters:

port => (string) The port of the database persistent => (boolean) Whether to use a persistent connection or not, defaults to false protocol => (string) The network protocol, defaults to TCPIP caseFolding => (int) style of case-alteration used for identifiers socket => (string) The socket or named pipe that should be used

Parameters

array | Zend_Config $config An array or instance of Zend_Config having configuration data

Exceptions

Zend_Db_Adapter_Exception

See also: Zend_Db_Adapter_Exception; Zend_Db_Adapter_Exception

Definition at line 164 of file Abstract.php.

     {
         /*
          * Verify that adapter parameters are in an array.
          */
         if (!is_array($config)) {
             /*
              * Convert Zend_Config argument to a plain array.
              */
             if ($config instanceof Zend_Config) {
                 $config = $config->toArray();
             } else {
                 #require_once 'Zend/Db/Adapter/Exception.php';
                 throw new Zend_Db_Adapter_Exception('Adapter parameters must be in an array or a Zend_Config object');
             }
         }
 
         $this->_checkRequiredOptions($config);
 
         $options = array(
             Zend_Db::CASE_FOLDING           => $this->_caseFolding,
             Zend_Db::AUTO_QUOTE_IDENTIFIERS => $this->_autoQuoteIdentifiers,
             Zend_Db::FETCH_MODE             => $this->_fetchMode,
         );
         $driverOptions = array();
 
         /*
          * normalize the config and merge it with the defaults
          */
         if (array_key_exists('options', $config)) {
             // can't use array_merge() because keys might be integers
             foreach ((array) $config['options'] as $key => $value) {
                 $options[$key] = $value;
             }
         }
         if (array_key_exists('driver_options', $config)) {
             if (!empty($config['driver_options'])) {
                 // can't use array_merge() because keys might be integers
                 foreach ((array) $config['driver_options'] as $key => $value) {
                     $driverOptions[$key] = $value;
                 }
             }
         }
 
         if (!isset($config['charset'])) {
             $config['charset'] = null;
         }
 
         if (!isset($config['persistent'])) {
             $config['persistent'] = false;
         }
 
         $this->_config = array_merge($this->_config, $config);
         $this->_config['options'] = $options;
         $this->_config['driver_options'] = $driverOptions;
 
 
         // obtain the case setting, if there is one
         if (array_key_exists(Zend_Db::CASE_FOLDING, $options)) {
             $case = (int) $options[Zend_Db::CASE_FOLDING];
             switch ($case) {
                 case Zend_Db::CASE_LOWER:
                 case Zend_Db::CASE_UPPER:
                 case Zend_Db::CASE_NATURAL:
                     $this->_caseFolding = $case;
                     break;
                 default:
                     #require_once 'Zend/Db/Adapter/Exception.php';
                     throw new Zend_Db_Adapter_Exception('Case must be one of the following constants: '
                         . 'Zend_Db::CASE_NATURAL, Zend_Db::CASE_LOWER, Zend_Db::CASE_UPPER');
             }
         }
 
         if (array_key_exists(Zend_Db::FETCH_MODE, $options)) {
             if (is_string($options[Zend_Db::FETCH_MODE])) {
                 $constant = 'Zend_Db::FETCH_' . strtoupper($options[Zend_Db::FETCH_MODE]);
                 if(defined($constant)) {
                     $options[Zend_Db::FETCH_MODE] = constant($constant);
                 }
             }
             $this->setFetchMode((int) $options[Zend_Db::FETCH_MODE]);
         }
 
         // obtain quoting property if there is one
         if (array_key_exists(Zend_Db::AUTO_QUOTE_IDENTIFIERS, $options)) {
             $this->_autoQuoteIdentifiers = (bool) $options[Zend_Db::AUTO_QUOTE_IDENTIFIERS];
         }
 
         // obtain allow serialization property if there is one
         if (array_key_exists(Zend_Db::ALLOW_SERIALIZATION, $options)) {
             $this->_allowSerialization = (bool) $options[Zend_Db::ALLOW_SERIALIZATION];
         }
 
         // obtain auto reconnect on unserialize property if there is one
         if (array_key_exists(Zend_Db::AUTO_RECONNECT_ON_UNSERIALIZE, $options)) {
             $this->_autoReconnectOnUnserialize = (bool) $options[Zend_Db::AUTO_RECONNECT_ON_UNSERIALIZE];
         }
 
         // create a profiler object
         $profiler = false;
         if (array_key_exists(Zend_Db::PROFILER, $this->_config)) {
             $profiler = $this->_config[Zend_Db::PROFILER];
             unset($this->_config[Zend_Db::PROFILER]);
         }
         $this->setProfiler($profiler);
     }

Member Function Documentation

◆ __sleep()

__sleep ( )

called when object is getting serialized This disconnects the DB object that cant be serialized

Exceptions

Zend_Db_Adapter_Exception

Returns: array

See also: Zend_Db_Adapter_Exception

Definition at line 1119 of file Abstract.php.

     {
         if ($this->_allowSerialization == false) {
             #require_once 'Zend/Db/Adapter/Exception.php';
             throw new Zend_Db_Adapter_Exception(
                 get_class($this) . ' is not allowed to be serialized'
             );
         }
         $this->_connection = null;
 
         return array_keys(
             array_diff_key(get_object_vars($this), array('_connection' => null))
         );
     }

◆ __wakeup()

__wakeup ( )

called when object is getting unserialized

Returns: void

Definition at line 1140 of file Abstract.php.

     {
         if ($this->_autoReconnectOnUnserialize == true) {
             $this->getConnection();
         }
     }

◆ _beginTransaction()

_beginTransaction ( )

abstractprotected

Begin a transaction.

◆ _checkRequiredOptions()

_checkRequiredOptions ( array $config )

protected

Check for config options that are mandatory. Throw exceptions if any are missing.

Parameters

array $config

Exceptions

Zend_Db_Adapter_Exception

See also: Zend_Db_Adapter_Exception; Zend_Db_Adapter_Exception; Zend_Db_Adapter_Exception

Definition at line 282 of file Abstract.php.

     {
         // we need at least a dbname
         if (! array_key_exists('dbname', $config)) {
             #require_once 'Zend/Db/Adapter/Exception.php';
             throw new Zend_Db_Adapter_Exception("Configuration array must have a key for 'dbname' that names the database instance");
         }
 
         if (! array_key_exists('password', $config)) {
             #require_once 'Zend/Db/Adapter/Exception.php';
             throw new Zend_Db_Adapter_Exception("Configuration array must have a key for 'password' for login credentials");
         }
 
         if (! array_key_exists('username', $config)) {
             #require_once 'Zend/Db/Adapter/Exception.php';
             throw new Zend_Db_Adapter_Exception("Configuration array must have a key for 'username' for login credentials");
         }
     }

◆ _commit()

_commit ( )

abstractprotected

Commit a transaction.

◆ _connect()

_connect ( )

abstractprotected

Creates a connection to the database.

Returns: void

◆ _quote()

_quote ( $value )

protected

Quote a raw string.

Parameters

string $value Raw string

Returns: string Quoted string

Definition at line 839 of file Abstract.php.

     {
         if (is_int($value)) {
             return $value;
         } elseif (is_float($value)) {
             return sprintf('%F', $value);
         }
         return "'" . addcslashes($value, "\000\n\r\\'\"\032") . "'";
     }

◆ _quoteIdentifier()

_quoteIdentifier	(	$value,
		$auto = `false`
	)

protected

Quote an identifier.

Parameters

string	$value	The identifier or expression.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns: string The quoted identifier and alias.

Definition at line 1039 of file Abstract.php.

     {
         if ($auto === false || $this->_autoQuoteIdentifiers === true) {
             $q = $this->getQuoteIdentifierSymbol();
             return ($q . str_replace("$q", "$q$q", $value) . $q);
         }
         return $value;
     }

◆ _quoteIdentifierAs()

_quoteIdentifierAs	(	$ident,
		$alias = `null`,
		$auto = `false`,
		$as = `' AS '`
	)

protected

Quote an identifier and an optional alias.

Parameters

string \| array \| Zend_Db_Expr	$ident	The identifier or expression.
string	$alias	An optional alias.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.
string	$as	The string to add between the identifier/expression and the alias.

Returns: string The quoted identifier and alias.

Definition at line 999 of file Abstract.php.

     {
         if ($ident instanceof Zend_Db_Expr) {
             $quoted = $ident->__toString();
         } elseif ($ident instanceof Zend_Db_Select) {
             $quoted = '(' . $ident->assemble() . ')';
         } else {
             if (is_string($ident)) {
                 $ident = explode('.', $ident);
             }
             if (is_array($ident)) {
                 $segments = array();
                 foreach ($ident as $segment) {
                     if ($segment instanceof Zend_Db_Expr) {
                         $segments[] = $segment->__toString();
                     } else {
                         $segments[] = $this->_quoteIdentifier($segment, $auto);
                     }
                 }
                 if ($alias !== null && end($ident) == $alias) {
                     $alias = null;
                 }
                 $quoted = implode('.', $segments);
             } else {
                 $quoted = $this->_quoteIdentifier($ident, $auto);
             }
         }
         if ($alias !== null) {
             $quoted .= $as . $this->_quoteIdentifier($alias, $auto);
         }
         return $quoted;
     }

◆ _rollBack()

_rollBack ( )

abstractprotected

Roll-back a transaction.

◆ _whereExpr()

_whereExpr ( $where )

protected

Convert an array, string, or Zend_Db_Expr object into a string to put in a WHERE clause.

Parameters

mixed $where

Returns: string

Definition at line 676 of file Abstract.php.

     {
         if (empty($where)) {
             return $where;
         }
         if (!is_array($where)) {
             $where = array($where);
         }
         foreach ($where as $cond => &$term) {
             // is $cond an int? (i.e. Not a condition)
             if (is_int($cond)) {
                 // $term is the full condition
                 if ($term instanceof Zend_Db_Expr) {
                     $term = $term->__toString();
                 }
             } else {
                 // $cond is the condition with placeholder,
                 // and $term is quoted into the condition
                 $term = $this->quoteInto($cond, $term);
             }
             $term = '(' . $term . ')';
         }
 
         $where = implode(' AND ', $where);
         return $where;
     }

◆ beginTransaction()

beginTransaction ( )

Leave autocommit mode and begin a transaction.

Returns: Zend_Db_Adapter_Abstract

Definition at line 492 of file Abstract.php.

     {
         $this->_connect();
         $q = $this->_profiler->queryStart('begin', Zend_Db_Profiler::TRANSACTION);
         $this->_beginTransaction();
         $this->_profiler->queryEnd($q);
         return $this;
     }

◆ closeConnection()

closeConnection ( )

abstract

Force the connection to close.

Returns: void

◆ commit()

commit ( )

Commit a transaction and return to autocommit mode.

Returns: Zend_Db_Adapter_Abstract

Definition at line 506 of file Abstract.php.

     {
         $this->_connect();
         $q = $this->_profiler->queryStart('commit', Zend_Db_Profiler::TRANSACTION);
         $this->_commit();
         $this->_profiler->queryEnd($q);
         return $this;
     }

◆ delete()

delete	(	$table,
		$where = `''`
	)

Deletes table rows based on a WHERE clause.

Parameters

mixed	$table	The table to update.
mixed	$where	DELETE WHERE clause(s).

Returns: int The number of affected rows.

Build the DELETE statement

Execute the statement and return the number of affected rows

Definition at line 650 of file Abstract.php.

     {
         $where = $this->_whereExpr($where);
 
         $sql = "DELETE FROM "
              . $this->quoteIdentifier($table, true)
              . (($where) ? " WHERE $where" : '');
 
         $stmt = $this->query($sql);
         $result = $stmt->rowCount();
         return $result;
     }

◆ describeTable()

describeTable	(	$tableName,
		$schemaName = `null`
	)

abstract

Returns the column descriptions for a table.

The return value is an associative array keyed by the column name, as returned by the RDBMS.

The value of each array element is an associative array with the following keys:

SCHEMA_NAME => string; name of database or schema TABLE_NAME => string; COLUMN_NAME => string; column name COLUMN_POSITION => number; ordinal position of column in table DATA_TYPE => string; SQL datatype name of column DEFAULT => string; default expression of column, null if none NULLABLE => boolean; true if column can have nulls LENGTH => number; length of CHAR/VARCHAR SCALE => number; scale of NUMERIC/DECIMAL PRECISION => number; precision of NUMERIC/DECIMAL UNSIGNED => boolean; unsigned property of an integer type PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key

Parameters

string	$tableName
string	$schemaName	OPTIONAL

Returns: array

◆ fetchAll()

fetchAll	(	$sql,
		$bind = `array()`,
		$fetchMode = `null`
	)

Fetches all SQL result rows as a sequential array. Uses the current fetchMode for the adapter.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.
mixed	$fetchMode	Override current fetch mode.

Returns: array

Definition at line 732 of file Abstract.php.

     {
         if ($fetchMode === null) {
             $fetchMode = $this->_fetchMode;
         }
         $stmt = $this->query($sql, $bind);
         $result = $stmt->fetchAll($fetchMode);
         return $result;
     }

◆ fetchAssoc()

fetchAssoc	(	$sql,
		$bind = `array()`
	)

Fetches all SQL result rows as an associative array.

The first column is the key, the entire row array is the value. You should construct the query to be sure that the first column contains unique values, or else rows with duplicate values in the first column will overwrite previous data.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.

Returns: array

Definition at line 774 of file Abstract.php.

     {
         $stmt = $this->query($sql, $bind);
         $data = array();
         while ($row = $stmt->fetch(Zend_Db::FETCH_ASSOC)) {
             $tmp = array_values(array_slice($row, 0, 1));
             $data[$tmp[0]] = $row;
         }
         return $data;
     }

◆ fetchCol()

fetchCol	(	$sql,
		$bind = `array()`
	)

Fetches the first column of all SQL result rows as an array.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.

Returns: array

Definition at line 792 of file Abstract.php.

     {
         $stmt = $this->query($sql, $bind);
         $result = $stmt->fetchAll(Zend_Db::FETCH_COLUMN, 0);
         return $result;
     }

◆ fetchOne()

fetchOne	(	$sql,
		$bind = `array()`
	)

Fetches the first column of the first row of the SQL result.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.

Returns: string

Definition at line 826 of file Abstract.php.

     {
         $stmt = $this->query($sql, $bind);
         $result = $stmt->fetchColumn(0);
         return $result;
     }

◆ fetchPairs()

fetchPairs	(	$sql,
		$bind = `array()`
	)

Fetches all SQL result rows as an array of key-value pairs.

The first column is the key, the second column is the value.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.

Returns: array

Definition at line 809 of file Abstract.php.

     {
         $stmt = $this->query($sql, $bind);
         $data = array();
         while ($row = $stmt->fetch(Zend_Db::FETCH_NUM)) {
             $data[$row[0]] = $row[1];
         }
         return $data;
     }

◆ fetchRow()

fetchRow	(	$sql,
		$bind = `array()`,
		$fetchMode = `null`
	)

Fetches the first row of the SQL result. Uses the current fetchMode for the adapter.

Parameters

string \| Zend_Db_Select	$sql	An SQL SELECT statement.
mixed	$bind	Data to bind into SELECT placeholders.
mixed	$fetchMode	Override current fetch mode.

Returns: mixed Array, object, or scalar depending on fetch mode.

Definition at line 751 of file Abstract.php.

     {
         if ($fetchMode === null) {
             $fetchMode = $this->_fetchMode;
         }
         $stmt = $this->query($sql, $bind);
         $result = $stmt->fetch($fetchMode);
         return $result;
     }

◆ foldCase()

foldCase ( $key )

Helper method to change the case of the strings used when returning result sets in FETCH_ASSOC and FETCH_BOTH modes.

This is not intended to be used by application code, but the method must be public so the Statement class can invoke it.

Parameters

string $key

Returns: string

Definition at line 1096 of file Abstract.php.

     {
         switch ($this->_caseFolding) {
             case Zend_Db::CASE_LOWER:
                 $value = strtolower((string) $key);
                 break;
             case Zend_Db::CASE_UPPER:
                 $value = strtoupper((string) $key);
                 break;
             case Zend_Db::CASE_NATURAL:
             default:
                 $value = (string) $key;
         }
         return $value;
     }

◆ getConfig()

getConfig ( )

Returns the configuration variables in this adapter.

Returns: array

Definition at line 325 of file Abstract.php.

     {
         return $this->_config;
     }

◆ getConnection()

getConnection ( )

Returns the underlying database connection object or resource. If not presently connected, this initiates the connection.

Returns: object|resource|null

Definition at line 314 of file Abstract.php.

     {
         $this->_connect();
         return $this->_connection;
     }

◆ getFetchMode()

getFetchMode ( )

Get the fetch mode.

Returns: int

Definition at line 718 of file Abstract.php.

     {
         return $this->_fetchMode;
     }

◆ getProfiler()

getProfiler ( )

Returns the profiler for this adapter.

Returns: Zend_Db_Profiler

Definition at line 423 of file Abstract.php.

     {
         return $this->_profiler;
     }

◆ getQuoteIdentifierSymbol()

getQuoteIdentifierSymbol ( )

Returns the symbol the adapter uses for delimited identifiers.

Returns: string

Definition at line 1053 of file Abstract.php.

     {
         return '"';
     }

◆ getServerVersion()

getServerVersion ( )

abstract

Retrieve server version in PHP style

Returns: string

◆ getStatementClass()

getStatementClass ( )

Get the default statement class.

Returns: string

Definition at line 433 of file Abstract.php.

     {
         return $this->_defaultStmtClass;
     }

◆ insert()

insert	(		$table,
		array	$bind
	)

Inserts a table row with specified data.

Parameters

mixed	$table	The table to insert data into.
array	$bind	Column-value pairs.

Returns: int The number of affected rows.

Exceptions

Zend_Db_Adapter_Exception

See also: Zend_Db_Adapter_Exception

Definition at line 537 of file Abstract.php.

     {
         // extract and quote col names from the array keys
         $cols = array();
         $vals = array();
         $i = 0;
         foreach ($bind as $col => $val) {
             $cols[] = $this->quoteIdentifier($col, true);
             if ($val instanceof Zend_Db_Expr) {
                 $vals[] = $val->__toString();
                 unset($bind[$col]);
             } else {
                 if ($this->supportsParameters('positional')) {
                     $vals[] = '?';
                 } else {
                     if ($this->supportsParameters('named')) {
                         unset($bind[$col]);
                         $bind[':col'.$i] = $val;
                         $vals[] = ':col'.$i;
                         $i++;
                     } else {
                         #require_once 'Zend/Db/Adapter/Exception.php';
                         throw new Zend_Db_Adapter_Exception(get_class($this) ." doesn't support positional or named binding");
                     }
                 }
             }
         }
 
         // build the statement
         $sql = "INSERT INTO "
              . $this->quoteIdentifier($table, true)
              . ' (' . implode(', ', $cols) . ') '
              . 'VALUES (' . implode(', ', $vals) . ')';
 
         // execute the statement and return the number of affected rows
         if ($this->supportsParameters('positional')) {
             $bind = array_values($bind);
         }
         $stmt = $this->query($sql, $bind);
         $result = $stmt->rowCount();
         return $result;
     }

◆ isConnected()

isConnected ( )

abstract

Test if a connection is active

Returns: boolean

◆ lastInsertId()

lastInsertId	(	$tableName = `null`,
		$primaryKey = `null`
	)

abstract

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

As a convention, on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence from the arguments and returns the last id generated by that sequence. On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method returns the last value generated for such a column, and the table name argument is disregarded.

Parameters

string	$tableName	OPTIONAL Name of table.
string	$primaryKey	OPTIONAL Name of primary key column.

Returns: string

◆ lastSequenceId()

lastSequenceId ( $sequenceName )

Return the most recent value from the specified sequence in the database. This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Parameters

string $sequenceName

Returns: string

Definition at line 1066 of file Abstract.php.

     {
         return null;
     }

◆ limit()

limit	(	$sql,
		$count,
		$offset = `0`
	)

abstract

Adds an adapter-specific LIMIT clause to the SELECT statement.

Parameters

mixed	$sql
integer	$count
integer	$offset

Returns: string

◆ listTables()

listTables ( )

abstract

Abstract MethodsReturns a list of the tables in the database.

Returns: array

◆ nextSequenceId()

nextSequenceId ( $sequenceName )

Generate a new value from the specified sequence in the database, and return it. This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Parameters

string $sequenceName

Returns: string

Definition at line 1079 of file Abstract.php.

     {
         return null;
     }

◆ prepare()

prepare ( $sql )

abstract

Prepare a statement and return a PDOStatement-like object.

Parameters

string | Zend_Db_Select $sql SQL query

Returns: Zend_Db_Statement|PDOStatement

◆ query()

query	(	$sql,
		$bind = `array()`
	)

Prepares and executes an SQL statement with bound data.

Parameters

mixed	$sql	The SQL statement with placeholders. May be a string or Zend_Db_Select.
mixed	$bind	An array of data to bind to the placeholders.

Returns: Zend_Db_Statement_Interface

Definition at line 457 of file Abstract.php.

     {
         // connect to the database if needed
         $this->_connect();
 
         // is the $sql a Zend_Db_Select object?
         if ($sql instanceof Zend_Db_Select) {
             if (empty($bind)) {
                 $bind = $sql->getBind();
             }
 
             $sql = $sql->assemble();
         }
 
         // make sure $bind to an array;
         // don't use (array) typecasting because
         // because $bind may be a Zend_Db_Expr object
         if (!is_array($bind)) {
             $bind = array($bind);
         }
 
         // prepare and execute the statement with profiling
         $stmt = $this->prepare($sql);
         $stmt->execute($bind);
 
         // return the results embedded in the prepared statement object
         $stmt->setFetchMode($this->_fetchMode);
         return $stmt;
     }

◆ quote()

quote	(	$value,
		$type = `null`
	)

Safely quotes a value for an SQL statement.

If an array is passed as the value, the array values are quoted and then returned as a comma-separated string.

Parameters

mixed	$value	The value to quote.
mixed	$type	OPTIONAL the SQL datatype name, or constant, or null.

Returns: mixed An SQL-safe quoted value (or string of separated values).

Definition at line 859 of file Abstract.php.

     {
         $this->_connect();
 
         if ($value instanceof Zend_Db_Select) {
             return '(' . $value->assemble() . ')';
         }
 
         if ($value instanceof Zend_Db_Expr) {
             return $value->__toString();
         }
 
         if (is_array($value)) {
             foreach ($value as &$val) {
                 $val = $this->quote($val, $type);
             }
             return implode(', ', $value);
         }
 
         if ($type !== null && array_key_exists($type = strtoupper($type), $this->_numericDataTypes)) {
             $quotedValue = '0';
             switch ($this->_numericDataTypes[$type]) {
                 case Zend_Db::INT_TYPE: // 32-bit integer
                     $quotedValue = (string) intval($value);
                     break;
                 case Zend_Db::BIGINT_TYPE: // 64-bit integer
                     // ANSI SQL-style hex literals (e.g. x'[\dA-F]+')
                     // are not supported here, because these are string
                     // literals, not numeric literals.
                     if (preg_match('/^(
                           [+-]?                  # optional sign
                           (?:
                             0[Xx][\da-fA-F]+     # ODBC-style hexadecimal
                             |\d+                 # decimal or octal, or MySQL ZEROFILL decimal
                             (?:[eE][+-]?\d+)?    # optional exponent on decimals or octals
                           )
                         )/x',
                         (string) $value, $matches)) {
                         $quotedValue = $matches[1];
                     }
                     break;
                 case Zend_Db::FLOAT_TYPE: // float or decimal
                     $quotedValue = sprintf('%F', $value);
             }
             return $quotedValue;
         }
 
         return $this->_quote($value);
     }

◆ quoteColumnAs()

quoteColumnAs	(	$ident,
		$alias,
		$auto = `false`
	)

Quote a column identifier and alias.

Parameters

string \| array \| Zend_Db_Expr	$ident	The identifier or expression.
string	$alias	An alias for the column.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns: string The quoted identifier and alias.

Definition at line 972 of file Abstract.php.

     {
         return $this->_quoteIdentifierAs($ident, $alias, $auto);
     }

◆ quoteIdentifier()

quoteIdentifier	(	$ident,
		$auto = `false`
	)

Quotes an identifier.

Accepts a string representing a qualified indentifier. For Example: $adapter->quoteIdentifier('myschema.mytable') Returns: "myschema"."mytable"

Or, an array of one or more identifiers that may form a qualified identifier: $adapter->quoteIdentifier(array('myschema','my.table')) Returns: "myschema"."my.table"

The actual quote character surrounding the identifiers may vary depending on the adapter.

Parameters

string \| array \| Zend_Db_Expr	$ident	The identifier.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns: string The quoted identifier.

Definition at line 959 of file Abstract.php.

     {
         return $this->_quoteIdentifierAs($ident, null, $auto);
     }

◆ quoteInto()

quoteInto	(	$text,
		$value,
		$type = `null`,
		$count = `null`
	)

Quotes a value and places into a piece of text at a placeholder.

The placeholder is a question-mark; all placeholders will be replaced with the quoted value. For example:

$text = "WHERE date < ?"; $date = "2005-01-02"; $safe = $sql->quoteInto($text, $date); // $safe = "WHERE date < '2005-01-02'"

Parameters

string	$text	The text with a placeholder.
mixed	$value	The value to quote.
string	$type	OPTIONAL SQL datatype
integer	$count	OPTIONAL count of placeholders to replace

Returns: string An SQL-safe quoted value placed into the original text.

Definition at line 928 of file Abstract.php.

     {
         if ($count === null) {
             return str_replace('?', $this->quote($value, $type), $text);
         } else {
             return implode($this->quote($value, $type), explode('?', $text, $count + 1));
         }
     }

◆ quoteTableAs()

quoteTableAs	(	$ident,
		$alias = `null`,
		$auto = `false`
	)

Quote a table identifier and alias.

Parameters

string \| array \| Zend_Db_Expr	$ident	The identifier or expression.
string	$alias	An alias for the table.
boolean	$auto	If true, heed the AUTO_QUOTE_IDENTIFIERS config option.

Returns: string The quoted identifier and alias.

Definition at line 985 of file Abstract.php.

     {
         return $this->_quoteIdentifierAs($ident, $alias, $auto);
     }

◆ rollBack()

rollBack ( )

Roll back a transaction and return to autocommit mode.

Returns: Zend_Db_Adapter_Abstract

Definition at line 520 of file Abstract.php.

     {
         $this->_connect();
         $q = $this->_profiler->queryStart('rollback', Zend_Db_Profiler::TRANSACTION);
         $this->_rollBack();
         $this->_profiler->queryEnd($q);
         return $this;
     }

◆ select()

select ( )

Creates and returns a new Zend_Db_Select object for this adapter.

Returns: Zend_Db_Select

Definition at line 708 of file Abstract.php.

     {
         return new Zend_Db_Select($this);
     }

◆ setFetchMode()

setFetchMode ( $mode )

abstract

Set the fetch mode.

Parameters

integer $mode

Returns: void

Exceptions

Zend_Db_Adapter_Exception

◆ setProfiler()

setProfiler ( $profiler )

Set the adapter's profiler object.

The argument may be a boolean, an associative array, an instance of Zend_Db_Profiler, or an instance of Zend_Config.

A boolean argument sets the profiler to enabled if true, or disabled if false. The profiler class is the adapter's default profiler class, Zend_Db_Profiler.

An instance of Zend_Db_Profiler sets the adapter's instance to that object. The profiler is enabled and disabled separately.

An associative array argument may contain any of the keys 'enabled', 'class', and 'instance'. The 'enabled' and 'instance' keys correspond to the boolean and object types documented above. The 'class' key is used to name a class to use for a custom profiler. The class must be Zend_Db_Profiler or a subclass. The class is instantiated with no constructor arguments. The 'class' option is ignored when the 'instance' option is supplied.

An object of type Zend_Config may contain the properties 'enabled', 'class', and 'instance', just as if an associative array had been passed instead.

Parameters

Zend_Db_Profiler | Zend_Config | array | boolean $profiler

Returns: Zend_Db_Adapter_Abstract Provides a fluent interface

Exceptions

Zend_Db_Profiler_Exception if the object instance or class specified is not Zend_Db_Profiler or an extension of that class.

See also: Zend_Db_Profiler_Exception; Zend_Db_Profiler_Exception

Definition at line 358 of file Abstract.php.

     {
         $enabled          = null;
         $profilerClass    = $this->_defaultProfilerClass;
         $profilerInstance = null;
 
         if ($profilerIsObject = is_object($profiler)) {
             if ($profiler instanceof Zend_Db_Profiler) {
                 $profilerInstance = $profiler;
             } else if ($profiler instanceof Zend_Config) {
                 $profiler = $profiler->toArray();
             } else {
                 #require_once 'Zend/Db/Profiler/Exception.php';
                 throw new Zend_Db_Profiler_Exception('Profiler argument must be an instance of either Zend_Db_Profiler'
                     . ' or Zend_Config when provided as an object');
             }
         }
 
         if (is_array($profiler)) {
             if (isset($profiler['enabled'])) {
                 $enabled = (bool) $profiler['enabled'];
             }
             if (isset($profiler['class'])) {
                 $profilerClass = $profiler['class'];
             }
             if (isset($profiler['instance'])) {
                 $profilerInstance = $profiler['instance'];
             }
         } else if (!$profilerIsObject) {
             $enabled = (bool) $profiler;
         }
 
         if ($profilerInstance === null) {
             if (!class_exists($profilerClass)) {
                 #require_once 'Zend/Loader.php';
                 Zend_Loader::loadClass($profilerClass);
             }
             $profilerInstance = new $profilerClass();
         }
 
         if (!$profilerInstance instanceof Zend_Db_Profiler) {
             #require_once 'Zend/Db/Profiler/Exception.php';
             throw new Zend_Db_Profiler_Exception('Class ' . get_class($profilerInstance) . ' does not extend '
                 . 'Zend_Db_Profiler');
         }
 
         if (null !== $enabled) {
             $profilerInstance->setEnabled($enabled);
         }
 
         $this->_profiler = $profilerInstance;
 
         return $this;
     }

◆ setStatementClass()

setStatementClass ( $class )

Set the default statement class.

Returns: Zend_Db_Adapter_Abstract Fluent interface

Definition at line 443 of file Abstract.php.

     {
         $this->_defaultStmtClass = $class;
         return $this;
     }

◆ supportsParameters()

supportsParameters ( $type )

abstract

Check if the adapter supports real SQL parameters.

Parameters

string $type 'positional' or 'named'

Returns: bool

◆ update()

update	(		$table,
		array	$bind,
			$where = `''`
	)

Updates table rows with specified data based on a WHERE clause.

Parameters

mixed	$table	The table to update.
array	$bind	Column-value pairs.
mixed	$where	UPDATE WHERE clause(s).

Returns: int The number of affected rows.

Exceptions

Zend_Db_Adapter_Exception

Build "col = ?" pairs for the statement, except for Zend_Db_Expr which is treated literally.

See also: Zend_Db_Adapter_Exception

Build the UPDATE statement

Execute the statement and return the number of affected rows

Definition at line 590 of file Abstract.php.

     {
         $set = array();
         $i = 0;
         foreach ($bind as $col => $val) {
             if ($val instanceof Zend_Db_Expr) {
                 $val = $val->__toString();
                 unset($bind[$col]);
             } else {
                 if ($this->supportsParameters('positional')) {
                     $val = '?';
                 } else {
                     if ($this->supportsParameters('named')) {
                         unset($bind[$col]);
                         $bind[':col'.$i] = $val;
                         $val = ':col'.$i;
                         $i++;
                     } else {
                         #require_once 'Zend/Db/Adapter/Exception.php';
                         throw new Zend_Db_Adapter_Exception(get_class($this) ." doesn't support positional or named binding");
                     }
                 }
             }
             $set[] = $this->quoteIdentifier($col, true) . ' = ' . $val;
         }
 
         $where = $this->_whereExpr($where);
 
         $sql = "UPDATE "
              . $this->quoteIdentifier($table, true)
              . ' SET ' . implode(', ', $set)
              . (($where) ? " WHERE $where" : '');
 
         if ($this->supportsParameters('positional')) {
             $stmt = $this->query($sql, array_values($bind));
         } else {
             $stmt = $this->query($sql, $bind);
         }
         $result = $stmt->rowCount();
         return $result;
     }

Field Documentation

◆ $_allowSerialization

$_allowSerialization = true

protected

Definition at line 132 of file Abstract.php.

◆ $_autoQuoteIdentifiers

$_autoQuoteIdentifiers = true

protected

Definition at line 109 of file Abstract.php.

◆ $_autoReconnectOnUnserialize

$_autoReconnectOnUnserialize = false

protected

Definition at line 140 of file Abstract.php.

◆ $_caseFolding

$_caseFolding = Zend_Db::CASE_NATURAL

protected

Definition at line 98 of file Abstract.php.

◆ $_config

$_config = array()

protected

Definition at line 51 of file Abstract.php.

◆ $_connection

$_connection = null

protected

Definition at line 87 of file Abstract.php.

◆ $_defaultProfilerClass

$_defaultProfilerClass = 'Zend_Db_Profiler'

protected

Definition at line 80 of file Abstract.php.

◆ $_defaultStmtClass

$_defaultStmtClass = 'Zend_Db_Statement'

protected

Definition at line 73 of file Abstract.php.

◆ $_fetchMode

$_fetchMode = Zend_Db::FETCH_ASSOC

protected

Definition at line 58 of file Abstract.php.

◆ $_numericDataTypes

$_numericDataTypes

protected

Initial value:

= array(
        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,
        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,
        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE
    )

Definition at line 122 of file Abstract.php.

◆ $_profiler

$_profiler

protected

Definition at line 66 of file Abstract.php.

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

vendor/magento/zendframework1/library/Zend/Db/Adapter/Abstract.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _beginTransaction()

◆ _checkRequiredOptions()

◆ _commit()

◆ _connect()

◆ _quote()

◆ _quoteIdentifier()

◆ _quoteIdentifierAs()

◆ _rollBack()

◆ _whereExpr()

◆ beginTransaction()

◆ closeConnection()

◆ commit()

◆ delete()

◆ describeTable()

◆ fetchAll()

◆ fetchAssoc()

◆ fetchCol()

◆ fetchOne()

◆ fetchPairs()

◆ fetchRow()

◆ foldCase()

◆ getConfig()

◆ getConnection()

◆ getFetchMode()

◆ getProfiler()

◆ getQuoteIdentifierSymbol()

◆ getServerVersion()

◆ getStatementClass()

◆ insert()

◆ isConnected()

◆ lastInsertId()

◆ lastSequenceId()

◆ limit()

◆ listTables()

◆ nextSequenceId()

◆ prepare()

◆ query()

◆ quote()

◆ quoteColumnAs()

◆ quoteIdentifier()

◆ quoteInto()

◆ quoteTableAs()

◆ rollBack()

◆ select()

◆ setFetchMode()

◆ setProfiler()

◆ setStatementClass()

◆ supportsParameters()

◆ update()

Field Documentation

◆ $_allowSerialization

◆ $_autoQuoteIdentifiers

◆ $_autoReconnectOnUnserialize

◆ $_caseFolding

◆ $_config

◆ $_connection

◆ $_defaultProfilerClass

◆ $_defaultStmtClass

◆ $_fetchMode

◆ $_numericDataTypes

◆ $_profiler