Inherited by Doctrine_Adapter_Statement_Mock, Doctrine_Adapter_Statement_Oracle, and Doctrine_Connection_Statement.

Public Member Functions
	bindColumn ($column, $param, $type=null)

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

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

	closeCursor ()

	columnCount ()

	errorCode ()

	errorInfo ()

	execute ($params=null)

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

	fetchAll ($fetchStyle=Doctrine_Core::FETCH_BOTH)

	fetchColumn ($columnIndex=0)

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

	getAttribute ($attribute)

	getColumnMeta ($column)

	nextRowset ()

	rowCount ()

	setAttribute ($attribute, $value)

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

Detailed Description

Definition at line 33 of file Interface.php.

Member Function Documentation

Doctrine_Adapter_Statement_Interface::bindColumn	(	$column,
		$param,
		$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.

Returns: boolean Returns TRUE on success or FALSE on failure

Doctrine_Adapter_Statement_Interface::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

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	$variable	Name of the PHP variable to bind to the SQL statement parameter.
integer	$type	Explicit data type for the parameter using the Doctrine_Core::PARAM_* constants. To return an INOUT parameter from a stored procedure, use the bitwise OR operator to set the Doctrine_Core::PARAM_INPUT_OUTPUT bits for the data_type parameter.
integer	$length	Length of the data type. To indicate that a parameter is an OUT parameter from a stored procedure, you must explicitly set the length.
mixed	$driverOptions

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::bindValue	(	$param,
		$value,
		$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.

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::closeCursor ( )

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

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::columnCount ( )

Returns the number of columns in the result set

Returns: 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.

Doctrine_Adapter_Statement_Interface::errorCode ( )

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

See Also: Doctrine_Adapter_Interface::errorCode()

Returns: string error code string

Doctrine_Adapter_Statement_Interface::errorInfo ( )

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

See Also: Doctrine_Adapter_Interface::errorInfo()

Returns: array error info array

Doctrine_Adapter_Statement_Interface::execute ( $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.

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::fetch	(	$fetchStyle = `Doctrine_Core::FETCH_BOTH`,
		$cursorOrientation = `Doctrine_Core::FETCH_ORI_NEXT`,
		$cursorOffset = `null`
	)

fetch

See Also: Doctrine_Core::FETCH_* constants

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.

Returns: mixed

Doctrine_Adapter_Statement_Interface::fetchAll ( $fetchStyle = Doctrine_Core::FETCH_BOTH )

Returns an array containing all of the result set rows

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	$columnIndex	Returns the indicated 0-indexed column when the value of $fetchStyle is Doctrine_Core::FETCH_COLUMN. Defaults to 0.

Returns: array

Doctrine_Adapter_Statement_Interface::fetchColumn ( $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.

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

Doctrine_Adapter_Statement_Interface::fetchObject	(	$className = `'stdClass'`,
		$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.

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

Doctrine_Adapter_Statement_Interface::getAttribute ( $attribute )

Retrieve a statement attribute

Parameters

integer $attribute

See Also: Doctrine_Core::ATTR_* constants

Returns: mixed the attribute value

Doctrine_Adapter_Statement_Interface::getColumnMeta ( $column )

Returns metadata for a column in a result set

Parameters

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

Returns

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.

Doctrine_Adapter_Statement_Interface::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.

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::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.

Returns: integer Returns the number of rows.

Doctrine_Adapter_Statement_Interface::setAttribute	(	$attribute,
		$value
	)

Set a statement attribute

Parameters

integer	$attribute
mixed	$value	the value of given attribute

Returns: boolean Returns TRUE on success or FALSE on failure.

Doctrine_Adapter_Statement_Interface::setFetchMode	(	$mode,
		$arg1 = `null`,
		$arg2 = `null`
	)

Set the default fetch mode for this statement

Parameters

integer $mode The fetch mode must be one of the Doctrine_Core::FETCH_* constants.

Returns: boolean Returns 1 on success or FALSE on failure.

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

Doctrine-1.2.4/Doctrine/Adapter/Statement/Interface.php

Public Member Functions

Detailed Description

Member Function Documentation