Docs For Class ADORecordSet

ADORecordSet ADORecordSet(
queryID
$queryID)

Constructor

Parameters:

queryID

$queryID

this is the queryID returned by ADOConnection->_query()

[ Top ]

void AbsolutePage(
[
$page = -1])

set/returns the current recordset page when paginating

Parameters:

$page

[ Top ]

the AbsolutePosition(
)

synonym for CurrentRow -- for ADO compat

Tags:

return:

current row in the recordset. If at EOF, will return the last row. 0-based.

[ Top ]

void AtFirstPage(
[
$status = false])

set/returns the status of the atFirstPage flag when paginating

Parameters:

$status

[ Top ]

void AtLastPage(
[
$status = false])

set/returns the status of the atLastPage flag when paginating

Parameters:

$status

[ Top ]

true Close(
)

Clean up recordset

Tags:

return:

or false

[ Top ]

the CurrentRow(
)

Tags:

return:

current row in the recordset. If at EOF, will return the last row. 0-based.

[ Top ]

the &FetchField(
[fieldoffset
$fieldoffset = -1])

Get the ADOFieldObject of a specific column.

Tags:

return:

ADOFieldObject for that column, or false.

Overridden in child classes as:

ADORecordSet_array::FetchField()

ADORecordSet_ado::FetchField()

ADORecordSet_db2::FetchField()

ADORecordSet_fbsql::FetchField()

ADORecordset_ibase::FetchField()

ADORecordset_informix72::FetchField()

ADORecordset_mssql::FetchField()

ADORecordSet_mysql::FetchField()

ADORecordSet_mysqli::FetchField()

ADORecordset_oci8::FetchField()

ADORecordSet_odbc::FetchField()

ADORecordSet_odbtp::FetchField()

ADORecordset_oracle::FetchField()

ADORecordSet_pdo::FetchField()

ADORecordSet_postgres64::FetchField()

ADORecordset_sqlite::FetchField()

ADORecordset_sybase::FetchField()

Parameters:

fieldoffset

$fieldoffset

is the column position to access(0-based).

[ Top ]

DB_OK FetchInto(

&$arr)

Fetch a row, returning PEAR_Error if no more rows.

This is PEAR DB compat mode.

Tags:

return:

or error object

Parameters:

&$arr

[ Top ]

the &FetchNextObj(
)

Return the fields array of the current row as an object for convenience.

The default is lower-case field names.

Tags:

return:

object with the properties set to the fields of the current row, or false if EOF

Fixed bug reported by tim@orotech.net

[ Top ]

the &FetchNextObject(
[$isupper
$isupper = true])

Return the fields array of the current row as an object for convenience.

The default is upper case field names.

Tags:

return:

object with the properties set to the fields of the current row, or false if EOF

Fixed bug reported by tim@orotech.net

Parameters:

$isupper

$isupper

to set the object property names to uppercase

[ Top ]

the &FetchObj(
)

Return the fields array of the current row as an object for convenience.

The default case is lowercase field names.

Tags:

return:

object with the properties set to the fields of the current row

[ Top ]

the &FetchObject(
[$isupper
$isupper = true])

Return the fields array of the current row as an object for convenience.

The default case is uppercase.

Tags:

return:

object with the properties set to the fields of the current row

Parameters:

$isupper

$isupper

to set the object property names to uppercase

[ Top ]

false &FetchRow(
)

Fetch a row, returning false if no more rows.

This is PEAR DB compat mode.

Tags:

return:

or array containing the current record

[ Top ]

the FieldCount(
)

Tags:

return:

number of columns in the recordset. Some databases will set this to 0 if no records are returned, others will return the number of columns in the query.

[ Top ]

the Fields(
colname
$colname)

Get the value of a field in the current row by column name.

Will not work if ADODB_FETCH_MODE is set to ADODB_FETCH_NUM.

Tags:

return:

value of $colname column

Overridden in child classes as:

ADORecordSet_array::Fields()

ADORecordSet_ado::Fields()

ADORecordSet_db2::Fields()

ADORecordset_ibase::Fields()

ADORecordset_mssql::Fields()

ADORecordSet_mysql::Fields()

ADORecordSet_mysqli::Fields()

ADORecordset_oci8::Fields()

ADORecordset_oci8po::Fields()

ADORecordSet_odbc::Fields()

ADORecordset_oracle::Fields()

ADORecordSet_pdo::Fields()

ADORecordSet_postgres64::Fields()

ADORecordset_sqlite::Fields()

Parameters:

colname

$colname

