TYPO3 main API: DataHandler

DataHandler uses LogDataTrait

The main data handler class which takes care of correctly updating and inserting records.

This class was formerly known as TCEmain.

This is the TYPO3 Core Engine class for manipulation of the database This class is used by eg. the tce_db BE route (SimpleDataHandlerController) which provides an interface for POST forms to this class.

Dependencies:

$GLOBALS['TCA'] must exist
$GLOBALS['LANG'] must exist

Also see document 'TYPO3 Core API' for details.

#[Autoconfigure]: $public: true; $shared: false

Constants

CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED = 'core-datahandler-elementsToBeDeleted'
CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX = 'core-datahandler-nestedElementCalls-': Prefix for the cache entries of nested element calls since the runtimeCache has a global scope.

Properties

$admin : bool: Will be set if user is admin
$autoVersionIdMap : array<string, array<int, string>>: Contains mapping of auto-versioned records.
$BE_USER : BackendUserAuthentication: The user-object the script uses. If not set from outside, this is set to the current global $BE_USER.
$bypassAccessCheckForRecords : bool: If TRUE, access check, check for deleted etc. for records is bypassed.
$bypassWorkspaceRestrictions : bool: If TRUE, workspace restrictions are bypassed on edit and create actions (process_datamap()).
$callBackObj : object|null: Object. Call back object for FlexForm traversal. Useful when external classes wants to use the iteration functions inside DataHandler for traversing a FlexForm structure.
$checkValue_currentRecord : array<string|int, mixed>: Set to "currentRecord" during checking of values.
$cmdmap : array<string, array<int|string, array<string|int, mixed>>>: Incoming command array. The array shape is checked in start() before setting this property.
$copyMappingArray : array<string, array<string|int, mixed>>: Used by the copy action to track the ids of new pages so subpages are correctly inserted! THIS is internally cleared for each executed copy operation! DO NOT USE THIS FROM OUTSIDE! Read from copyMappingArray_merged instead which is accumulating this information.
$copyMappingArray_merged : array<string|int, mixed>: This array is the sum of all copying operations in this class.
$copyTree : int: If 0 then branch is NOT copied.
$copyWhichTables : string: Comma-separated list. This list of tables decides which tables will be copied. If empty then none will.
$datamap : array<string, array<int|string, array<string|int, mixed>>>: Set with incoming data array. The array shape is checked in start() before setting this property.
$dbAnalysisStore : array<string|int, mixed>: For accumulation of MM relations that must be written after new records are created.
$defaultValues : array<string|int, mixed>: [table][fields]=value: New records are created with default values and you can set this array on the form $defaultValues[$table][$field] = $value to override the default values fetched from TCA.
$dontProcessTransformations : bool: If set, then transformations are NOT performed on the input.
$enableLogging : bool: If TRUE, actions are logged to sys_log.
$errorLog : array<string|int, mixed>: Errors are collected in this variable.
$isImporting : bool: If set, then the TCE class has been instantiated during an import action of a T3D
$neverHideAtCopy : bool: If set, then the 'hideAtCopy' flag for tables will be ignored.
$newRelatedIDs : array<string|int, mixed>: Holds the tables and there the ids of newly created child records from IRRE
$pagetreeNeedsRefresh : bool: Indicates whether the pagetree needs a refresh because of important changes
$pagetreeRefreshFieldsFromPages : array<string|int, mixed>: Fields from the pages-table for which changes will trigger a pagetree refresh
$registerDBList : array<string, array<int, array<string|int, mixed>>>: Used for tracking references that might need correction after operations
$registerDBPids : array<string|int, mixed>: Used for tracking references that might need correction in pid field after operations (e.g. IRRE)
$remapStack : array<string|int, mixed>: Array used for remapping uids and values at the end of process_datamap
$remapStackRecords : array<string|int, mixed>: Array used for remapping uids and values at the end of process_datamap (e.g. $remapStackRecords[<table>][<uid>] = <index in $remapStack>)
$reverseOrder : bool: If TRUE, the datamap array is reversed in the order, which is a nice thing if you're creating a whole new bunch of records.
$sortIntervals : int: The interval between sorting numbers used with tables with a 'sorting' field defined.
$storeLogMessages : bool: If TRUE, the default log-messages will be stored. This should not be necessary if the locallang-file for the log-display is properly configured. So disabling this will just save some database-space as the default messages are not saved.
$substNEWwithIDs : array<string|int, mixed>: When new elements are created, this array contains a map between their "NEW..." string IDs and the final uid they got when stored in database. This public array is rather important since it is used by many DH consumers to further work with records after creation.
$substNEWwithIDs_table : array<string|int, mixed>: Like $substNEWwithIDs, but where each old "NEW..." id is mapped to the table it was from.
$suggestedInsertUids : array<string|int, mixed>: Use this array to validate suggested uids for tables by setting [table]:[uid]. This is a dangerous option since it will force the inserted record to have a certain UID. The value just have to be TRUE, but if you set it to "DELETE" it will make sure any record with that UID will be deleted first (raw delete).
$userid : int: Will be set to uid of be_user executing this script
$checkModifyAccessListHookObjects : array<string|int, mixed>|null
$control : array<string|int, mixed>: Data submitted from the form view, used to control behaviours, e.g. this is used to activate/deactivate fields and thus store NULL values
$correlationId : CorrelationId|null: A string which can be used as correlationId for RecordHistory entries.
$deletedRecords : array<string|int, mixed>: Per-table array with UIDs that have been deleted.
$disableDeleteClause : bool: Disable delete clause
$excludedTablesAndFields : array<string|int, mixed>: The list of <table>-<fields> that cannot be edited by user. This is compiled from TCA/exclude-flag combined with non_exclude_fields for the user.
$historyRecords : array<string|int, mixed>: List of changed old record ids to new records ids
$isInWebMount_Cache : array<string|int, mixed>: Caching array for page ids in webmounts
$isRecordInWebMount_Cache : array<string|int, mixed>: Caching array for check of whether records are in a webmount
$mmHistoryRecords : array<string|int, mixed>: List of changed old record ids to new records ids
$outerMostInstance : self|null: The outermost instance of \TYPO3\CMS\Core\DataHandling\DataHandler: This object instantiates itself on versioning and localization .
$pageCache : array<int, array<string, int|string|null>>: Used for caching page records in pageInfo()
$recInsertAccessCache : array<string|int, mixed>: User by function checkRecordInsertAccess() to store whether a record can be inserted on a page id
$recordPidsForDeletedRecords : array<string|int, mixed>: Internal cache for pids of records which were deleted. It's not possible to retrieve the parent folder/page at a later stage
$recordsToClearCacheFor : array<string|int, mixed>: Internal cache for collecting records that should trigger cache clearing
$referenceIndexUpdater : ReferenceIndexUpdater: Registry object to gather reference index update requests and perform updates after main processing has been done. It is created upon first start() call and hand over when dealing with internal sub instances. The final update() call is done at the end of process_cmdmap() or process_datamap() in the outermost instance.
$remapStackActions : array<string|int, mixed>: Array used for executing addition actions after remapping happened (set processRemapStack())
$useTransOrigPointerField : bool: Will distinguish between translations (with parent) and localizations (without parent) while still using the same methods to copy the records TRUE: translation of a record connected to the default language FALSE: localization of a record without connection to the default language

Methods

