t3lib_loadDBGroup Class Reference

Inheritance diagram for t3lib_loadDBGroup:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 start ($itemlist, $tablelist, $MMtable='', $MMuid=0)
 readList ($itemlist)
 readMM ($tableName, $uid)
 writeMM ($tableName, $uid, $prependTableName=0)
 getValueArray ($prependTableName='')
 convertPosNeg ($valueArray, $fTable, $nfTable)
 getFromDB ()
 readyForInterface ()

Public Attributes

 $fromTC = 1
 $registerNonTableValues = 0
 $tableArray = Array()
 $itemArray = Array()
 $nonTableArray = array()
 $additionalWhere = array()
 $checkIfDeleted = 1
 $dbPaths = Array()
 $firstTable = ''
 $secondTable = ''


Detailed Description

Definition at line 72 of file class.t3lib_loaddbgroup.php.


Member Function Documentation

t3lib_loadDBGroup::start ( itemlist,
tablelist,
MMtable = '',
MMuid = 0 
)

Initialization of the class.

Parameters:
string List of group/select items
string Comma list of tables, first table takes priority if no table is set for an entry in the list.
string Name of a MM table.
integer Local UID for MM lookup
Returns:
void

Definition at line 99 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::readList ( itemlist  ) 

Explodes the item list and stores the parts in the internal arrays itemArray and tableArray from MM records.

Parameters:
string Item list
Returns:
void

Definition at line 140 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::readMM ( tableName,
uid 
)

Reads the record tablename/id into the internal arrays itemArray and tableArray from MM records. You can call this function after start if you supply no list to start()

Parameters:
string MM Tablename
integer Local UID
Returns:
void

Definition at line 186 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::writeMM ( tableName,
uid,
prependTableName = 0 
)

Writes the internal itemArray to MM table:

Parameters:
string MM table name
integer Local UID
boolean If set, then table names will always be written.
Returns:
void

Definition at line 215 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::getValueArray ( prependTableName = ''  ) 

After initialization you can extract an array of the elements from the object. Use this function for that.

Parameters:
boolean If set, then table names will ALWAYS be prepended (unless its a _NO_TABLE value)
Returns:
array A numeric array.

Definition at line 251 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::convertPosNeg ( valueArray,
fTable,
nfTable 
)

Converts id numbers from negative to positive.

Parameters:
array Array of [table]_[id] pairs.
string Foreign table (the one used for positive numbers)
string NEGative foreign table
Returns:
array The array with ID integer values, converted to positive for those where the table name was set but did NOT match the positive foreign table.

Definition at line 279 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::getFromDB (  ) 

Reads all records from internal tableArray into the internal ->results array where keys are table names and for each table, records are stored with uids as their keys. If $this->fromTC is set you can save a little memory since only uid,pid and a few other fields are selected.

Returns:
void

Definition at line 301 of file class.t3lib_loaddbgroup.php.

t3lib_loadDBGroup::readyForInterface (  ) 

Prepare items from itemArray to be transferred to the TCEforms interface (as a comma list)

Returns:
string
See also:
t3lib_transferdata::renderRecord()

Definition at line 336 of file class.t3lib_loaddbgroup.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!