is the field to access

[ Top ]

void &FieldTypesArray(
)

Get the ADOFieldObjects of all columns in an array.

[ Top ]

void Free(
)

PEAR DB Compat - do not use internally

[ Top ]

void &GetAll(
[
$nRows = -1])

Parameters:

$nRows

[ Top ]

an &GetArray(
[[nRows]
$nRows = -1])

return recordset as a 2-dimensional array.

Tags:

return:

array indexed by the rows (0-based) from the recordset

Overridden in child classes as:

ADORecordSet_array::GetArray()

Parameters:

[nRows]

$nRows

is the number of rows to return. -1 means every row.

[ Top ]

an &GetArrayLimit(
offset
$nrows, [[nrows]
$offset = -1])

return recordset as a 2-dimensional array.

Helper function for ADOConnection->SelectLimit()

Tags:

return:

array indexed by the rows (0-based) from the recordset

Overridden in child classes as:

ADORecordSet_db2::GetArrayLimit()

ADORecordset_oci8::GetArrayLimit()

ADORecordset_oci8po::GetArrayLimit()

ADORecordSet_odbc::GetArrayLimit()

Parameters:

offset	$nrows	is the row to start calculations from (1-based)
[nrows]	$offset	is the number of rows to return

[ Top ]

an &GetAssoc(
[[force_array]
$force_array = false], [[first2cols]
$first2cols = false])

return whole recordset as a 2-dimensional associative array if there are more than 2 columns.

The first column is treated as the key and is not included in the array. If there is only 2 columns, it will return a 1 dimensional array of key-value pairs unless $force_array == true.

Tags:

return:

associative array indexed by the first column of the array, or false if the data has less than 2 cols.

Overridden in child classes as:

ADORecordSet_ldap::GetAssoc()

Parameters:

[force_array]	$force_array	has only meaning if we have 2 data columns. If false, a 1 dimensional array is returned, otherwise a 2 dimensional array is returned. If this sounds confusing, read the source.
[first2cols]	$first2cols	means if there are more than 2 cols, ignore the remaining cols and instead of returning array[col0] => array(remaining cols), return array[col0] => col1

[ Top ]

void GetAssocKeys(
[
$upper = true])

Parameters:

$upper

[ Top ]

HTML GetMenu(
name
$name, [[defstr]
$defstr = ''], [[blank1stItem]
$blank1stItem = true], [[multiple]
$multiple = false], [[size]
$size = 0], [[selectAttr]
$selectAttr = ''], [
$compareFields0 = true])

Generate a SELECT tag string from a recordset, and return the string.

If the recordset has 2 cols, we treat the 1st col as the containing the text to display to the user, and 2nd col as the return value. Default strings are compared with the FIRST column.

Tags:

return:

changes by glen.davies@cce.ac.nz to support multiple hilited items

Parameters:

name	$name	name of SELECT tag
[defstr]	$defstr	the value to hilite. Use an array for multiple hilites for listbox.
[blank1stItem]	$blank1stItem	true to leave the 1st item in list empty
[multiple]	$multiple	true for listbox, false for popup
[size]	$size	#rows to show for listbox. not used by popup
[selectAttr]	$selectAttr	additional attributes to defined for SELECT tag. useful for holding javascript onChange='...' handlers. column 0 (1st col) if this is true. This is not documented.
	$compareFields0

[ Top ]

void GetMenu2(

$name, [
$defstr = ''], [
$blank1stItem = true], [
$multiple = false], [
$size = 0], [
$selectAttr = ''])

Generate a SELECT tag string from a recordset, and return the string.

If the recordset has 2 cols, we treat the 1st col as the containing the text to display to the user, and 2nd col as the return value. Default strings are compared with the SECOND column.

Parameters:

	$name
	$defstr
	$blank1stItem
	$multiple
	$size
	$selectAttr

[ Top ]

void GetMenu3(

$name, [
$defstr = ''], [
$blank1stItem = true], [
$multiple = false], [
$size = 0], [
$selectAttr = ''])

Parameters:

	$name
	$defstr
	$blank1stItem
	$multiple
	$size
	$selectAttr

[ Top ]

void &GetRowAssoc(
[
$upper = 1])

Use associative array to get fields array for databases that do not support associative arrays. Submitted by Paolo S. Asioli paolo.asioli#libero.it

If you don't want uppercase cols, set $ADODB_FETCH_MODE = ADODB_FETCH_ASSOC before you execute your SQL statement, and access $rs->fields['col'] directly.

