Zend_Db_Adapter_Pdo_Mysql Class Reference

Inheritance diagram for Zend_Db_Adapter_Pdo_Mysql:

Public Member Functions
	getQuoteIdentifierSymbol ()
	listTables ()
	describeTable ($tableName, $schemaName=null)
	limit ($sql, $count, $offset=0)
Public Member Functions inherited from Zend_Db_Adapter_Pdo_Abstract
	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 ()
Protected Member Functions inherited from Zend_Db_Adapter_Pdo_Abstract
	_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
	$_pdoType = 'mysql'
	$_numericDataTypes
Protected Attributes inherited from Zend_Db_Adapter_Pdo_Abstract
	$_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 39 of file Mysql.php.

Member Function Documentation

_connect()

_connect ( )

protected

Creates a PDO object and connects to the database.

Returns

void

Exceptions

Zend_Db_Adapter_Exception

Definition at line 98 of file Mysql.php.

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

        if (!empty($this->_config['charset'])
            && version_compare(PHP_VERSION, '5.3.6', '<')
        ) {
            $initCommand = "SET NAMES '" . $this->_config['charset'] . "'";
            $this->_config['driver_options'][1002] = $initCommand; // 1002 = PDO::MYSQL_ATTR_INIT_COMMAND
        }

        parent::_connect();
    }

_dsn()

_dsn ( )

protected

Override _dsn() and ensure that charset is incorporated in mysql

See also

Zend_Db_Adapter_Pdo_Abstract::_dsn()

Definition at line 83 of file Mysql.php.

    {
        $dsn = parent::_dsn();
        if (isset($this->_config['charset'])) {
            $dsn .= ';charset=' . $this->_config['charset'];
        }
        return $dsn;
    }

describeTable()

describeTable	(		$tableName,
			$schemaName = null
	)

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 IDENTITY => integer; true if column is auto-generated with unique values

Parameters

string	$tableName
string	$schemaName	OPTIONAL

Returns

array

Definition at line 160 of file Mysql.php.

    {
        // @todo  use INFORMATION_SCHEMA someday when MySQL's
        // implementation has reasonably good performance and
        // the version with this improvement is in wide use.

        if ($schemaName) {
            $sql = 'DESCRIBE ' . $this->quoteIdentifier("$schemaName.$tableName", true);
        } else {
            $sql = 'DESCRIBE ' . $this->quoteIdentifier($tableName, true);
        }
        $stmt = $this->query($sql);

        // Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection
        $result = $stmt->fetchAll(Zend_Db::FETCH_NUM);

        $field   = 0;
        $type    = 1;
        $null    = 2;
        $key     = 3;
        $default = 4;
        $extra   = 5;

        $desc = array();
        $i = 1;
        $p = 1;
        foreach ($result as $row) {
            list($length, $scale, $precision, $unsigned, $primary, $primaryPosition, $identity)
                = array(null, null, null, null, false, null, false);
            if (preg_match('/unsigned/', $row[$type])) {
                $unsigned = true;
            }
            if (preg_match('/^((?:var)?char)\((\d+)\)/', $row[$type], $matches)) {
                $row[$type] = $matches[1];
                $length = $matches[2];
            } else if (preg_match('/^decimal\((\d+),(\d+)\)/', $row[$type], $matches)) {
                $row[$type] = 'decimal';
                $precision = $matches[1];
                $scale = $matches[2];
            } else if (preg_match('/^float\((\d+),(\d+)\)/', $row[$type], $matches)) {
                $row[$type] = 'float';
                $precision = $matches[1];
                $scale = $matches[2];
            } else if (preg_match('/^((?:big|medium|small|tiny)?int)\((\d+)\)/', $row[$type], $matches)) {
                $row[$type] = $matches[1];
                // The optional argument of a MySQL int type is not precision
                // or length; it is only a hint for display width.
            }
            if (strtoupper($row[$key]) == 'PRI') {
                $primary = true;
                $primaryPosition = $p;
                if ($row[$extra] == 'auto_increment') {
                    $identity = true;
                } else {
                    $identity = false;
                }
                ++$p;
            }
            $desc[$this->foldCase($row[$field])] = array(
                'SCHEMA_NAME'      => null, // @todo
                'TABLE_NAME'       => $this->foldCase($tableName),
                'COLUMN_NAME'      => $this->foldCase($row[$field]),
                'COLUMN_POSITION'  => $i,
                'DATA_TYPE'        => $row[$type],
                'DEFAULT'          => $row[$default],
                'NULLABLE'         => (bool) ($row[$null] == 'YES'),
                'LENGTH'           => $length,
                'SCALE'            => $scale,
                'PRECISION'        => $precision,
                'UNSIGNED'         => $unsigned,
                'PRIMARY'          => $primary,
                'PRIMARY_POSITION' => $primaryPosition,
                'IDENTITY'         => $identity
            );
            ++$i;
        }
        return $desc;
    }

getQuoteIdentifierSymbol()

getQuoteIdentifierSymbol

(

)

Returns

string

Definition at line 117 of file Mysql.php.

    {
        return "`";
    }

limit()

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

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

Parameters

string	$sql
integer	$count
integer	$offset	OPTIONAL

Exceptions

Zend_Db_Adapter_Exception

Returns

string

See also

Zend_Db_Adapter_Exception

Zend_Db_Adapter_Exception

Definition at line 248 of file Mysql.php.

     {
        $count = intval($count);
        if ($count <= 0) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception("LIMIT argument count=$count is not valid");
        }

        $offset = intval($offset);
        if ($offset < 0) {
            #require_once 'Zend/Db/Adapter/Exception.php';
            throw new Zend_Db_Adapter_Exception("LIMIT argument offset=$offset is not valid");
        }

        $sql .= " LIMIT $count";
        if ($offset > 0) {
            $sql .= " OFFSET $offset";
        }

        return $sql;
    }

listTables()

listTables

(

)

Returns a list of the tables in the database.

Returns

array

Definition at line 127 of file Mysql.php.

    {
        return $this->fetchCol('SHOW TABLES');
    }

Field Documentation

$_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,
        'INT'                => Zend_Db::INT_TYPE,
        'INTEGER'            => Zend_Db::INT_TYPE,
        'MEDIUMINT'          => Zend_Db::INT_TYPE,
        'SMALLINT'           => Zend_Db::INT_TYPE,
        'TINYINT'            => Zend_Db::INT_TYPE,
        'BIGINT'             => Zend_Db::BIGINT_TYPE,
        'SERIAL'             => Zend_Db::BIGINT_TYPE,
        'DEC'                => Zend_Db::FLOAT_TYPE,
        'DECIMAL'            => Zend_Db::FLOAT_TYPE,
        'DOUBLE'             => Zend_Db::FLOAT_TYPE,
        'DOUBLE PRECISION'   => Zend_Db::FLOAT_TYPE,
        'FIXED'              => Zend_Db::FLOAT_TYPE,
        'FLOAT'              => Zend_Db::FLOAT_TYPE
    )

Definition at line 60 of file Mysql.php.

$_pdoType

$_pdoType = 'mysql'

protected

Definition at line 47 of file Mysql.php.

---

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

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