__construct() : mixed
addRemapAction() : void: Adds an instruction to the remap action stack (used with IRRE).
canDeletePage() : array<string|int, int>|string: Used to evaluate if a page can be deleted
cannotDeleteRecord() : string: Returns TRUE if record CANNOT be deleted, otherwise FALSE. Used to check before the versioning API allows a record to be marked for deletion.
checkModifyAccessList() : bool: Checking group modify_table access list
checkRecordInsertAccess() : bool: Checks if user may insert a record from $insertTable on $pid
checkRecordUpdateAccess() : bool: Checks if user may update a record with uid=$id from $table
checkValue() : array<string|int, mixed>: Evaluates a value according to $table/$field settings.
checkValue_category_processDBdata() : array<string|int, mixed>: Returns processed data for category fields
checkValue_checkMax() : array<string|int, mixed>: Checks if a fields has more items than defined via TCA in maxitems.
checkValue_flex_procInData() : array<string|int, mixed>: Starts the processing the input data for flexforms. This will traverse all sheets / languages and for each it will traverse the sub-structure.
checkValue_flex_procInData_travDS() : void: Processing of the sheet/language data array When it finds a field with a value the processing is done by ->checkValue_SW() by default but if a call back function name is given that method in this class will be called for the processing instead.
checkValue_group_select_explodeSelectGroupValue() : array<string|int, mixed>: Explodes the $value, which is a list of files/uids (group select)
checkValue_group_select_processDBdata() : array<string|int, mixed>: Returns data for group/db and select fields
checkValue_inline() : mixed: Evaluates 'inline' type values.
checkValue_input_Eval() : array<string|int, mixed>: Evaluation of 'input'-type values based on 'eval' list
checkValue_SW() : array<string|int, mixed>: Branches out evaluation of a field value based on its type as configured in $GLOBALS['TCA'] Can be called for FlexForm pseudo fields as well, BUT must not have $field set if so.
checkValue_text_Eval() : array<string|int, mixed>
checkValueForFile() : array<string|int, mixed>: Evaluates 'file' type values.
checkValueForInline() : array<string|int, mixed>|false: Evaluates 'inline' type values.
clear_cacheCmd() : void: Clears the cache based on the command $cacheCmd.
clearPrefixFromValue() : string: Removes the prependAtCopy prefix on values
compareFieldArrayWithCurrentAndUnset() : array<string|int, mixed>: Compares the incoming field array with the current record and unsets all fields which are the same.
copyPages() : void: Copying pages Main function for copying pages.
copyRecord() : int|null: Copying a single record
copyRecord_flexFormCallBack() : array<string|int, mixed>: Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.
copyRecord_procBasedOnFieldType() : array<string|int, mixed>|string|null: Processing/Preparing content for copyRecord() function
copyRecord_raw() : int|null: Copying records, but makes a "raw" copy of a record.
copySpecificPage() : int|null: Copying a single page ($uid) to $destPid and all tables in the array copyTablesArray.
dbAnalysisStoreExec() : void: Executing dbAnalysisStore This will save MM relations for new records but is executed after records are created because we need to know the ID of them
deleteAction() : void: Delete a single record
deleteClause() : string: Returns delete-clause for the $table
deleteEl() : void: Delete element from any table
deleteL10nOverlayRecords() : void: Find l10n-overlay records and perform the requested delete action for these records.
deletePages() : void: Used to delete page because it will check for branch below pages and disallowed tables on the page as well.
deleteRecord() : void: Deleting a record This function may not be used to delete pages-records unless the underlying records are already deleted Deletes a record regardless of versioning state (live or offline, doesn't matter, the uid decides) If both $noRecordCheck and $forceHardDelete are set it could even delete a "deleted"-flagged record!
deleteRecord_procBasedOnFieldType() : void: Process fields of a record to be deleted and search for special handling, like inline type, MM records, etc.
deleteRecord_procFields() : void: Before a record is deleted, check if it has references such as inline type or MM references.
destNotInsideSelf() : bool: Checks if page $id is a uid in the rootline of page id $destinationId Used when moving a page
disableDeleteClause() : void: Disables the delete clause for fetching records.
discard() : void: Discard a versioned record from this workspace. This deletes records from the database - no soft delete.
doesPageHaveUnallowedTables() : array<string|int, mixed>: Checks if there are records on a page from tables that are not allowed
doesRecordExist() : bool: Checks if record can be selected based on given permission criteria
eventPid() : int
fillInFieldArray() : array<string|int, mixed>: Filling in the field array $this->excludedTablesAndFields is used to filter fields if needed.
fixUniqueInPid() : void: Checks if any uniqueInPid eval input fields are in the record and if so, they are re-written to be correct.
getAutoVersionId() : int|null: Gets the automatically versionized id of a record.
getCopyHeader() : string: Get modified header for a copied record
getCorrelationId() : CorrelationId|null
getExcludeListArray() : array<string|int, mixed>: Generate an array of fields to be excluded from editing for the user. Based on "exclude"-field in TCA and a look up in non_exclude_fields Will also generate this list for admin-users so they must be check for before calling the function
getHistoryRecords() : array<string|int, mixed>
getPID() : int|false: Returns the pid of a record from $table with $uid
getRecordProperties() : array<string|int, mixed>: Returns an array with record properties, like header and pid No check for deleted or access is done! For versionized records, pid is resolved to its live versions pid.
getRecordPropertiesFromRow() : array<string|int, mixed>|null: Returns an array with record properties, like header and pid, based on the row
getRecordsWithSameValue() : array<string|int, mixed>: gets all records that have the same value in a field excluding the given uid
getRelationFieldType() : string|bool: Returns the subtype as a string of a relation (inline / file) field.
getSortNumber() : int|array<string|int, mixed>|bool|null: Returning sorting number for tables with a "sortby" column Using when new records are created and existing records are moved around.
getTableEntries() : array<string|int, mixed>: Extract entries from TSconfig for a specific table. This will merge specific and default configuration together.
getUnique() : string: Gets a unique value for $table/$id/$field based on $value
getVersionizedIncomingFieldArray() : void: If a parent record was versionized on a workspace in $this->process_datamap, it might be possible, that child records (e.g. on using IRRE) were affected.
hasDeletedRecord() : bool: Determines whether a particular record has been deleted using DataHandler::deleteRecord() in this instance.
hook_processDatamap_afterDatabaseOperations() : void: Hook: processDatamap_afterDatabaseOperations (calls $hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);)
insertDB() : int|null: Insert into database Does not check permissions but expects them to be verified on beforehand
insertNewCopyVersion() : int|null: Inserts a record in the database, passing TCA configuration values through checkValue() but otherwise does NOTHING and checks nothing regarding permissions.
insertUpdateDB_preprocessBasedOnFieldType() : array<string|int, mixed>: Preprocesses field array based on field type. Some fields must be adjusted before going to database. This is done on the copy of the field array because original values are used in remap action later.
int_pageTreeInfo() : array<string|int, mixed>: Returns array, $CPtable, of pages under the $pid going down to $counter levels.
isInWebMount() : bool: Checks if the input page ID is in the BE_USER webmounts
isOuterMostInstance() : bool: Determines whether this object is the outermost instance of itself Since DataHandler can create nested objects of itself, this method helps to determine the first (= outermost) one.
isRecordCopied() : bool: Determine if a record was copied or if a record is the result of a copy action.
isRecordInWebMount() : bool: Checking if a record with uid $id from $table is in the BE_USERS webmounts which is required for editing etc.
isReferenceField() : bool: Returns TRUE if the TCA/columns field type is a DB reference field
localize() : int|bool: Localizes a record to another system language
log() : int: Logging actions from DataHandler
moveL10nOverlayRecords() : void: Find l10n-overlay records and perform the requested move action for these records.
moveRecord() : void: Moving single records
moveRecord_procBasedOnFieldType() : void: Move child records depending on the field type of the parent record.
moveRecord_procFields() : void: Walk through all fields of the moved record and look for children of e.g. the inline type.
moveRecord_raw() : void: Moves a record without checking security of any sort.
newFieldArray() : array<string|int, mixed>: Returns a fieldArray with default values. Values will be picked up from the TCA array looking at the config key "default" for each column. If values are set in ->defaultValues they will overrule though.
printLogErrorMessages() : array<string|int, non-empty-string>: Print log error messages from the operations of this script instance and return a list of the erroneous records
process_cmdmap() : void|bool: Processing the cmd-array See "TYPO3 Core API" for a description of the options.
process_datamap() : bool|void: Processing the data-array Call this function to process the data-array set by start()
processRemapStack() : void: Processes the $this->remapStack at the end of copying, inserting, etc. actions.
recordInfo() : array<string|int, mixed>|null: Returns the row of a record given by $table and $id NOTICE: No check for deleted or access!
registerRecordIdForPageCacheClearing() : void: Clearing the cache based on a page being updated If the $table is 'pages' then cache is cleared for all pages on the same level (and subsequent?) Else just clear the cache for the parent page of the record.
registerReferenceIndexRowsForDrop() : void: Delete rows from sys_refindex a table / uid combination is involved in: Either on left side (tablename + recuid) OR right side (ref_table + ref_uid).
registerReferenceIndexUpdateForReferencesToItem() : void: Helper method to access referenceIndexUpdater->registerUpdateForReferencesToItem() from within workspace DataHandlerHook.
remapListedDBRecords() : void: Processes the fields with references as registered during the copy process. This includes all FlexForm fields which had references.
remapListedDBRecords_flexFormCallBack() : array<string|int, mixed>: Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.
remapListedDBRecords_procDBRefs() : array<string|int, mixed>|null: Performs remapping of old UID values to NEW uid values for a DB reference field.
remapListedDBRecords_procFile() : void: Performs remapping of old UID values to NEW uid values for an file field.
remapListedDBRecords_procInline() : void: Performs remapping of old UID values to NEW uid values for an inline field.
resolvePid() : int: Get the final pid based on $table and $pid ($destPid type... pos/neg)
setControl() : void
setCorrelationId() : void
setDefaultsFromUserTS() : void: Initializes default values coming from user TSconfig
setHistory() : void: Setting sys_history record, based on content previously set in $this->historyRecords[$table . ':' . $id] (by compareFieldArrayWithCurrentAndUnset())
setMirror() : void: Function that can mirror input values in datamap-array to other uid numbers.
start() : void: Initializing.
updateDB() : void: Update database record Does not check permissions but expects them to be verified on beforehand
updateRefIndex() : void: Register a table/uid combination in current user workspace for reference updating.
versionizeRecord() : int|null: Creates a new version of a record (Requires support in the table)
versionPublishManyToManyRelations() : void: Handle MM relations attached to a record when publishing a workspace record.
workspaceCannotEditOfflineVersion() : string: Evaluates if a user is allowed to edit the offline version
workspaceCannotEditRecord() : string|false: Checking if editing of an existing record is allowed in current workspace if that is offline.
addDefaultPermittedLanguageIfNotSet() : array<string|int, mixed>: If a "languageField" is specified for $table this function will add a possible value to the incoming array if none is found in there already.
addDeleteRestriction() : void: Add delete restriction if not disabled
applyDefaultsForFieldArray() : array<string|int, mixed>: When a new record is created, all values that haven't been set but are set via PageTSconfig / UserTSconfig get applied here.
applyFiltersToValues() : array<string|int, mixed>|mixed: Applies the filter methods from a column's TCA configuration to a value array.
castReferenceValue() : int|string: Casts a reference value. In case MM relations or foreign_field references are used. All other configurations, as well as foreign_table(!) could be stored as comma-separated-values as well. Since the system is not able to determine the default value automatically then, the TCA default value is used if it has been defined.
checkForRecordsFromDisallowedTables() : array<string|int, string>|null: Check if there are records from tables on the pages to be deleted which the current user is not allowed to
checkValue_file_processDBdata() : mixed: Returns data for file fields.
checkValue_inline_processDBdata() : string: Returns data for inline fields.
checkValueForCategory() : array<string|int, mixed>: Evaluate 'category' type values
checkValueForCheck() : array<string|int, mixed>: Evaluates 'check' type values.
checkValueForColor() : array<string|int, mixed>: Evaluate "color" type values.
checkValueForDatetime() : array<string|int, mixed>: Evaluate 'datetime' type values
checkValueForEmail() : array<string|int, mixed>: Evaluate "email" type values.
checkValueForFlex() : array<string|int, mixed>: Evaluates 'flex' type values.
checkValueForGroupFolderSelect() : array<string|int, mixed>: Evaluates 'group', 'folder' or 'select' type values.
checkValueForInput() : array<string|int, mixed>: Evaluate "input" type values.
checkValueForInternalReferences() : array<string|int, mixed>: Checks values that are used for internal references. If the provided $value is a NEW-identifier, the direct processing is stopped. Instead, the value is forwarded to the remap-stack to be post-processed and resolved into a proper UID after all data has been resolved.
checkValueForJson() : array<string|int, mixed>: Evaluate "json" type values.
checkValueForLanguage() : array<string|int, mixed>: Evaluate "language" type value.
checkValueForLink() : array<string|int, mixed>: Evaluate "link" type values.
checkValueForNumber() : array<string|int, mixed>: Evaluate 'number' type values
checkValueForPassword() : array<string|int, mixed>: Evaluate "password" type values.
checkValueForRadio() : array<string|int, mixed>: Evaluates 'radio' type values.
checkValueForSlug() : array<string|int, mixed>: Evaluate "slug" type values.
checkValueForText() : array<string|int, mixed>: Evaluate "text" type values.
checkValueForUuid() : array<string|int, mixed>: Evaluate "uuid" type values. Will create a new uuid in case an invalid uuid is provided and the field is marked as required.
controlActiveElements() : void: Controls active elements and sets NULL values if not active.
copy_remapTranslationSourceField() : void: Remap languageSource field to uids of newly created records
copyL10nOverlayRecords() : void: Find l10n-overlay records and perform the requested copy action for these records.
copyRecord_processManyToMany() : string: Processes the children of an MM relation field (select, group, inline) when the parent record is copied.
copyRecord_processRelation() : string: Processes relations in an inline (IRRE) or file element when the parent record is copied.
createRelationHandlerInstance() : RelationHandler
deleteSpecificPage() : void: Delete a page (or set deleted field to 1) and all records on it.
discardCsvReferencesToRecord() : void: When the to-discard record is the target of a CSV group field of another table record, these records need to be updated to no longer point to the discarded record.
discardLocalizationOverlayRecords() : void: Find localization overlays of a record and discard them.
discardLocalizedWorkspaceVersionsOfRecord() : void: When deleting a live element with sys_language_uid = 0, there may be translated records that have been created in workspaces only (t3ver_state=1). Those have to be discarded explicitly since the other 'delete' related code does not consider this case, otherwise the 'new' workspace translation would be dangling when the live record is gone.
discardMmRelations() : void: When a workspace record row is discarded that has mm relations, existing mm table rows need to be deleted. The method performs the delete operation depending on TCA field configuration.
discardRecordRelations() : void: Discard record relations like inline and MM of a record.
discardSubPagesAndRecordsOnPage() : void: Also discard any sub pages and records of a new parent page if this page is discarded.
discardWorkspaceVersionsOfRecord() : void: Discard workspace overlays of a live record: When a live row is deleted, all existing workspace overlays are discarded.
doesBranchExist() : array<string|int, int>|null: Checks if a whole branch of pages exists.
doesRecordExist_pageLookUp() : array<string|int, mixed>|false: Looks up a page based on permissions.
fixCopyAfterDuplFields() : array<string|int, mixed>: When a record is copied you can specify fields from the previous record which should be copied into the new one
fixUniqueInSite() : bool: Checks if any uniqueInSite eval fields are in the record and if so, they are re-written to be correct.
fixUniqueInSiteForSubpages() : void: Check if there are subpages that need an adoption as well
formatLogDetails() : string: Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.
formatLogDetailsStatic() : string: Static version for ViewHelpers etc.
getAllowedTablesToCopyWhenCopyingAPage() : array<string|int, mixed>: Compile a list of tables that should be copied along when a page is about to be copied.
getCheckModifyAccessListHookObjects() : array<string|int, mixed>: Gets the 'checkModifyAccessList' hook objects.
getCommandMapElements() : array<string|int, mixed>: Gets elements of the command map that match a particular command.
getDefaultLanguagePageId() : int: Find out if the record is a localization. If so, get the uid of the default language page.
getLanguageService() : LanguageService
getLocalTCE() : DataHandler: Returns an instance of DataHandler for handling local datamaps/cmdmaps
getOriginalParentOfRecord() : array<string|int, int>: Gets UID of parent record. If record is deleted it will be looked up in an array built before the record was deleted
getOuterMostInstance() : DataHandler: Gets the outer most instance of \TYPO3\CMS\Core\DataHandling\DataHandler Since \TYPO3\CMS\Core\DataHandling\DataHandler can create nested objects of itself, this method helps to determine the first (= outer most) one.
getPreviousLocalizedRecordUid() : int: Returning uid of "previous" localized record, if any, for tables with a "sortby" column.
getRecordHistoryStore() : RecordHistoryStore
getSiteLanguageForPage() : SiteLanguage|null: Find a site language by the given language ID for a specific page, and check for all available sites if the page ID is "0".
getUniqueCountStatement() : QueryBuilder: Gets the count of records for a unique field
hardDeleteSingleRecord() : void: Simple helper method to hard delete one row from table ignoring delete TCA field
increaseSortingOfFollowingRecords() : void: Increases sorting field value of all records with sorting higher than $sortingValue
initializeSlugFieldsToEmptyString() : array<string|int, mixed>: New records capable of handling slugs (TCA type 'slug'), always require the field value to be set, in order to run through the validation process to create a new slug. Fields having `null` as value are ignored and can be used to by-pass implicit slug initialization.
inlineLocalizeSynchronize() : void: Performs localization or synchronization of child records.
isElementToBeDeleted() : bool: Determines whether an element was registered to be deleted in the registry.
isNestedElementCallRegistered() : bool: Determines nested element calls.
isRecordLocalized() : bool: Returns true if a localization of a record exists.
isSubmittedValueEqualToStoredValue() : bool: Determines whether submitted values and stored values are equal.
isTableAllowedForThisPage() : bool: Checks if a table is allowed on a certain page id according to allowed tables set for the page "doktype" and its [ctrl][rootLevel]-settings if any.
overlayAutoVersionId() : int: Overlays the automatically versionized id of a record.
pageInfo() : string|int|null: Returns the value of the $field from page $id NOTICE; the function caches the result for faster delivery next time. You can use this function repeatedly without performance loss since it doesn't look up the same record twice!
postProcessDatabaseInsert() : int: Entry point to post process a database insert. Currently bails early unless a UID has been forced and the database platform is not MySQL.
postProcessPostgresqlInsert() : void: PostgreSQL works with sequences for auto increment columns. A sequence is not updated when a value is written to such a column. To avoid clashes when the sequence returns an existing ID this helper will update the sequence to the current max value of the column.
prepareCacheFlush() : array<string|int, mixed>: Prepare the cache clearing
prependLabel() : string: Return "copy" label for a table. Although the name is "prepend" it actually APPENDs the label (after ...)
processClearCacheQueue() : void: Do the actual clear cache
recordInfoWithPermissionCheck() : array<string, mixed>|false: Checks if record exists with and without permission check and returns that row
registerElementsToBeDeleted() : void: Registers elements to be deleted in the registry.
registerNestedElementCall() : void: Registers nested elements calls.
resetElementsToBeDeleted() : void: Resets the elements to be deleted in the registry.
resetNestedElementCalls() : void: Resets the nested element calls.
resolveFieldConfigurationAndRespectColumnsOverrides() : array<string|int, mixed>: Use columns overrides for evaluation.
resolveSortingAndPidForNewRecord() : array<string|int, mixed>: Sets the "sorting" DB field and the "pid" field of an incoming record that should be added (NEW1234) depending on the record that should be added or where it should be added.
resolveVersionedRecords() : array<string|int, mixed>: Resolves versioned records for the current workspace scope.
setNullValues() : void: Sets NULL values in haystack array.
undeleteRecord() : void: Restore live records by setting soft-delete flag to 0.
undeleteRecordRelations() : void: Check if a to-restore record has inline references and restore them.
unserializeLogData() : array<string|int, mixed>|null: Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.
unsetElementsToBeDeleted() : array<string|int, mixed>: Unsets elements (e.g. of the data map) that shall be deleted.
updateFlexFormData() : void: Updates FlexForm data.
validateValueForRequired() : bool: Checks if required=true is set: if set: checks if the value is not empty (or not "0").
workspaceAllowAutoCreation() : bool: Evaluates if auto creation of a version of a record is allowed.

CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED


    protected
        mixed
    CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED
    = 'core-datahandler-elementsToBeDeleted'

CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX

Prefix for the cache entries of nested element calls since the runtimeCache has a global scope.


    protected
        mixed
    CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX
    = 'core-datahandler-nestedElementCalls-'

$admin

Will be set if user is admin


    public
        bool
    $admin

Internal

should only be used from within TYPO3 Core

$autoVersionIdMap

Contains mapping of auto-versioned records.


    public
        array<string, array<int, string>>
    $autoVersionIdMap
     = []

Internal

should only be used from within TYPO3 Core

$BE_USER

The user-object the script uses. If not set from outside, this is set to the current global $BE_USER.


    public
        BackendUserAuthentication
    $BE_USER

$bypassAccessCheckForRecords

If TRUE, access check, check for deleted etc. for records is bypassed.


    public
        bool
    $bypassAccessCheckForRecords
     = false

YOU MUST KNOW what you are doing if you use this feature!

$bypassWorkspaceRestrictions

If TRUE, workspace restrictions are bypassed on edit and create actions (process_datamap()).


    public
        bool
    $bypassWorkspaceRestrictions
     = false

YOU MUST KNOW what you do if you use this feature!

Internal

should only be used from within TYPO3 Core

$callBackObj

Object. Call back object for FlexForm traversal. Useful when external classes wants to use the iteration functions inside DataHandler for traversing a FlexForm structure.


    public
        object|null
    $callBackObj
     = null

Internal

should only be used from within TYPO3 Core

$checkValue_currentRecord

Set to "currentRecord" during checking of values.


    public
        array<string|int, mixed>
    $checkValue_currentRecord
     = []

Internal

$cmdmap

Incoming command array. The array shape is checked in start() before setting this property.


    public
        array<string, array<int|string, array<string|int, mixed>>>
    $cmdmap
     = []

$copyMappingArray

Used by the copy action to track the ids of new pages so subpages are correctly inserted! THIS is internally cleared for each executed copy operation! DO NOT USE THIS FROM OUTSIDE! Read from copyMappingArray_merged instead which is accumulating this information.


    public
        array<string, array<string|int, mixed>>
    $copyMappingArray
     = []

NOTE: This is used by some outside scripts (e.g. hooks), as the results in $copyMappingArray_merged are only available after an action has been completed.

Internal

$copyMappingArray_merged

This array is the sum of all copying operations in this class.


    public
        array<string|int, mixed>
    $copyMappingArray_merged
     = []

Internal

should only be used from within TYPO3 Core

$copyTree

If 0 then branch is NOT copied.


    public
        int
    $copyTree
     = 0

If 1 then pages on the 1st level is copied. If 2 then pages on the second level is copied ... and so on

$copyWhichTables

Comma-separated list. This list of tables decides which tables will be copied. If empty then none will.


    public
        string
    $copyWhichTables
     = '*'

If '*' then all will (that the user has permission to of course)

Internal

should only be used from within TYPO3 Core

$datamap

Set with incoming data array. The array shape is checked in start() before setting this property.


    public
        array<string, array<int|string, array<string|int, mixed>>>
    $datamap
     = []

$dbAnalysisStore

For accumulation of MM relations that must be written after new records are created.


    public
        array<string|int, mixed>
    $dbAnalysisStore
     = []

Internal

$defaultValues

[table][fields]=value: New records are created with default values and you can set this array on the form $defaultValues[$table][$field] = $value to override the default values fetched from TCA.


    public
        array<string|int, mixed>
    $defaultValues
     = []

