Class: ADORecordSet_odbc

Source Location: /includes/classes/adodb/drivers/adodb-odbc.inc.php

Class Overview

ADODB_BASE_RS
   |
   --ADORecordSet
      |
      --ADORecordSet_odbc

RecordSet class that represents the dataset returned by the database.

Variables

Methods

Child classes:

ADORecordSet_access: RecordSet class that represents the dataset returned by the database.

ADORecordSet_odbc_db2: RecordSet class that represents the dataset returned by the database.

ADORecordSet_odbc_mssql: RecordSet class that represents the dataset returned by the database.

ADORecordSet_odbc_oracle: RecordSet class that represents the dataset returned by the database.

ADORecordSet_sapdb: RecordSet class that represents the dataset returned by the database.

ADORecordSet_sqlanywhere: RecordSet class that represents the dataset returned by the database.

ADORecordSet_vfp: RecordSet class that represents the dataset returned by the database.

Inherited Variables

Class: ADORecordSet

ADORecordSet::$blobSize
ADORecordSet::$canSeek
ADORecordSet::$connection
ADORecordSet::$datetime
ADORecordSet::$debug
ADORecordSet::$emptyDate
ADORecordSet::$emptyTimeStamp
ADORecordSet::$EOF
ADORecordSet::$fetchMode
ADORecordSet::$fields
ADORecordSet::$sql
ADORecordSet::$timeCreated
ADORecordSet::$_atFirstPage
ADORecordSet::$_atLastPage
ADORecordSet::$_closed
ADORecordSet::$_currentPage
ADORecordSet::$_currentRow
ADORecordSet::$_inited
ADORecordSet::$_lastPageNo
ADORecordSet::$_maxRecordCount
ADORecordSet::$_names
ADORecordSet::$_numOfFields
ADORecordSet::$_numOfRows
ADORecordSet::$_obj
ADORecordSet::$_queryID

Inherited Methods

Class: ADORecordSet

ADORecordSet::ADORecordSet(): Constructor
ADORecordSet::AbsolutePage(): set/returns the current recordset page when paginating
ADORecordSet::AbsolutePosition(): synonym for CurrentRow -- for ADO compat
ADORecordSet::AtFirstPage(): set/returns the status of the atFirstPage flag when paginating
ADORecordSet::AtLastPage(): set/returns the status of the atLastPage flag when paginating
ADORecordSet::Close(): Clean up recordset
ADORecordSet::CurrentRow()
ADORecordSet::FetchField(): Get the ADOFieldObject of a specific column.
ADORecordSet::FetchInto(): Fetch a row, returning PEAR_Error if no more rows.
ADORecordSet::FetchNextObj(): Return the fields array of the current row as an object for convenience.
ADORecordSet::FetchNextObject(): Return the fields array of the current row as an object for convenience.
ADORecordSet::FetchObj(): Return the fields array of the current row as an object for convenience.
ADORecordSet::FetchObject(): Return the fields array of the current row as an object for convenience.
ADORecordSet::FetchRow(): Fetch a row, returning false if no more rows.
ADORecordSet::FieldCount()
ADORecordSet::Fields(): Get the value of a field in the current row by column name.
ADORecordSet::FieldTypesArray(): Get the ADOFieldObjects of all columns in an array.
ADORecordSet::Free(): PEAR DB Compat - do not use internally
ADORecordSet::GetAll()
ADORecordSet::GetArray(): return recordset as a 2-dimensional array.
ADORecordSet::GetArrayLimit(): return recordset as a 2-dimensional array.
ADORecordSet::GetAssoc(): return whole recordset as a 2-dimensional associative array if there are more than 2 columns.
ADORecordSet::GetAssocKeys()
ADORecordSet::GetMenu(): Generate a SELECT tag string from a recordset, and return the string.
ADORecordSet::GetMenu2(): Generate a SELECT tag string from a recordset, and return the string.
ADORecordSet::GetMenu3()
ADORecordSet::GetRowAssoc(): Use associative array to get fields array for databases that do not support associative arrays. Submitted by Paolo S. Asioli paolo.asioli#libero.it
ADORecordSet::GetRows(): Synonym for GetArray() for compatibility with ADO.
ADORecordSet::Init()
ADORecordSet::LastPageNo()
ADORecordSet::MaxRecordCount()
ADORecordSet::MetaType(): 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:
ADORecordSet::Move(): Random access to a specific row in the recordset. Some databases do not support access to previous rows in the databases (no scrolling backwards).
ADORecordSet::MoveFirst(): Move to the first row in the recordset. Many databases do NOT support this.
ADORecordSet::MoveLast(): Move to the last row in the recordset.
ADORecordSet::MoveNext(): Move to next record in the recordset.
ADORecordSet::NextRecordSet()
ADORecordSet::NumCols(): PEAR DB compat, number of cols
ADORecordSet::NumRows(): PEAR DB compat, number of rows
ADORecordSet::PO_RecordCount(): Portable RecordCount. Pablo Roca <pabloroca@mvps.org>
ADORecordSet::RecordCount(): synonyms RecordCount and RowCount
ADORecordSet::RowCount(): synonyms RecordCount and RowCount
ADORecordSet::UnixDate()
ADORecordSet::UnixTimeStamp()
ADORecordSet::UserDate()
ADORecordSet::UserTimeStamp()
ADORecordSet::_close()

Class Details

[line 591]
RecordSet class that represents the dataset returned by the database.

To keep memory overhead low, this class holds only the current row in memory. No prefetching of data is done, so the RecordCount() can return -1 ( which means recordcount not known).

[ Top ]

Class Variables

$bind = false

[line 593]

Type:	mixed
Overrides:	Array

[ Top ]

$databaseType = "odbc"

[line 594]

Type:

mixed

[ Top ]

$dataProvider = "odbc"

[line 595]

Type:	mixed
Overrides:	Array

[ Top ]

$useFetchArray =

[line 596]

Type:

mixed

[ Top ]

$_has_stupid_odbc_fetch_api_change =

[line 597]

Type:

mixed

[ Top ]

Class Methods

constructor ADORecordSet_odbc [line 599]

ADORecordSet_odbc ADORecordSet_odbc(

$id, [
$mode = false])

Parameters:

	$id
	$mode

[ Top ]

method FetchField [line 617]

void &FetchField(
[
$fieldOffset = -1])

Overrides ADORecordSet::FetchField() (Get the ADOFieldObject of a specific column.)

Parameters:

$fieldOffset

[ Top ]

method Fields [line 632]

void Fields(

$colname)

Overrides ADORecordSet::Fields() (Get the value of a field in the current row by column name.)

Parameters:

$colname

[ Top ]

method GetArrayLimit [line 664]

void &GetArrayLimit(

$nrows, [
$offset = -1])

Overrides ADORecordSet::GetArrayLimit() (return recordset as a 2-dimensional array.)

Parameters:

	$nrows
	$offset

[ Top ]

method MoveNext [line 690]

void MoveNext(
)

Overrides ADORecordSet::MoveNext() (Move to next record in the recordset.)

[ Top ]

method _close [line 732]

void _close(
)

Overrides ADORecordSet::_close() (parent method not documented)

[ Top ]

method _fetch [line 713]

void _fetch(
)

[ Top ]

method _initrs [line 647]

void _initrs(
)

[ Top ]

method _seek [line 658]

void _seek(

$row)

Parameters:

$row

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:40:44 +0200 by phpDocumentor 1.4.1