RelationHandler

Load database groups (relations) Used to process the relations created by the TCA element types "group" and "select" for database records.

Table of Contents

Properties

$additionalWhere  : array<string|int, mixed>

$checkIfDeleted  : bool

Deleted-column is added to additionalWhere... if this is set.

$itemArray  : array<int, array<string, mixed>>

Contains items in a numeric array (table/id for each). Tablenames here might be "_NO_TABLE". Keeps the sorting of thee retrieved items.

$nonTableArray  : array<string|int, mixed>

Array for NON-table elements

$registerNonTableValues  : bool

If set, values that are not ids in tables are normally discarded. By this options they will be preserved.

$results  : array<string|int, mixed>

This array will be filled by getFromDB().

$tableArray  : array<string|int, mixed>

Contains the table names as keys. The values are the id-values for each table.

$undeleteRecord  : bool

If a record should be undeleted (so do not use the $useDeleteClause on \TYPO3\CMS\Backend\Utility\BackendUtility)

$currentTable  : string

Current table => Only needed for reverse relations

$fetchAllFields  : bool

$fetchAllFields if false getFromDB() fetches only uid, pid, thumbnail and label fields (as defined in TCA)

$firstTable  : string

Will contain the first table name in the $tablelist (for positive ids)

$MM_hasUidField  : bool

This is set to TRUE if the MM table has a UID field.

$MM_insert_fields  : array<string|int, mixed>

Array of fields and value pairs used for insert in MM table

$MM_is_foreign  : bool

If TRUE, uid_local and uid_foreign are switched, and the current table is inserted as tablename - this means you display a foreign relation "from the opposite side"

$MM_isMultiTableRelationship  : string

Is empty by default; if MM_is_foreign is set and there is more than one table allowed (on the "local" side), then it contains the first table (as a fallback)

$MM_match_fields  : array<string|int, mixed>

Array of fields value pairs that should match while SELECT and will be written into MM table if $MM_insert_fields is not set

$MM_oppositeUsage  : array<string|int, mixed>

Usage of an MM field on the opposite relation.

$MM_table_where  : string

Extra MM table where

$purged  : bool

$referenceIndexUpdater  : ReferenceIndexUpdater|null

$updateReferenceIndex  : bool

If false, reference index is not updated.

$useLiveParentIds  : bool

$useLiveReferenceIds  : bool

$workspaceId  : int|null

Methods

convertItemArray()  : bool

Converts elements in the local item array to use version ids instead of live ids, if possible. The most common use case is, to call that prior to processing with MM relations in a workspace context. For tha special case, ids on both side of the MM relation must use version ids if available.

countItems()  : mixed

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

getFromDB()  : array<string|int, mixed>

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.

getResolvedItemArray()  : array<string|int, mixed>

This method is typically called after getFromDB().

getValueArray()  : array<string|int, mixed>

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

isPurged()  : bool

Whether item array has been purged in this instance.

processDeletePlaceholder()  : bool

Removes items having a delete placeholder from $this->itemArray

purgeItemArray()  : bool

remapMM()  : mixed

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!

setFetchAllFields()  : mixed

Sets $fetchAllFields

setReferenceIndexUpdater()  : void

Setter to carry the 'deferred' reference index updater registry around.

setUpdateReferenceIndex()  : mixed

Sets whether the reference index shall be updated.

setUseLiveParentIds()  : mixed

setUseLiveReferenceIds()  : mixed

setWorkspaceId()  : void

Sets the current workspace id.

start()  : mixed

Initialization of the class.

writeForeignField()  : mixed

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

writeMM()  : mixed

Writes the internal itemArray to MM table:

completeOppositeUsageValues()  : array<string|int, mixed>

Completes MM values to be written by values from the opposite relation.

getConnectionForTableName()  : Connection

getLiveDefaultId()  : int

Gets the record uid of the live default record. If already pointing to the live record, the submitted record uid is returned.

getResolver()  : PlainDataResolver

getWorkspaceId()  : int

Gets the current workspace id.

isOnSymmetricSide()  : bool

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

purgeDeletePlaceholder()  : array<string|int, mixed>

Purges ids that have a delete placeholder

purgeItemArrayHandler()  : bool

Handles a purge callback on $this->itemArray

purgeLiveVersionedIds()  : array<string|int, mixed>

Purges ids that are live but have an accordant version.

purgeVersionedIds()  : array<string|int, mixed>

Purges ids that are versioned.

readForeignField()  : mixed

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.

readList()  : mixed

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

readMM()  : mixed

Reads the record tablename/id into the internal arrays itemArray and tableArray from MM records.

removeFromItemArray()  : mixed

sanitizeIds()  : array<string|int, mixed>

Removes empty values (null, '0', 0, false).

sortList()  : mixed

Does a sorting on $this->itemArray depending on a default sortby field.

updateRefIndex()  : array<string|int, mixed>

Update Reference Index (sys_refindex) for a record.