constructor
Parameters:
|
Doctrine_Connection |
$conn: |
Doctrine_Connection object, every connection statement holds an instance of Doctrine_Connection |
|
mixed |
$stmt: |
|
API Tags:
boolean bindColumn(
mixed
$column, string
$param, [integer
$type = null]
)
|
|
bindColumn 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::PARAM_* constants. |
API Tags:
| Return: | Returns TRUE on success or FALSE on failure |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::bindColumn()
- bindColumn Bind a column to a PHP variable
boolean bindParam(
$column, mixed
$variable, [integer
$type = null], [integer
$length = null], [mixed
$driverOptions = array()], mixed
$param
)
|
|
bindParam
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::PARAM_* constants. To return an INOUT parameter from a stored procedure, use the bitwise OR operator to set the Doctrine::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: |
|
|
|
$column: |
|
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::bindParam()
- bindParam
boolean bindValue(
mixed
$param, mixed
$value, [integer
$type = null]
)
|
|
bindValue 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::PARAM_* constants. |
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::bindValue()
- bindValue Binds a value to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement.
closeCursor Closes the cursor, enabling the statement to be executed again.
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::closeCursor()
- closeCursor Closes the cursor, enabling the statement to be executed again.
columnCount Returns the number of columns in the result set
API Tags:
| Return: | 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. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::columnCount()
- columnCount Returns the number of columns in the result set
errorCode Fetch the SQLSTATE associated with the last operation on the statement handle
API Tags:
Implementation of:
- Doctrine_Adapter_Statement_Interface::errorCode()
- errorCode Fetch the SQLSTATE associated with the last operation on the statement handle
errorInfo Fetch extended error information associated with the last operation on the statement handle
API Tags:
Implementation of:
- Doctrine_Adapter_Statement_Interface::errorInfo()
- errorInfo Fetch extended error information associated with the last operation on the statement handle
boolean execute(
[array
$params = null]
)
|
|
execute 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. |
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::execute()
- execute Executes a prepared statement
mixed fetch(
[
$fetchMode = Doctrine::FETCH_BOTH], [integer
$cursorOrientation = Doctrine::FETCH_ORI_NEXT], [integer
$cursorOffset = null], integer
$fetchStyle
)
|
|
fetch
Parameters:
|
integer |
$fetchStyle: |
Controls how the next row will be returned to the caller. This value must be one of the Doctrine::FETCH_* constants, defaulting to Doctrine::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::FETCH_ORI_* constants, defaulting to Doctrine::FETCH_ORI_NEXT. To request a scrollable cursor for your Doctrine_Adapter_Statement_Interface object, you must set the Doctrine::ATTR_CURSOR attribute to Doctrine::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::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::FETCH_ORI_REL, this value specifies the row to fetch relative to the cursor position before Doctrine_Adapter_Statement_Interface->fetch() was called. |
|
|
$fetchMode: |
|
API Tags:
| See: | Doctrine::FETCH_* constants |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::fetch()
- fetch
array fetchAll(
[integer
$fetchMode = Doctrine::FETCH_BOTH], [integer
$columnIndex = null]
)
|
|
fetchAll Returns an array containing all of the result set rows
Parameters:
|
integer |
$fetchMode: |
Controls how the next row will be returned to the caller. This value must be one of the Doctrine::FETCH_* constants, defaulting to Doctrine::FETCH_BOTH |
|
integer |
$columnIndex: |
Returns the indicated 0-indexed column when the value of $fetchStyle is Doctrine::FETCH_COLUMN. Defaults to 0. |
API Tags:
Implementation of:
- Doctrine_Adapter_Statement_Interface::fetchAll()
- fetchAll Returns an array containing all of the result set rows
string fetchColumn(
[integer
$columnIndex = 0]
)
|
|
fetchColumn 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. |
API Tags:
| Return: | returns a single column in the next row of a result set. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::fetchColumn()
- fetchColumn 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()]
)
|
|
fetchObject 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::FETCH_CLASS or Doctrine::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. |
API Tags:
| Return: | an instance of the required class with property names that correspond to the column names or FALSE in case of an error. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::fetchObject()
- fetchObject Fetches the next row and returns it as an object.
mixed getAttribute(
integer
$attribute
)
|
|
getAttribute Retrieve a statement attribute
Parameters:
API Tags:
| Return: | the attribute value |
| See: | Doctrine::ATTR_* constants |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::getAttribute()
- getAttribute Retrieve a statement attribute
array getColumnMeta(
integer
$column
)
|
|
getColumnMeta Returns metadata for a column in a result set
Parameters:
|
integer |
$column: |
The 0-indexed column in the result set. |
API Tags:
| Return: | 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. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::getColumnMeta()
- getColumnMeta Returns metadata for a column in a result set
getConnection returns the connection object this statement uses
API Tags:
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.
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::nextRowset()
- nextRowset Advances to the next rowset in a multi-rowset statement handle
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.
API Tags:
| Return: | Returns the number of rows. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::rowCount()
- 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
)
|
|
setAttribute Set a statement attribute
Parameters:
|
integer |
$attribute: |
|
|
mixed |
$value: |
the value of given attribute |
API Tags:
| Return: | Returns TRUE on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::setAttribute()
- setAttribute Set a statement attribute
boolean setFetchMode(
integer
$mode, [
$arg1 = null], [
$arg2 = null]
)
|
|
setFetchMode Set the default fetch mode for this statement
Parameters:
|
integer |
$mode: |
The fetch mode must be one of the Doctrine::FETCH_* constants. |
|
|
$arg1: |
|
|
|
$arg2: |
|
API Tags:
| Return: | Returns 1 on success or FALSE on failure. |
| Access: | public |
Implementation of:
- Doctrine_Adapter_Statement_Interface::setFetchMode()
- setFetchMode Set the default fetch mode for this statement