Inheritance diagram for Zend_Db_Statement_Oracle:

Public Member Functions
	setLobAsString ($lob_as_string)

	getLobAsString ()

	closeCursor ()

	columnCount ()

	errorCode ()

	errorInfo ()

	_execute (array $params=null)

	fetch ($style=null, $cursor=null, $offset=null)

	fetchAll ($style=null, $col=0)

	fetchColumn ($col=0)

	fetchObject ($class='stdClass', array $config=array())

	nextRowset ()

	rowCount ()

Public Member Functions inherited from Zend_Db_Statement
	__construct ($adapter, $sql)

	bindColumn ($column, &$param, $type=null)

	bindParam ($parameter, &$variable, $type=null, $length=null, $options=null)

	bindValue ($parameter, $value, $type=null)

	execute (array $params=null)

	fetchAll ($style=null, $col=null)

	fetchColumn ($col=0)

	fetchObject ($class='stdClass', array $config=array())

	getAttribute ($key)

	setAttribute ($key, $val)

	setFetchMode ($mode)

	_fetchBound ($row)

	getAdapter ()

	getDriverStatement ()

Protected Member Functions
	_prepare ($sql)

	_bindParam ($parameter, &$variable, $type=null, $length=null, $options=null)

Protected Member Functions inherited from Zend_Db_Statement
	_prepare ($sql)

	_parseParameters ($sql)

	_stripQuoted ($sql)

Protected Attributes
	$_keys

	$_values

	$_lobAsString = false

Protected Attributes inherited from Zend_Db_Statement
	$_stmt = null

	$_adapter = null

	$_fetchMode = Zend_Db::FETCH_ASSOC

	$_attribute = array()

	$_bindColumn = array()

	$_bindParam = array()

	$_sqlSplit = array()

	$_sqlParam = array()

	$_queryId = null

Detailed Description

Definition at line 37 of file Oracle.php.

Member Function Documentation

◆ _bindParam()

_bindParam	(		$parameter,
		&	$variable,
			$type = `null`,
			$length = `null`,
			$options = `null`
	)

protected

Binds a parameter to the specified variable name.

Parameters

mixed	$parameter	Name the parameter, either integer or string.
mixed	$variable	Reference to PHP variable containing the value.
mixed	$type	OPTIONAL Datatype of SQL parameter.
mixed	$length	OPTIONAL Length of SQL parameter.
mixed	$options	OPTIONAL Other options.

Returns: bool

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception

Definition at line 111 of file Oracle.php.

     {
         // default value
         if ($type === NULL) {
             $type = SQLT_CHR;
         }
 
         // default value
         if ($length === NULL) {
             $length = -1;
         }
 
         $retval = @oci_bind_by_name($this->_stmt, $parameter, $variable, $length, $type);
         if ($retval === false) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception(oci_error($this->_stmt));
         }
 
         return true;
     }

◆ _execute()

_execute ( array $params = null )

Executes a prepared statement.

Parameters

array $params OPTIONAL Values to bind to parameter placeholders.

Returns: bool

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception

Definition at line 229 of file Oracle.php.

     {
         $connection = $this->_adapter->getConnection();
 
         if (!$this->_stmt) {
             return false;
         }
 
         if ($params !== null) {
             if (!is_array($params)) {
                 $params = array($params);
             }
             $error = false;
             foreach (array_keys($params) as $name) {
                 if (!$this->bindParam($name, $params[$name], null, -1)) {
                     $error = true;
                     break;
                 }
             }
             if ($error) {
                 #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                 throw new Zend_Db_Statement_Oracle_Exception(oci_error($this->_stmt));
             }
         }
 
         $retval = @oci_execute($this->_stmt, $this->_adapter->_getExecuteMode());
         if ($retval === false) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception(oci_error($this->_stmt));
         }
 
         $this->_keys = Array();
         if ($field_num = oci_num_fields($this->_stmt)) {
             for ($i = 1; $i <= $field_num; $i++) {
                 $name = oci_field_name($this->_stmt, $i);
                 $this->_keys[] = $name;
             }
         }
 
         $this->_values = Array();
         if ($this->_keys) {
             $this->_values = array_fill(0, count($this->_keys), null);
         }
 
         return $retval;
     }

◆ _prepare()

_prepare ( $sql )

protected

Prepares statement handle

Parameters

string $sql

Returns: void

Exceptions

Zend_Db_Statement_Oracle_Exception

See also: Zend_Db_Statement_Oracle_Exception

Definition at line 87 of file Oracle.php.

     {
         $connection = $this->_adapter->getConnection();
         $this->_stmt = @oci_parse($connection, $sql);
         if (!$this->_stmt) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception(oci_error($connection));
         }
     }

◆ closeCursor()

closeCursor ( )

Closes the cursor, allowing the statement to be executed again.

Returns: bool

Implements Zend_Db_Statement_Interface.

Definition at line 140 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         oci_free_statement($this->_stmt);
         $this->_stmt = false;
         return true;
     }

◆ columnCount()

