Docs For Class DB

DB_result DB_result(
resource
&$dbh, resource
$result, [array
$options = array()])

DB_result constructor.

Parameters:

resource	`&$dbh`	—	DB object reference
resource	`$result`	—	result resource id
array	`$options`	—	assoc array with optional result options

[ Top ]

mixed fetchInto(
array
&$arr, [int
$fetchmode = DB_FETCHMODE_DEFAULT], [int
$rownum = null])

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

Return: DB_OK on success, null on no more rows or a DB_Error object on error
See: DB_common::setOption(), DB_common::setFetchMode()
Access: public

Parameters:

array	`&$arr`	—	(reference) array where data from the row should be placed
int	`$fetchmode`	—	how the resulting array should be indexed
int	`$rownum`	—	the row number to fetch

[ Top ]

array &fetchRow(
[int
$fetchmode = DB_FETCHMODE_DEFAULT], [int
$rownum = null])

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

Return: a row of data, null on no more rows or PEAR_Error object on error
See: DB_common::setOption(), DB_common::setFetchMode()
Access: public

Parameters:

int	`$fetchmode`	—	how the resulting array should be indexed
int	`$rownum`	—	the row number to fetch

[ Top ]

int free(
)

Frees the resources allocated for this result set.

Return: error code
Access: public

[ Top ]

integer getRowCounter(
)

returns the actual row number

[ Top ]

bool nextResult(
)

Get the next result if a batch of queries was executed.

Return: true if a new result is available or false if not.
Access: public

[ Top ]

int numCols(
)

Get the the number of columns in a result set.

Return: the number of columns, or a DB error
Access: public

[ Top ]

int numRows(
)

Get the number of rows in a result set.

Return: the number of rows, or a DB error
Access: public

[ Top ]

void setOption(

$key, [
$value = null])

Parameters:

	`$key`	—
	`$value`	—

[ Top ]

void tableInfo(
[
$mode = null])

See: DB_common::tableInfo()
Deprecated:

Parameters:

$mode —

[ Top ]

Class: DB_result

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$dbh =

$limit_count = null

$limit_from = null

$result =

$row_counter = null

Method Detail

DB_result (Constructor) [line 796]

Parameters:

fetchInto [line 933]

Parameters:

fetchRow [line 849]

Parameters:

free [line 1039]

getRowCounter [line 1072]

nextResult [line 1025]

numCols [line 995]

numRows [line 1010]

setOption [line 809]

Parameters:

tableInfo [line 1057]

Parameters: