Source for file mysqli.php
Documentation is available at mysqli.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2004 Manuel Lemos, Tomas V.V.Cox, |
// | Stig. S. Bakken, Lukas Smith |
// | All rights reserved. |
// +----------------------------------------------------------------------+
// | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB |
// | API as well as database abstraction for PHP applications. |
// | This LICENSE is in the BSD license style. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
// | Lukas Smith nor the names of his contributors may be used to endorse |
// | or promote products derived from this software without specific prior|
// | written permission. |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
// | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Author: Lukas Smith <smith@backendmedia.com> |
// +----------------------------------------------------------------------+
// $Id: mysqli.php,v 1.21 2005/04/25 13:09:03 lsmith Exp $
* @author Lukas Smith <smith@backendmedia.com>
$this->supported['summary_functions'] = true;
$this->options['default_table_type'] = null;
* This method is used to collect information about an error
// Doing this in case mode changes during runtime.
if (isset ($ecode_map[$native_code])) {
$error = $ecode_map[$native_code];
return array ($error, $native_code, $native_msg);
* Quotes a string so it can be safely used in a query. It will quote
* the text so it can safely be used within a query.
* @param string $text the input string to quote
* @return string quoted string
* 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 (<kbd>`</kbd>) in
* @param string $str identifier name to be quoted
* @return string quoted identifier string
// {{{ beginTransaction()
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('starting transaction', 'beginTransaction');
'beginTransaction: transactions are not in use');
$result = $this->_doQuery('SET AUTOCOMMIT = 0', true );
if (PEAR ::isError ($result)) {
* Commit the database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('commit transaction', 'commit');
'commit: transactions are not in use');
'commit: transaction changes are being auto committed');
$result = $this->_doQuery('COMMIT', true );
if (PEAR ::isError ($result)) {
$result = $this->_doQuery('SET AUTOCOMMIT = 1', true );
if (PEAR ::isError ($result)) {
* Cancel any database changes done during a transaction that is in
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug('rolling back transaction', 'rollback');
'rollback: transactions are not in use');
'rollback: transactions can not be rolled back when changes are auto committed');
$result = $this->_doQuery('ROLLBACK', true );
if (PEAR ::isError ($result)) {
$result = $this->_doQuery('SET AUTOCOMMIT = 1', true );
if (PEAR ::isError ($result)) {
* Connect to the database
* @return true on success, MDB2 Error Object on failure
if (!PEAR ::loadExtension ($this->phptype)) {
'connect: extension '. $this->phptype. ' is not compiled into PHP');
if ($this->options['ssl'] === true ) {
empty ($this->dsn['key']) ? null : $this->dsn['key'],
empty ($this->dsn['cert']) ? null : $this->dsn['cert'],
empty ($this->dsn['ca']) ? null : $this->dsn['ca'],
empty ($this->dsn['capath']) ? null : $this->dsn['capath'],
empty ($this->dsn['cipher']) ? null : $this->dsn['cipher']
if ($this->options['default_table_type']) {
$this->options['default_table_type'] = 'BDB';
$this->warnings[] = $default_table_type.
' is not a supported default table type';
if ($this->options['use_transactions'] && !$this->supports('transactions')) {
' is not a transaction-safe default table type; switched to INNODB';
$this->options['default_table_type'] = 'INNODB';
* Log out and disconnect from the database.
* @return mixed true on success, false if not connected and error
* @param string $query query
* @param boolean $isManip if the query is a manipulation query
* @param resource $connection
* @param string $database_name
* @return result or error object
function _doQuery($query, $isManip = false , $connection = null , $database_name = null )
$this->debug($query, 'query');
if ($this->options['disable_query']) {
if (PEAR ::isError ($error)) {
$function = $this->options['result_buffering']
? 'mysqli_query' : 'mysqli_unbuffered_query';
$result = @$function($connection, $query);
* Changes a query string for various DBMS specific reasons
* @param string $query query to modify
* @return the new (modified) query
&& !preg_match('/LIMIT\s*\d(\s*(,|OFFSET)\s*\d+)?/i', $query)
if (substr($query, -1 ) == ';') {
$query = substr($query, 0 , -1 );
return $query . " LIMIT $limit";
return $query . " LIMIT $offset, $limit";
* simple subselect emulation for Mysql
* @param string $query the SQL query for the subselect that may only
* @param string $type determines type of the field
* @return string comma seperated values
return $this->datatype->implodeArray ($col, $type);
* Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
* query, except that if there is already a row in the table with the same
* key field values, the REPLACE query just updates its values instead of
* The REPLACE type of query does not make part of the SQL standards. Since
* practically only MySQL implements it natively, this type of query is
* emulated through this method for other DBMS using standard types of
* queries inside a transaction to assure the atomicity of the operation.
* @param string $table name of the table on which the REPLACE query will
* @param array $fields associative array that describes the fields and the
* values that will be inserted or updated in the specified table. The
* indexes of the array are the names of all the fields of the table. The
* values of the array are also associative arrays that describe the
* values and other properties of the table fields.
* Here follows a list of field properties that need to be specified:
* Value to be assigned to the specified field. This value may be
* of specified in database independent type format as this
* function can perform the necessary datatype conversions.
* this property is required unless the Null property
* Name of the type of the field. Currently, all types Metabase
* are supported except for clob and blob.
* Default: no type conversion
* Boolean property that indicates that the value for this field
* The default value for fields missing in INSERT queries may be
* specified the definition of a table. Often, the default value
* is already null, but since the REPLACE may be emulated using
* an UPDATE query, make sure that all fields of the table are
* listed in this function argument array.
* Boolean property that indicates that this field should be
* handled as a primary key or at least as part of the compound
* unique index of the table that will determine the row that will
* updated if it exists or inserted a new row otherwise.
* This function will fail if no key field is specified or if the
* value of a key field is set to null because fields that are
* part of unique index they may not be null.
* @return mixed MDB2_OK on success, a MDB2 error on failure
for (reset($fields); $colnum < $count; next($fields), $colnum++ ) {
if (isset ($fields[$name]['null']) && $fields[$name]['null']) {
$value = $this->quote($fields[$name]['value'], $fields[$name]['type']);
if (isset ($fields[$name]['key']) && $fields[$name]['key']) {
'replace: key value '. $name. ' may not be NULL');
'replace: not specified which fields are keys');
$query = " REPLACE INTO $table ($query) VALUES ($values)";
$this->debug($query, 'query');
* returns the next free id of a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true the seqence is
* automatic created, if it
* @return mixed MDB2 Error Object or id
function nextID($seq_name, $ondemand = true )
$query = " INSERT INTO $sequence_name (". $this->options['seqcol_name']. ") VALUES (NULL)";
$result = $this->_doQuery($query, true );
if (PEAR ::isError ($result)) {
// Since we are creating the sequence on demand
// we know the first id = 1 so initialize the
$result = $this->manager->createSequence ($seq_name, 2 );
if (PEAR ::isError ($result)) {
'nextID: on demand sequence '. $seq_name. ' could not be created');
// First ID of a newly created sequence is 1
$query = " DELETE FROM $sequence_name WHERE ". $this->options['seqcol_name']." < $value";
$result = $this->_doQuery($query, true );
if (PEAR ::isError ($result)) {
$this->warnings[] = 'nextID: could not delete previous sequence table values from '. $seq_name;
* returns the autoincrement ID if supported or $id
* @param mixed $id value as returned by getBeforeId()
* @param string $table name of the table into which a new row was inserted
* @return mixed MDB2 Error Object or id
return $this->native->getInsertID ();
* returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB2 Error Object or id
return $this->queryOne("SELECT MAX(". $this->options['seqcol_name']." ) FROM $sequence_name" , 'integer');
class MDB2_Result_mysqli extends MDB2_Result_Common
* Fetch a row and insert the data into an existing array.
* @param int $fetchmode how the array data should be indexed
* @param int $rownum number of the row where the data can be found
* @return int data array on success, a MDB2 error on failure
function &fetchRow ($fetchmode = MDB2_FETCHMODE_DEFAULT , $rownum = null )
$seek = $this->seek ($rownum);
if (PEAR ::isError ($seek)) {
$fetchmode = $this->db->fetchmode;
'fetchRow: resultset has already been freed');
$this->db->_convertEmptyArrayValuesToNull ($row);
if (isset ($this->values)) {
$this->_assignBindColumns ($row);
if (isset ($this->types)) {
$row = $this->db->datatype ->convertResultRow ($this->types, $row);
$object_class = $this->db->options ['fetch_class'];
if ($object_class == 'stdClass') {
$row = &new $object_class($row);
* Retrieve the names of columns returned by the DBMS in a query result.
* @return mixed an associative array variable
* that will hold the names of columns. The
* indexes of the array are the column names
* mapped to lower case and the values are the
* respective numbers of the columns starting
* from 0. Some DBMS may not return any
* columns when the result set does not
* a MDB2 error on failure
function _getColumnNames ()
$numcols = $this->numCols ();
if (PEAR ::isError ($numcols)) {
for ($column = 0; $column < $numcols; $column++ ) {
$columns[$column_info->name ] = $column;
* Count the number of columns returned by the DBMS in a query result.
* @return mixed integer value with the number of columns, a MDB2 error
'numCols: resultset has already been freed');
return $this->db->raiseError ();
* Free the internal resources associated with result.
* @return boolean true on success, false if result is invalid
class MDB2_BufferedResult_mysqli extends MDB2_Result_mysqli
* seek to a specific row in a result set
* @param int $rownum number of the row where the data can be found
* @return mixed MDB2_OK on success, a MDB2 error on failure
function seek ($rownum = 0 )
if ($this->rownum != ($rownum - 1 ) && !@mysqli_data_seek($this->result, $rownum)) {
'seek: resultset has already been freed');
'seek: tried to seek to an invalid row number ('. $rownum. ')');
$this->rownum = $rownum - 1;
* check if the end of the result set has been reached
* @return mixed true or false on sucess, a MDB2 error on failure
$numrows = $this->numRows ();
if (PEAR ::isError ($numrows)) {
return $this->rownum < ($numrows - 1 );
* returns the number of rows in a result object
* @return mixed MDB2 Error Object or the number of rows
'numRows: resultset has already been freed');
return $this->raiseError ();
class MDB2_Statement_mysqli extends MDB2_Statement_Common
Documentation generated on Mon, 11 Mar 2019 14:20:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|