If ->setDefaultsFromUserTS is called UserTSconfig default values will overrule existing values in this array (thus UserTSconfig overrules externally set defaults which overrules TCA defaults)

Internal

should only be used from within TYPO3 Core

$dontProcessTransformations

If set, then transformations are NOT performed on the input.


    public
        bool
    $dontProcessTransformations
     = false

$enableLogging

If TRUE, actions are logged to sys_log.


    public
        bool
    $enableLogging
     = true

$errorLog

Errors are collected in this variable.


    public
        array<string|int, mixed>
    $errorLog
     = []

Internal

should only be used from within TYPO3 Core

$isImporting

If set, then the TCE class has been instantiated during an import action of a T3D


    public
        bool
    $isImporting
     = false

$neverHideAtCopy

If set, then the 'hideAtCopy' flag for tables will be ignored.


    public
        bool
    $neverHideAtCopy
     = false

$newRelatedIDs

Holds the tables and there the ids of newly created child records from IRRE


    public
        array<string|int, mixed>
    $newRelatedIDs
     = []

Internal

should only be used from within TYPO3 Core

$pagetreeNeedsRefresh

Indicates whether the pagetree needs a refresh because of important changes


    public
        bool
    $pagetreeNeedsRefresh
     = false

Internal

should only be used from within TYPO3 Core

$pagetreeRefreshFieldsFromPages

Fields from the pages-table for which changes will trigger a pagetree refresh


    public
        array<string|int, mixed>
    $pagetreeRefreshFieldsFromPages
     = ['pid', 'sorting', 'deleted', 'hidden', 'title', 'doktype', 'is_siteroot', 'fe_group', 'nav_hide', 'nav_title', 'module', 'starttime', 'endtime', 'content_from_pid', 'extendToSubpages']

$registerDBList

Used for tracking references that might need correction after operations


    public
        array<string, array<int, array<string|int, mixed>>>
    $registerDBList
     = []

Internal

$registerDBPids

Used for tracking references that might need correction in pid field after operations (e.g. IRRE)


    public
        array<string|int, mixed>
    $registerDBPids
     = []

Internal

$remapStack

Array used for remapping uids and values at the end of process_datamap


    public
        array<string|int, mixed>
    $remapStack
     = []

Internal

$remapStackRecords

Array used for remapping uids and values at the end of process_datamap (e.g. $remapStackRecords[<table>][<uid>] = <index in $remapStack>)


    public
        array<string|int, mixed>
    $remapStackRecords
     = []

Internal

$reverseOrder

If TRUE, the datamap array is reversed in the order, which is a nice thing if you're creating a whole new bunch of records.


    public
        bool
    $reverseOrder
     = false

$sortIntervals

The interval between sorting numbers used with tables with a 'sorting' field defined.


    public
        int
    $sortIntervals
     = 256

Min 1, should be power of 2

Internal

should only be used from within TYPO3 Core

$storeLogMessages

If TRUE, the default log-messages will be stored. This should not be necessary if the locallang-file for the log-display is properly configured. So disabling this will just save some database-space as the default messages are not saved.


    public
        bool
    $storeLogMessages
     = true

$substNEWwithIDs

When new elements are created, this array contains a map between their "NEW..." string IDs and the final uid they got when stored in database. This public array is rather important since it is used by many DH consumers to further work with records after creation.


    public
        array<string|int, mixed>
    $substNEWwithIDs
     = []

$substNEWwithIDs_table

Like $substNEWwithIDs, but where each old "NEW..." id is mapped to the table it was from.


    public
        array<string|int, mixed>
    $substNEWwithIDs_table
     = []

Internal

should only be used from within TYPO3 Core

$suggestedInsertUids

Use this array to validate suggested uids for tables by setting [table]:[uid]. This is a dangerous option since it will force the inserted record to have a certain UID. The value just have to be TRUE, but if you set it to "DELETE" it will make sure any record with that UID will be deleted first (raw delete).


    public
        array<string|int, mixed>
    $suggestedInsertUids
     = []

The option is used for import of T3D files when synchronizing between two mirrored servers. As a security measure this feature is available only for Admin Users (for now)

$userid

Will be set to uid of be_user executing this script


    public
        int
    $userid

Internal

should only be used from within TYPO3 Core

$checkModifyAccessListHookObjects


    protected
        array<string|int, mixed>|null
    $checkModifyAccessListHookObjects
     = null

$control

Data submitted from the form view, used to control behaviours, e.g. this is used to activate/deactivate fields and thus store NULL values


    protected
        array<string|int, mixed>
    $control
     = []

$correlationId

A string which can be used as correlationId for RecordHistory entries.


    protected
        CorrelationId|null
    $correlationId
     = null

The string can later be used to rollback multiple changes at once.

$deletedRecords

Per-table array with UIDs that have been deleted.


    protected
        array<string|int, mixed>
    $deletedRecords
     = []

$disableDeleteClause

Disable delete clause


    protected
        bool
    $disableDeleteClause
     = false

$excludedTablesAndFields

The list of <table>-<fields> that cannot be edited by user. This is compiled from TCA/exclude-flag combined with non_exclude_fields for the user.


    protected
        array<string|int, mixed>
    $excludedTablesAndFields
     = []

$historyRecords

List of changed old record ids to new records ids


    protected
        array<string|int, mixed>
    $historyRecords
     = []

$isInWebMount_Cache

Caching array for page ids in webmounts


    protected
        array<string|int, mixed>
    $isInWebMount_Cache
     = []

$isRecordInWebMount_Cache

Caching array for check of whether records are in a webmount


    protected
        array<string|int, mixed>
    $isRecordInWebMount_Cache
     = []

$mmHistoryRecords

List of changed old record ids to new records ids


    protected
        array<string|int, mixed>
    $mmHistoryRecords
     = []

$outerMostInstance

The outermost instance of \TYPO3\CMS\Core\DataHandling\DataHandler: This object instantiates itself on versioning and localization .


    protected
        self|null
    $outerMostInstance
     = null

$pageCache

Used for caching page records in pageInfo()


    protected
        array<int, array<string, int|string|null>>
    $pageCache
     = []

$recInsertAccessCache

User by function checkRecordInsertAccess() to store whether a record can be inserted on a page id


    protected
        array<string|int, mixed>
    $recInsertAccessCache
     = []

$recordPidsForDeletedRecords

Internal cache for pids of records which were deleted. It's not possible to retrieve the parent folder/page at a later stage


    protected
    static    array<string|int, mixed>
    $recordPidsForDeletedRecords
     = []

$recordsToClearCacheFor

Internal cache for collecting records that should trigger cache clearing


    protected
    static    array<string|int, mixed>
    $recordsToClearCacheFor
     = []

$referenceIndexUpdater

Registry object to gather reference index update requests and perform updates after main processing has been done. It is created upon first start() call and hand over when dealing with internal sub instances. The final update() call is done at the end of process_cmdmap() or process_datamap() in the outermost instance.


    protected
        ReferenceIndexUpdater
    $referenceIndexUpdater

$remapStackActions

Array used for executing addition actions after remapping happened (set processRemapStack())


    protected
        array<string|int, mixed>
    $remapStackActions
     = []

$useTransOrigPointerField

Will distinguish between translations (with parent) and localizations (without parent) while still using the same methods to copy the records TRUE: translation of a record connected to the default language FALSE: localization of a record without connection to the default language


    protected
        bool
    $useTransOrigPointerField
     = true

__construct()


    public
                    __construct(EventDispatcherInterface $eventDispatcher, CacheManager $cacheManager, FrontendInterface $runtimeCache, ConnectionPool $connectionPool, LoggerInterface $logger, PagePermissionAssembler $pagePermissionAssembler, TcaSchemaFactory $tcaSchemaFactory, PageDoktypeRegistry $pageDoktypeRegistry, FlexFormTools $flexFormTools, PasswordHashFactory $passwordHashFactory, Random $randomGenerator, TypoLinkCodecService $typoLinkCodecService, OpcodeCacheService $opcodeCacheService, FlashMessageService $flashMessageService) : mixed

Parameters

$eventDispatcher : EventDispatcherInterface
$cacheManager : CacheManager
$runtimeCache : FrontendInterface
$connectionPool : ConnectionPool
$logger : LoggerInterface
$pagePermissionAssembler : PagePermissionAssembler
$tcaSchemaFactory : TcaSchemaFactory
$pageDoktypeRegistry : PageDoktypeRegistry
$flexFormTools : FlexFormTools
$passwordHashFactory : PasswordHashFactory
$randomGenerator : Random
$typoLinkCodecService : TypoLinkCodecService
$opcodeCacheService : OpcodeCacheService
$flashMessageService : FlashMessageService

addRemapAction()

Adds an instruction to the remap action stack (used with IRRE).


    public
                    addRemapAction(string $table, int|string $id, callable $callback, array<string|int, mixed> $arguments) : void

Parameters

$table : string: The affected table
$id : int|string: The affected ID
$callback : callable: The callback information (object and method)
$arguments : array<string|int, mixed>: The arguments to be used with the callback

Internal

should only be used from within DataHandler

canDeletePage()

Used to evaluate if a page can be deleted


    public
                    canDeletePage(int $uid) : array<string|int, int>|string

Parameters

$uid : int: Page id

Internal

should only be used from within DataHandler

Return values

array<string|int, int>|string —

If array: List of page uids to traverse and delete (means OK), if string: error message.

cannotDeleteRecord()

Returns TRUE if record CANNOT be deleted, otherwise FALSE. Used to check before the versioning API allows a record to be marked for deletion.


    public
                    cannotDeleteRecord(string $table, int $id) : string

Parameters

$table : string: Record Table
$id : int: Record UID

Internal

should only be used from within DataHandler

Return values

string —

Returns a string IF there is an error (error string explaining). FALSE means record can be deleted

checkModifyAccessList()

Checking group modify_table access list


    public
                    checkModifyAccessList(string $table) : bool

Parameters

$table : string: Table name

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if the user has general access to modify the $table

checkRecordInsertAccess()

Checks if user may insert a record from $insertTable on $pid


    public
                    checkRecordInsertAccess(string $insertTable, int $pid[, int $action = SystemLogDatabaseAction::INSERT ]) : bool

Parameters

$insertTable : string: Tablename to check
$pid : int: Integer PID
$action : int = SystemLogDatabaseAction::INSERT: For logging: Action number.

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if the user may insert a record from table $insertTable on page $pid

checkRecordUpdateAccess()

Checks if user may update a record with uid=$id from $table


    public
                    checkRecordUpdateAccess(string $table, int $id) : bool

Parameters

$table : string: Record table
$id : int: Record UID

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if the user may update the record given by $table and $id

checkValue()

Evaluates a value according to $table/$field settings.


    public
                    checkValue(string $table, string $field, string $value, int|string $id, string $status, int $realPid, int $tscPID[, array<string|int, mixed> $incomingFieldArray = [] ]) : array<string|int, mixed>

This function is for real database fields - NOT FlexForm "pseudo" fields. NOTICE: Calling this function expects this: 1) That the data is saved!

Parameters

$table : string: Table name
$field : string: Field name
$value : string: Value to be evaluated. Notice, this is the INPUT value from the form. The original value (from any existing record) must be manually looked up inside the function if needed - or taken from $currentRecord array.
$id : int|string: The record-uid, mainly - but not exclusively - used for logging
$status : string: 'update' or 'new' flag
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$tscPID : int: TSconfig PID
$incomingFieldArray : array<string|int, mixed> = []: the fields being explicitly set by the outside (unlike $fieldArray)

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Returns the evaluated $value as key "value" in this array. Can be checked with isset($res['value']) ...

checkValue_category_processDBdata()

Returns processed data for category fields


    public
                    checkValue_category_processDBdata(array<string|int, mixed> $valueArray, array<string|int, mixed> $tcaFieldConf, string|int $id, string $status, string $table, string $field) : array<string|int, mixed>

Parameters

$valueArray : array<string|int, mixed>: Current value array
$tcaFieldConf : array<string|int, mixed>: TCA field config
$id : string|int: Record id, used for look-up of MM relations (local_uid)
$status : string: Status string ('update' or 'new')
$table : string: Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
$field : string: field name, needs to be set for writing to sys_history

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Modified value array

checkValue_checkMax()

Checks if a fields has more items than defined via TCA in maxitems.


    public
                    checkValue_checkMax(array<string|int, mixed> $tcaFieldConf, array<string|int, mixed> $valueArray) : array<string|int, mixed>

If there are more items than allowed, the item list is truncated to the defined number.

Parameters

$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$valueArray : array<string|int, mixed>: Current value array of items

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

The truncated value array of items

checkValue_flex_procInData()

Starts the processing the input data for flexforms. This will traverse all sheets / languages and for each it will traverse the sub-structure.


    public
                    checkValue_flex_procInData(array<string|int, mixed> $dataPart, array<string|int, mixed> $dataPart_current, array<string|int, mixed> $dataStructure, array<string|int, mixed> $pParams[, string $callBackFunc = '' ][, array<string|int, mixed> $workspaceOptions = [] ]) : array<string|int, mixed>

See checkValue_flex_procInData_travDS() for more details. WARNING: Currently, it traverses based on the actual data array and NOT the structure. This means that values for non-valid fields, lKey/vKey/sKeys will be accepted! For traversal of data with a call back function you should rather use \TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools

Parameters

$dataPart : array<string|int, mixed>: The 'data' part of the INPUT flexform data
$dataPart_current : array<string|int, mixed>: The 'data' part of the CURRENT flexform data
$dataStructure : array<string|int, mixed>: Data structure for the form (might be sheets or not). Only values in the data array which has a configuration in the data structure will be processed.
$pParams : array<string|int, mixed>: A set of parameters to pass through for the calling of the evaluation functions
$callBackFunc : string = '': Optional call back function, see checkValue_flex_procInData_travDS() DEPRECATED, use \TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools instead for traversal!
$workspaceOptions : array<string|int, mixed> = []

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

The modified 'data' part.

checkValue_flex_procInData_travDS()

Processing of the sheet/language data array When it finds a field with a value the processing is done by ->checkValue_SW() by default but if a call back function name is given that method in this class will be called for the processing instead.


    public
                    checkValue_flex_procInData_travDS(array<string|int, mixed> &$dataValues, array<string|int, mixed> $dataValues_current, array<string|int, mixed> $DSelements, array<string|int, mixed> $pParams, string $callBackFunc, string $structurePath[, array<string|int, mixed> $workspaceOptions = [] ]) : void

Parameters

$dataValues : array<string|int, mixed>: New values (those being processed): Multidimensional Data array for sheet/language, passed by reference!
$dataValues_current : array<string|int, mixed>: Current values: Multidimensional Data array. May be empty array() if not needed (for callBackFunctions)
$DSelements : array<string|int, mixed>: Data structure which fits the data array
$pParams : array<string|int, mixed>: A set of parameters to pass through for the calling of the evaluation functions / call back function
$callBackFunc : string: Call back function, default is checkValue_SW(). If $this->callBackObj is set to an object, the callback function in that object is called instead.
$structurePath : string
$workspaceOptions : array<string|int, mixed> = []

Internal

should only be used from within DataHandler

checkValue_group_select_explodeSelectGroupValue()

Explodes the $value, which is a list of files/uids (group select)


    public
                    checkValue_group_select_explodeSelectGroupValue(string $value) : array<string|int, mixed>

Parameters

$value : string: Input string, comma separated values. For each part it will also be detected if a '|' is found and the first part will then be used if that is the case. Further the value will be rawurldecoded.

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

The value array.

checkValue_group_select_processDBdata()