columnCount ( )

Returns the number of columns in the result set. Returns null if the statement has no result set metadata.

Returns: int The number of columns.

Implements Zend_Db_Statement_Interface.

Definition at line 157 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         return oci_num_fields($this->_stmt);
     }

◆ errorCode()

errorCode ( )

Retrieves the error code, if any, associated with the last operation on the statement handle.

Returns: string error code.

Implements Zend_Db_Statement_Interface.

Definition at line 173 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         $error = oci_error($this->_stmt);
 
         if (!$error) {
             return false;
         }
 
         return $error['code'];
     }

◆ errorInfo()

errorInfo ( )

Retrieves an array of error information, if any, associated with the last operation on the statement handle.

Returns: array

Implements Zend_Db_Statement_Interface.

Definition at line 195 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         $error = oci_error($this->_stmt);
         if (!$error) {
             return false;
         }
 
         if (isset($error['sqltext'])) {
             return array(
                 $error['code'],
                 $error['message'],
                 $error['offset'],
                 $error['sqltext'],
             );
         } else {
             return array(
                 $error['code'],
                 $error['message'],
             );
         }
     }

◆ fetch()

fetch	(	$style = `null`,
		$cursor = `null`,
		$offset = `null`
	)

Fetches a row from the result set.

Parameters

int	$style	OPTIONAL Fetch mode for this fetch operation.
int	$cursor	OPTIONAL Absolute, relative, or other.
int	$offset	OPTIONAL Number for absolute or relative cursors.

Returns: mixed Array, object, or scalar depending on fetch mode.

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 291 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         if ($style === null) {
             $style = $this->_fetchMode;
         }
 
         $lob_as_string = $this->getLobAsString() ? OCI_RETURN_LOBS : 0;
 
         switch ($style) {
             case Zend_Db::FETCH_NUM:
                 $row = oci_fetch_array($this->_stmt, OCI_NUM | OCI_RETURN_NULLS | $lob_as_string);
                 break;
             case Zend_Db::FETCH_ASSOC:
                 $row = oci_fetch_array($this->_stmt, OCI_ASSOC | OCI_RETURN_NULLS | $lob_as_string);
                 break;
             case Zend_Db::FETCH_BOTH:
                 $row = oci_fetch_array($this->_stmt, OCI_BOTH | OCI_RETURN_NULLS | $lob_as_string);
                 break;
             case Zend_Db::FETCH_OBJ:
                 $row = oci_fetch_object($this->_stmt);
                 break;
             case Zend_Db::FETCH_BOUND:
                 $row = oci_fetch_array($this->_stmt, OCI_BOTH | OCI_RETURN_NULLS | $lob_as_string);
                 if ($row !== false) {
                     return $this->_fetchBound($row);
                 }
                 break;
             default:
                 #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                 throw new Zend_Db_Statement_Oracle_Exception(
                     array(
                         'code'    => 'HYC00',
                         'message' => "Invalid fetch mode '$style' specified"
                     )
                 );
                 break;
         }
 
         if (! $row && $error = oci_error($this->_stmt)) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception($error);
         }
 
         if (is_array($row) && array_key_exists('zend_db_rownum', $row)) {
             unset($row['zend_db_rownum']);
         }
 
         return $row;
     }

◆ fetchAll()

fetchAll	(	$style = `null`,
		$col = `0`
	)

Returns an array containing all of the result set rows.

Parameters

int	$style	OPTIONAL Fetch mode.
int	$col	OPTIONAL Column number, if fetch mode is by column.

Returns: array Collection of rows, each in a format by the fetch mode.

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 359 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         // make sure we have a fetch mode
         if ($style === null) {
             $style = $this->_fetchMode;
         }
 
         $flags = OCI_FETCHSTATEMENT_BY_ROW;
 
         switch ($style) {
             case Zend_Db::FETCH_BOTH:
                 #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                 throw new Zend_Db_Statement_Oracle_Exception(
                     array(
                         'code'    => 'HYC00',
                         'message' => "OCI8 driver does not support fetchAll(FETCH_BOTH), use fetch() in a loop instead"
                     )
                 );
                 // notreached
                 $flags |= OCI_NUM;
                 $flags |= OCI_ASSOC;
                 break;
             case Zend_Db::FETCH_NUM:
                 $flags |= OCI_NUM;
                 break;
             case Zend_Db::FETCH_ASSOC:
                 $flags |= OCI_ASSOC;
                 break;
             case Zend_Db::FETCH_OBJ:
                 break;
             case Zend_Db::FETCH_COLUMN:
                 $flags = $flags &~ OCI_FETCHSTATEMENT_BY_ROW;
                 $flags |= OCI_FETCHSTATEMENT_BY_COLUMN;
                 $flags |= OCI_NUM;
                 break;
             default:
                 #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                 throw new Zend_Db_Statement_Oracle_Exception(
                     array(
                         'code'    => 'HYC00',
                         'message' => "Invalid fetch mode '$style' specified"
                     )
                 );
                 break;
         }
 
         $result = Array();
         if ($flags != OCI_FETCHSTATEMENT_BY_ROW) { /* not Zend_Db::FETCH_OBJ */
             if (! ($rows = oci_fetch_all($this->_stmt, $result, 0, -1, $flags) )) {
                 if ($error = oci_error($this->_stmt)) {
                     #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                     throw new Zend_Db_Statement_Oracle_Exception($error);
                 }
                 if (!$rows) {
                     return array();
                 }
             }
             if ($style == Zend_Db::FETCH_COLUMN) {
                 $result = $result[$col];
             }
             foreach ($result as &$row) {
                 if (is_array($row) && array_key_exists('zend_db_rownum', $row)) {
                     unset($row['zend_db_rownum']);
                 }
             }
         } else {
             while (($row = oci_fetch_object($this->_stmt)) !== false) {
                 $result [] = $row;
             }
             if ($error = oci_error($this->_stmt)) {
                 #require_once 'Zend/Db/Statement/Oracle/Exception.php';
                 throw new Zend_Db_Statement_Oracle_Exception($error);
             }
         }
 
         return $result;
     }

