class Doctrine_Adapter_Statement_Oracle implements Doctrine_Adapter_Statement_Interface (View source)

Oracle connection adapter statement class.

Properties

string $queryString
protected resource $connection
protected resource $statement
protected integer $executeMode
protected array $bindParams
protected array $attributes
protected array $ociErrors

Methods

__construct(Doctrine_Adapter_Oracle $connection, string $query, integer $executeMode)

the constructor

boolean
bindColumn(mixed $column, string $param, integer $type = null)

Bind a column to a PHP variable

boolean
bindValue(mixed $param, mixed $value, integer $type = null)

Binds a value to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement.

boolean
bindParam($column, $variable, $type = null, $length = null, $driverOptions = array())

Binds a PHP variable to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement. Unlike Doctrine_Adapter_Statement_Interface->bindValue(), the variable is bound as a reference and will only be evaluated at the time that Doctrine_Adapter_Statement_Interface->execute() is called.

boolean
closeCursor()

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

integer
columnCount()

Returns the number of columns in the result set

string
errorCode()

Fetch the SQLSTATE associated with the last operation on the statement handle

array
errorInfo()

Fetch extended error information associated with the last operation on the statement handle

boolean
execute(array $params = null)

Executes a prepared statement

mixed
fetch(integer $fetchStyle = Doctrine_Core::FETCH_BOTH, integer $cursorOrientation = Doctrine_Core::FETCH_ORI_NEXT, integer $cursorOffset = null)

fetch

array
fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH, $colnum = 0)

Returns an array containing all of the result set rows

string
fetchColumn(integer $columnIndex = 0)

Returns a single column from the next row of a result set or FALSE if there are no more rows.

mixed
fetchObject(string $className = 'stdClass', array $args = array())

Fetches the next row and returns it as an object.

array
getColumnMeta(integer $column)

Returns metadata for a column in a result set

boolean
nextRowset()

Advances to the next rowset in a multi-rowset statement handle

integer
rowCount()

rowCount() returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding object.

boolean
setAttribute(integer $attribute, mixed $value)

Set a statement attribute

mixed
getAttribute(integer $attribute)

Retrieve a statement attribute

boolean
setFetchMode($mode, $arg1 = null, $arg2 = null)

Set the default fetch mode for this statement

Details

__construct(Doctrine_Adapter_Oracle $connection, string $query, integer $executeMode)

the constructor

Parameters

Doctrine_Adapter_Oracle $connection
string $query Query string to be executed
integer $executeMode OCI execute mode

boolean bindColumn(mixed $column, string $param, integer $type = null)

Bind a column to a PHP variable

Parameters

mixed $column Number of the column (1-indexed) or name of the column in the result set. If using the column name, be aware that the name should match the case of the column, as returned by the driver.
string $param Name of the PHP variable to which the column will be bound.
integer $type Data type of the parameter, specified by the Doctrine_Core::PARAM_* constants.

Return Value

boolean Returns TRUE on success or FALSE on failure

boolean bindValue(mixed $param, mixed $value, integer $type = null)

Binds a value to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement.

Parameters

mixed $param Parameter identifier. For a prepared statement using named placeholders, this will be a parameter name of the form :name. For a prepared statement using question mark placeholders, this will be the 1-indexed position of the parameter
mixed $value The value to bind to the parameter.
integer $type Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants.

Return Value

boolean Returns TRUE on success or FALSE on failure.

boolean bindParam($column, $variable, $type = null, $length = null, $driverOptions = array())

Binds a PHP variable to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement. Unlike Doctrine_Adapter_Statement_Interface->bindValue(), the variable is bound as a reference and will only be evaluated at the time that Doctrine_Adapter_Statement_Interface->execute() is called.

Most parameters are input parameters, that is, parameters that are used in a read-only fashion to build up the query. Some drivers support the invocation of stored procedures that return data as output parameters, and some also as input/output parameters that both send in data and are updated to receive it.

Parameters

$column
$variable
$type
$length
$driverOptions

Return Value

boolean Returns TRUE on success or FALSE on failure.

boolean closeCursor()

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

Return Value

boolean Returns TRUE on success or FALSE on failure.

integer columnCount()

Returns the number of columns in the result set

Return Value

integer Returns the number of columns in the result set represented by the Doctrine_Adapter_Statement_Interface object. If there is no result set, this method should return 0.

string errorCode()

Fetch the SQLSTATE associated with the last operation on the statement handle

Return Value

string error code string

See also

Doctrine_Adapter_Interface::errorCode

array errorInfo()

Fetch extended error information associated with the last operation on the statement handle

Return Value

array error info array

See also

Doctrine_Adapter_Interface::errorInfo

boolean execute(array $params = null)

Executes a prepared statement