Returns data for group/db and select fields


    public
                    checkValue_group_select_processDBdata(array<string|int, mixed> $valueArray, array<string|int, mixed> $tcaFieldConf, int $id, string $status, string $type, string $currentTable, string $currentField) : array<string|int, mixed>

Parameters

$valueArray : array<string|int, mixed>: Current value array
$tcaFieldConf : array<string|int, mixed>: TCA field config
$id : int: Record id, used for look-up of MM relations (local_uid)
$status : string: Status string ('update' or 'new')
$type : string: The type, either 'select', 'group' or 'inline'
$currentTable : string: Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
$currentField : string: field name, needs to be set for writing to sys_history

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Modified value array

checkValue_inline()

Evaluates 'inline' type values.


    public
                    checkValue_inline(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, array<string|int, mixed> $PP, string $field[, array<string|int, mixed>|null $additionalData = null ]) : mixed

(partly copied from the select_group function on this issue)

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$PP : array<string|int, mixed>: Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID
$field : string: Field name
$additionalData : array<string|int, mixed>|null = null: Additional data to be forwarded to sub-processors

Internal

should only be used from within DataHandler

checkValue_input_Eval()

Evaluation of 'input'-type values based on 'eval' list


    public
                    checkValue_input_Eval(string $value, array<string|int, mixed> $evalArray, string $is_in[, string $table = '' ][, string|int $id = '' ]) : array<string|int, mixed>

Parameters

$value : string: Value to evaluate
$evalArray : array<string|int, mixed>: Array of evaluations to traverse.
$is_in : string: Is-in string for 'is_in' evaluation
$table : string = '': Table name the eval is evaluated on
$id : string|int = '': Record ID the eval is evaluated on

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Modified $value in key 'value' or empty array

checkValue_SW()

Branches out evaluation of a field value based on its type as configured in $GLOBALS['TCA'] Can be called for FlexForm pseudo fields as well, BUT must not have $field set if so.


    public
                    checkValue_SW(array<string|int, mixed> $res, string|null $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, mixed $curValue, string $status, int $realPid, string $recFID, string $field, int $tscPID[, array<string|int, mixed>|null $additionalData = null ]) : array<string|int, mixed>

And hey, there's a good thing about the method arguments: 13 is prime :-P

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the "value" key.
$value : string|null: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from $GLOBALS['TCA']
$table : string: Table name
$id : int: UID of record
$curValue : mixed: Current value of the field
$status : string: 'update' or 'new' flag
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$recFID : string: Field identifier [table:uid:field] for flexforms
$field : string: Field name. Must NOT be set if the call is for a flexform field (since flexforms are not allowed within flexforms).
$tscPID : int: TSconfig PID
$additionalData : array<string|int, mixed>|null = null: Additional data to be forwarded to sub-processors

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Returns the evaluated $value as key "value" in this array.

checkValue_text_Eval()


    public
                    checkValue_text_Eval(string $value, array<string|int, mixed> $evalArray, string $is_in) : array<string|int, mixed>

Parameters

$value : string: The field value to be evaluated
$evalArray : array<string|int, mixed>: Array of evaluations to traverse.
$is_in : string: The "is_in" value of the field configuration from TCA

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>

checkValueForFile()

Evaluates 'file' type values.


    public
                    checkValueForFile(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, string $field[, array<string|int, mixed>|null $additionalData = null ]) : array<string|int, mixed>

Parameters

$res : array<string|int, mixed>
$value : string
$tcaFieldConf : array<string|int, mixed>
$table : string
$id : int|string
$field : string
$additionalData : array<string|int, mixed>|null = null

Return values

array<string|int, mixed>

checkValueForInline()

Evaluates 'inline' type values.


    public
                    checkValueForInline(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, string $status, string $field[, array<string|int, mixed>|null $additionalData = null ]) : array<string|int, mixed>|false

(partly copied from the select_group function on this issue)

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$status : string: 'update' or 'new' flag
$field : string: Field name
$additionalData : array<string|int, mixed>|null = null: Additional data to be forwarded to sub-processors

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>|false —

Modified $res array

clear_cacheCmd()

Clears the cache based on the command $cacheCmd.


    public
                    clear_cacheCmd(int|string $cacheCmd) : void

$cacheCmd='pages' Clears cache for all pages and page-based caches inside the cache manager. Requires admin-flag to be set for BE_USER.

$cacheCmd='all' Clears all cache_tables. This is necessary if templates are updated. Requires admin-flag to be set for BE_USER.

The following cache_* are intentionally not cleared by 'all'

all caches inside the cache manager that are inside the group "system"
they are only needed to build up the core system and templates. If the group of system caches needs to be deleted explicitly, use flushCachesInGroup('system') of CacheManager directly.

$cacheCmd=[integer] Clears cache for the page pointed to by $cacheCmd (an integer).

$cacheCmd='cacheTag:[string]' Flush page cache by given tag

$cacheCmd='cacheId:[string]' Removes cache identifier from page and page section cache

Can call a list of post processing functions as defined in $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc'] (numeric array with values being the function references, called by GeneralUtility::callUserFunction()).

Parameters

$cacheCmd : int|string: The cache command, see above description

clearPrefixFromValue()

Removes the prependAtCopy prefix on values


    public
                    clearPrefixFromValue(string $table, string $value) : string

Parameters

$table : string: Table name
$value : string: The value to fix

Internal

should only be used from within DataHandler

Return values

string —

Clean name

compareFieldArrayWithCurrentAndUnset()

Compares the incoming field array with the current record and unsets all fields which are the same.


    public
                    compareFieldArrayWithCurrentAndUnset(string $table, int $id, array<string|int, mixed> $fieldArray) : array<string|int, mixed>

Used for existing records being updated

Parameters

$table : string: Record table name
$id : int: Record uid
$fieldArray : array<string|int, mixed>: Array of field=>value pairs intended to be inserted into the database. All keys with values matching exactly the current value will be unset!

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Returns $fieldArray. If the returned array is empty, then the record should not be updated!

copyPages()

Copying pages Main function for copying pages.


    public
                    copyPages(int $uid, int $destPid) : void

Parameters

$uid : int: Page UID to copy
$destPid : int: Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

Internal

should only be used from within DataHandler

copyRecord()

Copying a single record


    public
                    copyRecord(string $table, int $uid, int $destPid[, bool $first = false ][, array<string|int, mixed> $overrideValues = [] ][, string $excludeFields = '' ][, int $language = 0 ][, bool $ignoreLocalization = false ]) : int|null

Parameters

$table : string: Element table
$uid : int: Element UID
$destPid : int: =0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if
$first : bool = false: Is a flag set, if the record copied is NOT a 'slave' to another record copied. That is, if this record was asked to be copied in the cmd-array
$overrideValues : array<string|int, mixed> = []: Associative array with field/value pairs to override directly. Notice; Fields must exist in the table record and NOT be among excluded fields!
$excludeFields : string = '': Commalist of fields to exclude from the copy process (might get default values)
$language : int = 0: Language ID
$ignoreLocalization : bool = false: If TRUE, any localization routine is skipped

Internal

should only be used from within DataHandler

Return values

int|null —

ID of new record, if any

copyRecord_flexFormCallBack()

Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.


    public
                    copyRecord_flexFormCallBack(array<string|int, mixed> $pParams, array<string|int, mixed> $dsConf, string $dataValue, string $_1, string $_2, array<string|int, mixed> $workspaceOptions) : array<string|int, mixed>

Parameters

$pParams : array<string|int, mixed>: Array of parameters in num-indexes: table, uid, field
$dsConf : array<string|int, mixed>: TCA field configuration (from Data Structure XML)
$dataValue : string: The value of the flexForm field
$_1 : string: Not used.
$_2 : string: Not used.
$workspaceOptions : array<string|int, mixed>

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Result array with key "value" containing the value of the processing.

copyRecord_procBasedOnFieldType()

Processing/Preparing content for copyRecord() function


    public
                    copyRecord_procBasedOnFieldType(string $table, int $uid, string $field, string|null $value, array<string|int, mixed> $row, array<string|int, mixed> $conf, int $realDestPid[, int $language = 0 ][, array<string|int, mixed> $workspaceOptions = [] ]) : array<string|int, mixed>|string|null

Parameters

$table : string: Table name
$uid : int: Record uid
$field : string: Field name being processed
$value : string|null: Input value to be processed.
$row : array<string|int, mixed>: Record array
$conf : array<string|int, mixed>: TCA field configuration
$realDestPid : int: Real page id (pid) the record is copied to
$language : int = 0: Language ID used in the duplicated record
$workspaceOptions : array<string|int, mixed> = []: Options to be forwarded if actions happen on a workspace currently

Internal

Return values

array<string|int, mixed>|string|null

copyRecord_raw()

Copying records, but makes a "raw" copy of a record.


    public
                    copyRecord_raw(string $table, int $uid, int $pid[, array<string|int, mixed> $overrideArray = [] ][, array<string|int, mixed> $workspaceOptions = [] ]) : int|null

Basically the only thing observed is field processing like the copying of files and correction of ids. All other fields are 1-1 copied. Technically the copy is made with THIS instance of the DataHandler class contrary to copyRecord() which creates a new instance and uses the processData() function. The copy is created by insertNewCopyVersion() which bypasses most of the regular input checking associated with processData() - maybe copyRecord() should even do this as well!? This function is used to create new versions of a record. NOTICE: DOES NOT CHECK PERMISSIONS to create! And since page permissions are just passed through and not changed to the user who executes the copy we cannot enforce permissions without getting an incomplete copy - unless we change permissions of course.

Parameters

$table : string: Element table
$uid : int: Element UID
$pid : int: Element PID (real PID, not checked)
$overrideArray : array<string|int, mixed> = []: Override array - must NOT contain any fields not in the table!
$workspaceOptions : array<string|int, mixed> = []: Options to be forwarded if actions happen on a workspace currently

Internal

should only be used from within DataHandler

Return values

int|null —

Returns the new ID of the record (if applicable)

copySpecificPage()

Copying a single page ($uid) to $destPid and all tables in the array copyTablesArray.


    public
                    copySpecificPage(int $uid, int $destPid, array<string|int, mixed> $copyTablesArray[, bool $first = false ]) : int|null

Parameters

$uid : int: Page uid
$destPid : int: Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if
$copyTablesArray : array<string|int, mixed>: Table on pages to copy along with the page.
$first : bool = false: Is a flag set, if the record copied is NOT a 'slave' to another record copied. That is, if this record was asked to be copied in the cmd-array

Internal

should only be used from within DataHandler

Return values

int|null —

The id of the new page, if applicable.

dbAnalysisStoreExec()

Executing dbAnalysisStore This will save MM relations for new records but is executed after records are created because we need to know the ID of them


    public
                    dbAnalysisStoreExec() : void

Internal

should only be used from within DataHandler

deleteAction()

Delete a single record


    public
                    deleteAction(string $table, int $id) : void

Parameters

$table : string: Table name
$id : int: Record UID

Internal

should only be used from within DataHandler

deleteClause()

Returns delete-clause for the $table


    public
                    deleteClause(string $table) : string

Parameters

$table : string: Table name

Internal

should only be used from within DataHandler

Return values

string —

Delete clause

deleteEl()

Delete element from any table


    public
                    deleteEl(string $table, int $uid[, bool $noRecordCheck = false ][, bool $forceHardDelete = false ][, bool $deleteRecordsOnPage = true ]) : void

Parameters

$table : string: Table name
$uid : int: Record UID
$noRecordCheck : bool = false: Flag: If $noRecordCheck is set, then the function does not check permission to delete record
$forceHardDelete : bool = false: If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
$deleteRecordsOnPage : bool = true: If false and if deleting pages, records on the page will not be deleted (edge case while swapping workspaces)

Internal

should only be used from within DataHandler

deleteL10nOverlayRecords()

Find l10n-overlay records and perform the requested delete action for these records.


    public
                    deleteL10nOverlayRecords(string $table, int $uid) : void

Parameters

$table : string: Record Table
$uid : int: Record UID

Internal

should only be used from within DataHandler

deletePages()

Used to delete page because it will check for branch below pages and disallowed tables on the page as well.


    public
                    deletePages(int $uid[, bool $force = false ][, bool $forceHardDelete = false ][, bool $deleteRecordsOnPage = true ]) : void

Parameters

$uid : int: Page id
$force : bool = false: If TRUE, pages are not checked for permission.
$forceHardDelete : bool = false: If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
$deleteRecordsOnPage : bool = true: If false, records on the page will not be deleted (edge case while swapping workspaces)

Internal

should only be used from within DataHandler

deleteRecord()