◆ fetchColumn()

fetchColumn ( $col = 0 )

Returns a single column from the next row of a result set.

Parameters

int $col OPTIONAL Position of the column to fetch.

Returns: string

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception; Zend_Db_Adapter_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 461 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         if (!oci_fetch($this->_stmt)) {
             // if no error, there is simply no record
             if (!$error = oci_error($this->_stmt)) {
                 return false;
             }
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception($error);
         }
 
         $data = oci_result($this->_stmt, $col+1); //1-based
         if ($data === false) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception(oci_error($this->_stmt));
         }
 
         if ($this->getLobAsString()) {
             // instanceof doesn't allow '-', we must use a temporary string
             $type = 'OCI-Lob';
             if ($data instanceof $type) {
                 $data = $data->read($data->size());
             }
         }
 
         return $data;
     }

◆ fetchObject()

fetchObject	(		$class = `'stdClass'`,
		array	$config = `array()`
	)

Fetches the next row and returns it as an object.

Parameters

string	$class	OPTIONAL Name of the class to create.
array	$config	OPTIONAL Constructor arguments for the class.

Returns: mixed One object instance of the specified class.

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 507 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         $obj = oci_fetch_object($this->_stmt);
 
         if ($error = oci_error($this->_stmt)) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception($error);
         }
 
         /* @todo XXX handle parameters */
 
         return $obj;
     }

◆ getLobAsString()

getLobAsString ( )

Return whether or not LOB are returned as string

Returns: boolean

Definition at line 75 of file Oracle.php.

     {
         return $this->_lobAsString;
     }

◆ nextRowset()

nextRowset ( )

Retrieves the next rowset (result set) for a SQL statement that has multiple result sets. An example is a stored procedure that returns the results of multiple queries.

Returns: bool

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Statement_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 536 of file Oracle.php.

     {
         #require_once 'Zend/Db/Statement/Oracle/Exception.php';
         throw new Zend_Db_Statement_Oracle_Exception(
             array(
                 'code'    => 'HYC00',
                 'message' => 'Optional feature not implemented'
             )
         );
     }

◆ rowCount()

rowCount ( )

Returns the number of rows affected by the execution of the last INSERT, DELETE, or UPDATE statement executed by this statement object.

Returns: int The number of rows affected.

Exceptions

Zend_Db_Statement_Exception

See also: Zend_Db_Adapter_Oracle_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 558 of file Oracle.php.

     {
         if (!$this->_stmt) {
             return false;
         }
 
         $num_rows = oci_num_rows($this->_stmt);
 
         if ($num_rows === false) {
             #require_once 'Zend/Db/Statement/Oracle/Exception.php';
             throw new Zend_Db_Statement_Oracle_Exception(oci_error($this->_stmt));
         }
 
         return $num_rows;
     }

◆ setLobAsString()

setLobAsString ( $lob_as_string )

Activate/deactivate return of LOB as string

Parameters

string $lob_as_string

Returns: Zend_Db_Statement_Oracle

Definition at line 64 of file Oracle.php.

     {
         $this->_lobAsString = (bool) $lob_as_string;
         return $this;
     }

Field Documentation

◆ $_keys

$_keys

protected

Column names.

Definition at line 43 of file Oracle.php.

◆ $_lobAsString

$_lobAsString = false

protected

Definition at line 56 of file Oracle.php.

◆ $_values

$_values

protected

Fetched result values.

Definition at line 48 of file Oracle.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Db/Statement/Oracle.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _bindParam()

◆ _execute()

◆ _prepare()

◆ closeCursor()

◆ columnCount()

◆ errorCode()

◆ errorInfo()

◆ fetch()

◆ fetchAll()

◆ fetchColumn()

◆ fetchObject()

◆ getLobAsString()

◆ nextRowset()

◆ rowCount()

◆ setLobAsString()

Field Documentation

◆ $_keys

◆ $_lobAsString

◆ $_values