Class: DB_mysqli

Source Location: /DB-1.6.8/DB/mysqli.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_mysqli

Database independent query interface definition for PHP's mysqli extension.

Author(s):

Daniel Convissor <danielc at php.net>

Version:

$Id: mysqli.php,v 1.31 2004/07/12 17:51:24 danielc Exp $

Variables

Methods

Inherited Variables

Class: DB_common

DB_common::$dbh
DB_common::$errorcode_map
DB_common::$features
DB_common::$fetchmode_object_class
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_maxstmt

Inherited Methods

Class: DB_common

DB_common::DB_common(): Constructor
DB_common::affectedRows(): Returns the affected rows of a query
DB_common::autoCommit(): enable automatic Commit
DB_common::autoExecute(): Automaticaly generate an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Automaticaly generate an insert or update query and pass it to prepare()
DB_common::buildManipSQL(): Make automaticaly an sql query for prepare()
DB_common::commit(): starts a Commit
DB_common::createSequence(): Creates a new sequence
DB_common::dropSequence(): Deletes a sequence
DB_common::errorCode(): Map native error codes to DB's portable ones
DB_common::errorMessage(): Map a DB error code to a textual message. This is actually just a wrapper for DB::errorMessage()
DB_common::errorNative(): Returns an errormessage, provides by the database
DB_common::escapeSimple(): Escape a string according to the current DBMS's standards
DB_common::execute(): Executes a DB statement prepared with prepare()
DB_common::executeMultiple(): This function does several execute() calls on the same statement handle
DB_common::freePrepared(): Free the resource used in a prepared query
DB_common::getAll(): Fetch all the rows returned from a query
DB_common::getAssoc(): Fetch the entire result set of a query and return it as an associative array using the first column as the key
DB_common::getCol(): Fetch a single column from a result set and return it as an indexed array
DB_common::getListOf(): list internal DB info valid values for $type are db dependent, often: databases, users, view, functions
DB_common::getOne(): Fetch the first column of the first row of data returned from a query
DB_common::getOption(): Returns the value of an option
DB_common::getRow(): Fetch the first row of data returned from a query
DB_common::getSpecialQuery(): Returns the query needed to get some backend info
DB_common::getTables()
DB_common::limitQuery(): Generates a limited query
DB_common::nextId(): Returns the next free id in a sequence
DB_common::numRows(): Returns the number of rows in a result object
DB_common::prepare(): Prepares a query for multiple execution with execute()
DB_common::provides(): Tell whether a DB implementation or its backend extension supports a given feature
DB_common::query(): Send a query to the database and return any results with a DB_result object
DB_common::quote(): DEPRECATED: Quotes a string so it can be safely used in a query
DB_common::quoteIdentifier(): Quote a string so it can be safely used as a table or column name
DB_common::quoteSmart(): Format input so it can be safely used in a query
DB_common::quoteString(): DEPRECATED: Quotes a string so it can be safely used within string delimiters in a query
DB_common::raiseError(): Communicate an error and invoke error callbacks, etc
DB_common::rollback(): starts a rollback
DB_common::setFetchMode(): Sets which fetch mode should be used by default on queries on this connection
DB_common::setOption(): Set run-time configuration options for PEAR DB
DB_common::tableInfo(): Returns information about a table or a result set

Class Details

[line 41]
Database independent query interface definition for PHP's mysqli extension.

This is for MySQL versions 4.1 and above. Requires PHP 5.

Note that persistent connections no longer exist.

Author: Daniel Convissor <danielc@php.net>
Version: $Id: mysqli.php,v 1.31 2004/07/12 17:51:24 danielc Exp $
Since: Class functional since Release 1.6.3

[ Top ]

Class Variables

$autocommit = true

[line 51]

Type:

mixed

[ Top ]

$connection =

[line 45]

Type:

mixed

[ Top ]

$dbsyntax =

[line 46]

Type:

mixed

[ Top ]

$fetchmode = DB_FETCHMODE_ORDERED

[line 52]

Type:	mixed
Overrides:	Array

[ Top ]

$mysqli_flags = array(
        MYSQLI_NOT_NULL_FLAG        => 'not_null',
        MYSQLI_PRI_KEY_FLAG         => 'primary_key',
        MYSQLI_UNIQUE_KEY_FLAG      => 'unique_key',
        MYSQLI_MULTIPLE_KEY_FLAG    => 'multiple_key',
        MYSQLI_BLOB_FLAG            => 'blob',
        MYSQLI_UNSIGNED_FLAG        => 'unsigned',
        MYSQLI_ZEROFILL_FLAG        => 'zerofill',
        MYSQLI_AUTO_INCREMENT_FLAG  => 'auto_increment',
        MYSQLI_TIMESTAMP_FLAG       => 'timestamp',
        MYSQLI_SET_FLAG             => 'set',
        // MYSQLI_NUM_FLAG             => 'numeric',  // unnecessary
        // MYSQLI_PART_KEY_FLAG        => 'multiple_key',  // duplicatvie
        MYSQLI_GROUP_FLAG           => 'group_by'
    )

