t3lib_loadDBGroup Class Reference

Inheritance diagram for t3lib_loadDBGroup:


Public Member Functions
	start ($itemlist, $tablelist, $MMtable='', $MMuid=0, $currentTable='', $conf=array())
	readList ($itemlist)
	sortList ($sortby)
	readMM ($tableName, $uid)
	writeMM ($MM_tableName, $uid, $prependTableName=0)
	remapMM ($MM_tableName, $uid, $newUid, $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)
Public Attributes
	$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 = ''

Detailed Description

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

Member Function Documentation

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 712 of file class.t3lib_loaddbgroup.php.

References $key, $val, and t3lib_div::testInt().

t3lib_loadDBGroup::countItems ( $ returnAsArray = true )

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

Parameters:

boolean

Whether to put the count value in an array

Returns:: mixed The plain count as integer or the same inside an array

Definition at line 795 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 734 of file class.t3lib_loaddbgroup.php.

References $GLOBALS, $key, $res, $row, and $val.

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 684 of file class.t3lib_loaddbgroup.php.

References $val.

t3lib_loadDBGroup::isOnSymmetricSide	(	$	parentUid,
		$	parentConf,
		$	childRec
	)

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

Parameters:

	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

Returns:: boolean Returns true if looking from the symmetric ("other") side to the relation.

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

References t3lib_div::testInt().

Referenced by t3lib_TCEforms_inline::renderForeignRecordHeader(), t3lib_TCEforms_inline::renderForeignRecordHeaderControl(), t3lib_TCEforms_inline::skipField(), and writeForeignField().

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.

Parameters:

	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

Returns:: void

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

References $GLOBALS, $key, $row, and t3lib_BEfunc::deleteClause().

Referenced by start().

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 199 of file class.t3lib_loaddbgroup.php.

References $key, $val, t3lib_div::testInt(), and t3lib_div::trimExplode().

Referenced by start().

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 277 of file class.t3lib_loaddbgroup.php.

References $additionalWhere, $GLOBALS, $key, $res, $row, and $value.

Referenced by start().

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 769 of file class.t3lib_loaddbgroup.php.

References $GLOBALS, $key, $TCA, $val, t3lib_div::fixed_lgd_cs(), and t3lib_BEfunc::getRecordTitle().

t3lib_loadDBGroup::remapMM	(	$	MM_tableName,
		$	uid,
		$	newUid,
		$	prependTableName = `0`
	)

Remaps MM table elements from one local uid to another Does NOT update the reference index for you, must be called subsequently to do that!

Parameters:

	string	MM table name
	integer	Local, current UID
	integer	Local, new UID
	boolean	If set, then table names will always be written.

Returns:: void

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

References $additionalWhere, $GLOBALS, and $value.

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!

Parameters:

string

$sortby: The default_sortby field/command (e.g. 'price DESC')

Returns:: void

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

References $GLOBALS, $res, and $row.

Referenced by start().

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

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
	string	current table name
	integer	TCA configuration for current field

Returns:: void

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

References $currentTable, $GLOBALS, $key, $val, t3lib_div::loadTCA(), readForeignField(), readList(), readMM(), sortList(), and t3lib_div::trimExplode().

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)

Parameters:

	string	Table name
	integer	Record UID

Returns:: void

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

References $refIndexObj, and t3lib_div::makeInstance().

Referenced by writeForeignField(), and writeMM().

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)

Parameters:

	array	$conf: TCA configuration for current field
	integer	$parentUid: The uid of the parent record
	boolean	updateToUid Whether to update the foreign field with the parentUid (on Copy)
	boolean	$skipSorting: Do not update the sorting columns, this could happen for imported values