Doctrine


Doctrine\DBAL\Driver\Statement
/Doctrine/DBAL/Driver/Statement.php at line 39

Interface Statement

Statement

public interface Statement

Statement interface. Drivers must implement this interface.

This resembles (a subset of) the PDOStatement interface.

Author:
Konsta Vesterinen
Roman Borschel
License:
http://www.opensource.org/licenses/lgpl-license.php LGPL
See Also:
www.doctrine-project.org
Since:
2.0
Version:
$Revision$

Method Summary
boolean

bindParam(mixed column, mixed variable, integer type, mixed param)

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

boolean

bindValue(mixed param, mixed value, integer type)

Binds a value to a corresponding named or positional placeholder in the SQL statement that was used to prepare the statement.

boolean

closeCursor()

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

integer

columnCount()

columnCount Returns the number of columns in the result set

string

errorCode()

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

array

errorInfo()

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

boolean

execute(array params)

Executes a prepared statementIf 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

mixed

fetch(integer fetchStyle, integer cursorOrientation, integer cursorOffset)

fetch

array

fetchAll(integer fetchStyle, integer columnIndex)

Returns an array containing all of the result set rows

string

fetchColumn(integer columnIndex)

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

integer

rowCount()

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

Method Detail

/Doctrine/DBAL/Driver/Statement.php at line 78

bindParam

public boolean bindParam(mixed column, mixed variable, integer type, mixed param)

Binds a PHP variable to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement. Unlike PDOStatement->bindValue(), the variable is bound as a reference and will only be evaluated at the time that PDOStatement->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:
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
variable - Name of the PHP variable to bind to the SQL statement parameter.
type - Explicit data type for the parameter using the PDO::PARAM_* constants. To return an INOUT parameter from a stored procedure, use the bitwise OR operator to set the PDO::PARAM_INPUT_OUTPUT bits for the data_type parameter.
Returns:
Returns TRUE on success or FALSE on failure.

/Doctrine/DBAL/Driver/Statement.php at line 54

bindValue

public boolean bindValue(mixed param, mixed value, integer type)

Binds a value to a corresponding named or positional placeholder in the SQL statement that was used to prepare the statement.

Parameters:
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
value - The value to bind to the parameter.
type - Explicit data type for the parameter using the PDO::PARAM_* constants.
Returns:
Returns TRUE on success or FALSE on failure.

/Doctrine/DBAL/Driver/Statement.php at line 85

closeCursor

public boolean closeCursor()

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

Returns:
Returns TRUE on success or FALSE on failure.

/Doctrine/DBAL/Driver/Statement.php at line 95

columnCount

public integer columnCount()

columnCount Returns the number of columns in the result set

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

/Doctrine/DBAL/Driver/Statement.php at line 104

errorCode

public string errorCode()

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

See Also:
Doctrine_Adapter_Interface::errorCode()
Returns:
error code string

/Doctrine/DBAL/Driver/Statement.php at line 113

errorInfo

public array errorInfo()

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

See Also:
Doctrine_Adapter_Interface::errorInfo()
Returns:
error info array

/Doctrine/DBAL/Driver/Statement.php at line 129

execute

public boolean execute(array params)

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:
params - An array of values with as many elements as there are bound parameters in the SQL statement being executed.
Returns:
Returns TRUE on success or FALSE on failure.

/Doctrine/DBAL/Driver/Statement.php at line 158

fetch

public mixed fetch(integer fetchStyle, integer cursorOrientation, integer cursorOffset)

fetch

See Also:
constants
Parameters:
fetchStyle - Controls how the next row will be returned to the caller. This value must be one of the Query::HYDRATE_* constants, defaulting to Query::HYDRATE_BOTH
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 Query::HYDRATE_ORI_* constants, defaulting to Query::HYDRATE_ORI_NEXT. To request a scrollable cursor for your PDOStatement object, you must set the PDO::ATTR_CURSOR attribute to Doctrine::CURSOR_SCROLL when you prepare the SQL statement with Doctrine_Adapter_Interface->prepare().
cursorOffset - For a PDOStatement object representing a scrollable cursor for which the $cursorOrientation parameter is set to Query::HYDRATE_ORI_ABS, this value specifies the absolute number of the row in the result set that shall be fetched. For a PDOStatement object representing a scrollable cursor for which the $cursorOrientation parameter is set to Query::HYDRATE_ORI_REL, this value specifies the row to fetch relative to the cursor position before PDOStatement->fetch() was called.

/Doctrine/DBAL/Driver/Statement.php at line 172

fetchAll

public array fetchAll(integer fetchStyle, integer columnIndex)

Returns an array containing all of the result set rows

Parameters:
fetchStyle - Controls how the next row will be returned to the caller. This value must be one of the Query::HYDRATE_* constants, defaulting to Query::HYDRATE_BOTH
columnIndex - Returns the indicated 0-indexed column when the value of $fetchStyle is Query::HYDRATE_COLUMN. Defaults to 0.

/Doctrine/DBAL/Driver/Statement.php at line 185

fetchColumn

public string fetchColumn(integer columnIndex)

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

Parameters:
columnIndex - 0-indexed number of the column you wish to retrieve from the row. If no value is supplied, PDOStatement->fetchColumn() fetches the first column.
Returns:
returns a single column in the next row of a result set.

/Doctrine/DBAL/Driver/Statement.php at line 199

rowCount

public integer rowCount()

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:
Returns the number of rows.

Doctrine