Zend_Db_Adapter_Mysqli Class Reference

Inheritance diagram for Zend_Db_Adapter_Mysqli:

Public Member Functions
	getQuoteIdentifierSymbol ()
	listTables ()
	describeTable ($tableName, $schemaName=null)
	isConnected ()
	closeConnection ()
	prepare ($sql)
	lastInsertId ($tableName=null, $primaryKey=null)
	setFetchMode ($mode)
	limit ($sql, $count, $offset=0)
	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
	_quote ($value)
	_connect ()
	_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
	$_numericDataTypes
	$_stmt = null
	$_defaultStmtClass = 'Zend_Db_Statement_Mysqli'
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 52 of file Mysqli.php.

Member Function Documentation

_beginTransaction()

_beginTransaction ( )

protected

Begin a transaction.

Returns

void

Definition at line 425 of file Mysqli.php.

    {
        $this->_connect();
        $this->_connection->autocommit(false);
    }

_commit()

_commit ( )

protected

Commit a transaction.

Returns

void

Definition at line 436 of file Mysqli.php.

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

_connect()

_connect ( )

protected

Creates a connection to the database.

Returns

void

Exceptions

Zend_Db_Adapter_Mysqli_Exception

See also

Zend_Db_Adapter_Mysqli_Exception

Zend_Db_Adapter_Mysqli_Exception

Definition at line 280 of file Mysqli.php.

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

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

        if (isset($this->_config['port'])) {
            $port = (integer) $this->_config['port'];
        } else {
            $port = null;
        }

        if (isset($this->_config['socket'])) {
            $socket = $this->_config['socket'];
        } else {
            $socket = null;
        }

        $this->_connection = mysqli_init();

        if(!empty($this->_config['driver_options'])) {
            foreach($this->_config['driver_options'] as $option=>$value) {
                if(is_string($option)) {
                    // Suppress warnings here
                    // Ignore it if it's not a valid constant
                    $option = @constant(strtoupper($option));
                    if($option === null)
                        continue;
                }
                mysqli_options($this->_connection, $option, $value);
            }
        }

        // Suppress connection warnings here.
        // Throw an exception instead.
        $_isConnected = @mysqli_real_connect(
            $this->_connection,
            $this->_config['host'],
            $this->_config['username'],
            $this->_config['password'],
            $this->_config['dbname'],
            $port,
            $socket
        );

        if ($_isConnected === false || mysqli_connect_errno()) {

            $this->closeConnection();
            #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
            throw new Zend_Db_Adapter_Mysqli_Exception(mysqli_connect_error());
        }

        if (!empty($this->_config['charset'])) {
            mysqli_set_charset($this->_connection, $this->_config['charset']);
        }
    }

_quote()

_quote (   $value )

protected

Quote a raw string.

Parameters

mixed

$value

Raw string

Returns

string Quoted string

Definition at line 104 of file Mysqli.php.

    {
        if (is_int($value) || is_float($value)) {
            return $value;
        }
        $this->_connect();
        return "'" . $this->_connection->real_escape_string($value) . "'";
    }

_rollBack()

_rollBack ( )

protected

Roll-back a transaction.

Returns

void

Definition at line 448 of file Mysqli.php.

    {
        $this->_connect();
        $this->_connection->rollback();
        $this->_connection->autocommit(true);
    }

closeConnection()

closeConnection

(

)

Force the connection to close.

Returns

void

Definition at line 363 of file Mysqli.php.

    {
        if ($this->isConnected()) {
            $this->_connection->close();
        }
        $this->_connection = null;
    }

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

Todo:

use INFORMATION_SCHEMA someday when MySQL's implementation isn't too slow.

Use mysqli extension API, because DESCRIBE doesn't work well as a prepared statement on MySQL 4.1.

See also

Zend_Db_Adapter_Mysqli_Exception

The optional argument of a MySQL int type is not precision or length; it is only a hint for display width.