Deleting a record This function may not be used to delete pages-records unless the underlying records are already deleted Deletes a record regardless of versioning state (live or offline, doesn't matter, the uid decides) If both $noRecordCheck and $forceHardDelete are set it could even delete a "deleted"-flagged record!


    public
                    deleteRecord(string $table, int $uid[, bool $noRecordCheck = false ][, bool $forceHardDelete = false ]) : void

Parameters

$table : string: Table name
$uid : int: Record UID
$noRecordCheck : bool = false: Flag: If $noRecordCheck is set, then the function does not check permission to delete record
$forceHardDelete : bool = false: If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!

Internal

should only be used from within DataHandler

deleteRecord_procBasedOnFieldType()

Process fields of a record to be deleted and search for special handling, like inline type, MM records, etc.


    public
                    deleteRecord_procBasedOnFieldType(string $table, int $uid, string $value, array<string|int, mixed> $conf) : void

Parameters

$table : string: Record Table
$uid : int: Record UID
$value : string: Record field value
$conf : array<string|int, mixed>: TCA configuration of current field

Internal

should only be used from within DataHandler

deleteRecord_procFields()

Before a record is deleted, check if it has references such as inline type or MM references.


    public
                    deleteRecord_procFields(string $table, int $uid) : void

If so, set these child records also to be deleted.

Parameters

$table : string: Record Table
$uid : int: Record UID

Internal

should only be used from within DataHandler

destNotInsideSelf()

Checks if page $id is a uid in the rootline of page id $destinationId Used when moving a page


    public
                    destNotInsideSelf(int $destinationId, int $id) : bool

Parameters

$destinationId : int: Destination Page ID to test
$id : int: Page ID to test for presence inside Destination

Internal

should only be used from within DataHandler

Return values

bool —

Returns FALSE if ID is inside destination (including equal to)

disableDeleteClause()

Disables the delete clause for fetching records.


    public
                    disableDeleteClause() : void

In general only undeleted records will be used. If the delete clause is disabled, also deleted records are taken into account.

discard()

Discard a versioned record from this workspace. This deletes records from the database - no soft delete.


    public
                    discard(string $table, int|null $uid[, array<string|int, mixed>|null $record = null ]) : void

This main entry method is called recursive for sub pages, localizations, relations and records on a page. The method checks user access and gathers facts about this record to hand the deletion over to detail methods.

The incoming $uid or $row can be anything: The workspace of current user is respected and only records of current user workspace are discarded. If giving a live record uid, the versioned overly will be fetched.

Parameters

$table : string: Database table name
$uid : int|null: Uid of live or versioned record to be discarded, or null if $record is given
$record : array<string|int, mixed>|null = null: Record row that should be discarded. Used instead of $uid within recursion.

Internal

should only be used from within DataHandler

doesPageHaveUnallowedTables()

Checks if there are records on a page from tables that are not allowed


    public
                    doesPageHaveUnallowedTables(int|string $page_uid, int $doktype) : array<string|int, mixed>

Parameters

$page_uid : int|string: Page ID
$doktype : int: Page doktype

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Returns a list of the tables that are 'present' on the page but not allowed with the page_uid/doktype

doesRecordExist()

Checks if record can be selected based on given permission criteria


    public
                    doesRecordExist(string $table, int $id, int $perms) : bool

Parameters

$table : string: Record table name
$id : int: Record UID
$perms : int: Permission restrictions to observe: integer that will be bitwise AND'ed.

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if the record given by $table, $id and $perms can be selected

eventPid()


    public
                    eventPid(string $table, int $uid, int $pid) : int

Parameters

$table : string
$uid : int
$pid : int

Internal

should only be used from within DataHandler

Return values

int

fillInFieldArray()

Filling in the field array $this->excludedTablesAndFields is used to filter fields if needed.


    public
                    fillInFieldArray(string $table, int|string $id, array<string|int, mixed> $fieldArray, array<string|int, mixed> $incomingFieldArray, int $realPid, string $status, int $tscPID) : array<string|int, mixed>

Parameters

$table : string: Table name
$id : int|string: Record ID
$fieldArray : array<string|int, mixed>: Default values, Preset $fieldArray with 'pid' maybe (pid and uid will be not be overridden anyway)
$incomingFieldArray : array<string|int, mixed>: Is which fields/values you want to set. There are processed and put into $fieldArray if OK
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$status : string: Is 'new' or 'update'
$tscPID : int: TSconfig PID

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Field Array

fixUniqueInPid()

Checks if any uniqueInPid eval input fields are in the record and if so, they are re-written to be correct.


    public
                    fixUniqueInPid(string $table, int $uid) : void

Parameters

$table : string: Table name
$uid : int: Record UID

Internal

should only be used from within DataHandler

getAutoVersionId()

Gets the automatically versionized id of a record.


    public
                    getAutoVersionId(string $table, int $id) : int|null

Parameters

$table : string: Name of the table
$id : int: Uid of the record

Internal

should only be used from within TYPO3 Core

Return values

int|null

getCopyHeader()

Get modified header for a copied record


    public
                    getCopyHeader(string $table, int $pid, string $field, string $value, int $count[, string $prevTitle = '' ]) : string

Parameters

$table : string: Table name
$pid : int: PID value in which other records to test might be
$field : string: Field name to get header value for.
$value : string: Current field value
$count : int: Counter (number of recursions)
$prevTitle : string = '': Previous title we checked for (in previous recursion)

Internal

should only be used from within DataHandler

Return values

string —

The field value, possibly appended with a "copy label

getCorrelationId()


    public
                    getCorrelationId() : CorrelationId|null

Return values

CorrelationId|null

getExcludeListArray()

Generate an array of fields to be excluded from editing for the user. Based on "exclude"-field in TCA and a look up in non_exclude_fields Will also generate this list for admin-users so they must be check for before calling the function


    public
                    getExcludeListArray() : array<string|int, mixed>

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Array of [table]-[field] pairs to exclude from editing.

getHistoryRecords()


    public
                    getHistoryRecords() : array<string|int, mixed>

Internal

should only be used from within TYPO3 Core

Return values

array<string|int, mixed>

getPID()

Returns the pid of a record from $table with $uid


    public
                    getPID(string $table, int $uid) : int|false

Parameters

$table : string: Table name
$uid : int: Record uid

Internal

should only be used from within DataHandler

Return values

int|false —

PID value (unless the record did not exist in which case FALSE is returned)

getRecordProperties()

Returns an array with record properties, like header and pid No check for deleted or access is done! For versionized records, pid is resolved to its live versions pid.


    public
                    getRecordProperties(string $table, int $id[, bool $noWSOL = false ]) : array<string|int, mixed>

Used for logging

Parameters

$table : string: Table name
$id : int: Uid of record
$noWSOL : bool = false: If set, no workspace overlay is performed

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Properties of record

getRecordPropertiesFromRow()

Returns an array with record properties, like header and pid, based on the row


    public
                    getRecordPropertiesFromRow(string $table, array<string|int, mixed> $row) : array<string|int, mixed>|null

Parameters

$table : string: Table name
$row : array<string|int, mixed>: Input row

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>|null —

Output array

getRecordsWithSameValue()

gets all records that have the same value in a field excluding the given uid


    public
                    getRecordsWithSameValue(string $tableName, int $uid, string $fieldName, string|int $value[, int $pageId = 0 ]) : array<string|int, mixed>

Parameters

$tableName : string: Table name
$uid : int: UID to filter out in the lookup (the record itself...)
$fieldName : string: Field name for which $value must be unique
$value : string|int: Value string.
$pageId : int = 0: If set, the value will be unique for this PID

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>

getRelationFieldType()

Returns the subtype as a string of a relation (inline / file) field.


    public
                    getRelationFieldType(array<string|int, mixed> $conf) : string|bool

If it's not a relation field at all, it returns FALSE.

Parameters

$conf : array<string|int, mixed>: Config array for TCA/columns field

Internal

should only be used from within DataHandler

Return values

string|bool —

string Inline subtype (field|mm|list), boolean: FALSE

getSortNumber()

Returning sorting number for tables with a "sortby" column Using when new records are created and existing records are moved around.


    public
                    getSortNumber(string $table, int $uid, int $pid) : int|array<string|int, mixed>|bool|null

The strategy is:

if no record exists: set interval as sorting number
if inserted before an element: put in the middle of the existing elements
if inserted behind the last element: add interval to last sorting number
if collision: move all subsequent records by 2 * interval, insert new record with collision + interval

How to calculate the maximum possible inserts for the worst case of adding all records to the top, such that the sorting number stays within INT_MAX

i = interval (currently 256) c = number of inserts until collision s = max sorting number to reach (INT_MAX - 32bit) n = number of records (~83 million)

c = 2 * g g = log2(i) / 2 + 1 n = g * s / i - g + 1

The algorithm can be tuned by adjusting the interval value. Higher value means less collisions, but also less inserts are possible to stay within INT_MAX.

Parameters

$table : string: Table name
$uid : int: Uid of record to find sorting number for. May be zero in case of new.
$pid : int: Positioning PID, either >=0 (pointing to page in which case we find sorting number for first record in page) or <0 (pointing to record in which case to find next sorting number after this record)

Internal

should only be used from within DataHandler

Return values

int|array<string|int, mixed>|bool|null —

Returns integer if PID is >=0, otherwise an array with PID and sorting number. Possibly FALSE in case of error.

getTableEntries()

Extract entries from TSconfig for a specific table. This will merge specific and default configuration together.


    public
                    getTableEntries(string $table, array<string|int, mixed> $TSconfig) : array<string|int, mixed>

Parameters

$table : string: Table name
$TSconfig : array<string|int, mixed>: TSconfig for page

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

TSconfig merged

getUnique()

Gets a unique value for $table/$id/$field based on $value


    public
                    getUnique(string $table, string $field, string $value, int $id[, int $newPid = 0 ]) : string

Parameters

$table : string: Table name
$field : string: Field name for which $value must be unique
$value : string: Value string.
$id : int: UID to filter out in the lookup (the record itself...)
$newPid : int = 0: If set, the value will be unique for this PID

Internal

should only be used from within DataHandler

Return values

string —

Modified value (if not-unique). Will be the value appended with a number (until 100, then the function just breaks).

getVersionizedIncomingFieldArray()

If a parent record was versionized on a workspace in $this->process_datamap, it might be possible, that child records (e.g. on using IRRE) were affected.


    public
                    getVersionizedIncomingFieldArray(string $table, int $id, array<string|int, mixed> &$incomingFieldArray, array<string|int, mixed> &$registerDBList) : void

This function finds these relations and updates their uids in the $incomingFieldArray. The $incomingFieldArray is updated by reference!

Parameters

$table : string: Table name of the parent record
$id : int: Uid of the parent record
$incomingFieldArray : array<string|int, mixed>: Reference to the incomingFieldArray of process_datamap
$registerDBList : array<string|int, mixed>: Reference to the $registerDBList array that was created/updated by versionizing calls to DataHandler in process_datamap.

Internal

should only be used from within DataHandler

hasDeletedRecord()

Determines whether a particular record has been deleted using DataHandler::deleteRecord() in this instance.


    public
                    hasDeletedRecord(string $tableName, int $uid) : bool

Parameters

$tableName : string
$uid : int

Internal

should only be used from within TYPO3 Core

Return values

bool

hook_processDatamap_afterDatabaseOperations()

Hook: processDatamap_afterDatabaseOperations (calls $hookObj->processDatamap_afterDatabaseOperations($status, $table, $id, $fieldArray, $this);)


    public
                    hook_processDatamap_afterDatabaseOperations(array<string|int, mixed> &$hookObjectsArr, string &$status, string &$table, string &$id, array<string|int, mixed> &$fieldArray) : void

Note: When using the hook after INSERT operations, you will only get the temporary NEW... id passed to your hook as $id, but you can easily translate it to the real uid of the inserted record using the $this->substNEWwithIDs array.

Parameters

$hookObjectsArr : array<string|int, mixed>: (reference) Array with hook objects
$status : string: (reference) Status of the current operation, 'new' or 'update
$table : string: (reference) The table currently processing data for
$id : string: (reference) The record uid currently processing data for, [integer] or [string] (like 'NEW...')
$fieldArray : array<string|int, mixed>: (reference) The field array of a record

Internal

should only be used from within DataHandler

insertDB()

Insert into database Does not check permissions but expects them to be verified on beforehand


    public
                    insertDB(string $table, string $id, array<string|int, mixed> $fieldArray[, bool $newVersion = false ][, int $suggestedUid = 0 ][, bool $dontSetNewIdIndex = false ]) : int|null

Parameters

$table : string: Record table name
$id : string: "NEW...." uid string
$fieldArray : array<string|int, mixed>: Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done. "pid" must point to the destination of the record!
$newVersion : bool = false: Set to TRUE if new version is created.
$suggestedUid : int = 0: Suggested UID value for the inserted record. See the array $this->suggestedInsertUids; Admin-only feature
$dontSetNewIdIndex : bool = false: If TRUE, the ->substNEWwithIDs array is not updated. Only useful in very rare circumstances!

Internal

should only be used from within DataHandler

Return values

int|null —

Returns ID on success.

insertNewCopyVersion()

Inserts a record in the database, passing TCA configuration values through checkValue() but otherwise does NOTHING and checks nothing regarding permissions.


    public
                    insertNewCopyVersion(string $table, array<string|int, mixed> $fieldArray, int $realPid) : int|null

Passes the "version" parameter to insertDB() so the copy will look like a new version in the log - should probably be changed or modified a bit for more broad usage...

Parameters

$table : string: Table name
$fieldArray : array<string|int, mixed>: Field array to insert as a record
$realPid : int: The value of PID field.

Internal

should only be used from within DataHandler

Return values

int|null —

Returns the new ID of the record (if applicable)

insertUpdateDB_preprocessBasedOnFieldType()

Preprocesses field array based on field type. Some fields must be adjusted before going to database. This is done on the copy of the field array because original values are used in remap action later.


    public
                    insertUpdateDB_preprocessBasedOnFieldType(string $table, array<string|int, mixed> $fieldArray) : array<string|int, mixed>

Parameters

$table : string: Table name
$fieldArray : array<string|int, mixed>: Field array to check

Internal

should only be used from within TYPO3 Core

Return values

array<string|int, mixed> —

Updated field array

int_pageTreeInfo()

Returns array, $CPtable, of pages under the $pid going down to $counter levels.


    public
                    int_pageTreeInfo(array<string|int, mixed> $CPtable, int $pid, int $counter, int $rootID) : array<string|int, mixed>

Selecting ONLY pages which the user has read-access to!

Parameters

$CPtable : array<string|int, mixed>: Accumulation of page uid=>pid pairs in branch of $pid
$pid : int: Page ID for which to find subpages
$counter : int: Number of levels to go down.
$rootID : int: ID of root point for new copied branch: The idea seems to be that a copy is not made of the already new page!

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Return array.

isInWebMount()

Checks if the input page ID is in the BE_USER webmounts


    public
                    isInWebMount(int $pid) : bool

Parameters

$pid : int: Page ID to check

Internal

should only be used from within DataHandler

Return values

bool —

TRUE if OK. Cached results.

isOuterMostInstance()

Determines whether this object is the outermost instance of itself Since DataHandler can create nested objects of itself, this method helps to determine the first (= outermost) one.


    public
                    isOuterMostInstance() : bool

Return values

bool

isRecordCopied()

Determine if a record was copied or if a record is the result of a copy action.


    public
                    isRecordCopied(string $table, int $uid) : bool

Parameters

$table : string: The tablename of the record
$uid : int: The uid of the record

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if the record is copied or is the result of a copy action

isRecordInWebMount()

Checking if a record with uid $id from $table is in the BE_USERS webmounts which is required for editing etc.


    public
                    isRecordInWebMount(string $table, int $id) : bool

Parameters

$table : string: Table name
$id : int: UID of record

Internal

should only be used from within DataHandler

Return values

bool —

Returns TRUE if OK. Cached results.

isReferenceField()

Returns TRUE if the TCA/columns field type is a DB reference field


    public
                    isReferenceField(array<string|int, mixed> $conf) : bool

Parameters

$conf : array<string|int, mixed>: Config array for TCA/columns field

Internal

should only be used from within DataHandler

Return values

bool —

TRUE if DB reference field (group/db or select with foreign-table)

localize()

Localizes a record to another system language


    public
                    localize(string $table, int $uid, int $language) : int|bool

Parameters

$table : string: Table name
$uid : int: Record uid (to be localized)
$language : int: Language ID

Internal

should only be used from within DataHandler

Return values

int|bool —

The uid (int) of the new translated record or FALSE (bool) if something went wrong

log()

Logging actions from DataHandler


    public
                    log(string $table, int $recuid, int $action, int|string $recpid, int $error, string $details[, int $details_nr = -1 ][, array<string|int, mixed> $data = [] ][, int $event_pid = -1 ][, string $NEWid = '' ]) : int

Parameters

$table : string: Table name the log entry is concerned with. Blank if NA
$recuid : int: Record UID. Zero if NA
$action : int: Action number: 0=No category, 1=new record, 2=update record, 3= delete record, 4= move record, 5= Check/evaluate
$recpid : int|string: Normally 0 (zero). If set, it indicates that this log-entry is used to notify the backend of a record which is moved to another location
$error : int: The severity: 0 = message, 1 = error, 2 = System Error, 3 = security notice (admin), 4 warning
$details : string: Default error message in english
$details_nr : int = -1: This number is unique for every combination of $type and $action. This is the error-message number, which can later be used to translate error messages. 0 if not categorized, -1 if temporary
$data : array<string|int, mixed> = []: Array with special information that may go into $details by '%s' marks / sprintf() when the log is shown
$event_pid : int = -1: The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
$NEWid : string = '': NEW id for new records

Internal

should only be used from within TYPO3 Core

Return values

int —

Log entry UID (0 if no log entry was written or logging is disabled)

moveL10nOverlayRecords()

Find l10n-overlay records and perform the requested move action for these records.


    public
                    moveL10nOverlayRecords(string $table, int $uid, int $destPid, int $originalRecordDestinationPid) : void

Parameters

$table : string: Record Table
$uid : int: Record UID
$destPid : int: Position to move to
$originalRecordDestinationPid : int: Position to move the original record to

Internal

should only be used from within DataHandler

moveRecord()

Moving single records


    public
                    moveRecord(string $table, int $uid, int $destPid) : void

Parameters

$table : string: Table name to move
$uid : int: Record uid to move
$destPid : int: Position to move to: $destPid: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

Internal

should only be used from within DataHandler

moveRecord_procBasedOnFieldType()

Move child records depending on the field type of the parent record.


    public
                    moveRecord_procBasedOnFieldType(string $table, int $uid, int $destPid, string $value, array<string|int, mixed> $conf) : void

Parameters

$table : string: Record Table
$uid : int: Record UID
$destPid : int: Position to move to
$value : string: Record field value
$conf : array<string|int, mixed>: TCA configuration of current field

Internal

should only be used from within DataHandler

moveRecord_procFields()

Walk through all fields of the moved record and look for children of e.g. the inline type.


    public
                    moveRecord_procFields(string $table, int $uid, int $destPid) : void

If child records are found, they are also move to the new $destPid.

Parameters

$table : string: Record Table
$uid : int: Record UID
$destPid : int: Position to move to

Internal

should only be used from within DataHandler

moveRecord_raw()

Moves a record without checking security of any sort.


    public
                    moveRecord_raw(string $table, int $uid, int $destPid) : void

USE ONLY INTERNALLY

Parameters

$table : string: Table name to move
$uid : int: Record uid to move
$destPid : int: Position to move to: $destPid: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

Internal

should only be used from within DataHandler

newFieldArray()

Returns a fieldArray with default values. Values will be picked up from the TCA array looking at the config key "default" for each column. If values are set in ->defaultValues they will overrule though.


    public
                    newFieldArray(string $table) : array<string|int, mixed>

Used for new records and during copy operations for defaults

Parameters

$table : string: Table name for which to set default values.

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Array with default values.

printLogErrorMessages()

Print log error messages from the operations of this script instance and return a list of the erroneous records


    public
                    printLogErrorMessages() : array<string|int, non-empty-string>

Internal

should only be used from within TYPO3 Core

Return values

array<string|int, non-empty-string>

process_cmdmap()

Processing the cmd-array See "TYPO3 Core API" for a description of the options.


    public
                    process_cmdmap() : void|bool

Return values

void|bool

process_datamap()

Processing the data-array Call this function to process the data-array set by start()


    public
                    process_datamap() : bool|void

Return values

bool|void

processRemapStack()

Processes the $this->remapStack at the end of copying, inserting, etc. actions.


    public
                    processRemapStack() : void

The remapStack takes care about the correct mapping of new and old uids in case of relational data.

Internal

should only be used from within DataHandler

recordInfo()

Returns the row of a record given by $table and $id NOTICE: No check for deleted or access!


    public
                    recordInfo(string $table, int $id) : array<string|int, mixed>|null

Parameters

$table : string: Table name
$id : int: UID of the record from $table

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>|null —

Returns the selected record on success, otherwise NULL.

registerRecordIdForPageCacheClearing()

Clearing the cache based on a page being updated If the $table is 'pages' then cache is cleared for all pages on the same level (and subsequent?) Else just clear the cache for the parent page of the record.


    public
                    registerRecordIdForPageCacheClearing(string $table, int $uid[, int $pid = null ]) : void

Parameters

$table : string: Table name of record that was just updated.
$uid : int: UID of updated / inserted record
$pid : int = null: REAL PID of page of a deleted/moved record to get TSconfig in ClearCache.

Internal

This method is not meant to be called directly but only from the core itself or from hooks

registerReferenceIndexRowsForDrop()

Delete rows from sys_refindex a table / uid combination is involved in: Either on left side (tablename + recuid) OR right side (ref_table + ref_uid).


    public
                    registerReferenceIndexRowsForDrop(string $table, int $uid, int $workspace) : void

Useful in scenarios like workspace-discard where parents or children are hard deleted: The expensive updateRefIndex() does not need to be called since we can just drop straight ahead.

Parameters

$table : string: Table name, used as tablename and ref_table
$uid : int: Record uid, used as recuid and ref_uid
$workspace : int: Workspace the record lives in

Internal

should only be used from within DataHandler

registerReferenceIndexUpdateForReferencesToItem()

Helper method to access referenceIndexUpdater->registerUpdateForReferencesToItem() from within workspace DataHandlerHook.


    public
                    registerReferenceIndexUpdateForReferencesToItem(string $table, int $uid, int $workspace[, int|null $targetWorkspace = null ]) : void

Parameters

$table : string
$uid : int
$workspace : int
$targetWorkspace : int|null = null

Internal

Exists only for workspace DataHandlerHook. May vanish any time.

remapListedDBRecords()

Processes the fields with references as registered during the copy process. This includes all FlexForm fields which had references.


    public
                    remapListedDBRecords() : void

Internal

should only be used from within DataHandler

remapListedDBRecords_flexFormCallBack()

Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.


    public
                    remapListedDBRecords_flexFormCallBack(array<string|int, mixed> $pParams, array<string|int, mixed> $dsConf, string $dataValue) : array<string|int, mixed>

Parameters

$pParams : array<string|int, mixed>: Set of parameters in numeric array: table, uid, field
$dsConf : array<string|int, mixed>: TCA config for field (from Data Structure of course)
$dataValue : string: Field value (from FlexForm XML)

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Array where the "value" key carries the value.

remapListedDBRecords_procDBRefs()

Performs remapping of old UID values to NEW uid values for a DB reference field.


    public
                    remapListedDBRecords_procDBRefs(array<string|int, mixed> $conf, string $value, int $MM_localUid, string $table) : array<string|int, mixed>|null

Parameters

$conf : array<string|int, mixed>: TCA field config
$value : string: Field value
$MM_localUid : int: UID of local record (for MM relations - might need to change if support for FlexForms should be done!)
$table : string: Table name

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>|null —

Returns array of items ready to implode for field content.

remapListedDBRecords_procFile()

Performs remapping of old UID values to NEW uid values for an file field.


    public
                    remapListedDBRecords_procFile(mixed $conf, mixed $value, mixed $uid, mixed $table) : void

Parameters

$conf : mixed
$value : mixed
$uid : mixed
$table : mixed

Internal

should only be used from within DataHandler

remapListedDBRecords_procInline()

Performs remapping of old UID values to NEW uid values for an inline field.


    public
                    remapListedDBRecords_procInline(array<string|int, mixed> $conf, string $value, int $uid, string $table) : void

Parameters

$conf : array<string|int, mixed>: TCA field config
$value : string: Field value
$uid : int: The uid of the ORIGINAL record
$table : string: Table name

Internal

should only be used from within DataHandler

resolvePid()

Get the final pid based on $table and $pid ($destPid type... pos/neg)


    public
                    resolvePid(string $table, int $pid) : int

Parameters

$table : string: Table name
$pid : int: "Destination pid" : If the value is >= 0 it's just returned directly (through (int)though) but if the value is <0 then the method looks up the record with the uid equal to abs($pid) (positive number) and returns the PID of that record! The idea is that negative numbers point to the record AFTER WHICH the position is supposed to be!

Internal

should only be used from within DataHandler

Return values

int

setControl()


    public
                    setControl(array<string|int, mixed> $control) : void

Parameters

$control : array<string|int, mixed>

Internal

setCorrelationId()


    public
                    setCorrelationId(CorrelationId $correlationId) : void

Parameters

$correlationId : CorrelationId

setDefaultsFromUserTS()

Initializes default values coming from user TSconfig


    public
                    setDefaultsFromUserTS(array<string|int, mixed> $userTS) : void

Parameters

$userTS : array<string|int, mixed>: User TSconfig array

Internal

should only be used from within DataHandler

setHistory()

Setting sys_history record, based on content previously set in $this->historyRecords[$table . ':' . $id] (by compareFieldArrayWithCurrentAndUnset())


    public
                    setHistory(string $table, int $id) : void

This functionality is now moved into the RecordHistoryStore and can be used instead.

Parameters

$table : string: Table name
$id : int: Record ID

Internal

should only be used from within DataHandler

setMirror()

Function that can mirror input values in datamap-array to other uid numbers.


    public
                    setMirror(array<string|int, mixed> $mirror) : void

Example: $mirror[table][11] = '22,33' will look for content in $this->datamap[table][11] and copy it to $this->datamap[table][22] and $this->datamap[table][33]

Parameters

$mirror : array<string|int, mixed>: This array has the syntax $mirror[table_name][uid] = [list of uids to copy data-value TO!]

Internal

start()

Initializing.


    public
                    start(array<string|int, mixed> $dataMap, array<string|int, mixed> $commandMap[, BackendUserAuthentication|null $backendUser = null ][, ReferenceIndexUpdater|null $referenceIndexUpdater = null ]) : void

For details, see 'TYPO3 Core API' document. This method does not start the processing of data, but merely initializes the object.

Parameters

$dataMap : array<string|int, mixed>: Data to be modified or inserted in the database
$commandMap : array<string|int, mixed>: Commands to copy, move, delete, localize, versionize records.
$backendUser : BackendUserAuthentication|null = null: An alternative user, default is $GLOBALS['BE_USER']
$referenceIndexUpdater : ReferenceIndexUpdater|null = null

updateDB()

Update database record Does not check permissions but expects them to be verified on beforehand


    public
                    updateDB(string $table, int $id, array<string|int, mixed> $fieldArray) : void

Parameters

$table : string: Record table name
$id : int: Record uid
$fieldArray : array<string|int, mixed>: Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done.

Internal

should only be used from within DataHandler

updateRefIndex()


    public
                    updateRefIndex(string $table, int $uid[, int|null $workspace = null ]) : void

Should be called on almost any update to a record which could affect references inside the record.

Parameters

$table : string: Table name
$uid : int: Record UID
$workspace : int|null = null: Workspace the record lives in

Internal

should only be used from within DataHandler

versionizeRecord()

Creates a new version of a record (Requires support in the table)


    public
                    versionizeRecord(string $table, int $id, string $label[, bool $delete = false ]) : int|null

Parameters

$table : string: Table name
$id : int: Record uid to versionize
$label : string: Version label
$delete : bool = false: If TRUE, the version is created to delete the record.

Internal

should only be used from within DataHandler

Return values

int|null —

Returns the id of the new version (if any)

versionPublishManyToManyRelations()

Handle MM relations attached to a record when publishing a workspace record.


    public
                    versionPublishManyToManyRelations(string $table, array<string|int, mixed> $liveRecord, array<string|int, mixed> $workspaceRecord, int $fromWorkspace) : void

Strategy:

Find all MM tables the record can be attached to by scanning TCA. Handle flex form "first level" fields too, but skip scanning for MM relations in container sections, since core does not support that since v7 - FormEngine throws an exception in this case.
For each found MM table: Delete current MM rows of the live record, and update MM rows of the workspace record to now point to the live record.

Parameters

$table : string
$liveRecord : array<string|int, mixed>
$workspaceRecord : array<string|int, mixed>
$fromWorkspace : int

Internal

should only be used from within DataHandler

workspaceCannotEditOfflineVersion()

Evaluates if a user is allowed to edit the offline version


    public
                    workspaceCannotEditOfflineVersion(string $table, array<string|int, mixed> $record) : string

Parameters

$table : string: Table of record
$record : array<string|int, mixed>: array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)

