Docs For Class MDB2_Result

MDB2_Result_Common (Constructor) [line 3288]

MDB2_Result_Common MDB2_Result_Common(
mixed
&$db, mixed
&$result, [mixed
$limit = 0], [mixed
$offset = 0])

PHP 4 Constructor

[ Top ]

bindColumn [line 3668]

mixed bindColumn(
int
$column, mixed
&$value, [string
$type = null])

Set bind variable to a column.

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Parameters:

int	`$column`	—	column number or name
mixed	`&$value`	—	variable reference
string	`$type`	—	specifies the type of the field

[ Top ]

fetchAll [line 3461]

mixed fetchAll(
[int
$fetchmode = MDB2_FETCHMODE_DEFAULT], [bool
$rekey = false], [bool
$force_array = false], [bool
$group = false])

Fetch and return a column of data (it uses fetchRow for that)

Return: data array on success, a MDB2 error on failure
See: getAssoc()
Access: public

Parameters:

int	`$fetchmode`	—	the fetch mode to use: MDB2_FETCHMODE_ORDERED MDB2_FETCHMODE_ASSOC MDB2_FETCHMODE_ORDERED \| MDB2_FETCHMODE_FLIPPED MDB2_FETCHMODE_ASSOC \| MDB2_FETCHMODE_FLIPPED
bool	`$rekey`	—	if set to true, the $all will have the first column as its first dimension
bool	`$force_array`	—	used only when the query returns exactly two columns. If true, the values of the returned array will be one-element arrays instead of scalars.
bool	`$group`	—	if true, the values of the returned array is wrapped in another array. If the same key value (in the first column) repeats itself, the values will be appended to this array instead of overwriting the existing values.

[ Top ]

fetchCol [line 3415]

mixed fetchCol(
[int
$colnum = 0])

Fetch and return a column of data (it uses current for that)

Return: data array on success, a MDB2 error on failure
Access: public

Parameters:

int $colnum — the column number to fetch

[ Top ]

fetchOne [line 3389]

string fetchOne(
[int
$colnum = 0], [int
$rownum = null])

fetch single column from the next row from a result set

Return: data on success, a MDB2 error on failure
Access: public

Parameters:

int	`$colnum`	—	the column number to fetch
int	`$rownum`	—	number of the row where the data can be found

[ Top ]

fetchRow [line 3369]

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

Fetch and return a row of data

Return: data array on success, a MDB2 error on failure
Access: public

Parameters:

int	`$fetchmode`	—	how the array data should be indexed
int	`$rownum`	—	number of the row where the data can be found

[ Top ]

free [line 3721]

bool free(
)

Free the internal resources associated with result.

Return: true on success, false if result is invalid
Access: public

[ Top ]

getColumnNames [line 3588]

mixed getColumnNames(
[bool
$reverse = false])

Retrieve the names of columns returned by the DBMS in a query result or from the cache.

Return: Array variable that holds the names of columns or an MDB2 error on failure. Some DBMS may not return any columns when the result set does not contain any rows.
Access: public

Parameters:

bool $reverse — If set to true the values are the column names, otherwise the names of the columns are the keys.

[ Top ]

getResource [line 3649]

resource getResource(
)

return the resource associated with the result object

Access: public

[ Top ]

nextResult [line 3566]

true nextResult(
a
0)

Move the internal result pointer to the next available result

Return: on success, false if there is no more result set or an error object on failure
Access: public

Parameters:

a 0 — valid result resource

[ Top ]

numCols [line 3633]

mixed numCols(
)

Count the number of columns returned by the DBMS in a query result.

Return: integer value with the number of columns, a MDB2 error on failure
Access: public

[ Top ]

numRows [line 3547]

mixed numRows(
)

Returns the number of rows in a result object

Return: MDB2 Error Object or the number of rows
Access: public

[ Top ]

rowCount [line 3532]

int rowCount(
)

Returns the actual row number that was last fetched (count from 0)

Access: public

[ Top ]

seek [line 3343]

mixed seek(
[int
$rownum = 0])

Seek to a specific row in a result set

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Parameters:

int $rownum — number of the row where the data can be found

[ Top ]

setResultTypes [line 3317]

mixed setResultTypes(
array
$types)

Define the list of types to be associated with the columns of a given result set.

This function may be called before invoking fetchRow(), fetchOne(), fetchCol() and fetchAll() so that the necessary data type conversions are performed on the data to be retrieved by them. If this function is not called, the type of all result set columns is assumed to be text, thus leading to not perform any conversions.

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Parameters:

array $types — variable that lists the data types to be expected in the result set columns. If this array contains less types than the number of columns that are returned in the result set, the remaining columns are assumed to be of the type text. Currently, the types clob and blob are not fully supported.

[ Top ]

Class: MDB2_Result_Common

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$column_names =

$db =

$limit =

$offset =

$offset_count = 0

$result =

$rownum = -1

$types = array()

$values = array()

Method Detail

MDB2_Result_Common (Constructor) [line 3288]

bindColumn [line 3668]

Parameters:

fetchAll [line 3461]

Parameters:

fetchCol [line 3415]

Parameters:

fetchOne [line 3389]

Parameters:

fetchRow [line 3369]

Parameters:

free [line 3721]

getColumnNames [line 3588]

Parameters:

getResource [line 3649]

nextResult [line 3566]

Parameters:

numCols [line 3633]

numRows [line 3547]

rowCount [line 3532]

seek [line 3343]

Parameters:

setResultTypes [line 3317]

Parameters: