API Documentation

Zend/Db/Adapter/Mysqli.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Adapter  
Version
$Id: Mysqli.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Db_Adapter_Mysqli

Package: Zend\Db\Adapter

Parent(s)
\Zend_Db_Adapter_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_defaultStmtClass= ''Zend_Db_Statement_Mysqli''

Default class name for a DB statement.

Default value'Zend_Db_Statement_Mysqli'Details
Type
string
Propertyprotectedarray  $_numericDataTypes= 'array( Zend_Db::INT_TYPE => Zend_Db::INT_TYPE'

Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

Associative array of datatypes to values 0, 1, or 2.

Values are: 0 = 32-bit integer 1 = 64-bit integer 2 = float or decimal

Default valuearray( Zend_Db::INT_TYPE => Zend_Db::INT_TYPEDetails
Type
array
Propertyprotected\Zend_Db_Statement_Mysqli  $_stmt= 'null'

Default valuenullDetails
Type
\Zend_Db_Statement_Mysqli

Methods

methodprotected_beginTransaction( ) : void

Begin a transaction.

methodprotected_commit( ) : void

Commit a transaction.

methodprotected_connect( ) : void

Creates a connection to the database.

Throws
Exception Description
\Zend_Db_Adapter_Mysqli_Exception
methodprotected_quote( mixed $value ) : string

Quote a raw string.

Parameters
Name Type Description
$value mixed

Raw string

Returns
Type Description
string Quoted string
methodprotected_rollBack( ) : void

Roll-back a transaction.

methodpubliccloseConnection( ) : void

Force the connection to close.

methodpublicdescribeTable( string $tableName, string $schemaName = null ) : array

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
Name Type Description
$tableName string
$schemaName string

OPTIONAL

Returns
Type Description
array
methodpublicgetQuoteIdentifierSymbol( ) : string

Returns the symbol the adapter uses for delimiting identifiers.

Returns
Type Description
string
methodpublicgetServerVersion( ) : string

Retrieve server version in PHP style

Returns
Type Description
string
methodpublicisConnected( ) : boolean

Test if a connection is active

Returns
Type Description
boolean
methodpubliclastInsertId( string $tableName = null, string $primaryKey = null ) : string

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
Name Type Description
$tableName string

OPTIONAL Name of table.

$primaryKey string

OPTIONAL Name of primary key column.

Returns
Type Description
string
Details
Todo
Return value should be int?  
methodpubliclimit( string $sql, int $count, int $offset = 0 ) : string

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

Parameters
Name Type Description
$sql string
$count int
$offset int

OPTIONAL

Returns
Type Description
string
methodpubliclistTables( ) : array

Returns a list of the tables in the database.

Returns
Type Description
array
methodpublicprepare( string $sql ) : \Zend_Db_Statement_Mysqli

Prepare a statement and return a PDOStatement-like object.

Parameters
Name Type Description
$sql string

SQL query

Returns
Type Description
\Zend_Db_Statement_Mysqli
methodpublicsetFetchMode( int $mode ) : void

Set the fetch mode.

Parameters
Name Type Description
$mode int
Throws
Exception Description
\Zend_Db_Adapter_Mysqli_Exception
methodpublicsupportsParameters( string $type ) : bool

Check if the adapter supports real SQL parameters.

Parameters
Name Type Description
$type string

'positional' or 'named'

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.