Zend_Db_Adapter_Pdo_Abstract Class Reference

Inheritance diagram for Zend_Db_Adapter_Pdo_Abstract:

Public Member Functions
	isConnected ()
	closeConnection ()
	prepare ($sql)
	lastInsertId ($tableName=null, $primaryKey=null)
	query ($sql, $bind=array())
	exec ($sql)
	setFetchMode ($mode)
	supportsParameters ($type)
	getServerVersion ()
Public Member Functions inherited from Zend_Db_Adapter_Abstract
	__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
	_dsn ()
	_connect ()
	_quote ($value)
	_beginTransaction ()
	_commit ()
	_rollBack ()
Protected Member Functions inherited from Zend_Db_Adapter_Abstract
	_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
	$_defaultStmtClass = 'Zend_Db_Statement_Pdo'
Protected Attributes inherited from Zend_Db_Adapter_Abstract
	$_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 45 of file Abstract.php.

Member Function Documentation

_beginTransaction()

_beginTransaction ( )

protected

Begin a transaction.

Definition at line 302 of file Abstract.php.

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

_commit()

_commit ( )

protected

Commit a transaction.

Definition at line 311 of file Abstract.php.

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

_connect()

_connect ( )

protected

Creates a PDO object and connects to the database.

Returns

void

Exceptions

Zend_Db_Adapter_Exception

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 87 of file Abstract.php.

    {
        // if we already have a PDO object, no need to re-connect.
        if ($this->_connection) {
            return;
        }

        // get the dsn first, because some adapters alter the $_pdoType
        $dsn = $this->_dsn();

        // check for PDO extension
        if (!extension_loaded('pdo')) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception('The PDO extension is required for this adapter but the extension is not loaded');
        }

        // check the PDO driver is available
        if (!in_array($this->_pdoType, PDO::getAvailableDrivers())) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception('The ' . $this->_pdoType . ' driver is not currently installed');
        }

        // create PDO connection
        $q = $this->_profiler->queryStart('connect', Zend_Db_Profiler::CONNECT);

        // add the persistence flag if we find it in our config array
        if (isset($this->_config['persistent']) && ($this->_config['persistent'] == true)) {
            $this->_config['driver_options'][PDO::ATTR_PERSISTENT] = true;
        }

        try {
            $this->_connection = new PDO(
                $dsn,
                $this->_config['username'],
                $this->_config['password'],
                $this->_config['driver_options']
            );

            $this->_profiler->queryEnd($q);

            // set the PDO connection to perform case-folding on array keys, or not
            $this->_connection->setAttribute(PDO::ATTR_CASE, $this->_caseFolding);

            // always use exceptions.
            $this->_connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

        } catch (PDOException $e) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception($e->getMessage(), $e->getCode(), $e);
        }

    }

_dsn()

_dsn ( )

protected

Creates a PDO DSN for the adapter from $this->_config settings.

Returns

string

Definition at line 60 of file Abstract.php.

    {
        // baseline of DSN parts
        $dsn = $this->_config;

        // don't pass the username, password, charset, persistent and driver_options in the DSN
        unset($dsn['username']);
        unset($dsn['password']);
        unset($dsn['options']);
        unset($dsn['charset']);
        unset($dsn['persistent']);
        unset($dsn['driver_options']);

        // use all remaining parts in the DSN
        foreach ($dsn as $key => $val) {
            $dsn[$key] = "$key=$val";
        }

        return $this->_pdoType . ':' . implode(';', $dsn);
    }

_quote()

_quote (   $value )

protected

Quote a raw string.

Parameters

string

$value

Raw string

Returns

string Quoted string

Definition at line 290 of file Abstract.php.

    {
        if (is_int($value) || is_float($value)) {
            return $value;
        }
        $this->_connect();
        return $this->_connection->quote($value);
    }

_rollBack()

_rollBack ( )

protected

Roll-back a transaction.

Definition at line 320 of file Abstract.php.

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

closeConnection()

closeConnection

(

)

Force the connection to close.

Returns

void

Definition at line 164 of file Abstract.php.

    {
        $this->_connection = null;
    }

exec()

exec

(

$sql

)

Executes an SQL statement and return the number of affected rows

Parameters

mixed

$sql

The SQL statement with placeholders. May be a string or Zend_Db_Select.

Returns