Internal

this method will be moved to EXT:workspaces

Return values

string —

String error code, telling the failure state. FALSE=All ok

workspaceCannotEditRecord()

Checking if editing of an existing record is allowed in current workspace if that is offline.


    public
                    workspaceCannotEditRecord(string $table, array<string|int, mixed>|int $recData) : string|false

Rules for editing in offline mode:

record supports versioning and is an offline version from workspace and has the current stage
or record (any) is in a branch where there is a page which is a version from the workspace and where the stage is not preventing records

Parameters

$table : string: Table of record
$recData : array<string|int, mixed>|int: Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_oid, t3ver_stage (if versioningWS is set)

Internal

should only be used from within TYPO3 Core

Return values

string|false —

String error code, telling the failure state. FALSE=All ok

addDefaultPermittedLanguageIfNotSet()

If a "languageField" is specified for $table this function will add a possible value to the incoming array if none is found in there already.


    protected
                    addDefaultPermittedLanguageIfNotSet(string $table, array<string|int, mixed> $incomingFieldArray, int $pageId) : array<string|int, mixed>

Parameters

$table : string
$incomingFieldArray : array<string|int, mixed>
$pageId : int

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed>

addDeleteRestriction()

Add delete restriction if not disabled


    protected
                    addDeleteRestriction(QueryRestrictionContainerInterface $restrictions) : void

Parameters

$restrictions : QueryRestrictionContainerInterface

applyDefaultsForFieldArray()

When a new record is created, all values that haven't been set but are set via PageTSconfig / UserTSconfig get applied here.


    protected
                    applyDefaultsForFieldArray(string $table, int $pageId, array<string|int, mixed> $prepopulatedFieldArray) : array<string|int, mixed>

This is only executed for new records. The most important part is that the pageTS of the actual resolved $pid is taken, and a new field array with empty defaults is set again.

Parameters

$table : string
$pageId : int
$prepopulatedFieldArray : array<string|int, mixed>

Return values

array<string|int, mixed>

applyFiltersToValues()

Applies the filter methods from a column's TCA configuration to a value array.


    protected
                    applyFiltersToValues(array<string|int, mixed> $tcaFieldConfiguration, array<string|int, mixed> $values) : array<string|int, mixed>|mixed

Parameters

$tcaFieldConfiguration : array<string|int, mixed>
$values : array<string|int, mixed>

Return values

array<string|int, mixed>|mixed

castReferenceValue()

Casts a reference value. In case MM relations or foreign_field references are used. All other configurations, as well as foreign_table(!) could be stored as comma-separated-values as well. Since the system is not able to determine the default value automatically then, the TCA default value is used if it has been defined.


    protected
                    castReferenceValue(int|string $value, array<string|int, mixed> $configuration, bool $isNew) : int|string

Parameters

$value : int|string: The value to be casted (e.g. '', '0', '1,2,3')
$configuration : array<string|int, mixed>: The TCA configuration of the accordant field
$isNew : bool: is the record new or not

Return values

int|string

checkForRecordsFromDisallowedTables()

Check if there are records from tables on the pages to be deleted which the current user is not allowed to


    protected
                    checkForRecordsFromDisallowedTables(array<string|int, int> $pageIds) : array<string|int, string>|null

Parameters

$pageIds : array<string|int, int>: IDs of pages which should be checked

Return values

array<string|int, string>|null —

Return null, if permission granted, otherwise an array with the tables that are not allowed to be deleted

checkValue_file_processDBdata()

Returns data for file fields.


    protected
                    checkValue_file_processDBdata(mixed $valueArray, mixed $tcaFieldConf, mixed $id, mixed $table) : mixed

Parameters

$valueArray : mixed
$tcaFieldConf : mixed
$id : mixed
$table : mixed

checkValue_inline_processDBdata()

Returns data for inline fields.


    protected
                    checkValue_inline_processDBdata(array<string|int, mixed> $valueArray, array<string|int, mixed> $tcaFieldConf, int $id, string $status, string $table, string $field) : string

Parameters

$valueArray : array<string|int, mixed>: Current value array
$tcaFieldConf : array<string|int, mixed>: TCA field config
$id : int: Record id
$status : string: Status string ('update' or 'new')
$table : string: Table name, needs to be passed to \TYPO3\CMS\Core\Database\RelationHandler
$field : string: The current field the values are modified for

Return values

string —

Modified values

checkValueForCategory()

Evaluate 'category' type values


    protected
                    checkValueForCategory(array<string|int, mixed> $result, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, string $status, string $field) : array<string|int, mixed>

Parameters

$result : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int|string: uid of record
$status : string: The status - 'update' or 'new' flag
$field : string: Field name

Return values

array<string|int, mixed>

checkValueForCheck()

Evaluates 'check' type values.


    protected
                    checkValueForCheck(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, int $realPid, string $field) : array<string|int, mixed>

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$field : string: Field name

Return values

array<string|int, mixed> —

Modified $res array

checkValueForColor()