Definition at line 177 of file Mysqli.php.

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

        if ($queryResult = $this->getConnection()->query($sql)) {
            while ($row = $queryResult->fetch_assoc()) {
                $result[] = $row;
            }
            $queryResult->close();
        } else {
            #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
            throw new Zend_Db_Adapter_Mysqli_Exception($this->getConnection()->error);
        }

        $desc = array();

        $row_defaults = array(
            'Length'          => null,
            'Scale'           => null,
            'Precision'       => null,
            'Unsigned'        => null,
            'Primary'         => false,
            'PrimaryPosition' => null,
            'Identity'        => false
        );
        $i = 1;
        $p = 1;
        foreach ($result as $key => $row) {
            $row = array_merge($row_defaults, $row);
            if (preg_match('/unsigned/', $row['Type'])) {
                $row['Unsigned'] = true;
            }
            if (preg_match('/^((?:var)?char)\((\d+)\)/', $row['Type'], $matches)) {
                $row['Type'] = $matches[1];
                $row['Length'] = $matches[2];
            } else if (preg_match('/^decimal\((\d+),(\d+)\)/', $row['Type'], $matches)) {
                $row['Type'] = 'decimal';
                $row['Precision'] = $matches[1];
                $row['Scale'] = $matches[2];
            } else if (preg_match('/^float\((\d+),(\d+)\)/', $row['Type'], $matches)) {
                $row['Type'] = 'float';
                $row['Precision'] = $matches[1];
                $row['Scale'] = $matches[2];
            } else if (preg_match('/^((?:big|medium|small|tiny)?int)\((\d+)\)/', $row['Type'], $matches)) {
                $row['Type'] = $matches[1];
            }
            if (strtoupper($row['Key']) == 'PRI') {
                $row['Primary'] = true;
                $row['PrimaryPosition'] = $p;
                if ($row['Extra'] == 'auto_increment') {
                    $row['Identity'] = true;
                } else {
                    $row['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'           => $row['Length'],
                'SCALE'            => $row['Scale'],
                'PRECISION'        => $row['Precision'],
                'UNSIGNED'         => $row['Unsigned'],
                'PRIMARY'          => $row['Primary'],
                'PRIMARY_POSITION' => $row['PrimaryPosition'],
                'IDENTITY'         => $row['Identity']
            );
            ++$i;
        }
        return $desc;
    }

getQuoteIdentifierSymbol()

getQuoteIdentifierSymbol

(

)

Returns the symbol the adapter uses for delimiting identifiers.

Returns

string

Definition at line 118 of file Mysqli.php.

    {
        return "`";
    }

getServerVersion()

getServerVersion

(

)

Retrieve server version in PHP style

Returns

string

Definition at line 547 of file Mysqli.php.

    {
        $this->_connect();
        $version = $this->_connection->server_version;
        $major = (int) ($version / 10000);
        $minor = (int) ($version % 10000 / 100);
        $revision = (int) ($version % 100);
        return $major . '.' . $minor . '.' . $revision;
    }

isConnected()

isConnected

(

)

Test if a connection is active

Returns

boolean

Definition at line 353 of file Mysqli.php.

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

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.

MySQL does not support sequences, so $tableName and $primaryKey are ignored.

Parameters

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

Returns

string

Todo:

Return value should be int?

Definition at line 414 of file Mysqli.php.

    {
        $mysqli = $this->_connection;
        return (string) $mysqli->insert_id;
    }

limit()

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

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

Parameters

string	$sql
int	$count
int	$offset	OPTIONAL

Returns

string

See also

Zend_Db_Adapter_Mysqli_Exception

Zend_Db_Adapter_Mysqli_Exception

Definition at line 497 of file Mysqli.php.

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

        $offset = intval($offset);
        if ($offset < 0) {
            #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
            throw new Zend_Db_Adapter_Mysqli_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

See also

Zend_Db_Adapter_Mysqli_Exception

Definition at line 128 of file Mysqli.php.

    {
        $result = array();
        // Use mysqli extension API, because SHOW doesn't work
        // well as a prepared statement on MySQL 4.1.
        $sql = 'SHOW TABLES';
        if ($queryResult = $this->getConnection()->query($sql)) {
            while ($row = $queryResult->fetch_row()) {
                $result[] = $row[0];
            }
            $queryResult->close();
        } else {
            #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
            throw new Zend_Db_Adapter_Mysqli_Exception($this->getConnection()->error);
        }
        return $result;
    }

prepare()

prepare

(

$sql

)

Prepare a statement and return a PDOStatement-like object.

Parameters

string

$sql

SQL query

Returns

Zend_Db_Statement_Mysqli

Definition at line 377 of file Mysqli.php.

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

setFetchMode()

setFetchMode

(

$mode

)

Set the fetch mode.

Parameters

int

$mode

Returns

void

Exceptions

Zend_Db_Adapter_Mysqli_Exception

See also

Zend_Db_Adapter_Mysqli_Exception

Zend_Db_Adapter_Mysqli_Exception

Definition at line 462 of file Mysqli.php.

    {
        switch ($mode) {
            case Zend_Db::FETCH_LAZY:
            case Zend_Db::FETCH_ASSOC:
            case Zend_Db::FETCH_NUM:
            case Zend_Db::FETCH_BOTH:
            case Zend_Db::FETCH_NAMED:
            case Zend_Db::FETCH_OBJ:
                $this->_fetchMode = $mode;
                break;
            case Zend_Db::FETCH_BOUND: // bound to PHP variable
                #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
                throw new Zend_Db_Adapter_Mysqli_Exception('FETCH_BOUND is not supported yet');
                break;
            default:
                #require_once 'Zend/Db/Adapter/Mysqli/Exception.php';
                throw new Zend_Db_Adapter_Mysqli_Exception("Invalid fetch mode '$mode' specified");
        }
    }

supportsParameters()

supportsParameters

(

$type

)

Check if the adapter supports real SQL parameters.

Parameters

string

$type

'positional' or 'named'

Returns

bool

Definition at line 531 of file Mysqli.php.

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

Field Documentation

$_defaultStmtClass

$_defaultStmtClass = 'Zend_Db_Statement_Mysqli'

protected

Definition at line 95 of file Mysqli.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,
        '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 66 of file Mysqli.php.

$_stmt

$_stmt = null

protected

Definition at line 88 of file Mysqli.php.

---

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

• vendor/magento/zendframework1/library/Zend/Db/Adapter/Mysqli.php