[line 61]

Array for converting MYSQLI_*_FLAG constants to text values

Since: Property available since Release 1.6.5
Access: public

Type:

array

[ Top ]

$mysqli_types = array(
        MYSQLI_TYPE_DECIMAL     => 'decimal',
        MYSQLI_TYPE_TINY        => 'tinyint',
        MYSQLI_TYPE_SHORT       => 'int',
        MYSQLI_TYPE_LONG        => 'int',
        MYSQLI_TYPE_FLOAT       => 'float',
        MYSQLI_TYPE_DOUBLE      => 'double',
        // MYSQLI_TYPE_NULL        => 'DEFAULT NULL',  // let flags handle it
        MYSQLI_TYPE_TIMESTAMP   => 'timestamp',
        MYSQLI_TYPE_LONGLONG    => 'bigint',
        MYSQLI_TYPE_INT24       => 'mediumint',
        MYSQLI_TYPE_DATE        => 'date',
        MYSQLI_TYPE_TIME        => 'time',
        MYSQLI_TYPE_DATETIME    => 'datetime',
        MYSQLI_TYPE_YEAR        => 'year',
        MYSQLI_TYPE_NEWDATE     => 'date',
        MYSQLI_TYPE_ENUM        => 'enum',
        MYSQLI_TYPE_SET         => 'set',
        MYSQLI_TYPE_TINY_BLOB   => 'tinyblob',
        MYSQLI_TYPE_MEDIUM_BLOB => 'mediumblob',
        MYSQLI_TYPE_LONG_BLOB   => 'longblob',
        MYSQLI_TYPE_BLOB        => 'blob',
        MYSQLI_TYPE_VAR_STRING  => 'varchar',
        MYSQLI_TYPE_STRING      => 'char',
        MYSQLI_TYPE_GEOMETRY    => 'geometry',
    )

[line 83]

Array for converting MYSQLI_TYPE_* constants to text values

Since: Property available since Release 1.6.5
Access: public

Type:

array

[ Top ]

$num_rows = array()

[line 49]

Type:

mixed

[ Top ]

$phptype =

[line 46]

Type:	mixed
Overrides:	Array

[ Top ]

$prepare_tokens = array()

[line 47]

Type:	mixed
Overrides:	Array

[ Top ]

$prepare_types = array()

[line 48]

Type:	mixed
Overrides:	Array

[ Top ]

$transaction_opcount = 0

[line 50]

Type:

mixed

[ Top ]

Method Detail

DB_mysqli (Constructor) [line 118]

DB_mysqli DB_mysqli(
)

DB_mysql constructor.

Access: public

[ Top ]

affectedRows [line 498]

integer affectedRows(
)

Gets the number of rows affected by the data manipulation query. For other queries, this function returns 0.

Return: number of rows affected by the last query

Overrides DB_common::affectedRows() (Returns the affected rows of a query)

[ Top ]

autoCommit [line 433]

void autoCommit(
[
$onoff = false])

Enable/disable automatic commits.

Overrides DB_common::autoCommit() (enable automatic Commit)

Parameters:

$onoff —

[ Top ]

commit [line 447]

void commit(
)

Commit the current transaction.

Overrides DB_common::commit() (starts a Commit)

[ Top ]

connect [line 163]

mixed connect(

$dsninfo, [boolean
$persistent = false], string
$dsn)

Connect to a database and log in as the specified user.

Return: DB_OK on success, a DB error on failure
Access: public

Parameters:

string	`$dsn`	—	the data source name (see DB::parseDSN for syntax)
boolean	`$persistent`	—	(optional) whether the connection should be persistent
	`$dsninfo`	—

[ Top ]

createSequence [line 621]

int createSequence(
string
$seq_name)

Creates a new sequence

Return: DB_OK on success. A DB_Error object is returned if problems arise.
See: DB_common::createSequence()
Access: public

Overrides DB_common::createSequence() (Creates a new sequence)

Parameters:

string $seq_name — name of the new sequence

[ Top ]

disconnect [line 235]

boolean disconnect(
)

Log out and disconnect from the database.

Return: true on success, false if not connected
Access: public

[ Top ]

dropSequence [line 648]

int dropSequence(
string
$seq_name)