If the prepared statement included parameter markers, you must either: call PDOStatement->bindParam() to bind PHP variables to the parameter markers: bound variables pass their value as input and receive the output value, if any, of their associated parameter markers or pass an array of input-only parameter values

Parameters

array $params An array of values with as many elements as there are bound parameters in the SQL statement being executed.

Return Value

boolean Returns TRUE on success or FALSE on failure.

mixed fetch(integer $fetchStyle = Doctrine_Core::FETCH_BOTH, integer $cursorOrientation = Doctrine_Core::FETCH_ORI_NEXT, integer $cursorOffset = null)

fetch

Parameters

integer $fetchStyle Controls how the next row will be returned to the caller. This value must be one of the Doctrine_Core::FETCH_* constants, defaulting to Doctrine_Core::FETCH_BOTH
integer $cursorOrientation For a PDOStatement object representing a scrollable cursor, this value determines which row will be returned to the caller. This value must be one of the Doctrine_Core::FETCH_ORI_* constants, defaulting to Doctrine_Core::FETCH_ORI_NEXT. To request a scrollable cursor for your Doctrine_Adapter_Statement_Interface object, you must set the Doctrine_Core::ATTR_CURSOR attribute to Doctrine_Core::CURSOR_SCROLL when you prepare the SQL statement with Doctrine_Adapter_Interface->prepare().
integer $cursorOffset For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for which the $cursorOrientation parameter is set to Doctrine_Core::FETCH_ORI_ABS, this value specifies the absolute number of the row in the result set that shall be fetched.

                                 For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for
                                 which the $cursorOrientation parameter is set to Doctrine_Core::FETCH_ORI_REL, this value
                                 specifies the row to fetch relative to the cursor position before
                                 Doctrine_Adapter_Statement_Interface->fetch() was called.

Return Value

mixed

See also

Doctrine_Core::FETCH_* constants

array fetchAll($fetchStyle = Doctrine_Core::FETCH_BOTH, $colnum = 0)

Returns an array containing all of the result set rows

Parameters

$fetchStyle
$colnum

Return Value

array

string fetchColumn(integer $columnIndex = 0)

Returns a single column from the next row of a result set or FALSE if there are no more rows.

Parameters

integer $columnIndex 0-indexed number of the column you wish to retrieve from the row. If no value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn() fetches the first column.

Return Value

string returns a single column in the next row of a result set.

mixed fetchObject(string $className = 'stdClass', array $args = array())

Fetches the next row and returns it as an object.

Fetches the next row and returns it as an object. This function is an alternative to Doctrine_Adapter_Statement_Interface->fetch() with Doctrine_Core::FETCH_CLASS or Doctrine_Core::FETCH_OBJ style.

Parameters

string $className Name of the created class, defaults to stdClass.
array $args Elements of this array are passed to the constructor.

Return Value

mixed an instance of the required class with property names that correspond to the column names or FALSE in case of an error.

array getColumnMeta(integer $column)

Returns metadata for a column in a result set

Parameters

integer $column The 0-indexed column in the result set.

Return Value

array Associative meta data array with the following structure:

     native_type                 The PHP native type used to represent the column value.
     driver:decl_                type The SQL type used to represent the column value in the database. If the column in the result set is the result of a function, this value is not returned by PDOStatement->getColumnMeta().
     flags                       Any flags set for this column.
     name                        The name of this column as returned by the database.
     len                         The length of this column. Normally -1 for types other than floating point decimals.
     precision                   The numeric precision of this column. Normally 0 for types other than floating point decimals.
     pdo_type                    The type of this column as represented by the PDO::PARAM_* constants.

boolean nextRowset()

Advances to the next rowset in a multi-rowset statement handle

Some database servers support stored procedures that return more than one rowset (also known as a result set). The nextRowset() method enables you to access the second and subsequent rowsets associated with a PDOStatement object. Each rowset can have a different set of columns from the preceding rowset.

Return Value

boolean Returns TRUE on success or FALSE on failure.

integer rowCount()

rowCount() returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding object.

If the last SQL statement executed by the associated Statement object was a SELECT statement, some databases may return the number of rows returned by that statement. However, this behaviour is not guaranteed for all databases and should not be relied on for portable applications.

Return Value

integer Returns the number of rows.

boolean setAttribute(integer $attribute, mixed $value)

Set a statement attribute

Parameters

integer $attribute
mixed $value the value of given attribute

Return Value

boolean Returns TRUE on success or FALSE on failure.

mixed getAttribute(integer $attribute)

Retrieve a statement attribute

Parameters

integer $attribute

Return Value

mixed the attribute value

See also

Doctrine_Core::ATTR_* constants

boolean setFetchMode($mode, $arg1 = null, $arg2 = null)

Set the default fetch mode for this statement

Parameters

$mode
$arg1
$arg2

Return Value

boolean Returns 1 on success or FALSE on failure.