$upper 0 = lowercase, 1 = uppercase, 2 = whatever is returned by FetchField

Overridden in child classes as:

ADORecordSet_ldap::GetRowAssoc()

ADORecordSet_mysql::GetRowAssoc()

ADORecordSet_mysqli::GetRowAssoc()

ADORecordSet_postgres64::GetRowAssoc()

Parameters:

$upper

[ Top ]

an &GetRows(
[[nRows]
$nRows = -1])

Synonym for GetArray() for compatibility with ADO.

Tags:

return:

array indexed by the rows (0-based) from the recordset

Parameters:

[nRows]

$nRows

is the number of rows to return. -1 means every row.

[ Top ]

void Init(
)

Overridden in child classes as:

ADORecordset_oci8::Init()

ADORecordSet_pdo::Init()

[ Top ]

void LastPageNo(
[
$page = false])

Parameters:

$page

[ Top ]

void MaxRecordCount(
)

[ Top ]

the MetaType(
t
$t, [len
$len = -1], [fieldobj
$fieldobj = false])

Get the metatype of the column. This is used for formatting. This is because many databases use different names for the same type, so we transform the original type to our standardised version which uses 1 character codes:

Tags:

return:

general type of the data: C for character < 250 chars X for teXt (>= 250 chars) B for Binary N for numeric or floating point D for date T for timestamp L for logical/Boolean I for integer R for autoincrement counter/integer

Overridden in child classes as:

ADORecordSet_array_mysqli::MetaType()

ADORecordSet_ado::MetaType()

ADORecordSet_fbsql::MetaType()

ADORecordset_ibase::MetaType()

ADORecordSet_mysql::MetaType()

ADORecordSet_mysqli::MetaType()

ADORecordset_oci8::MetaType()

ADORecordSet_odbc_db2::MetaType()

ADORecordSet_vfp::MetaType()

ADORecordset_oracle::MetaType()

ADORecordSet_postgres64::MetaType()

Parameters:

t	$t	is the type passed in. Normally is ADOFieldObject->type.
len	$len	is the maximum length of that field. This is because we treat character fields bigger than a certain size as a 'B' (blob).
fieldobj	$fieldobj	is the field object returned by the database driver. Can hold additional info (eg. primary_key for mysql).

[ Top ]

true Move(
[rowNumber
$rowNumber = 0])

Random access to a specific row in the recordset. Some databases do not support access to previous rows in the databases (no scrolling backwards).

Tags:

return:

if there still rows available, or false if there are no more rows (EOF).

Parameters:

rowNumber

$rowNumber

is the row to move to (0-based)

[ Top ]

true MoveFirst(
)

Move to the first row in the recordset. Many databases do NOT support this.

Tags:

return:

or false

Overridden in child classes as:

ADORecordset_informix72::MoveFirst()

ADORecordSet_odbtp::MoveFirst()

[ Top ]

true MoveLast(
)

Move to the last row in the recordset.

Tags:

return:

or false

Overridden in child classes as:

ADORecordset_informix72::MoveLast()

ADORecordSet_odbtp::MoveLast()

[ Top ]

true MoveNext(
)

Move to next record in the recordset.

Tags:

return:

if there still rows available, or false if there are no more rows (EOF).

Overridden in child classes as:

ADORecordSet_array::MoveNext()

ADORecordSet_db2::MoveNext()

ADORecordset_mssql::MoveNext()

ADORecordSet_mysql::MoveNext()

ADORecordSet_ext_mysql::MoveNext()

ADORecordSet_mysqlt::MoveNext()

ADORecordSet_ext_mysqlt::MoveNext()

ADORecordSet_mysqli::MoveNext()

ADORecordset_oci8::MoveNext()

ADORecordset_oci8po::MoveNext()

ADORecordSet_odbc::MoveNext()

ADORecordSet_postgres64::MoveNext()

ADORecordSet_postgres7::MoveNext()

ADORecordSet_assoc_postgres7::MoveNext()

[ Top ]

void NextRecordSet(
)

Overridden in child classes as:

ADORecordSet_ado::NextRecordSet()

ADORecordset_mssql::NextRecordSet()

ADORecordSet_odbtp::NextRecordSet()

[ Top ]

void NumCols(
)

PEAR DB compat, number of cols

[ Top ]

void NumRows(
)

PEAR DB compat, number of rows

[ Top ]

the PO_RecordCount(
[
$table = ""], [
$condition = ""])

Portable RecordCount. Pablo Roca <pabloroca@mvps.org>

Tags:

return:

number of records from a previous SELECT. All databases support this.

