ADORecordSet_array Class Reference

Inheritance diagram for ADORecordSet_array:

Inheritance graph
[legend]
Collaboration diagram for ADORecordSet_array:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ADORecordSet_array ($fakeid=1)
 _transpose ($addfieldnames=true)
 InitArray ($array, $typearr, $colnames=false)
 InitArrayFields (&$array, &$fieldarr)
& GetArray ($nRows=-1)
 _initrs ()
 Fields ($colname)
& FetchField ($fieldOffset=-1)
 _seek ($row)
 MoveNext ()
 _fetch ()
 _close ()

Public Attributes

 $databaseType = 'array'
 $_array
 $_types
 $_colnames
 $_skiprow1
 $_fieldobjects
 $canSeek = true
 in other words, we use a text area for editing.
 $affectedrows = false
 $insertid = false
 $sql = ''
 indicates that seek is supported
 $compat = false

Detailed Description

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

Definition at line 3719 of file adodb.inc.php.

Member Function Documentation

ADORecordSet_array::ADORecordSet_array ( $  fakeid = 1  ) 

Constructor

Definition at line 3737 of file adodb.inc.php.

ADORecordSet_array::InitArray ( $  array,
$  typearr,
$  colnames = false 
)

Setup the array.

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

Definition at line 3790 of file adodb.inc.php.

ADORecordSet_array::InitArrayFields ( &$  array,
&$  fieldarr 
)

Setup the Array and datatype file objects

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

Definition at line 3811 of file adodb.inc.php.

& ADORecordSet_array::GetArray ( $  nRows = -1  ) 

return recordset as a 2-dimensional array.

Parameters:
[nRows] is the number of rows to return. -1 means every row.
Returns:
an array indexed by the rows (0-based) from the recordset

Reimplemented from ADORecordSet.

Definition at line 3821 of file adodb.inc.php.

ADORecordSet_array::Fields ( $  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.

Parameters:
colname is the field to access
Returns:
the value of $colname column

Reimplemented from ADORecordSet.

Definition at line 3841 of file adodb.inc.php.

& ADORecordSet_array::FetchField ( $  fieldoffset = -1  ) 

Get the ADOFieldObject of a specific column.

Parameters:
fieldoffset is the column position to access(0-based).
Returns:
the ADOFieldObject for that column, or false.

Reimplemented from ADORecordSet.

Definition at line 3859 of file adodb.inc.php.

ADORecordSet_array::MoveNext (  ) 

Move to next record in the recordset.

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

Reimplemented from ADORecordSet.

Definition at line 3883 of file adodb.inc.php.

Member Data Documentation

ADORecordSet_array::$canSeek = true

in other words, we use a text area for editing.

any varchar/char field this size or greater is treated as a blob

Reimplemented from ADORecordSet.

Definition at line 3728 of file adodb.inc.php.

The documentation for this class was generated from the following file:
This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!