Classes:
Doctrine
Doctrine_Access
Doctrine_Adapter
Doctrine_Adapter_Db2_Exception
Doctrine_Adapter_Exception
Doctrine_Adapter_Statement
Doctrine_AuditLog
Doctrine_AuditLog_Listener
Doctrine_Collection
Doctrine_Collection_Exception
Doctrine_Collection_Iterator
Doctrine_Collection_Iterator_Expandable
Doctrine_Collection_Iterator_Normal
Doctrine_Collection_Iterator_Offset
Doctrine_Collection_Offset
Doctrine_Column
Doctrine_Compiler
Doctrine_Compiler_Exception
Doctrine_Configurable
Doctrine_Connection
Doctrine_Connection_Common
Doctrine_Connection_Db2
Doctrine_Connection_Exception
Doctrine_Connection_Firebird
Doctrine_Connection_Firebird_Exception
Doctrine_Connection_Informix
Doctrine_Connection_Informix_Exception
Doctrine_Connection_Mock
Doctrine_Connection_Module
Doctrine_Connection_Mssql
Doctrine_Connection_Mssql_Exception
Doctrine_Connection_Mysql
Doctrine_Connection_Mysql_Exception
Doctrine_Connection_Oracle
Doctrine_Connection_Oracle_Exception
Doctrine_Connection_Pgsql
Doctrine_Connection_Pgsql_Exception
Doctrine_Connection_Profiler
Doctrine_Connection_Profiler_Exception
Doctrine_Connection_Sqlite
Doctrine_Connection_Sqlite_Exception
Doctrine_Connection_Statement
Doctrine_Connection_UnitOfWork
Doctrine_DataDict
Doctrine_DataDict_Exception
Doctrine_DataDict_Informix
Doctrine_DataType
Doctrine_Db
Doctrine_Event
Doctrine_EventListener
Doctrine_EventListener_Chain
Doctrine_EventListener_Exception
Doctrine_Exception
Doctrine_Export
Doctrine_Export_Exception
Doctrine_Export_Firebird
Doctrine_Export_Frontbase
Doctrine_Export_Mssql
Doctrine_Export_Mysql
Doctrine_Export_Oracle
Doctrine_Export_Pgsql
Doctrine_Export_Reporter
Doctrine_Export_Schema
Doctrine_Export_Schema_Xml
Doctrine_Export_Schema_Yml
Doctrine_Export_Sqlite
Doctrine_Expression
Doctrine_Expression_Driver
Doctrine_Expression_Exception
Doctrine_Expression_Firebird
Doctrine_Expression_Informix
Doctrine_Expression_Mock
Doctrine_Expression_Mssql
Doctrine_Expression_Mysql
Doctrine_Expression_Oracle
Doctrine_Expression_Pgsql
Doctrine_Expression_Sqlite
Doctrine_File
Doctrine_File_Index
Doctrine_Formatter
Doctrine_Hook
Doctrine_Hook_Equal
Doctrine_Hook_Integer
Doctrine_Hook_Parser
Doctrine_Hook_Parser_Complex
Doctrine_Hook_WordLike
Doctrine_Hydrate
Doctrine_Hydrate_Array
Doctrine_Hydrate_Exception
Doctrine_Hydrate_Record
Doctrine_Import
Doctrine_Import_Builder
Doctrine_Import_Builder_BaseClass
Doctrine_Import_Builder_Exception
Doctrine_Import_Exception
Doctrine_Import_Firebird
Doctrine_Import_Informix
Doctrine_Import_Mssql
Doctrine_Import_Mysql
Doctrine_Import_Oracle
Doctrine_Import_Pgsql
Doctrine_Import_Reader
Doctrine_Import_Reader_Db
Doctrine_Import_Reader_Exception
Doctrine_Import_Reader_Xml_Propel
Doctrine_Import_Schema
Doctrine_Import_Schema_Xml
Doctrine_Import_Schema_Yml
Doctrine_Import_Sqlite
Doctrine_IntegrityMapper
Doctrine_Lib
Doctrine_Locking_Exception
Doctrine_Locking_Manager_Pessimistic
Doctrine_Manager
Doctrine_Manager_Exception
Doctrine_Node
Doctrine_Node_AdjacencyList
Doctrine_Node_AdjacencyList_LevelOrderIterator
Doctrine_Node_AdjacencyList_PostOrderIterator
Doctrine_Node_AdjacencyList_PreOrderIterator
Doctrine_Node_Exception
Doctrine_Node_MaterializedPath
Doctrine_Node_MaterializedPath_LevelOrderIterator
Doctrine_Node_MaterializedPath_PostOrderIterator
Doctrine_Node_MaterializedPath_PreOrderIterator
Doctrine_Node_NestedSet
Doctrine_Node_NestedSet_LevelOrderIterator
Doctrine_Node_NestedSet_PostOrderIterator
Doctrine_Node_NestedSet_PreOrderIterator
Doctrine_Null
Doctrine_Object
Doctrine_Plugin
Doctrine_Query
Doctrine_Query_Abstract
Doctrine_Query_Check
Doctrine_Query_Condition
Doctrine_Query_Exception
Doctrine_Query_Filter
Doctrine_Query_Filter_Chain
Doctrine_Query_From
Doctrine_Query_Groupby
Doctrine_Query_Having
Doctrine_Query_JoinCondition
Doctrine_Query_Limit
Doctrine_Query_Offset
Doctrine_Query_Orderby
Doctrine_Query_Parser
Doctrine_Query_Part
Doctrine_Query_Select
Doctrine_Query_Set
Doctrine_Query_Where
Doctrine_RawSql
Doctrine_RawSql_Exception
Doctrine_Record
Doctrine_Record_Abstract
Doctrine_Record_Exception
Doctrine_Record_Filter
Doctrine_Record_Iterator
Doctrine_Record_Listener
Doctrine_Record_Listener_Chain
Doctrine_Record_State_Exception
Doctrine_Relation
Doctrine_Relation_Association
Doctrine_Relation_Association_Self
Doctrine_Relation_Exception
Doctrine_Relation_ForeignKey
Doctrine_Relation_LocalKey
Doctrine_Relation_Nest
Doctrine_Relation_Parser
Doctrine_Relation_Parser_Exception
Doctrine_Schema
Doctrine_Schema_Column
Doctrine_Schema_Database
Doctrine_Schema_Exception
Doctrine_Schema_Object
Doctrine_Schema_Relation
Doctrine_Schema_Table
Doctrine_Search
Doctrine_Search_Analyzer
Doctrine_Search_Analyzer_Exception
Doctrine_Search_Analyzer_Standard
Doctrine_Search_Exception
Doctrine_Search_Indexer
Doctrine_Search_Indexer_Dir
Doctrine_Search_Indexer_Exception
Doctrine_Search_Listener
Doctrine_Search_Parser
Doctrine_Search_Query
Doctrine_Search_Record
Doctrine_Search_Scorer
Doctrine_Search_Template
Doctrine_Sequence
Doctrine_Sequence_Db2
Doctrine_Sequence_Exception
Doctrine_Sequence_Firebird
Doctrine_Sequence_Informix
Doctrine_Sequence_Mssql
Doctrine_Sequence_Mysql
Doctrine_Sequence_Oracle
Doctrine_Sequence_Pgsql
Doctrine_Sequence_Sqlite
Doctrine_Table
Doctrine_Table_Exception
Doctrine_Table_Repository
Doctrine_Table_Repository_Exception
Doctrine_Template
Doctrine_Template_NestedSet
Doctrine_Template_Searchable
Doctrine_Template_Taggable
Doctrine_Template_Versionable
Doctrine_Tokenizer
Doctrine_Transaction
Doctrine_Transaction_Exception
Doctrine_Transaction_Firebird
Doctrine_Transaction_Informix
Doctrine_Transaction_Mock
Doctrine_Transaction_Mssql
Doctrine_Transaction_Mysql
Doctrine_Transaction_Oracle
Doctrine_Transaction_Pgsql
Doctrine_Transaction_Sqlite
Doctrine_Tree
Doctrine_Tree_AdjacencyList
Doctrine_Tree_Exception
Doctrine_Tree_MaterializedPath
Doctrine_Tree_NestedSet
Doctrine_Util
Doctrine_Validator
Doctrine_Validator_Country
Doctrine_Validator_Creditcard
Doctrine_Validator_Date
Doctrine_Validator_Email
Doctrine_Validator_Enum
Doctrine_Validator_ErrorStack
Doctrine_Validator_Exception
Doctrine_Validator_HtmlColor
Doctrine_Validator_Ip
Doctrine_Validator_Minlength
Doctrine_Validator_Nospace
Doctrine_Validator_Notblank
Doctrine_Validator_Notnull
Doctrine_Validator_Range
Doctrine_Validator_Regexp
Doctrine_Validator_Unique
Doctrine_Validator_Unsigned
Doctrine_Validator_Usstate
Doctrine_View
Doctrine_View_Exception
Doctrine_Cache
Doctrine_Cache
Doctrine_Cache_Apc
Doctrine_Cache_Array
Doctrine_Cache_Db
Doctrine_Cache_Driver
Doctrine_Cache_Exception
Doctrine_Cache_Memcache
Doctrine_Adapter
Doctrine_Adapter_Db2
Doctrine_Adapter_Mock
Doctrine_Adapter_Mysqli
Doctrine_Adapter_Oracle
Doctrine_Adapter_Statement_Mock
Doctrine_DataDict
Doctrine_DataDict_Firebird
Doctrine_DataDict_Mssql
Doctrine_DataDict_Mysql
Doctrine_DataDict_Oracle
Doctrine_DataDict_Pgsql
Doctrine_DataDict_Sqlite