But aware possible problems in multiuser environments. For better speed the table must be indexed by the condition. Heavy test this before deploying.

Parameters:

	$table
	$condition

[ Top ]

the RecordCount(
)

synonyms RecordCount and RowCount

Tags:

return:

number of rows or -1 if this is not supported

[ Top ]

the RowCount(
)

synonyms RecordCount and RowCount

Tags:

return:

number of rows or -1 if this is not supported

[ Top ]

date UnixDate(
$v
$v)

Tags:

return:

in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format

Overridden in child classes as:

ADORecordSet_array_mssql::UnixDate()

ADORecordSet_array_sybase::UnixDate()

ADORecordset_mssql::UnixDate()

ADORecordset_sybase::UnixDate()

Parameters:

$v

is a date string in YYYY-MM-DD format

[ Top ]

date UnixTimeStamp(
$v
$v)

Tags:

return:

in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format

Overridden in child classes as:

ADORecordSet_array_mssql::UnixTimeStamp()

ADORecordSet_array_sybase::UnixTimeStamp()

ADORecordset_mssql::UnixTimeStamp()

ADORecordset_sybase::UnixTimeStamp()

Parameters:

$v

is a timestamp string in YYYY-MM-DD HH-NN-SS format

[ Top ]

a UserDate(
v
$v, [fmt
$fmt = 'Y-m-d'])

Tags:

return:

date formated as user desires

Parameters:

v	$v	is the character date in YYYY-MM-DD format, returned by database
fmt	$fmt	is the format to apply to it, using date()

[ Top ]

a UserTimeStamp(
v
$v, [fmt
$fmt = 'Y-m-d H:i:s'])

Tags:

return:

timestamp formated as user desires

Parameters:

v	$v	is the character timestamp in YYYY-MM-DD hh:mm:ss format
fmt	$fmt	is the format to apply to it, using date()

[ Top ]

void _close(
)

Overridden in child classes as:

ADORecordSet_array::_close()

ADORecordSet_ado::_close()

ADORecordSet_db2::_close()

ADORecordSet_fbsql::_close()

ADORecordset_ibase::_close()

ADORecordset_informix72::_close()

ADORecordSet_ldap::_close()

ADORecordset_mssql::_close()

ADORecordSet_mysql::_close()

ADORecordSet_mysqli::_close()

ADORecordset_oci8::_close()

ADORecordSet_odbc::_close()

ADORecordSet_odbtp::_close()

ADORecordset_oracle::_close()

ADORecordSet_pdo::_close()

ADORecordSet_postgres64::_close()

ADORecordset_sqlite::_close()

ADORecordset_sybase::_close()

[ Top ]

Class: ADORecordSet

Class Overview

Variables

Methods

Child classes:

Class Details

Class Variables

$bind = false

$blobSize = 100

$canSeek = false

$connection = false

$dataProvider = "native"

$datetime = false

$debug = false

$emptyDate = '&nbsp;'

$emptyTimeStamp = '&nbsp;'

$EOF = false

$fetchMode =

$fields = false

$sql =

$timeCreated = 0

$_atFirstPage = false

$_atLastPage = false

$_closed = false

$_currentPage = -1

$_currentRow = -1

$_inited = false

$_lastPageNo = -1

$_maxRecordCount = 0

$_names =

$_numOfFields = -1

$_numOfRows = -1

$_obj =

$_queryID = -1

Class Methods

constructor ADORecordSet [line 2782]

Parameters:

method AbsolutePage [line 3699]

Parameters:

method AbsolutePosition [line 3404]

Tags:

method AtFirstPage [line 3708]

Parameters:

method AtLastPage [line 3723]

Parameters:

method Close [line 3334]

Tags:

method CurrentRow [line 3397]

Tags:

method FetchField [line 3420]

Tags:

Parameters:

method FetchInto [line 3167]

Tags:

Parameters:

method FetchNextObj [line 3493]

Tags:

method FetchNextObject [line 3511]

Tags:

Parameters:

method FetchObj [line 3446]

Tags:

method FetchObject [line 3460]

Tags:

Parameters:

method FetchRow [line 3148]

Tags:

method FieldCount [line 3410]

Tags:

method Fields [line 3288]

Tags:

Parameters:

method FieldTypesArray [line 3432]

method Free [line 3119]

method GetAll [line 2889]

Parameters:

method GetArray [line 2873]

Tags:

Parameters:

method GetArrayLimit [line 2913]

$emptyDate = ' '

$emptyTimeStamp = ' '