Evaluate "color" type values.


    protected
                    checkValueForColor(string $value, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForDatetime()

Evaluate 'datetime' type values


    protected
                    checkValueForDatetime(mixed $value, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>

Parameters

$value : mixed: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA

Return values

array<string|int, mixed>

checkValueForEmail()

Evaluate "email" type values.


    protected
                    checkValueForEmail(string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, int $realPid, string $field) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int|string: UID of record - might be a NEW.. string for new records
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$field : string: Field name

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForFlex()

Evaluates 'flex' type values.


    protected
                    checkValueForFlex(array<string|int, mixed> $res, string|array<string|int, mixed> $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, mixed $curValue, string $status, int $realPid, string $recFID, int $tscPID, string $field) : array<string|int, mixed>

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string|array<string|int, mixed>: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$curValue : mixed: Current value of the field
$status : string: 'update' or 'new' flag
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$recFID : string: Field identifier [table:uid:field] for flexforms
$tscPID : int: TSconfig PID
$field : string: Field name

Return values

array<string|int, mixed> —

Modified $res array

checkValueForGroupFolderSelect()

Evaluates 'group', 'folder' or 'select' type values.


    protected
                    checkValueForGroupFolderSelect(array<string|int, mixed> $res, string|array<string|int, mixed> $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, string $status, string $field) : array<string|int, mixed>

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string|array<string|int, mixed>: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$status : string: 'update' or 'new' flag
$field : string: Field name

Return values

array<string|int, mixed> —

Modified $res array

checkValueForInput()

Evaluate "input" type values.


    protected
                    checkValueForInput(string $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, int $realPid, string $field) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$field : string: Field name

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForInternalReferences()

Checks values that are used for internal references. If the provided $value is a NEW-identifier, the direct processing is stopped. Instead, the value is forwarded to the remap-stack to be post-processed and resolved into a proper UID after all data has been resolved.


    protected
                    checkValueForInternalReferences(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, string $field) : array<string|int, mixed>

This method considers TCA types that cannot handle and resolve these internal values directly, like 'passthrough', 'none' or 'user'. Values are only modified here if the $field is used as 'transOrigPointerField' or 'translationSource'.

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int|string: UID of record
$field : string: The field name

Return values

array<string|int, mixed> —

The result array. The processed value (if any!) is set in the "value" key.

checkValueForJson()

Evaluate "json" type values.


    protected
                    checkValueForJson(array<string|int, mixed>|string $value, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>

Parameters

$value : array<string|int, mixed>|string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA

Return values

array<string|int, mixed> —

The result array. The processed value (if any!) is set in the "value" key.

checkValueForLanguage()

Evaluate "language" type value.


    protected
                    checkValueForLanguage(int $value, string $table, string $field) : array<string|int, mixed>

Checks whether the user is allowed to add such a value as language

Parameters

$value : int: The value to set.
$table : string: Table name
$field : string: Field name

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForLink()

Evaluate "link" type values.


    protected
                    checkValueForLink(string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, string $field) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int|string: UID of record - might be a NEW.. string for new records
$field : string: The name of the current field

Return values

array<string|int, mixed> —

The result array. The processed value (if any!) is set in the "value" key.

checkValueForNumber()

Evaluate 'number' type values


    protected
                    checkValueForNumber(mixed $value, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>

Parameters

$value : mixed: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA

Return values

array<string|int, mixed>

checkValueForPassword()

Evaluate "password" type values.


    protected
                    checkValueForPassword(string $value, array<string|int, mixed> $tcaFieldConf, string $table, int|string $id, int $realPid[, array<string|int, mixed> $incomingFieldArray = [] ]) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int|string: UID of record - might be a NEW.. string for new records
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$incomingFieldArray : array<string|int, mixed> = []: the fields being explicitly set by the outside (unlike $fieldArray) for the record

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForRadio()

Evaluates 'radio' type values.


    protected
                    checkValueForRadio(array<string|int, mixed> $res, string $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, int $pid, string $field) : array<string|int, mixed>

Parameters

$res : array<string|int, mixed>: The result array. The processed value (if any!) is set in the 'value' key.
$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: The table of the record
$id : int: The id of the record
$pid : int: The pid of the record
$field : string: The field to check

Return values

array<string|int, mixed> —

Modified $res array

checkValueForSlug()

Evaluate "slug" type values.


    protected
                    checkValueForSlug(string $value, array<string|int, mixed> $tcaFieldConf, string $table, int $id, int $realPid, string $field[, array<string|int, mixed> $incomingFieldArray = [] ]) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$id : int: UID of record
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$field : string: Field name
$incomingFieldArray : array<string|int, mixed> = []: the fields being explicitly set by the outside (unlike $fieldArray) for the record

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForText()

Evaluate "text" type values.


    protected
                    checkValueForText(string|null $value, array<string|int, mixed> $tcaFieldConf, string $table, int $realPid, string $field) : array<string|int, mixed>

Parameters

$value : string|null: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA
$table : string: Table name
$realPid : int: The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.
$field : string: Field name

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

checkValueForUuid()

Evaluate "uuid" type values. Will create a new uuid in case an invalid uuid is provided and the field is marked as required.


    protected
                    checkValueForUuid(string $value, array<string|int, mixed> $tcaFieldConf) : array<string|int, mixed>

Parameters

$value : string: The value to set.
$tcaFieldConf : array<string|int, mixed>: Field configuration from TCA

Return values

array<string|int, mixed> —

$res The result array. The processed value (if any!) is set in the "value" key.

controlActiveElements()

Controls active elements and sets NULL values if not active.


    protected
                    controlActiveElements() : void

Datamap is modified accordant to submitted control values.

copy_remapTranslationSourceField()

Remap languageSource field to uids of newly created records


    protected
                    copy_remapTranslationSourceField(string $table, array<string|int, mixed> $l10nRecords, array<string|int, mixed> $languageSourceMap) : void

Parameters

$table : string: Table name
$l10nRecords : array<string|int, mixed>: array of localized records from the page we're copying from (source records)
$languageSourceMap : array<string|int, mixed>: array mapping source records uids to newly copied uids

copyL10nOverlayRecords()

Find l10n-overlay records and perform the requested copy action for these records.


    protected
                    copyL10nOverlayRecords(string $table, int $uid, int $destPid[, bool $first = false ][, array<string|int, mixed> $overrideValues = [] ][, string $excludeFields = '' ]) : void

Parameters

$table : string
$uid : int: uid default language record
$destPid : int: Position to copy to
$first : bool = false
$overrideValues : array<string|int, mixed> = []
$excludeFields : string = ''

copyRecord_processManyToMany()

Processes the children of an MM relation field (select, group, inline) when the parent record is copied.


    protected
                    copyRecord_processManyToMany(string $table, int $uid, string $field, string $value, array<string|int, mixed> $conf, int $language) : string

Parameters

$table : string
$uid : int
$field : string
$value : string
$conf : array<string|int, mixed>
$language : int

Return values

string

copyRecord_processRelation()

Processes relations in an inline (IRRE) or file element when the parent record is copied.


    protected
                    copyRecord_processRelation(string $table, int $uid, string $field, string $value, array<string|int, mixed> $row, array<string|int, mixed> $conf, int $realDestPid, int $language, array<string|int, mixed> $workspaceOptions) : string

Parameters

$table : string
$uid : int
$field : string
$value : string
$row : array<string|int, mixed>
$conf : array<string|int, mixed>
$realDestPid : int
$language : int
$workspaceOptions : array<string|int, mixed>

Return values

string

createRelationHandlerInstance()


    protected
                    createRelationHandlerInstance() : RelationHandler

Return values

RelationHandler

deleteSpecificPage()

Delete a page (or set deleted field to 1) and all records on it.


    protected
                    deleteSpecificPage(int $uid, bool $forceHardDelete, bool $deleteRecordsOnPage) : void

Parameters

$uid : int: Page id
$forceHardDelete : bool: If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
$deleteRecordsOnPage : bool: If false, records on the page will not be deleted (edge case while swapping workspaces)

Internal

discardCsvReferencesToRecord()

When the to-discard record is the target of a CSV group field of another table record, these records need to be updated to no longer point to the discarded record.


    protected
                    discardCsvReferencesToRecord(string $table, array<string|int, mixed> $record) : void

Those referencing records are not very easy to find with only the to-discard record being available. The solution used here looks up records referencing the to-discard record by fetching a list of references from sys_refindex, where the to-discard record is on the right side (ref_* fields) and in the workspace the to-discard record lives in. The referencing record fields are then updated to drop the to-discard record from the CSV list.

Using sys_refindex for this task is a bit risky: This would fail if a DataHandler call adds a reference to the record and requests discarding the record in one call - the refindex is always only updated at the very end of a DataHandler call, the logic below wouldn't catch this since it would be based on an outdated sys_refindex. The scenario however is of little use and not used in core, so it should be fine.

Parameters

$table : string: Table name of this record
$record : array<string|int, mixed>: The record row to handle

discardLocalizationOverlayRecords()

Find localization overlays of a record and discard them.


    protected
                    discardLocalizationOverlayRecords(string $table, array<string|int, mixed> $record) : void

Parameters

$table : string: Table of this record
$record : array<string|int, mixed>: Record row

discardLocalizedWorkspaceVersionsOfRecord()

When deleting a live element with sys_language_uid = 0, there may be translated records that have been created in workspaces only (t3ver_state=1). Those have to be discarded explicitly since the other 'delete' related code does not consider this case, otherwise the 'new' workspace translation would be dangling when the live record is gone.


    protected
                    discardLocalizedWorkspaceVersionsOfRecord(string $table, int $uid) : void

Parameters

$table : string
$uid : int

discardMmRelations()

When a workspace record row is discarded that has mm relations, existing mm table rows need to be deleted. The method performs the delete operation depending on TCA field configuration.


    protected
                    discardMmRelations(string $table, array<string|int, mixed> $fieldConfig, array<string|int, mixed> $record) : void

Parameters

$table : string: Table name of this record
$fieldConfig : array<string|int, mixed>: TCA configuration of this field
$record : array<string|int, mixed>: The full record of a left- or ride-side relation

discardRecordRelations()

Discard record relations like inline and MM of a record.


    protected
                    discardRecordRelations(string $table, array<string|int, mixed> $record) : void

Parameters

$table : string: Table name of this record
$record : array<string|int, mixed>: The record row to handle

discardSubPagesAndRecordsOnPage()

Also discard any sub pages and records of a new parent page if this page is discarded.


    protected
                    discardSubPagesAndRecordsOnPage(array<string|int, mixed> $page) : void

Discarding only in specific localization, if needed.

Parameters

$page : array<string|int, mixed>: Page record row

discardWorkspaceVersionsOfRecord()

Discard workspace overlays of a live record: When a live row is deleted, all existing workspace overlays are discarded.


    protected
                    discardWorkspaceVersionsOfRecord(string $table, int $uid) : void

Parameters

$table : string: Table name
$uid : int: Record UID

Internal

should only be used from within DataHandler

doesBranchExist()

Checks if a whole branch of pages exists.


    protected
                    doesBranchExist(int $pid, int $permissions[, array<string|int, mixed> $pageIdsInBranch = [] ]) : array<string|int, int>|null

Tests the branch under $pid like doesRecordExist(), but it doesn't test the page with $pid as uid - use doesRecordExist() for this purpose.

Parameters

$pid : int: Page ID to select subpages from.
$permissions : int: Perms integer to check each page record for.
$pageIdsInBranch : array<string|int, mixed> = []: List of page uids, this is added to and returned in the end

Internal

should only be used from within DataHandler

Return values

array<string|int, int>|null —

List of page IDs in branch, if there are subpages, empty array if there are none or null if no permission

doesRecordExist_pageLookUp()

Looks up a page based on permissions.


    protected
                    doesRecordExist_pageLookUp(int $id, int $perms[, array<string|int, mixed> $columns = ['uid'] ]) : array<string|int, mixed>|false

Parameters

$id : int: Page id
$perms : int: Permission integer
$columns : array<string|int, mixed> = ['uid']: Columns to select

Internal

Return values

array<string|int, mixed>|false

fixCopyAfterDuplFields()

When a record is copied you can specify fields from the previous record which should be copied into the new one


    protected
                    fixCopyAfterDuplFields(string $table, int $prevUid) : array<string|int, mixed>

Parameters

$table : string: Table name
$prevUid : int: UID of previous record

Internal

should only be used from within DataHandler

Return values

array<string|int, mixed> —

Output array (For when the copying operation needs to get the information instead of updating the info)

fixUniqueInSite()

Checks if any uniqueInSite eval fields are in the record and if so, they are re-written to be correct.


    protected
                    fixUniqueInSite(string $table, int $uid) : bool

Parameters

$table : string: Table name
$uid : int: Record UID

Return values

bool —

whether the record had to be fixed or not

fixUniqueInSiteForSubpages()

Check if there are subpages that need an adoption as well


    protected
                    fixUniqueInSiteForSubpages(int $pageId) : void

Parameters

$pageId : int

formatLogDetails()

Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.


    protected
                    formatLogDetails(string $detailString, mixed $substitutes) : string

Parameters

$detailString : string
$substitutes : mixed

Return values

string

formatLogDetailsStatic()

Static version for ViewHelpers etc.


    protected
            static        formatLogDetailsStatic(string $detailString, array<string|int, mixed> $substitutes) : string

Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.

Parameters

$detailString : string
$substitutes : array<string|int, mixed>

Return values

string

getAllowedTablesToCopyWhenCopyingAPage()

Compile a list of tables that should be copied along when a page is about to be copied.


    protected
                    getAllowedTablesToCopyWhenCopyingAPage() : array<string|int, mixed>

First, get the list that the user is allowed to modify (all if admin), and then check against a possible limitation within "DataHandler->copyWhichTables" if not set to "*" to limit the list further down

Return values

array<string|int, mixed>

getCheckModifyAccessListHookObjects()

Gets the 'checkModifyAccessList' hook objects.


    protected
                    getCheckModifyAccessListHookObjects() : array<string|int, mixed>

The first call initializes the accordant objects.

Return values

array<string|int, mixed> —

The 'checkModifyAccessList' hook objects (if any)

getCommandMapElements()

Gets elements of the command map that match a particular command.


    protected
                    getCommandMapElements(string $needle) : array<string|int, mixed>

Parameters

$needle : string: The command to be matched

Return values

array<string|int, mixed>

getDefaultLanguagePageId()

Find out if the record is a localization. If so, get the uid of the default language page.


    protected
                    getDefaultLanguagePageId(int $pageId) : int

Always returns the uid of the workspace live record: No explicit workspace overlay is applied.

Parameters

$pageId : int: Page UID, can be the default page record, or a page translation record ID

Return values

int —

UID of the default page record in live workspace

getLanguageService()


    protected
                    getLanguageService() : LanguageService

Return values

LanguageService

getLocalTCE()

Returns an instance of DataHandler for handling local datamaps/cmdmaps


    protected
                    getLocalTCE() : DataHandler

Return values

DataHandler

getOriginalParentOfRecord()

Gets UID of parent record. If record is deleted it will be looked up in an array built before the record was deleted


    protected
                    getOriginalParentOfRecord(string $table, int $uid) : array<string|int, int>

Parameters

$table : string: Table where record lives/lived
$uid : int: Record UID

Return values

array<string|int, int> —

Parent UIDs

getOuterMostInstance()

Gets the outer most instance of \TYPO3\CMS\Core\DataHandling\DataHandler Since \TYPO3\CMS\Core\DataHandling\DataHandler can create nested objects of itself, this method helps to determine the first (= outer most) one.


    protected
                    getOuterMostInstance() : DataHandler

Return values

DataHandler

getPreviousLocalizedRecordUid()

Returning uid of "previous" localized record, if any, for tables with a "sortby" column.


    protected
                    getPreviousLocalizedRecordUid(string $table, int $uid, int $pid, int $targetLanguage) : int

Used when records are localized, so that localized records are sorted in the same order as the source language records.

The uid of the returned record is later used to create the localized record "after" (higher sorting value) than the one the uid is returned of.

There are basically two scenarios:

The localized record is to be placed as the first record of the target pid/language combination. In this case, there is no "before" record in this language. The method returns input $uid, saying "insert the localized record with a higher sorting value than the record the localization is created from".
There is a localized record "before" (lower sorting value) in the target pid/language combination. For instance because source language element 2 is being translated and source language element 1 has already been translated. In this case, the uid of the 'element 1' is returned, saying "insert the localized record with a higher sorting value than the "before" record in this language.

The algorithm first fetches the record of given input uid. It then looks if there is a record with a lower sorting value for this pid/language combination. If no, input uid is returned ("place with higher sorting than source language record"). If yes, it looks if there is a localization of that source record in the target language and return the uid of that target language record ("place with higher sorting that this traget language record"). When dealing with table tt_content, colpos is also taken into account.

Parameters

$table : string: Table name
$uid : int: Uid of source language record
$pid : int: Pid of source language record
$targetLanguage : int: Target language id

Return values

int —

uid of record after which the localized record should be inserted

getRecordHistoryStore()


    protected
                    getRecordHistoryStore() : RecordHistoryStore

Return values

RecordHistoryStore

getSiteLanguageForPage()

Find a site language by the given language ID for a specific page, and check for all available sites if the page ID is "0".


    protected
                    getSiteLanguageForPage(int $pageId, int $languageId) : SiteLanguage|null

Note: Currently, the first language matching the given id is used, while there might be more languages with the same id in additional sites.

Parameters

$pageId : int
$languageId : int

Return values

SiteLanguage|null

getUniqueCountStatement()

Gets the count of records for a unique field


    protected
                    getUniqueCountStatement(string $value, string $table, string $field, int $uid, int $pid) : QueryBuilder

Parameters

$value : string: The string value which should be unique
$table : string: Table name
$field : string: Field name for which $value must be unique
$uid : int: UID to filter out in the lookup (the record itself...)
$pid : int: If set, the value will be unique for this PID

Return values

QueryBuilder —

Return the prepared statement to check uniqueness

hardDeleteSingleRecord()

Simple helper method to hard delete one row from table ignoring delete TCA field


    protected
                    hardDeleteSingleRecord(string $table, int $uid) : void

Parameters

$table : string: A row from this table should be deleted
$uid : int: Uid of row to be deleted

increaseSortingOfFollowingRecords()

Increases sorting field value of all records with sorting higher than $sortingValue


    protected
                    increaseSortingOfFollowingRecords(string $table, int $pid[, int|null $sortingValue = null ]) : void

Used internally by getSortNumber() to "make space" in sorting values when inserting new record

Parameters

$table : string: Table name
$pid : int: Page Uid in which to resort records
$sortingValue : int|null = null: All sorting numbers larger than this number will be shifted

initializeSlugFieldsToEmptyString()

New records capable of handling slugs (TCA type 'slug'), always require the field value to be set, in order to run through the validation process to create a new slug. Fields having `null` as value are ignored and can be used to by-pass implicit slug initialization.


    protected
                    initializeSlugFieldsToEmptyString(string $tableName, array<string|int, mixed> $fieldValues) : array<string|int, mixed>

Parameters

$tableName : string
$fieldValues : array<string|int, mixed>

Return values

array<string|int, mixed>

inlineLocalizeSynchronize()

Performs localization or synchronization of child records.


    protected
                    inlineLocalizeSynchronize(string $table, int $id, array<string|int, mixed> $command) : void

The $command argument expects an array, but supports a string for backward-compatibility.

$command = array( 'field' => 'tx_myfieldname', 'language' => 2, // either the key 'action' or 'ids' must be set 'action' => 'synchronize', // or 'localize' 'ids' => array(1, 2, 3, 4) // child element ids );

Parameters

$table : string: The table of the localized parent record
$id : int: The uid of the localized parent record
$command : array<string|int, mixed>: Defines the command to be performed (see example above)

isElementToBeDeleted()

Determines whether an element was registered to be deleted in the registry.


    protected
                    isElementToBeDeleted(string $table, int $id) : bool

Parameters

$table : string: Name of the table
$id : int: Uid of the record

Return values

bool

isNestedElementCallRegistered()

Determines nested element calls.


    protected
                    isNestedElementCallRegistered(string $table, int $id, string $identifier) : bool

Parameters

$table : string: Name of the table
$id : int: Uid of the record
$identifier : string: Name of the action to be checked

Return values

bool

isRecordLocalized()

Returns true if a localization of a record exists.


    protected
                    isRecordLocalized(string $table, int $uid, int $language) : bool

Parameters

$table : string
$uid : int
$language : int

Return values

bool

isSubmittedValueEqualToStoredValue()

Determines whether submitted values and stored values are equal.


    protected
                    isSubmittedValueEqualToStoredValue(mixed $submittedValue, mixed $storedValue, string $storedType[, bool $allowNull = false ]) : bool

This prevents from adding superfluous field changes which would be shown in the record history as well. For NULL fields (see accordant TCA definition 'nullable'), a special handling is required since (!strcmp(NULL, '')) would be a false-positive.

Parameters

$submittedValue : mixed: Value that has submitted (e.g. from a backend form)
$storedValue : mixed: Value that is currently stored in the database
$storedType : string: SQL type of the stored value column (see mysql_field_type(), e.g 'int', 'string', ...)
$allowNull : bool = false: Whether NULL values are allowed by accordant TCA definition ('nullable')

Return values

bool —

Whether both values are considered to be equal

isTableAllowedForThisPage()

Checks if a table is allowed on a certain page id according to allowed tables set for the page "doktype" and its [ctrl][rootLevel]-settings if any.


    protected
                    isTableAllowedForThisPage(int $pageUid, string $checkTable) : bool

Parameters

$pageUid : int: Page id for which to check, including 0 (zero) if checking for page tree root.
$checkTable : string: Table name to check

Internal

should only be used from within DataHandler

Return values

bool —

TRUE if OK

overlayAutoVersionId()

Overlays the automatically versionized id of a record.


    protected
                    overlayAutoVersionId(string $table, int $id) : int

Parameters

$table : string: Name of the table
$id : int: Uid of the record

Return values

int

pageInfo()

Returns the value of the $field from page $id NOTICE; the function caches the result for faster delivery next time. You can use this function repeatedly without performance loss since it doesn't look up the same record twice!


    protected
                    pageInfo(int $id, string $field) : string|int|null

Parameters

$id : int: Page uid
$field : string: Field name for which to return value

Internal

should only be used from within DataHandler

Return values

string|int|null —

Value of the field. Result is cached in $this->pageCache[$id][$field] and returned from there next time!

postProcessDatabaseInsert()

Entry point to post process a database insert. Currently bails early unless a UID has been forced and the database platform is not MySQL.


    protected
                    postProcessDatabaseInsert(Connection $connection, string $tableName, int $suggestedUid) : int

Parameters

$connection : Connection
$tableName : string
$suggestedUid : int

Return values

int

postProcessPostgresqlInsert()

PostgreSQL works with sequences for auto increment columns. A sequence is not updated when a value is written to such a column. To avoid clashes when the sequence returns an existing ID this helper will update the sequence to the current max value of the column.


    protected
                    postProcessPostgresqlInsert(Connection $connection, string $tableName) : void

Parameters

$connection : Connection
$tableName : string

prepareCacheFlush()

Prepare the cache clearing


    protected
                    prepareCacheFlush(string $table, int $uid, int $pid) : array<string|int, mixed>

Parameters

$table : string: Table name of record that needs to be cleared
$uid : int: UID of record for which the cache needs to be cleared
$pid : int: Original pid of the page of the record which the cache needs to be cleared

Internal

This function is internal only it may be changed/removed also in minor version numbers.

Return values

array<string|int, mixed> —

Array with tagsToClear and clearCacheCommands

prependLabel()

Return "copy" label for a table. Although the name is "prepend" it actually APPENDs the label (after ...)


    protected
                    prependLabel(string $table) : string

Parameters

$table : string: Table name

Return values

string —

Label to append, containing "%s" for the number

processClearCacheQueue()

Do the actual clear cache


    protected
                    processClearCacheQueue() : void

recordInfoWithPermissionCheck()

Checks if record exists with and without permission check and returns that row


    protected
                    recordInfoWithPermissionCheck(string $table, int $id, int $perms[, string $fieldList = '*' ]) : array<string, mixed>|false

Parameters

$table : string

Record table name

$id : int

Record UID

$perms : int

Permission restrictions to observe: An integer that will be bitwise AND'ed.

$fieldList : string = '*'

fields - default is '*'

Return values

array<string, mixed>|false —

Row if exists and accessible, false otherwise

registerElementsToBeDeleted()

Registers elements to be deleted in the registry.


    protected
                    registerElementsToBeDeleted() : void

registerNestedElementCall()

Registers nested elements calls.


    protected
                    registerNestedElementCall(string $table, int $id, string $identifier) : void

This is used to track nested calls (e.g. for following m:n relations).

Parameters

$table : string: Name of the table
$id : int: Uid of the record
$identifier : string: Name of the action to be tracked

resetElementsToBeDeleted()

Resets the elements to be deleted in the registry.


    protected
                    resetElementsToBeDeleted() : void

resetNestedElementCalls()

Resets the nested element calls.


    protected
                    resetNestedElementCalls() : void

resolveFieldConfigurationAndRespectColumnsOverrides()

Use columns overrides for evaluation.


    protected
                    resolveFieldConfigurationAndRespectColumnsOverrides(string $table, string $field) : array<string|int, mixed>

Fetch the TCA ["config"] part for a specific field, including the columnsOverrides value. Used for checkValue purposes currently (as it takes the checkValue_currentRecord value).

Parameters

$table : string
$field : string

Return values

array<string|int, mixed>

resolveSortingAndPidForNewRecord()

Sets the "sorting" DB field and the "pid" field of an incoming record that should be added (NEW1234) depending on the record that should be added or where it should be added.


    protected
                    resolveSortingAndPidForNewRecord(string $table, int $pid, array<string|int, mixed> $fieldArray) : array<string|int, mixed>

This method is called from process_datamap()

Parameters

$table : string: the table name of the record to insert
$pid : int: the real PID (numeric) where the record should be
$fieldArray : array<string|int, mixed>: field+value pairs to add

Return values

array<string|int, mixed> —

the modified field array

resolveVersionedRecords()

Resolves versioned records for the current workspace scope.


    protected
                    resolveVersionedRecords(string $tableName, string $fieldNames, string $sortingField, array<string|int, mixed> $liveIds) : array<string|int, mixed>

Delete placeholders are substituted and removed.

Parameters

$tableName : string: Name of the table to be processed
$fieldNames : string: List of the field names to be fetched
$sortingField : string: Name of the sorting field to be used
$liveIds : array<string|int, mixed>: Flat array of (live) record ids

Return values

array<string|int, mixed>

setNullValues()

Sets NULL values in haystack array.


    protected
                    setNullValues(array<string|int, mixed> $active, array<string|int, mixed> &$haystack) : void

The general behaviour in the user interface is to enable/activate fields. Thus, this method uses NULL as value to be stored if a field is not active.

Parameters

$active : array<string|int, mixed>: hierarchical array with active elements
$haystack : array<string|int, mixed>: hierarchical array with haystack to be modified

undeleteRecord()

Restore live records by setting soft-delete flag to 0.


    protected
                    undeleteRecord(string $table, int $uid) : void

Usually only used by ext:recycler. Connected relations (eg. inline) are restored, too. Additional existing localizations are not restored.

Parameters

$table : string: Record table name
$uid : int: Record uid

undeleteRecordRelations()

Check if a to-restore record has inline references and restore them.


    protected
                    undeleteRecordRelations(string $table, int $uid, array<string|int, mixed> $record) : void

Parameters

$table : string: Record table name
$uid : int: Record uid
$record : array<string|int, mixed>: Record row

unserializeLogData()

Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.


    protected
                    unserializeLogData(mixed $logData) : array<string|int, mixed>|null

Parameters

$logData : mixed

Return values

array<string|int, mixed>|null

unsetElementsToBeDeleted()

Unsets elements (e.g. of the data map) that shall be deleted.


    protected
                    unsetElementsToBeDeleted(array<string|int, mixed> $elements) : array<string|int, mixed>

This avoids to modify records that will be deleted later on.

Parameters

$elements : array<string|int, mixed>: Elements to be modified

Return values

array<string|int, mixed>

updateFlexFormData()

Updates FlexForm data.


    protected
                    updateFlexFormData(string $flexFormId, array<string|int, mixed> $modifications) : void

Parameters

$flexFormId : string

e.g.

$modifications : array<string|int, mixed>

Modifications with paths and values (e.g. 'sDEF/lDEV/field/vDEF' => 'TYPO3')

validateValueForRequired()

Checks if required=true is set: if set: checks if the value is not empty (or not "0").


    protected
                    validateValueForRequired(array<string|int, mixed> $tcaFieldConfig, mixed $value) : bool

if not set: does not matter, always returns true:

Parameters

$tcaFieldConfig : array<string|int, mixed>
$value : mixed

Return values

bool —

true if the required flag is set and the value is properly set, or if the required flag is not needed (and thus always valid).

workspaceAllowAutoCreation()

Evaluates if auto creation of a version of a record is allowed.


    protected
                    workspaceAllowAutoCreation(string $table, int $id, int|null $recpid) : bool

Auto-creation of version: In offline workspace, test if versioning is enabled and look for workspace version of input record. If there is no versionized record found we will create one and save to that.

Parameters

$table : string: Table of the record
$id : int: UID of record
$recpid : int|null: PID of record

Internal

should only be used from within TYPO3 Core

Return values

bool —

TRUE if ok.

DataHandler uses LogDataTrait

Attributes

Table of Contents

Constants

Properties

Methods

Constants

CACHE_IDENTIFIER_ELEMENTS_TO_BE_DELETED

CACHE_IDENTIFIER_NESTED_ELEMENT_CALLS_PREFIX

Properties

$admin

$autoVersionIdMap

$BE_USER

$bypassAccessCheckForRecords

$bypassWorkspaceRestrictions

$callBackObj

$checkValue_currentRecord

$cmdmap

Tags

$copyMappingArray

$copyMappingArray_merged

$copyTree

$copyWhichTables

$datamap

Tags

$dbAnalysisStore

$defaultValues

$dontProcessTransformations

$enableLogging

$errorLog

$isImporting

$neverHideAtCopy

$newRelatedIDs

$pagetreeNeedsRefresh

$pagetreeRefreshFieldsFromPages

$registerDBList

$registerDBPids

$remapStack

$remapStackRecords

$reverseOrder

$sortIntervals

$storeLogMessages

$substNEWwithIDs

$substNEWwithIDs_table

$suggestedInsertUids

$userid

$checkModifyAccessListHookObjects

$control

$correlationId

$deletedRecords

$disableDeleteClause

$excludedTablesAndFields

$historyRecords

$isInWebMount_Cache

$isRecordInWebMount_Cache

$mmHistoryRecords

$outerMostInstance

$pageCache

$recInsertAccessCache

$recordPidsForDeletedRecords

$recordsToClearCacheFor

$referenceIndexUpdater

$remapStackActions

$useTransOrigPointerField

Methods

__construct()

Parameters

addRemapAction()

Parameters

canDeletePage()

Parameters

Return values

cannotDeleteRecord()

Parameters

Return values

checkModifyAccessList()

Parameters

Return values

checkRecordInsertAccess()

Parameters