# Interface: Doctrine_Adapter_Statement_Interface

Source Location: /Doctrine/Adapter/Statement/Interface.php

## Interface Doctrine_Adapter_Statement_Interface

Interface Overview

Doctrine_Adapter_Statement Located in /Doctrine/Adapter/Statement/Interface.php [line 32]
Author(s): Konsta Vesterinen <kvesteri@cc.hut.fi> Information Tags:
Version: | $Revision: 1080 $
Link: | www.phpdoctrine.com
Since: | 1.0
License: | LGPL
| Methods bindColumn bindParam bindValue closeCursor columnCount errorCode errorInfo execute fetch fetchAll fetchColumn fetchObject getAttribute getColumnMeta nextRowset rowCount setAttribute setFetchMode

[ Top ]
Method Summary

boolean | bindColumn() | bindColumn Bind a column to a PHP variable
boolean | bindParam() | bindParam
boolean | bindValue() | bindValue Binds a value to a corresponding named or question mark placeholder in the SQL statement that was use to prepare the statement.
boolean | closeCursor() | 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() | execute Executes a prepared statement
mixed | fetch() | fetch
array | fetchAll() | fetchAll Returns an array containing all of the result set rows
string | fetchColumn() | fetchColumn Returns a single column from the next row of a result set or FALSE if there are no more rows.
mixed | fetchObject() | fetchObject Fetches the next row and returns it as an object.
mixed | getAttribute() | getAttribute Retrieve a statement attribute
array | getColumnMeta() | getColumnMeta Returns metadata for a column in a result set
boolean | nextRowset() | nextRowset Advances to the next rowset in a multi-rowset statement handle
integer | rowCount() | rowCount rowCount() returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding object.
boolean | setAttribute() | setAttribute Set a statement attribute
boolean | setFetchMode() | setFetchMode Set the default fetch mode for this statement

