Class: ADORecordSet_array

Source Location: /includes/classes/adodb/adodb.inc.php

Class Overview

ADODB_BASE_RS
   |
   --ADORecordSet
      |
      --ADORecordSet_array

This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

Variables

Methods

Child classes:

ADORecordSet_array_mssql: This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

ADORecordSet_array_mysqli: This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

ADORecordSet_array_sybase: This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

Inherited Variables

Class: ADORecordSet

ADORecordSet::$bind
ADORecordSet::$blobSize
ADORecordSet::$connection
ADORecordSet::$dataProvider
ADORecordSet::$datetime
ADORecordSet::$debug
ADORecordSet::$emptyDate
ADORecordSet::$emptyTimeStamp
ADORecordSet::$EOF
ADORecordSet::$fetchMode
ADORecordSet::$fields
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 3742]
This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

Note that the constructor is different from the standard ADORecordSet

[ Top ]

Class Variables

$affectedrows = false

[line 3752]

Type:

mixed

[ Top ]

$canSeek = true

[line 3751]

Type:	mixed
Overrides:	Array

[ Top ]

$compat = false

[line 3755]

Type:

mixed

[ Top ]

$databaseType = 'array'

[line 3744]

Type:

mixed

[ Top ]

$insertid = false

[line 3753]

Type:

mixed

[ Top ]

$sql = ''

[line 3754]

Type:	mixed
Overrides:	Array

[ Top ]

$_array =

[line 3746]

Type:

mixed

[ Top ]

$_colnames =

[line 3748]

Type:

mixed

[ Top ]

$_fieldobjects =

[line 3750]

Type:

mixed

[ Top ]

$_skiprow1 =

[line 3749]

Type:

mixed

[ Top ]

$_types =

[line 3747]

Type:

mixed

[ Top ]

Class Methods

constructor ADORecordSet_array [line 3760]

ADORecordSet_array ADORecordSet_array(
[
$fakeid = 1])

Constructor

Parameters:

$fakeid

[ Top ]

method FetchField [line 3882]

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

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

Parameters:

$fieldOffset

[ Top ]

method Fields [line 3864]

void Fields(

$colname)

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

Parameters:

$colname

[ Top ]

method GetArray [line 3844]

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

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

Parameters:

$nRows

[ Top ]

method InitArray [line 3813]

void InitArray(
array
$array, typearr
$typearr, [[colnames]
$colnames = false])

Setup the array.

Parameters:

array	$array	is a 2-dimensional array holding the data. The first row should hold the column names unless paramter $colnames is used.
typearr	$typearr	holds an array of types. These are the same types used in MetaTypes (C,B,L,I,N).
[colnames]	$colnames	array of column names. If set, then the first row of $array should not hold the column names.

[ Top ]

method InitArrayFields [line 3834]

void InitArrayFields(
array
&$array, fieldarr
&$fieldarr)

Setup the Array and datatype file objects

Parameters:

array	&$array	is a 2-dimensional array holding the data. The first row should hold the column names unless paramter $colnames is used.
fieldarr	&$fieldarr	holds an array of ADOFieldObject's.

[ Top ]

method MoveNext [line 3906]

void MoveNext(
)

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

[ Top ]

method _close [line 3939]

void _close(
)

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

[ Top ]

method _fetch [line 3926]

void _fetch(
)

[ Top ]

method _initrs [line 3854]

void _initrs(
)

[ Top ]

method _seek [line 3895]

void _seek(

$row)

Parameters:

$row

[ Top ]

method _transpose [line 3770]

void _transpose(
[
$addfieldnames = true])

Parameters:

$addfieldnames

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:43:04 +0200 by phpDocumentor 1.4.1