integer Number of rows that were modified or deleted by the SQL statement

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 256 of file Abstract.php.

    {
        if ($sql instanceof Zend_Db_Select) {
            $sql = $sql->assemble();
        }

        try {
            $affected = $this->getConnection()->exec($sql);

            if ($affected === false) {
                $errorInfo = $this->getConnection()->errorInfo();
                #require_once 'Zend/Db/Adapter/Exception.php';
                throw new Zend_Db_Adapter_Exception($errorInfo[2]);
            }

            return $affected;
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

getServerVersion()

getServerVersion

(

)

Retrieve server version in PHP style

Returns

string

Definition at line 384 of file Abstract.php.

    {
        $this->_connect();
        try {
            $version = $this->_connection->getAttribute(PDO::ATTR_SERVER_VERSION);
        } catch (PDOException $e) {
            // In case of the driver doesn't support getting attributes
            return null;
        }
        $matches = null;
        if (preg_match('/((?:[0-9]{1,2}\.){1,3}[0-9]{1,2})/', $version, $matches)) {
            return $matches[1];
        } else {
            return null;
        }
    }

isConnected()

isConnected

(

)

Test if a connection is active

Returns

boolean

Definition at line 154 of file Abstract.php.

    {
        return ((bool) ($this->_connection instanceof PDO));
    }

lastInsertId()

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

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.

On RDBMS brands that don't support sequences, $tableName and $primaryKey are ignored.

Parameters

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

Returns

string

Definition at line 206 of file Abstract.php.

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

prepare()

prepare

(

$sql

)

Prepares an SQL statement.

Parameters

string	$sql	The SQL statement with placeholders.
array	$bind	An array of data to bind to the placeholders.

Returns

PDOStatement

Definition at line 176 of file Abstract.php.

    {
        $this->_connect();
        $stmtClass = $this->_defaultStmtClass;
        if (!class_exists($stmtClass)) {
            #require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($stmtClass);
        }
        $stmt = new $stmtClass($this, $sql);
        $stmt->setFetchMode($this->_fetchMode);
        return $stmt;
    }

query()

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

Special handling for PDO query(). All bind parameter names must begin with ':'

Parameters

string | Zend_Db_Select	$sql	The SQL statement with placeholders.
array	$bind	An array of data to bind to the placeholders.

Returns

Zend_Db_Statement_Pdo

Exceptions

Zend_Db_Adapter_Exception

To re-throw PDOException.

See also

Zend_Db_Statement_Exception

Definition at line 221 of file Abstract.php.

    {
        if (empty($bind) && $sql instanceof Zend_Db_Select) {
            $bind = $sql->getBind();
        }

        if (is_array($bind)) {
            foreach ($bind as $name => $value) {
                if (!is_int($name) && !preg_match('/^:/', $name)) {
                    $newName = ":$name";
                    unset($bind[$name]);
                    $bind[$newName] = $value;
                }
            }
        }

        try {
            return parent::query($sql, $bind);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

setFetchMode()

setFetchMode

(

$mode

)

Set the PDO fetch mode.

Todo:

Support FETCH_CLASS and FETCH_INTO.

Parameters

int

$mode

A PDO fetch mode.

Returns

void

Exceptions

Zend_Db_Adapter_Exception

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 334 of file Abstract.php.

    {
        //check for PDO extension
        if (!extension_loaded('pdo')) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception('The PDO extension is required for this adapter but the extension is not loaded');
        }
        switch ($mode) {
            case PDO::FETCH_LAZY:
            case PDO::FETCH_ASSOC:
            case PDO::FETCH_NUM:
            case PDO::FETCH_BOTH:
            case PDO::FETCH_NAMED:
            case PDO::FETCH_OBJ:
                $this->_fetchMode = $mode;
                break;
            default:
                #require_once 'Zend/Db/Adapter/Exception.php';
                throw new Zend_Db_Adapter_Exception("Invalid fetch mode '$mode' specified");
                break;
        }
    }

supportsParameters()

supportsParameters

(

$type

)

Check if the adapter supports real SQL parameters.

Parameters

string

$type

'positional' or 'named'

Returns

bool

Definition at line 369 of file Abstract.php.

    {
        switch ($type) {
            case 'positional':
            case 'named':
            default:
                return true;
        }
    }

Field Documentation

$_defaultStmtClass

$_defaultStmtClass = 'Zend_Db_Statement_Pdo'

protected

Definition at line 53 of file Abstract.php.

---

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

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