Source for file oci8.php
Documentation is available at oci8.php
// vim: set et ts=4 sw=4 fdm=marker:
// +----------------------------------------------------------------------+
// | PHP versions 4 and 5 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1998-2008 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: oci8.php 327310 2012-08-27 15:16:18Z danielc $
* @author Lukas Smith <smith@pooteeweet.org>
var $string_quoting = array ('start' => "'", 'end' => "'", 'escape' => "'", 'escape_pattern' => '@');
$this->dbsyntax = 'oci8';
$this->supported['sequences'] = true;
$this->supported['indexes'] = true;
$this->supported['summary_functions'] = true;
$this->supported['order_by_text'] = true;
$this->supported['current_id'] = true;
$this->supported['affected_rows'] = true;
$this->supported['transactions'] = true;
$this->supported['savepoints'] = true;
$this->supported['limit_queries'] = true;
$this->supported['LOBs'] = true;
$this->supported['replace'] = 'emulated';
$this->supported['sub_selects'] = true;
$this->supported['triggers'] = true;
$this->supported['auto_increment'] = false; // implementation is broken
$this->supported['primary_key'] = true;
$this->supported['result_introspection'] = true;
$this->supported['prepared_statements'] = true;
$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['database_name_prefix'] = false;
$this->options['emulate_database'] = true;
$this->options['default_tablespace'] = false;
$this->options['default_text_field_length'] = 2000;
$this->options['lob_allow_url_include'] = false;
$this->options['result_prefetching'] = false;
$this->options['max_identifiers_length'] = 30;
* This method is used to collect information about an error
$error_data = @OCIError ($error);
} elseif ($this->connection) {
$error_data = @OCIError ($this->connection);
$error_data = @OCIError ();
$native_code = $error_data['code'];
$native_msg = $error_data['message'];
1 => MDB2_ERROR_CONSTRAINT ,
900 => MDB2_ERROR_SYNTAX ,
904 => MDB2_ERROR_NOSUCHFIELD ,
911 => MDB2_ERROR_SYNTAX , //invalid character
913 => MDB2_ERROR_VALUE_COUNT_ON_ROW ,
921 => MDB2_ERROR_SYNTAX ,
923 => MDB2_ERROR_SYNTAX ,
942 => MDB2_ERROR_NOSUCHTABLE ,
955 => MDB2_ERROR_ALREADY_EXISTS ,
1400 => MDB2_ERROR_CONSTRAINT_NOT_NULL ,
1401 => MDB2_ERROR_INVALID ,
1407 => MDB2_ERROR_CONSTRAINT_NOT_NULL ,
1418 => MDB2_ERROR_NOT_FOUND ,
1435 => MDB2_ERROR_NOT_FOUND ,
1476 => MDB2_ERROR_DIVZERO ,
1722 => MDB2_ERROR_INVALID_NUMBER ,
2289 => MDB2_ERROR_NOSUCHTABLE ,
2291 => MDB2_ERROR_CONSTRAINT ,
2292 => MDB2_ERROR_CONSTRAINT ,
2449 => MDB2_ERROR_CONSTRAINT ,
4081 => MDB2_ERROR_ALREADY_EXISTS , //trigger already exists
24344 => MDB2_ERROR_SYNTAX , //success with compilation error
if (isset ($ecode_map[$native_code])) {
$error = $ecode_map[$native_code];
return array ($error, $native_code, $native_msg);
// {{{ 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));
if (null !== $savepoint) {
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
if (!$this->destructor_registered && $this->opened_persistent) {
$this->destructor_registered = true;
$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) {
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if (!@OCICommit ($connection)) {
return $this->raiseError (null , null , null ,
'Unable to commit transaction', __FUNCTION__ );
$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) {
$query = 'ROLLBACK TO SAVEPOINT '. $savepoint;
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
if (!@OCIRollback ($connection)) {
return $this->raiseError (null , null , null ,
'Unable to rollback transaction', __FUNCTION__ );
$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 ));
$isolation = 'READ COMMITTED';
$isolation = 'SERIALIZABLE';
return $this->raiseError (MDB2_ERROR_UNSUPPORTED , null , null ,
'isolation level is not supported: '. $isolation, __FUNCTION__ );
$query = " ALTER SESSION 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['service']) && $this->dsn['hostspec']) {
//oci8://username:password@foo.example.com[:port]/?service=service
// service name is given, it is assumed that hostspec is really a
// hostname, we try to construct an oracle connection string from this
$port = $this->dsn['port'] ? $this->dsn['port'] : 1521;
$sid = sprintf("(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)
(CONNECT_DATA=(SERVICE_NAME=%s)))",
} elseif ($this->dsn['hostspec']) {
// we are given something like 'oci8://username:password@foo/'
// we have hostspec but not a service name, now we assume that
// hostspec is a tnsname defined in tnsnames.ora
$sid = $this->dsn['hostspec'];
if (isset ($this->dsn['port']) && $this->dsn['port']) {
$sid = $sid. ':'. $this->dsn['port'];
// oci://username:password@
// if everything fails, we have to rely on environment variables
// not before a check to 'emulate_database'
if (!$this->options['emulate_database'] && $this->database_name) {
$sid = $this->database_name;
} elseif (getenv('ORACLE_SID')) {
} elseif ($sid = getenv('TWO_TASK')) {
return $this->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'not a valid connection string or environment variable [ORACLE_SID|TWO_TASK] not set',
if ($this->_isNewLinkSet ()) {
$connect_function = 'oci_new_connect';
$connect_function = $persistent ? 'oci_pconnect' : 'oci_connect';
$charset = empty ($this->dsn['charset']) ? null : $this->dsn['charset'];
$session_mode = empty ($this->dsn['session_mode']) ? null : $this->dsn['session_mode'];
$connection = @$connect_function($username, $password, $sid, $charset, $session_mode);
if (isset ($error['code']) && $error['code'] == 12541 ) {
// Couldn't find TNS listener. Try direct connection.
$connection = @$connect_function($username, $password, null , $charset);
$connect_function = $persistent ? 'OCIPLogon' : 'OCILogon';
$connection = @$connect_function($username, $password, $sid);
if (!empty ($this->dsn['charset'])) {
$result = $this->setCharset ($this->dsn['charset'], $connection);
if (MDB2 ::isError ($result)) {
return $this->raiseError (MDB2_ERROR_CONNECT_FAILED , null , null ,
'unable to establish a connection', __FUNCTION__ );
if (empty ($this->dsn['disable_iso_date'])) {
$query = "ALTER SESSION SET NLS_DATE_FORMAT='YYYY-MM-DD HH24:MI:SS'";
$err = & $this->_doQuery($query, true , $connection);
if (MDB2 ::isError ($err)) {
$query = "ALTER SESSION SET NLS_NUMERIC_CHARACTERS='. '";
$err = & $this->_doQuery($query, true , $connection);
if (MDB2 ::isError ($err)) {
* Connect to the database
* @return MDB2_OK 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)
&& $this->opened_persistent == $this->options['persistent']
if ($this->database_name && $this->options['emulate_database']) {
$this->dsn['username'] = $this->options['database_name_prefix']. $this->database_name;
$connection = $this->_doConnect($this->dsn['username'],
$this->options['persistent']);
if (MDB2 ::isError ($connection)) {
$this->connection = $connection;
$this->connected_dsn = $this->dsn;
$this->connected_database_name = '';
$this->opened_persistent = $this->options['persistent'];
$this->dbsyntax = $this->dsn['dbsyntax'] ? $this->dsn['dbsyntax'] : $this->phptype;
if ($this->database_name) {
if ($this->database_name != $this->connected_database_name) {
$query = 'ALTER SESSION SET CURRENT_SCHEMA = "' . strtoupper($this->database_name) . '"';
if (MDB2 ::isError ($result)) {
$err = $this->raiseError ($result, null , null ,
'Could not select the database: '. $this->database_name, __FUNCTION__ );
$this->connected_database_name = $this->database_name;
if ($server_info['major'] >= '10') {
$this->as_keyword = ' AS ';
* 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'],
$this->options['persistent']);
if (MDB2 ::isError ($connection)) {
$query = 'ALTER SESSION SET CURRENT_SCHEMA = "' . strtoupper($name) . '"';
$result = $this->_doQuery($query, true , $connection, false );
if (MDB2 ::isError ($result)) {
if (!MDB2 ::isError ($result, MDB2_ERROR_NOT_FOUND )) {
* 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;
if (!$this->opened_persistent || $force) {
$ok = @oci_close ($this->connection);
$ok = @OCILogOff ($this->connection);
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 containing 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'];
$connection = $this->_doConnect($user, $pass, $this->options['persistent']);
if (MDB2 ::isError ($connection)) {
$this->offset = $this->limit = 0;
$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
$result = $this->_doQuery($query, $is_manip, $connection, false );
if (!MDB2 ::isError ($result)) {
$result = $this->_affectedRows ($connection, $result);
$result = $this->_wrapResult ($result, $types, true , true , $limit, $offset);
* 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
// taken from http://svn.ez.no/svn/ezcomponents/packages/Database
$query = " SELECT * FROM (SELECT a.*, ROWNUM mdb2rn FROM ($query) a WHERE ROWNUM <= $max) WHERE mdb2rn >= $min";
$query = " SELECT a.* FROM ($query) a WHERE ROWNUM <= $max";
* @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->getOption ('disable_query')) {
if (null === $connection) {
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
$query = str_replace("\r\n", "\n", $query); //for fixing end-of-line character in the PL/SQL in windows
$result = @OCIParse ($connection, $query);
$err = $this->raiseError (null , null , null ,
'Could not create statement', __FUNCTION__ );
$mode = $this->in_transaction ? OCI_DEFAULT : OCI_COMMIT_ON_SUCCESS;
if (!@OCIExecute ($result, $mode)) {
$err = $this->raiseError ($result, null , null ,
'Could not execute statement', __FUNCTION__ );
if (is_numeric($this->options['result_prefetching'])) {
@ocisetprefetch ($result, $this->options['result_prefetching']);
$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)) {
return @OCIRowCount ($result);
// {{{ 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;
$server_info = @ociserverversion ($connection);
return $this->raiseError (null , null , null ,
'Could not get server information', __FUNCTION__ );
$this->connected_server_info = $server_info;
if (!preg_match('/ (\d+)\.(\d+)\.(\d+)\.([\d\.]+) /', $server_info, $tmp)) {
return $this->raiseError (MDB2_ERROR_INVALID , null , null ,
'Could not parse version information:'. $server_info, __FUNCTION__ );
'native' => $server_info,
* 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 ())
if ($this->options['emulate_prepared']) {
return parent ::prepare ($query, $types, $result_types, $lobs);
$is_manip = ($result_types === MDB2_PREPARE_MANIP );
$this->offset = $this->limit = 0;
$result = $this->debug ($query, __FUNCTION__ , array ('is_manip' => $is_manip, 'when' => 'pre'));
if (MDB2 ::isError ($result)) {
$query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
$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
if ($query[$position] == $placeholder_type_guess) {
if (null === $placeholder_type) {
$placeholder_type = $query[$p_position];
$question = $colon = $placeholder_type;
if (!empty ($types) && is_array($types)) {
if ($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__ );
// use parameter name in type array
if (isset ($count) && isset ($types_tmp[++ $count])) {
$types[$parameter] = $types_tmp[$count];
$length = strlen($parameter) + 1;
//$length = strlen($parameter);
$length = 1; // strlen('?')
if (!in_array($parameter, $positions)) {
$positions[] = $parameter;
if (isset ($types[$parameter])
&& ($types[$parameter] == 'clob' || $types[$parameter] == 'blob')
if (!isset ($lobs[$parameter])) {
$lobs[$parameter] = $parameter;
$value = $this->quote (true , $types[$parameter]);
if (MDB2 ::isError ($value)) {
$position = $p_position + strlen($value) - 1;
} elseif ($placeholder_type == '?') {
$position = $p_position + $length;
$position = $p_position + 1;
$columns = $variables = '';
foreach ($lobs as $parameter => $field) {
$columns.= ($columns ? ', ' : ' RETURNING '). $field;
$variables.= ($variables ? ', ' : ' INTO '). ':'. $parameter;
$query.= $columns. $variables;
$connection = $this->getConnection ();
if (MDB2 ::isError ($connection)) {
$statement = @OCIParse ($connection, $query);
$err = $this->raiseError (null , null , null ,
'Could not create statement', __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));
* 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 );
$query = " SELECT $sequence_name.nextval FROM DUAL";
$this->pushErrorHandling (PEAR_ERROR_RETURN );
$this->expectError (MDB2_ERROR_NOSUCHTABLE );
$result = $this->queryOne ($query, 'integer');
$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->nextId ($seq_name, false );
* 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
$old_seq = $table. (empty ($field) ? '' : '_'. $field);
$sequence_name = $this->quoteIdentifier ($this->getSequenceName ($table), true );
$result = $this->queryOne (" SELECT $sequence_name.currval" , 'integer');
if (MDB2 ::isError ($result)) {
$sequence_name = $this->quoteIdentifier ($this->getSequenceName ($old_seq), true );
$result = $this->queryOne (" SELECT $sequence_name.currval" , 'integer');
* Returns the current id of a sequence
* @param string $seq_name name of the sequence
* @return mixed MDB2_Error or id
$sequence_name = $this->getSequenceName ($seq_name);
$query = 'SELECT (last_number-1) FROM all_sequences';
$query.= ' WHERE sequence_name='. $this->quote ($sequence_name, 'text');
$query.= ' OR sequence_name='. $this->quote (strtoupper($sequence_name), 'text');
return $this->queryOne ($query, 'integer');
* MDB2 OCI8 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
@OCIFetchInto ($this->result, $row, OCI_ASSOC+OCI_RETURN_NULLS );
&& $this->db->options ['portability'] & MDB2_PORTABILITY_FIX_CASE
@OCIFetchInto ($this->result, $row, OCI_RETURN_NULLS );
if (false === $this->result) {
$err = $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
// remove additional column at the end
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++ ) {
$column_name = @OCIColumnName ($this->result, $column + 1 );
$columns[$column_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
$cols = @OCINumCols ($this->result);
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__ );
* Free the internal resources associated with $result.
* @return boolean true on success, false if $result is invalid
if (is_resource($this->result) && $this->db->connection ) {
$free = @OCIFreeCursor ($this->result);
return $this->db->raiseError (null , null , null ,
'Could not free result', __FUNCTION__ );
* MDB2 OCI8 buffered result driver
* @author Lukas Smith <smith@pooteeweet.org>
* @param int $rownum row number upto which the buffer should be filled
if the row number is null all rows are ready into the buffer
* @return boolean true on success, false on failure
} elseif (isset ($this->buffer[$rownum])) {
return (bool) $this->buffer[$rownum];
&& ($row = @OCIFetchInto ($this->result, $buffer, OCI_RETURN_NULLS ))
// remove additional column at the end
if (empty ($this->types)) {
if (is_object($buffer[$key]) && is_a($buffer[$key], 'oci-lob')) {
$buffer[$key] = $buffer[$key]->load ();
* 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 )
if (false === $this->result) {
$err = $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
if (null === $this->result) {
$seek = $this->seek($rownum);
if (MDB2 ::isError ($seek)) {
$target_rownum = $this->rownum + 1;
if ($fetchmode == MDB2_FETCHMODE_DEFAULT ) {
$fetchmode = $this->db->fetchmode;
$row = $this->buffer[$target_rownum];
if ( $fetchmode == MDB2_FETCHMODE_ASSOC
|| $fetchmode == MDB2_FETCHMODE_OBJECT
$column_names = $this->getColumnNames ();
foreach ($column_names as $name => $i) {
$column_names[$name] = $row[$i];
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);
* 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 (false === $this->result) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __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 (false === $this->result) {
return $this->db->raiseError (MDB2_ERROR_NEED_MORE_DATA , null , null ,
'resultset has already been freed', __FUNCTION__ );
if (null === $this->result) {
* 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) {
* Free the internal resources associated with $result.
* @return boolean true on success, false if $result is invalid
* MDB2 OCI8 statement driver
* @author Lukas Smith <smith@pooteeweet.org>
// {{{ Variables (Properties)
* Bind a variable to a parameter of a prepared query.
* @param int $parameter the order number of the parameter in the query
* statement. The order number of the first parameter is 1.
* @param mixed &$value variable that is meant to be bound to specified
* parameter. The type of the value depends on the $type argument.
* @param string $type specifies the type of the field
* @param int $maxlength specifies the maximum length of the field; if set to -1, the
* current length of $value is used
* @return mixed MDB2_OK on success, a MDB2 error on failure
function bindParam($parameter, &$value, $type = null , $maxlength = -1 )
if (MDB2_OK === ($ret = parent ::bindParam ($parameter, $value, $type))) {
* 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) {
return 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)) {
$lobs = $quoted_values = array ();
foreach ($this->positions as $parameter) {
return $this->db->raiseError (MDB2_ERROR_NOT_FOUND , null , null ,
'Unable to bind to missing placeholder: '. $parameter, __FUNCTION__ );
$type = array_key_exists($parameter, $this->types) ? $this->types[$parameter] : null;
if ($type == 'clob' || $type == 'blob') {
$lobs[$i]['file'] = false;
$fp = $this->values[$parameter];
$this->values[$parameter] = '';
$this->values[$parameter] .= fread($fp, 8192 );
} elseif (is_object($this->values[$parameter]) && is_a($this->values[$parameter], 'OCI-Lob')) {
} elseif ($this->db->getOption ('lob_allow_url_include')
&& preg_match('/^(\w+:\/\/)(.*)$/', $this->values[$parameter], $match)
$lobs[$i]['file'] = true;
if ($match[1 ] == 'file://') {
$this->values[$parameter] = $match[2 ];
$lobs[$i]['value'] = $this->values[$parameter];
$lobs[$i]['descriptor'] = & $this->values[$parameter];
// Test to see if descriptor has already been created for this
// variable (i.e. if it has been bound more than once):
if (!(is_object($this->values[$parameter]) && is_a($this->values[$parameter], 'OCI-Lob'))) {
$this->values[$parameter] = @OCINewDescriptor ($connection, OCI_D_LOB );
if (false === $this->values[$parameter]) {
$result = $this->db->raiseError (null , null , null ,
'Unable to create descriptor for LOB in parameter: '. $parameter, __FUNCTION__ );
$lob_type = ($type == 'blob' ? OCI_B_BLOB : OCI_B_CLOB );
if (!@OCIBindByName ($this->statement, ':'. $parameter, $lobs[$i]['descriptor'], -1 , $lob_type)) {
$result = $this->db->raiseError ($this->statement, null , null ,
'could not bind LOB parameter', __FUNCTION__ );
} else if ($type == OCI_B_BFILE ) {
// Test to see if descriptor has already been created for this
// variable (i.e. if it has been bound more than once):
if (!(is_object($this->values[$parameter]) && is_a($this->values[$parameter], "OCI-Lob"))) {
$this->values[$parameter] = @OCINewDescriptor ($connection, OCI_D_FILE );
if (false === $this->values[$parameter]) {
$result = $this->db->raiseError (null , null , null ,
'Unable to create descriptor for BFILE in parameter: '. $parameter, __FUNCTION__ );
if (!@OCIBindByName ($this->statement, ':'. $parameter, $this->values[$parameter], -1 , $type)) {
$result = $this->db->raiseError ($this->statement, null , null ,
'Could not bind BFILE parameter', __FUNCTION__ );
} else if ($type == OCI_B_ROWID ) {
// Test to see if descriptor has already been created for this
// variable (i.e. if it has been bound more than once):
if (!is_a($this->values[$parameter], "OCI-Lob")) {
$this->values[$parameter] = @OCINewDescriptor ($connection, OCI_D_ROWID );
if (false === $this->values[$parameter]) {
$result = $this->db->raiseError (null , null , null ,
'Unable to create descriptor for ROWID in parameter: '. $parameter, __FUNCTION__ );
if (!@OCIBindByName ($this->statement, ':'. $parameter, $this->values[$parameter], -1 , $type)) {
$result = $this->db->raiseError ($this->statement, null , null ,
'Could not bind ROWID parameter', __FUNCTION__ );
} else if ($type == OCI_B_CURSOR ) {
// Test to see if cursor has already been allocated for this
// variable (i.e. if it has been bound more than once):
$this->values[$parameter] = @OCINewCursor ($connection);
if (false === $this->values[$parameter]) {
$result = $this->db->raiseError (null , null , null ,
'Unable to allocate cursor for parameter: '. $parameter, __FUNCTION__ );
if (!@OCIBindByName ($this->statement, ':'. $parameter, $this->values[$parameter], -1 , $type)) {
$result = $this->db->raiseError ($this->statement, null , null ,
'Could not bind CURSOR parameter', __FUNCTION__ );
$this->values[$parameter] = $this->db->quote ($this->values[$parameter], $type, false );
$quoted_values[$i] = & $this->values[$parameter];
if (MDB2 ::isError ($quoted_values[$i])) {
return $quoted_values[$i];
if (!@OCIBindByName ($this->statement, ':'. $parameter, $quoted_values[$i], $maxlength)) {
$result = $this->db->raiseError ($this->statement, null , null ,
'could not bind non-abstract parameter', __FUNCTION__ );
if (!MDB2 ::isError ($result)) {
$mode = (!empty ($lobs) || $this->db->in_transaction ) ? OCI_DEFAULT : OCI_COMMIT_ON_SUCCESS;
if (!@OCIExecute ($this->statement, $mode)) {
$err = $this->db->raiseError ($this->statement, null , null ,
'could not execute statement', __FUNCTION__ );
foreach ($lob_keys as $i) {
if ((null !== $lobs[$i]['value']) && $lobs[$i]['value'] !== '') {
// @see http://bugs.php.net/bug.php?id=27485
$result = $lobs[$i]['descriptor']->savefile ($lobs[$i]['value']);
$result = $lobs[$i]['descriptor']->save ($lobs[$i]['value']);
$result = $this->db->raiseError (null , null , null ,
'Unable to save descriptor contents', __FUNCTION__ );
if (!MDB2 ::isError ($result)) {
if (!$this->db->in_transaction ) {
if (!@OCICommit ($connection)) {
$result = $this->db->raiseError (null , null , null ,
'Unable to commit transaction', __FUNCTION__ );
++ $this->db->uncommitedqueries;
if (MDB2 ::isError ($result)) {
$affected_rows = $this->db->_affectedRows ($connection, $this->statement);
$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__ );
if ((null !== $this->statement) && !@OCIFreeStatement ($this->statement)) {
$result = $this->db->raiseError (null , null , null ,
'Could not free statement', __FUNCTION__ );
Documentation generated on Mon, 11 Mar 2019 15:51:20 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|