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-2006 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@pooteeweet.org> |
// +----------------------------------------------------------------------+
// $Id: mysqli.php 327320 2012-08-27 15:52:50Z danielc $
* @author Lukas Smith <smith@pooteeweet.org>
'escape_pattern' => '\\',
* The ouptut of mysqli_errno() in _doQuery(), if any.
* The ouptut of mysqli_error() in _doQuery(), if any.
array ('start' => '-- ', 'end' => "\n", 'escape' => false ),
array ('start' => '#', 'end' => "\n", 'escape' => false ),
array ('start' => '/*', 'end' => '*/', 'escape' => false ),
$this->phptype = 'mysqli';
$this->dbsyntax = 'mysql';
$this->supported['sequences'] = 'emulated';
$this->supported['indexes'] = true;
$this->supported['affected_rows'] = true;
$this->supported['transactions'] = false;
$this->supported['savepoints'] = false;
$this->supported['summary_functions'] = true;
$this->supported['order_by_text'] = true;
$this->supported['current_id'] = 'emulated';
$this->supported['limit_queries'] = true;
$this->supported['LOBs'] = true;
$this->supported['replace'] = true;
$this->supported['sub_selects'] = 'emulated';
$this->supported['triggers'] = false;
$this->supported['auto_increment'] = true;
$this->supported['primary_key'] = true;
$this->supported['result_introspection'] = true;
$this->supported['prepared_statements'] = 'emulated';
$this->supported['identifier_quoting'] = true;
$this->supported['pattern_escaping'] = true;
$this->supported['new_link'] = true;
$this->options['DBA_username'] = false;
$this->options['DBA_password'] = false;
$this->options['default_table_type'] = '';
$this->options['multi_query'] = false;
$this->options['max_identifiers_length'] = 64;
$this->_reCheckSupportedOptions ();
// {{{ _reCheckSupportedOptions()
* If the user changes certain options, other capabilities may depend
* on the new settings, so we need to check them (again).
function _reCheckSupportedOptions ()
$this->supported['transactions'] = $this->options['use_transactions'];
$this->supported['savepoints'] = $this->options['use_transactions'];
if ($this->options['default_table_type']) {
switch (strtoupper($this->options['default_table_type'])) {
$this->supported['savepoints'] = false;
$this->supported['transactions'] = false;
$this->warnings[] = $this->options['default_table_type'] .
' is not a supported default table type';
// {{{ function setOption($option, $value)
* set the option for the db class
* @param string option name
* @param mixed value for the option
* @return mixed MDB2_OK or MDB2 Error Object
$res = parent ::setOption ($option, $value);
$this->_reCheckSupportedOptions ();
* This method is used to collect information about an error
} elseif ($this->connection) {
1000 => MDB2_ERROR_INVALID , //hashchk
1001 => MDB2_ERROR_INVALID , //isamchk
1004 => MDB2_ERROR_CANNOT_CREATE ,
1005 => MDB2_ERROR_CANNOT_CREATE ,
1006 => MDB2_ERROR_CANNOT_CREATE ,
1007 => MDB2_ERROR_ALREADY_EXISTS ,
1008 => MDB2_ERROR_CANNOT_DROP ,
1009 => MDB2_ERROR_CANNOT_DROP ,
1010 => MDB2_ERROR_CANNOT_DROP ,
1011 => MDB2_ERROR_CANNOT_DELETE ,
1022 => MDB2_ERROR_ALREADY_EXISTS ,
1029 => MDB2_ERROR_NOT_FOUND ,
1032 => MDB2_ERROR_NOT_FOUND ,
1044 => MDB2_ERROR_ACCESS_VIOLATION ,
1045 => MDB2_ERROR_ACCESS_VIOLATION ,
1046 => MDB2_ERROR_NODBSELECTED ,
1048 => MDB2_ERROR_CONSTRAINT ,
1049 => MDB2_ERROR_NOSUCHDB ,
1050 => MDB2_ERROR_ALREADY_EXISTS ,
1051 => MDB2_ERROR_NOSUCHTABLE ,
1054 => MDB2_ERROR_NOSUCHFIELD ,
1060 => MDB2_ERROR_ALREADY_EXISTS ,
1061 => MDB2_ERROR_ALREADY_EXISTS ,
1062 => MDB2_ERROR_ALREADY_EXISTS ,
1064 => MDB2_ERROR_SYNTAX ,
1067 => MDB2_ERROR_INVALID ,
1072 => MDB2_ERROR_NOT_FOUND ,
1086 => MDB2_ERROR_ALREADY_EXISTS ,
1091 => MDB2_ERROR_NOT_FOUND ,
1100 => MDB2_ERROR_NOT_LOCKED ,
1109 => MDB2_ERROR_NOT_FOUND ,
1125 => MDB2_ERROR_ALREADY_EXISTS ,
1136 => MDB2_ERROR_VALUE_COUNT_ON_ROW ,
1138 => MDB2_ERROR_INVALID ,
1142 => MDB2_ERROR_ACCESS_VIOLATION ,
1143 => MDB2_ERROR_ACCESS_VIOLATION ,
1146 => MDB2_ERROR_NOSUCHTABLE ,
1149 => MDB2_ERROR_SYNTAX ,
1169 => MDB2_ERROR_CONSTRAINT ,
1176 => MDB2_ERROR_NOT_FOUND ,
1177 => MDB2_ERROR_NOSUCHTABLE ,
1213 => MDB2_ERROR_DEADLOCK ,
1216 => MDB2_ERROR_CONSTRAINT ,
1217 => MDB2_ERROR_CONSTRAINT ,
1227 => MDB2_ERROR_ACCESS_VIOLATION ,
1235 => MDB2_ERROR_CANNOT_CREATE ,
1299 => MDB2_ERROR_INVALID_DATE ,
1300 => MDB2_ERROR_INVALID ,
1304 => MDB2_ERROR_ALREADY_EXISTS ,
1305 => MDB2_ERROR_NOT_FOUND ,
1306 => MDB2_ERROR_CANNOT_DROP ,
1307 => MDB2_ERROR_CANNOT_CREATE ,
1334 => MDB2_ERROR_CANNOT_ALTER ,
1339 => MDB2_ERROR_NOT_FOUND ,
1356 => MDB2_ERROR_INVALID ,
1359 => MDB2_ERROR_ALREADY_EXISTS ,
1360 => MDB2_ERROR_NOT_FOUND ,
1363 => MDB2_ERROR_NOT_FOUND ,
1365 => MDB2_ERROR_DIVZERO ,
1451 => MDB2_ERROR_CONSTRAINT ,
1452 => MDB2_ERROR_CONSTRAINT ,
1542 => MDB2_ERROR_CANNOT_DROP ,
1546 => MDB2_ERROR_CONSTRAINT ,
1582 => MDB2_ERROR_CONSTRAINT ,
2003 => MDB2_ERROR_CONNECT_FAILED ,
2019 => MDB2_ERROR_INVALID ,
if ($this->options['portability'] & MDB2_PORTABILITY_ERRORS ) {
$ecode_map[1022 ] = MDB2_ERROR_CONSTRAINT;
$ecode_map[1048 ] = MDB2_ERROR_CONSTRAINT_NOT_NULL;
$ecode_map[1062 ] = MDB2_ERROR_CONSTRAINT;
// Doing this in case mode changes during runtime.
$ecode_map[1022 ] = MDB2_ERROR_ALREADY_EXISTS;
$ecode_map[1048 ] = MDB2_ERROR_CONSTRAINT;
$ecode_map[1062 ] = MDB2_ERROR_ALREADY_EXISTS;
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 the input string to quote
* @param bool escape wildcards
* @return string quoted string
function escape($text, $escape_wildcards = false )
$text = $this->escapePattern ($text);
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
// {{{ beginTransaction()
* Start a transaction or set a savepoint.
* @param string name of a savepoint to set
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('Starting transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
$this->_getServerCapabilities ();
if (null !== $savepoint) {
if (!$this->supports ('savepoints')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'savepoints are not supported', __FUNCTION__ );
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'savepoint cannot be released when changes are auto committed', __FUNCTION__ );
$query = 'SAVEPOINT '. $savepoint;
if ($this->in_transaction) {
return MDB2_OK; //nothing to do
$result = $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = true;
* Commit the database changes done during a transaction that is in
* progress or release a savepoint. This function may only be called when
* auto-committing is disabled, otherwise it will fail. Therefore, a new
* transaction is implicitly started after committing the pending changes.
* @param string name of a savepoint to release
* @return mixed MDB2_OK on success, a MDB2 error on failure
function commit($savepoint = null )
$this->debug ('Committing transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'commit/release savepoint cannot be done changes are auto committed', __FUNCTION__ );
if (null !== $savepoint) {
if (!$this->supports ('savepoints')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'savepoints are not supported', __FUNCTION__ );
if (version_compare($server_info['major']. '.'. $server_info['minor']. '.'. $server_info['patch'], '5.0.3', '<')) {
$query = 'RELEASE SAVEPOINT '. $savepoint;
if (!$this->supports ('transactions')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'transactions are not supported', __FUNCTION__ );
$result = $this->_doQuery('COMMIT', true );
if (MDB2 ::isError ($result)) {
$query = 'SET AUTOCOMMIT = 1';
$result = $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = false;
* Cancel any database changes done during a transaction or since a specific
* savepoint that is in progress. This function may only be called when
* auto-committing is disabled, otherwise it will fail. Therefore, a new
* transaction is implicitly started after canceling the pending changes.
* @param string name of a savepoint to rollback to
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('Rolling back transaction/savepoint', __FUNCTION__ , array ('is_manip' => true , 'savepoint' => $savepoint));
if (!$this->in_transaction) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'rollback cannot be done changes are auto committed', __FUNCTION__ );
if (null !== $savepoint) {
if (!$this->supports ('savepoints')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'savepoints are not supported', __FUNCTION__ );
$query = 'ROLLBACK TO SAVEPOINT '. $savepoint;
$result = $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$query = 'SET AUTOCOMMIT = 1';
$result = $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$this->in_transaction = false;
// {{{ function setTransactionIsolation()
* Set the transacton isolation level.
* @param string standard isolation level
* READ UNCOMMITTED (allows dirty reads)
* READ COMMITTED (prevents dirty reads)
* REPEATABLE READ (prevents nonrepeatable reads)
* SERIALIZABLE (prevents phantom reads)
* @param array some transaction options:
* 'wait' => 'WAIT' | 'NO WAIT'
* 'rw' => 'READ WRITE' | 'READ ONLY'
* @return mixed MDB2_OK on success, a MDB2 error on failure
$this->debug ('Setting transaction isolation level', __FUNCTION__ , array ('is_manip' => true ));
if (!$this->supports ('transactions')) {
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'transactions are not supported', __FUNCTION__ );
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'isolation level is not supported: '. $isolation, __FUNCTION__ );
$query = " SET SESSION TRANSACTION ISOLATION LEVEL $isolation";
* do the grunt work of the connect
* @return connection on success or MDB2 Error Object on failure
function _doConnect($username, $password, $persistent = false )
return $this->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'extension '. $this->phptype. ' is not compiled into PHP', __FUNCTION__ );
if (!empty ($this->dsn['charset']) && defined('MYSQLI_SET_CHARSET_NAME')) {
@mysqli_options($connection, MYSQLI_SET_CHARSET_NAME , $this->dsn['charset']);
if ($this->options['ssl']) {
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']
return $this->raiseError (null ,
null , null , $err, __FUNCTION__ );
return $this->raiseError (MDB2_ERROR_CONNECT_FAILED , null , null ,
'unable to establish a connection', __FUNCTION__ );
if (!empty ($this->dsn['charset']) && !defined('MYSQLI_SET_CHARSET_NAME')) {
$result = $this->setCharset($this->dsn['charset'], $connection);
if (MDB2 ::isError ($result)) {
* Connect to the database
* @return true on success, MDB2 Error Object on failure
//if (count(array_diff($this->connected_dsn, $this->dsn)) == 0) {
if (MDB2 ::areEquals ($this->connected_dsn, $this->dsn)) {
if (MDB2 ::isError ($connection)) {
$this->connection = $connection;
$this->connected_dsn = $this->dsn;
$this->connected_database_name = $this->database_name;
$this->dbsyntax = $this->dsn['dbsyntax'] ? $this->dsn['dbsyntax'] : $this->phptype;
$this->_getServerCapabilities ();
* Set the charset on the current connection
* @param string charset (or array(charset, collation))
* @param resource connection handle
* @return true on success, MDB2 Error Object on failure
if (null === $connection) {
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if (OS_WINDOWS && ((40111 > $client_info) ||
((50000 <= $client_info) && (50006 > $client_info)))
if (null !== $collation) {
return $this->_doQuery($query, true , $connection);
$err = $this->raiseError (null , null , null ,
'Could not set client character set', __FUNCTION__ );
* check if given database name is exists?
* @param string $name name of the database that should be checked
* @return mixed true/false on success, a MDB2 error on failure
$connection = $this->_doConnect($this->dsn['username'],
if (MDB2 ::isError ($connection)) {
* Log out and disconnect from the database.
* @param boolean $force if the disconnect should be forced even if the
* connection is opened persistently
* @return mixed true on success, false if not connected and error
if ($this->in_transaction) {
$database_name = $this->database_name;
$persistent = $this->options['persistent'];
$this->dsn = $this->connected_dsn;
$this->database_name = $this->connected_database_name;
$this->options['persistent'] = $this->opened_persistent;
$this->database_name = $database_name;
$this->options['persistent'] = $persistent;
return $this->raiseError (MDB2_ERROR_DISCONNECT_FAILED ,
null , null , null , __FUNCTION__ );
return parent ::disconnect ($force);
* @param string $query the SQL query
* @param mixed $types array that contains the types of the columns in
* @param boolean $is_manip if the query is a manipulation query
* @return mixed MDB2_OK on success, a MDB2 error on failure
$user = $this->options['DBA_username']? $this->options['DBA_username'] : $this->dsn['username'];
$pass = $this->options['DBA_password']? $this->options['DBA_password'] : $this->dsn['password'];
if (MDB2 ::isError ($connection)) {
$this->offset = $this->limit = 0;
$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
$result = $this->_doQuery($query, $is_manip, $connection, $this->database_name);
if (!MDB2 ::isError ($result)) {
$result = $this->_affectedRows ($connection, $result);
* @param string $query query
* @param boolean $is_manip if the query is a manipulation query
* @param resource $connection
* @param string $database_name
* @return result or error object
function _doQuery($query, $is_manip = false , $connection = null , $database_name = null )
$this->last_query = $query;
$result = $this->debug ($query, 'query', array ('is_manip' => $is_manip, 'when' => 'pre'));
if (MDB2 ::isError ($result)) {
if ($this->options['disable_query']) {
$result = $is_manip ? 0 : null;
if (null === $connection) {
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if (null === $database_name) {
$database_name = $this->database_name;
if ($database_name != $this->connected_database_name) {
$err = $this->raiseError (null , null , null ,
'Could not select the database: '. $database_name, __FUNCTION__ );
$this->connected_database_name = $database_name;
if ($this->options['multi_query']) {
$resultmode = $this->options['result_buffering'] ? MYSQLI_USE_RESULT : MYSQLI_USE_RESULT;
// Store now because standaloneQuery throws off $this->connection.
$err = $this->raiseError (null , null , null ,
'Could not execute statement', __FUNCTION__ );
if ($this->options['multi_query']) {
if ($this->options['result_buffering']) {
$err = $this->raiseError (null , null , null ,
'Could not get the first result from a multi query', __FUNCTION__ );
$err = $this->raiseError (null , null , null ,
'Could not get the first result from a multi query', __FUNCTION__ );
$this->debug ($query, 'query', array ('is_manip' => $is_manip, 'when' => 'post', 'result' => $result));
* Returns the number of rows affected
* @param resource $result
* @param resource $connection
* @return mixed MDB2 Error Object or the number of rows affected
function _affectedRows ($connection, $result = null )
if (null === $connection) {
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
* Changes a query string for various DBMS specific reasons
* @param string $query query to modify
* @param boolean $is_manip if it is a DML query
* @param integer $limit limit the number of rows
* @param integer $offset start reading from given offset
* @return string modified query
if ($this->options['portability'] & MDB2_PORTABILITY_DELETE_COUNT ) {
// "DELETE FROM table" gives 0 affected rows in MySQL.
// This little hack lets you know how many rows were deleted.
if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $query)) {
'DELETE FROM \1 WHERE 1=1', $query);
&& !preg_match('/LIMIT\s*\d(?:\s*(?:,|OFFSET)\s*\d+)?(?:[^\)]*)?$/i', $query)
if (substr($query, -1 ) == ';') {
$query = substr($query, 0 , -1 );
// LIMIT doesn't always come last in the query
// @see http://dev.mysql.com/doc/refman/5.0/en/select.html
if (preg_match('/(\s+INTO\s+(?:OUT|DUMP)FILE\s.*)$/ims', $query, $matches)) {
$query = preg_replace('/(\s+INTO\s+(?:OUT|DUMP)FILE\s.*)$/ims', '', $query);
} elseif (preg_match('/(\s+FOR\s+UPDATE\s*)$/i', $query, $matches)) {
$query = preg_replace('/(\s+FOR\s+UPDATE\s*)$/im', '', $query);
} elseif (preg_match('/(\s+LOCK\s+IN\s+SHARE\s+MODE\s*)$/im', $query, $matches)) {
$query = preg_replace('/(\s+LOCK\s+IN\s+SHARE\s+MODE\s*)$/im', '', $query);
return $query . " LIMIT $limit" . $after;
return $query . " LIMIT $offset, $limit" . $after;
// {{{ getServerVersion()
* return version information about the server
* @param bool $native determines if the raw version string should be returned
* @return mixed array/string with version information or MDB2 error object
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if ($this->connected_server_info) {
$server_info = $this->connected_server_info;
return $this->raiseError (null , null , null ,
'Could not get server information', __FUNCTION__ );
$this->connected_server_info = $server_info;
$tmp = explode('.', $server_info, 3 );
if (isset ($tmp[2 ]) && strpos($tmp[2 ], '-')) {
$tmp2[0 ] = isset ($tmp[2 ]) ? $tmp[2 ] : null;
'major' => isset ($tmp[0 ]) ? $tmp[0 ] : null ,
'minor' => isset ($tmp[1 ]) ? $tmp[1 ] : null ,
'native' => $server_info,
// {{{ _getServerCapabilities()
* Fetch some information about the server capabilities
* (transactions, subselects, prepared statements, etc).
function _getServerCapabilities ()
$this->supported['sub_selects'] = 'emulated';
$this->supported['prepared_statements'] = 'emulated';
$this->supported['triggers'] = false;
$server_version = $server_info['major']. '.'. $server_info['minor']. '.'. $server_info['patch'];
$this->supported['sub_selects'] = true;
$this->supported['prepared_statements'] = true;
// SAVEPOINTs were introduced in MySQL 4.0.14 and 4.1.1 (InnoDB)
$this->supported['savepoints'] = false;
$this->supported['savepoints'] = false;
$this->supported['triggers'] = true;
// {{{ function _skipUserDefinedVariable($query, $position)
* Utility method, used by prepare() to avoid misinterpreting MySQL user
* defined variables (SELECT @x:=5) for placeholders.
* Check if the placeholder is a false positive, i.e. if it is an user defined
* variable instead. If so, skip it and advance the position, otherwise
* return the current position, which is valid
* @param integer $position current string cursor position
* @return integer $new_position
$substring = substr($query, $pos, $position - $pos + 2 );
return $position + 1; //found an user defined variable: skip it
* Prepares a query for multiple execution with execute().
* With some database backends, this is emulated.
* prepare() requires a generic query as string like
* 'INSERT INTO numbers VALUES(?,?)' or
* 'INSERT INTO numbers VALUES(:foo,:bar)'.
* The ? and :name and are placeholders which can be set using
* bindParam() and the query can be sent off using the execute() method.
* The allowed format for :name can be set with the 'bindname_format' option.
* @param string $query the query to prepare
* @param mixed $types array that contains the types of the placeholders
* @param mixed $result_types array that contains the types of the columns in
* the result set or MDB2_PREPARE_RESULT, if set to
* MDB2_PREPARE_MANIP the query is handled as a manipulation query
* @param mixed $lobs key (field) value (parameter) pair for all lob placeholders
* @return mixed resource handle for the prepared query on success, a MDB2
* @see bindParam, execute
function prepare($query, $types = null , $result_types = null , $lobs = array ())
// connect to get server capabilities (http://pear.php.net/bugs/16147)
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if ($this->options['emulate_prepared']
|| $this->supported['prepared_statements'] !== true
return parent ::prepare ($query, $types, $result_types, $lobs);
$is_manip = ($result_types === MDB2_PREPARE_MANIP );
$this->offset = $this->limit = 0;
$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
$result = $this->debug ($query, __FUNCTION__ , array ('is_manip' => $is_manip, 'when' => 'pre'));
if (MDB2 ::isError ($result)) {
$placeholder_type_guess = $placeholder_type = null;
while ($position < strlen($query)) {
$q_position = strpos($query, $question, $position);
$c_position = strpos($query, $colon, $position);
if ($q_position && $c_position) {
$p_position = min($q_position, $c_position);
$p_position = $q_position;
$p_position = $c_position;
if (null === $placeholder_type) {
$placeholder_type_guess = $query[$p_position];
$new_pos = $this->_skipDelimitedStrings ($query, $position, $p_position);
if (MDB2 ::isError ($new_pos)) {
if ($new_pos != $position) {
continue; //evaluate again starting from the new position
//make sure this is not part of an user defined variable
if ($new_pos != $position) {
continue; //evaluate again starting from the new position
if ($query[$position] == $placeholder_type_guess) {
if (null === $placeholder_type) {
$placeholder_type = $query[$p_position];
$question = $colon = $placeholder_type;
if ($placeholder_type == ':') {
$regexp = '/^.{'. ($position+1 ). '}('. $this->options['bindname_format']. ').*$/s';
$err = $this->raiseError (MDB2_ERROR_SYNTAX , null , null ,
'named parameter name must match "bindname_format" option', __FUNCTION__ );
$positions[$p_position] = $parameter;
$positions[$p_position] = count($positions);
$position = $p_position + 1;
static $prep_statement_counter = 1;
$statement_name = sprintf ($this->options ['statement_format'], $this->phptype , $prep_statement_counter++ . sha1 (microtime () + mt_rand ()));
$statement_name = substr(strtolower($statement_name), 0 , $this->options['max_identifiers_length']);
$query = " PREPARE $statement_name FROM ". $this->quote ($query, 'text');
$statement = $this->_doQuery($query, true , $connection);
if (MDB2 ::isError ($statement)) {
$statement = $statement_name;
$err = $this->raiseError (null , null , null ,
'Unable to create prepared statement handle', __FUNCTION__ );
$class_name = 'MDB2_Statement_'. $this->phptype;
$obj = new $class_name($this, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
$this->debug ($query, __FUNCTION__ , array ('is_manip' => $is_manip, 'when' => 'post', 'result' => $obj));
* 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 old row is deleted before the new row is inserted.
* 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.
* @see http://dev.mysql.com/doc/refman/5.0/en/replace.html
* @return mixed MDB2_OK on success, a MDB2 error on failure
for (reset($fields); $colnum < $count; next($fields), $colnum++ ) {
$query.= $this->quoteIdentifier ($name, true );
if (isset ($fields[$name]['null']) && $fields[$name]['null']) {
$type = isset ($fields[$name]['type']) ? $fields[$name]['type'] : null;
$value = $this->quote ($fields[$name]['value'], $type);
if (MDB2 ::isError ($value)) {
if (isset ($fields[$name]['key']) && $fields[$name]['key']) {
return $this->raiseError (MDB2_ERROR_CANNOT_REPLACE , null , null ,
'key value '. $name. ' may not be NULL', __FUNCTION__ );
return $this->raiseError (MDB2_ERROR_CANNOT_REPLACE , null , null ,
'not specified which fields are keys', __FUNCTION__ );
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
$table = $this->quoteIdentifier ($table, true );
$query = " REPLACE INTO $table ($query) VALUES ($values)";
$result = $this->_doQuery($query, true , $connection);
if (MDB2 ::isError ($result)) {
return $this->_affectedRows ($connection, $result);
* Returns the next free id of a sequence
* @param string $seq_name name of the sequence
* @param boolean $ondemand when true the sequence is
* automatic created, if it
* @return mixed MDB2 Error Object or id
function nextID($seq_name, $ondemand = true )
$sequence_name = $this->quoteIdentifier ($this->getSequenceName ($seq_name), true );
$seqcol_name = $this->quoteIdentifier ($this->options['seqcol_name'], true );
$query = " INSERT INTO $sequence_name ($seqcol_name) VALUES (NULL)";
$this->pushErrorHandling (PEAR_ERROR_RETURN );
$this->expectError (MDB2_ERROR_NOSUCHTABLE );
$result = $this->_doQuery($query, true );
$this->popErrorHandling ();
if (MDB2 ::isError ($result)) {
if ($ondemand && $result->getCode () == MDB2_ERROR_NOSUCHTABLE ) {
$this->loadModule ('Manager', null , true );
$result = $this->manager->createSequence ($seq_name);
if (MDB2 ::isError ($result)) {
return $this->raiseError ($result, null , null ,
'on demand sequence '. $seq_name. ' could not be created', __FUNCTION__ );
return $this->nextID($seq_name, false );
$query = " DELETE FROM $sequence_name WHERE $seqcol_name < $value";
$result = $this->_doQuery($query, true );
if (MDB2 ::isError ($result)) {
$this->warnings[] = 'nextID: could not delete previous sequence table values from '. $seq_name;
* Returns the autoincrement ID if supported or $id or fetches the current
* ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
* @param string $table name of the table into which a new row was inserted
* @param string $field name of the field into which a new row was inserted
* @return mixed MDB2 Error Object or id
// not using mysql_insert_id() due to http://pear.php.net/bugs/bug.php?id=8051
// not casting to integer to handle BIGINT http://pear.php.net/bugs/bug.php?id=17650
return $this->queryOne ('SELECT LAST_INSERT_ID()');
* Returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB2 Error Object or id
$sequence_name = $this->quoteIdentifier ($this->getSequenceName ($seq_name), true );
$seqcol_name = $this->quoteIdentifier ($this->options['seqcol_name'], true );
$query = " SELECT MAX($seqcol_name) FROM $sequence_name";
return $this->queryOne ($query, 'integer');
* MDB2 MySQLi result driver
* @author Lukas Smith <smith@pooteeweet.org>
* 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 (MDB2 ::isError ($seek)) {
if ($fetchmode == MDB2_FETCHMODE_DEFAULT ) {
$fetchmode = $this->db->fetchmode;
if ( $fetchmode == MDB2_FETCHMODE_ASSOC
|| $fetchmode == MDB2_FETCHMODE_OBJECT
&& $this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
if (false === $this->result) {
$err = & $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
$mode = $this->db->options ['portability'] & MDB2_PORTABILITY_EMPTY_TO_NULL;
if ($this->db->options ['portability'] & MDB2_PORTABILITY_RTRIM ) {
if (empty ($this->types)) {
$mode += MDB2_PORTABILITY_RTRIM;
$this->db->_fixResultArrayValues ($row, $mode);
if ( ( $fetchmode != MDB2_FETCHMODE_ASSOC
&& $fetchmode != MDB2_FETCHMODE_OBJECT )
$row = $this->db->datatype ->convertResultRow ($this->types, $row, $rtrim);
} elseif (($fetchmode == MDB2_FETCHMODE_ASSOC
|| $fetchmode == MDB2_FETCHMODE_OBJECT )
&& !empty ($this->types_assoc)
$row = $this->db->datatype ->convertResultRow ($this->types_assoc, $row, $rtrim);
if (!empty ($this->values)) {
$this->_assignBindColumns ($row);
if ($fetchmode === MDB2_FETCHMODE_OBJECT ) {
$object_class = $this->db->options ['fetch_class'];
if ($object_class == 'stdClass') {
$rowObj = new $object_class($row);
* Retrieve the names of columns returned by the DBMS in a query result.
* @return mixed Array variable that holds the names of columns as keys
* or an MDB2 error on failure.
* Some DBMS may not return any columns when the result set
* does not contain any rows.
function _getColumnNames ()
if (MDB2 ::isError ($numcols)) {
for ($column = 0; $column < $numcols; $column++ ) {
$columns[$column_info->name ] = $column;
if ($this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE ) {
* 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
if (false === $this->result) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
if (null === $this->result) {
return count($this->types);
return $this->db->raiseError (null , null , null ,
'Could not get column count', __FUNCTION__ );
* Move the internal result pointer to the next available result
* @return true on success, false if there is no more result set or an error object on failure
$connection = $this->db->getConnection ();
if (MDB2 ::isError ($connection)) {
* Free the internal resources associated with result.
* @return boolean true on success, false if result is invalid
if (is_object($this->result) && $this->db->connection ) {
return $this->db->raiseError (null , null , null ,
'Could not free result', __FUNCTION__ );
* MDB2 MySQLi buffered result driver
* @author Lukas Smith <smith@pooteeweet.org>
* 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)) {
if (false === $this->result) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
if (null === $this->result) {
return $this->db->raiseError (MDB2_ERROR_INVALID , null , null ,
'tried to seek to an invalid row number ('. $rownum. ')', __FUNCTION__ );
$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
if (MDB2 ::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
if (false === $this->result) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
if (null === $this->result) {
return $this->db->raiseError (null , null , null ,
'Could not get row count', __FUNCTION__ );
* Move the internal result pointer to the next available result
* @param a valid result resource
* @return true on success, false if there is no more result set or an error object on failure
$connection = $this->db->getConnection ();
if (MDB2 ::isError ($connection)) {
* MDB2 MySQLi statement driver
* @author Lukas Smith <smith@pooteeweet.org>
* Execute a prepared query statement helper method.
* @param mixed $result_class string which specifies which result class to use
* @param mixed $result_wrap_class string which specifies which class to wrap results in
* @return mixed MDB2_Result or integer (affected rows) on success,
* a MDB2 error on failure
function _execute ($result_class = true , $result_wrap_class = true )
if (null === $this->statement) {
$result = parent ::_execute ($result_class, $result_wrap_class);
$this->db->last_query = $this->query;
$this->db->debug ($this->query, 'execute', array ('is_manip' => $this->is_manip, 'when' => 'pre', 'parameters' => $this->values));
if ($this->db->getOption ('disable_query')) {
$result = $this->is_manip ? 0 : null;
$connection = $this->db->getConnection ();
if (MDB2 ::isError ($connection)) {
$query = 'EXECUTE '. $this->statement;
if (!empty ($this->positions)) {
$paramReferences = array ();
$parameters = array (0 => $this->statement, 1 => '');
foreach ($this->positions as $parameter) {
return $this->db->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'Unable to bind to missing placeholder: '. $parameter, __FUNCTION__ );
$value = $this->values[$parameter];
$type = array_key_exists($parameter, $this->types) ? $this->types[$parameter] : null;
if (is_resource($value) || $type == 'clob' || $type == 'blob' && $this->db->options ['lob_allow_url_include']) {
if ($match[1 ] == 'file://') {
$value = @fopen($value, 'r');
$data.= @fread($value, $this->db->options ['lob_buffer_length']);
$quoted = $this->db->quote ($value, $type);
if (MDB2 ::isError ($quoted)) {
$param_query = 'SET @'. $parameter. ' = '. $quoted;
$result = $this->db->_doQuery ($param_query, true , $connection);
if (MDB2 ::isError ($result)) {
if (is_resource($value) || $type == 'clob' || $type == 'blob') {
$paramReferences[$i] = null;
// mysqli_stmt_bind_param() requires parameters to be passed by reference
$parameters[] = & $paramReferences[$i];
$paramReferences[$i] = $this->db->quote ($value, $type, false );
if (MDB2 ::isError ($paramReferences[$i])) {
return $paramReferences[$i];
// mysqli_stmt_bind_param() requires parameters to be passed by reference
$parameters[] = & $paramReferences[$i];
$parameters[1 ].= $this->db->datatype ->mapPrepareDatatype ($type);
$err = $this->db->raiseError (null , null , null ,
'Unable to bind parameters', __FUNCTION__ );
foreach ($lobs as $i => $parameter) {
$value = $this->values[$parameter];
if (preg_match('/^(\w+:\/\/)(.*)$/', $value, $match)) {
if ($match[1 ] == 'file://') {
$value = @fopen($value, 'r');
$data = @fread($value, $this->db->options ['lob_buffer_length']);
$result = $this->db->_doQuery ($query, $this->is_manip, $connection);
if (MDB2 ::isError ($result)) {
$affected_rows = $this->db->_affectedRows ($connection, $result);
$result = $this->db->_wrapResult ($result, $this->result_types,
$result_class, $result_wrap_class, $this->limit, $this->offset);
$err = $this->db->raiseError (null , null , null ,
'Unable to execute statement', __FUNCTION__ );
if ($this->db->options ['result_buffering']) {
$result = $this->db->_wrapResult ($this->statement, $this->result_types,
$result_class, $result_wrap_class, $this->limit, $this->offset);
$this->db->debug ($this->query, 'execute', array ('is_manip' => $this->is_manip, 'when' => 'post', 'result' => $result));
* Release resources allocated for the specified prepared query.
* @return mixed MDB2_OK on success, a MDB2 error on failure
if (null === $this->positions) {
return $this->db->raiseError (MDB2_ERROR , null , null ,
'Prepared statement has already been freed', __FUNCTION__ );
$result = $this->db->raiseError (null , null , null ,
'Could not free statement', __FUNCTION__ );
} elseif (null !== $this->statement) {
$connection = $this->db->getConnection ();
if (MDB2 ::isError ($connection)) {
$query = 'DEALLOCATE PREPARE '. $this->statement;
$result = $this->db->_doQuery ($query, true , $connection);
Documentation generated on Mon, 11 Mar 2019 15:51:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|