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 ()
 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 3709 of file adodb.inc.php.


Member Function Documentation

ADORecordSet_array.ADORecordSet_array ( fakeid = 1  ) 

Constructor

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

References ADORecordSet.ADORecordSet().

Referenced by ADORecordSet_array_sybase.ADORecordSet_array_sybase().

Here is the call graph for this function:

ADORecordSet_array._transpose (  ) 

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

References $ADODB_INCLUDED_LIB, _initrs(), adodb_probetypes(), and adodb_transpose().

Here is the call graph for this function:

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 3780 of file adodb.inc.php.

References $array, $typearr, and ADORecordSet.Init().

Here is the call graph for this function:

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 3801 of file adodb.inc.php.

References $array, and ADORecordSet.Init().

Here is the call graph for this function:

& 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 3811 of file adodb.inc.php.

References $arr, and ADORecordSet.GetArray().

Here is the call graph for this function:

ADORecordSet_array._initrs (  ) 

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

Referenced by _transpose().

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 3831 of file adodb.inc.php.

References FetchField().

Here is the call graph for this function:

& 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 3849 of file adodb.inc.php.

Referenced by Fields().

ADORecordSet_array._seek ( row  ) 

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

References $row.

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 3873 of file adodb.inc.php.

ADORecordSet_array._fetch (  ) 

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

ADORecordSet_array._close (  ) 

Reimplemented from ADORecordSet.

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


Member Data Documentation

ADORecordSet_array.$databaseType = 'array'

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

ADORecordSet_array.$_array

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

ADORecordSet_array.$_types

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

ADORecordSet_array.$_colnames

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

ADORecordSet_array.$_skiprow1

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

ADORecordSet_array.$_fieldobjects

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

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 3718 of file adodb.inc.php.

ADORecordSet_array.$affectedrows = false

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

ADORecordSet_array.$insertid = false

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

ADORecordSet_array.$sql = ''

indicates that seek is supported

Reimplemented from ADORecordSet.

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

ADORecordSet_array.$compat = false

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


The documentation for this class was generated from the following file:
This documentation is part of typo3-unleashed.net.
It's an automatically created code documentation of the TYPO3 Content Management System.
Created with doxygen