[ Top ]
Methods
bindColumn [line 45]

`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

[ Top ]
bindParam [line 88]

`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

[ Top ]
bindValue [line 60]

`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

[ Top ]
closeCursor [line 95]

`boolean closeCursor( )`

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

API Tags:

Return: | Returns TRUE on success or FALSE on failure.
Access: | public

[ Top ]
columnCount [line 104]

`integer columnCount( )`

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

[ Top ]
errorCode [line 112]

`string errorCode( )`

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

API Tags:

Return: | error code string
See: | Doctrine_Adapter_Interface::errorCode()
Access: | public

[ Top ]
errorInfo [line 120]

`array errorInfo( )`

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

API Tags:

Return: | error info array
See: | Doctrine_Adapter_Interface::errorInfo()
Access: | public

[ Top ]
execute [line 136]

`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

[ Top ]
fetch [line 164]

`mixed fetch( [integer $fetchStyle = Doctrine::FETCH_BOTH], [integer $cursorOrientation = Doctrine::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::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.

API Tags:

See: | Doctrine::FETCH_* constants
Access: | public

[ Top ]
fetchAll [line 180]

`array fetchAll( [integer $fetchStyle = Doctrine::FETCH_BOTH], integer $columnIndex )`

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

Access: | public

[ Top ]
fetchColumn [line 192]

`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

[ Top ]
fetchObject [line 206]

`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

[ Top ]
getAttribute [line 215]

`mixed getAttribute( integer $attribute )`

getAttribute Retrieve a statement attribute

Parameters:

integer | $attribute: |

API Tags:

Return: | the attribute value
See: | Doctrine::ATTR_* constants
Access: | public

[ Top ]
getColumnMeta [line 232]

`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

[ Top ]
nextRowset [line 244]

`boolean nextRowset( )`

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

[ Top ]
rowCount [line 257]

`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.

API Tags:

Return: | Returns the number of rows.
Access: | public

[ Top ]
setAttribute [line 266]

`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

[ Top ]
setFetchMode [line 274]

`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

[ Top ]