Deletes a sequence

Return: DB_OK on success. DB_Error if problems.
See: DB_common::dropSequence()
Access: public

Overrides DB_common::dropSequence() (Deletes a sequence)

Parameters:

string $seq_name — name of the sequence to be deleted

[ Top ]

errorNative [line 517]

int errorNative(
)

Get the native error code of the last error (if any) that occured on the current connection.

Return: native MySQL error code
Access: public

Overrides DB_common::errorNative() (Returns an errormessage, provides by the database)

[ Top ]

escapeSimple [line 736]

string escapeSimple(
string
$str)

Escape a string according to the current DBMS's standards

Return: the escaped string

Overrides DB_common::escapeSimple() (Escape a string according to the current DBMS's standards)

Parameters:

string $str — the string to be escaped

[ Top ]

freeResult [line 377]

bool freeResult(
resource
$result)

Free the internal resources associated with $result.

Return: true on success, false if $result is invalid
Access: public

Parameters:

resource $result — MySQL result identifier

[ Top ]

getSpecialQuery [line 919]

string getSpecialQuery(
string
$type)

Returns the query needed to get some backend info.

Return: The SQL query string

Overrides DB_common::getSpecialQuery() (Returns the query needed to get some backend info)

Parameters:

string $type — What kind of info you want to retrieve

[ Top ]

modifyLimitQuery [line 751]

void modifyLimitQuery(

$query, 
$from, 
$count, [
$params = array()])

Parameters:

	`$query`	—
	`$from`	—
	`$count`	—
	`$params`	—

[ Top ]

modifyQuery [line 743]

void modifyQuery(

$query)

Parameters:

$query —

[ Top ]

mysqlRaiseError [line 773]

object DB mysqlRaiseError(
[integer
$errno = null])

Gather information about an error, then use that info to create a DB error object and finally return that object.

Return: error object
See: DB_common::raiseError()
See: DB_common::errorCode()

Parameters:

integer $errno — PEAR error number (usually a DB constant) if manually raising an error

[ Top ]

nextId [line 538]

int nextId(
string
$seq_name, [boolean
$ondemand = true])

Returns the next free id in a sequence

Return: the next id number in the sequence. DB_Error if problem.
See: DB_common::nextID()
Access: public

Overrides DB_common::nextId() (Returns the next free id in a sequence)

Parameters:

string	`$seq_name`	—	name of the sequence
boolean	`$ondemand`	—	when true, the seqence is automatically created if it does not exist

[ Top ]

nextResult [line 305]

false nextResult(
resource
$result)

Move the internal mysql result pointer to the next available result.

This method has not been implemented yet.

Access: public

Parameters:

resource $result — a valid sql result resource

[ Top ]

numCols [line 397]

int numCols(
$result
$result)

Get the number of columns in a result set.

Return: the number of columns per row in $result
Access: public

Parameters:

$result $result — MySQL result identifier

[ Top ]

numRows [line 418]

int numRows(
resource
$result)

Get the number of rows in a result set.

Return: the number of rows in $result
Access: public

Overrides DB_common::numRows() (Returns the number of rows in a result object)

Parameters:

resource $result — MySQL result identifier

[ Top ]

quoteIdentifier [line 719]

string quoteIdentifier(
string
$str)

Quote a string so it can be safely used as a table or column name

Quoting style depends on which database driver is being used.

MySQL can't handle the backtick character (`) in table or column names.

Return: quoted identifier string
Since: 1.6.0
Access: public

Overrides DB_common::quoteIdentifier() (Quote a string so it can be safely used as a table or column name)

Parameters:

string $str — identifier name to be quoted

[ Top ]

rollback [line 471]

void rollback(
)

Roll back (undo) the current transaction.

Overrides DB_common::rollback() (starts a rollback)

[ Top ]

simpleQuery [line 255]

mixed simpleQuery(
string
$query)

Send a query to MySQL and return the results as a MySQL resource identifier.

Return: a valid MySQL result for successful SELECT queries, DB_OK for other successful queries. A DB error is returned on failure.
Access: public

Parameters:

string $query — the SQL query

[ Top ]

tableInfo [line 811]

array tableInfo(
object|string
$result, [int
$mode = null])

Returns information about a table or a result set.

WARNING: this method will probably not work because the mysqli_*() functions it relies upon may not exist.

Return: an associative array with the information requested or an error object if something is wrong
See: DB_common::tableInfo()
Access: public

Overrides DB_common::tableInfo() (Returns information about a table or a result set)

Parameters:

object\|string	`$result`	—	DB_result object from a query or a string containing the name of a table
int	`$mode`	—	a valid tableInfo mode

[ Top ]