Class: ADORecordSet_array

Source Location: /lodel/scripts/adodb/adodb.inc.php

Class ADORecordSet_array

Class Overview

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

Located in /lodel/scripts/adodb/adodb.inc.php [line 3719]

ADODB_BASE_RS
   |
   --ADORecordSet
      |
      --ADORecordSet_array

Properties

Methods

[ Top ]

Descendants

Child Class	Description
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_sybase	This class encapsulates the concept of a recordset created in memory as an array. This is useful for the creation of cached recordsets.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From 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 From 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()

[ Top ]

Property Summary

mixed	$affectedrows
mixed	$canSeek
mixed	$compat
mixed	$databaseType
mixed	$insertid
mixed	$sql
mixed	$_array
mixed	$_colnames
mixed	$_fieldobjects
mixed	$_skiprow1
mixed	$_types

[ Top ]

Method Summary

ADORecordSet_array	ADORecordSet_array()	Constructor
void	&FetchField()
void	Fields()
void	&GetArray()
void	InitArray()	Setup the array.
void	InitArrayFields()	Setup the Array and datatype file objects
void	MoveNext()
void	_close()
void	_fetch()
void	_initrs()
void	_seek()
void	_transpose()

[ Top ]

Properties

mixed $affectedrows = false [line 3729]

[ Top ]

mixed $canSeek = true [line 3728]

Redefinition of:

ADORecordSet::$canSeek

[ Top ]

mixed $compat = false [line 3732]

[ Top ]

mixed $databaseType = 'array' [line 3721]

[ Top ]

mixed $insertid = false [line 3730]

[ Top ]

mixed $sql = '' [line 3731]

Redefinition of:

ADORecordSet::$sql

[ Top ]

mixed $_array [line 3723]

[ Top ]

mixed $_colnames [line 3725]

[ Top ]

mixed $_fieldobjects [line 3727]

[ Top ]

mixed $_skiprow1 [line 3726]

[ Top ]

mixed $_types [line 3724]

[ Top ]

Methods

Constructor ADORecordSet_array [line 3737]

ADORecordSet_array ADORecordSet_array(
[
$fakeid = 1] 
)

Constructor

Parameters:

$fakeid:

[ Top ]

FetchField [line 3859]

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

Parameters:

$fieldOffset:

Redefinition of:

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

[ Top ]

Fields [line 3841]

void Fields(

$colname 
)

Parameters:

$colname:

Redefinition of:

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

[ Top ]

GetArray [line 3821]

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

Parameters:

$nRows:

Redefinition of:

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

[ Top ]

InitArray [line 3790]

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 ]

InitArrayFields [line 3811]

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 ]

MoveNext [line 3883]

void MoveNext(
)

Redefinition of:

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

[ Top ]

_close [line 3916]

void _close(
)

Redefinition of:

ADORecordSet::_close()

[ Top ]

_fetch [line 3903]

void _fetch(
)

[ Top ]

_initrs [line 3831]

void _initrs(
)

[ Top ]

_seek [line 3872]

void _seek(

$row 
)

Parameters:

$row:

[ Top ]

_transpose [line 3747]

void _transpose(
[
$addfieldnames = true] 
)

Parameters:

$addfieldnames:

[ Top ]

Documentation generated on Thu, 24 Jul 2008 05:07:10 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]