Solutions Open Source

Référence de la classe t3lib_loadDBGroup

Graphe d'héritage de t3lib_loadDBGroup:

Inheritance graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 start ($itemlist, $tablelist, $MMtable='', $MMuid=0, $currentTable='', $conf=array())
 readList ($itemlist)
 sortList ($sortby)
 readMM ($tableName, $uid)
 writeMM ($tableName, $uid, $prependTableName=0)
 readForeignField ($uid, $conf)
 writeForeignField ($conf, $parentUid, $updateToUid=0, $skipSorting=false)
 getValueArray ($prependTableName='')
 convertPosNeg ($valueArray, $fTable, $nfTable)
 getFromDB ()
 readyForInterface ()
 countItems ($returnAsArray=true)
 updateRefIndex ($table, $id)
 isOnSymmetricSide ($parentUid, $parentConf, $childRec)

Attributs publics

 $fromTC = 1
 $registerNonTableValues = 0
 $tableArray = Array()
 $itemArray = Array()
 $nonTableArray = array()
 $additionalWhere = array()
 $checkIfDeleted = 1
 $dbPaths = Array()
 $firstTable = ''
 $secondTable = ''
 $MM_is_foreign = 0
 $MM_oppositeField = ''
 $MM_oppositeTable = ''
 $MM_oppositeFieldConf = ''
 $MM_isMultiTableRelationship = 0
 $currentTable
 $undeleteRecord
 $MM_match_fields = array()
 $MM_insert_fields = array()
 $MM_table_where = ''


Documentation des fonctions membres

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

Initialization of the class.

Paramètres:
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
string current table name
integer TCA configuration for current field
Renvoie:
void

t3lib_loadDBGroup::readList ( itemlist  ) 

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

Paramètres:
string Item list
Renvoie:
void

t3lib_loadDBGroup::sortList ( sortby  ) 

Does a sorting on $this->itemArray depending on a default sortby field. This is only used for automatic sorting of comma separated lists. This function is only relevant for data that is stored in comma separated lists!

Paramètres:
string $sortby: The default_sortby field/command (e.g. 'price DESC')
Renvoie:
void

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

Paramètres:
string MM Tablename
integer Local UID
Renvoie:
void

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

Writes the internal itemArray to MM table:

Paramètres:
string MM table name
integer Local UID
boolean If set, then table names will always be written.
Renvoie:
void

t3lib_loadDBGroup::readForeignField ( uid,
conf 
)

Reads items from a foreign_table, that has a foreign_field (uid of the parent record) and stores the parts in the internal array itemArray and tableArray.

Paramètres:
integer $uid: The uid of the parent record (this value is also on the foreign_table in the foreign_field)
array $conf: TCA configuration for current field
Renvoie:
void

t3lib_loadDBGroup::writeForeignField ( conf,
parentUid,
updateToUid = 0,
skipSorting = false 
)

Write the sorting values to a foreign_table, that has a foreign_field (uid of the parent record)

Paramètres:
array $conf: TCA configuration for current field
integer $parentUid: The uid of the parent record
boolean 
updateForeignField
parentUid (on Copy)
boolean $skipSorting: Do not update the sorting columns, this could happen for imported values
Renvoie:
void

t3lib_loadDBGroup::getValueArray ( prependTableName = ''  ) 

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

Paramètres:
boolean If set, then table names will ALWAYS be prepended (unless its a _NO_TABLE value)
Renvoie:
array A numeric array.

t3lib_loadDBGroup::convertPosNeg ( valueArray,
fTable,
nfTable 
)

Converts id numbers from negative to positive.

Paramètres:
array Array of [table]_[id] pairs.
string Foreign table (the one used for positive numbers)
string NEGative foreign table
Renvoie:
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.

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.

Renvoie:
void

t3lib_loadDBGroup::readyForInterface (  ) 

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

Renvoie:
string
Voir également:
t3lib_transferdata::renderRecord()

t3lib_loadDBGroup::countItems ( returnAsArray = true  ) 

Counts the items in $this->itemArray and puts this value in an array by default.

Paramètres:
boolean Whether to put the count value in an array
Renvoie:
mixed The plain count as integer or the same inside an array

t3lib_loadDBGroup::updateRefIndex ( table,
id 
)

Update Reference Index (sys_refindex) for a record Should be called any almost any update to a record which could affect references inside the record. (copied from TCEmain)

Paramètres:
string Table name
integer Record UID
Renvoie:
void

t3lib_loadDBGroup::isOnSymmetricSide ( parentUid,
parentConf,
childRec 
)

Checks, if we're looking from the "other" side, the symmetric side, to a symmetric relation.

Paramètres:
string $parentUid: The uid of the parent record
array $parentConf: The TCA configuration of the parent field embedding the child records
array $childRec: The record row of the child record
Renvoie:
boolean Returns true if looking from the symmetric ("other") side to the relation.


Documentation des données membres

t3lib_loadDBGroup::$fromTC = 1

Réimplémentée dans FE_loadDBGroup.

t3lib_loadDBGroup::$registerNonTableValues = 0

t3lib_loadDBGroup::$tableArray = Array()

t3lib_loadDBGroup::$itemArray = Array()

t3lib_loadDBGroup::$nonTableArray = array()

t3lib_loadDBGroup::$additionalWhere = array()

t3lib_loadDBGroup::$checkIfDeleted = 1

t3lib_loadDBGroup::$dbPaths = Array()

t3lib_loadDBGroup::$firstTable = ''

t3lib_loadDBGroup::$secondTable = ''

t3lib_loadDBGroup::$MM_is_foreign = 0

t3lib_loadDBGroup::$MM_oppositeField = ''

t3lib_loadDBGroup::$MM_oppositeTable = ''

t3lib_loadDBGroup::$MM_oppositeFieldConf = ''

t3lib_loadDBGroup::$MM_isMultiTableRelationship = 0

t3lib_loadDBGroup::$currentTable

t3lib_loadDBGroup::$undeleteRecord

t3lib_loadDBGroup::$MM_match_fields = array()

t3lib_loadDBGroup::$MM_insert_fields = array()

t3lib_loadDBGroup::$MM_table_where = ''


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:19 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3