DB_result
This class implements a wrapper for a DB result set
A new instance of this class will be returned by the DB implementation after processing a query that returns data.
Located in /web/lib/external/pear-db/DB.php (line 995)
boolean
$autofree
(line 1004)
Should results be freed automatically when there are no more rows?
object
$dbh
(line 1010)
A reference to the DB_<driver> object
integer
$fetchmode
(line 1017)
The current default fetch mode
string
$fetchmode_object_class
(line 1026)
The name of the class into which results should be fetched when DB_FETCHMODE_OBJECT is in effect
integer
$limit_count
= null (line 1032)
The number of rows to fetch from a limit query
integer
$limit_from
= null (line 1038)
The row to start fetching from in limit queries
array
$parameters
(line 1045)
The execute parameters that created this result
string
$query
(line 1055)
The query string that created this result
Copied here incase it changes in $dbh, which is referenced
resource
$result
(line 1061)
The query result resource id created by PHP
integer
$row_counter
= null (line 1067)
The present row being dealt with
resource
$statement
(line 1084)
The prepared statement resource id created by PHP in $dbh
This resource is only available when the result set was created using a driver's native execute() method, not PEAR DB's emulated one.
Copied here incase it changes in $dbh, which is referenced
This constructor sets the object's properties
- object &$dbh: the DB object reference
- resource $result: the result resource id
- array $options: an associative array with result options
Fetch a row of data into an array which is passed by reference
The type of array returned can be controlled either by setting this method's $fetchmode parameter or by changing the default fetch mode setFetchMode() before calling this method.
There are two options for standardizing the information returned from databases, ensuring their values are consistent when changing DBMS's. These portability options can be turned on when creating a new DB object or by using setOption().
- DB_PORTABILITY_LOWERCASE convert names of fields to lower case
- DB_PORTABILITY_RTRIM right trim the data
- array &$arr: the variable where the data should be placed
- int $fetchmode: the constant indicating how to format the data
- int $rownum: the row number to fetch (index starts at 0)
Fetch a row of data and return it by reference into an array
The type of array returned can be controlled either by setting this method's $fetchmode parameter or by changing the default fetch mode setFetchMode() before calling this method.
There are two options for standardizing the information returned from databases, ensuring their values are consistent when changing DBMS's. These portability options can be turned on when creating a new DB object or by using setOption().
- DB_PORTABILITY_LOWERCASE convert names of fields to lower case
- DB_PORTABILITY_RTRIM right trim the data
- int $fetchmode: the constant indicating how to format the data
- int $rownum: the row number to fetch (index starts at 0)
Tells which row number is currently being processed
Set options for the DB_result object
- string $key: the option to set
- mixed $value: the value to set the option to
Documentation generated on Wed, 09 Feb 2011 08:59:19 +0700 by phpDocumentor 1.4.2