Inheritance diagram for TYPO3\CMS\Backend\Utility\BackendUtility:

Static Public Member Functions
static	deleteClause ($table, $tableAlias='')

static	getRecord ($table, $uid, $fields=' *', $where='', $useDeleteClause=true)

static	getRecordWSOL ($table, $uid, $fields=' *', $where='', $useDeleteClause=true, $unsetMovePointers=false)

static	getRecordRaw ($table, $where='', $fields=' *')

static	getRecordsByField ($theTable, $theField, $theValue, $whereClause='', $groupBy='', $orderBy='', $limit='', $useDeleteClause=true)

static	splitTable_Uid ($str)

static	getSQLselectableList ($in_list, $tablename, $default_tablename)

static	BEenableFields ($table, $inv=false)

static	getRecordLocalization ($table, $uid, $language, $andWhereClause='')

static	BEgetRootLine ($uid, $clause='', $workspaceOL=false)

static	openPageTree ($pid, $clearExpansion)

static	getRecordPath ($uid, $clause, $titleLimit, $fullTitleLimit=0)

static	getExcludeFields ()

static	getExplicitAuthFieldValues ()

static	getOriginalTranslationTable ($table)

static	isTableLocalizable ($table)

static	getInlineLocalizationMode ($table, $fieldOrConfig)

static	readPageAccess ($id, $perms_clause)

static	getTCAtypes ($table, $rec, $useFieldNameAsKey=false)

static	getTCAtypeValue ($table, $row)

static	getSpecConfParts ($defaultExtrasString, $_='')

static	getSpecConfParametersFromArray ($pArr)

static	getFlexFormDS ($conf, $row, $table, $fieldName='', $WSOL=true, $newRecordPidValue=0)

static	getRegisteredFlexForms ($table='tt_content')

static	getPagesTSconfig ($id, $rootLine=null, $returnPartArray=false)

static	implodeTSParams ($p, $k='')

static	getUserNames ($fields='username, usergroup, usergroup_cached_list, uid', $where='')

static	getGroupNames ($fields='title, uid', $where='')

static	getListGroupNames ($fields='title, uid')

static	blindUserNames ($usernames, $groupArray, $excludeBlindedFlag=false)

static	blindGroupNames ($groups, $groupArray, $excludeBlindedFlag=false)

static	daysUntil ($tstamp)

static	date ($tstamp)

static	datetime ($value)

static	time ($value, $withSeconds=true)

static	calcAge ($seconds, $labels=' min\|hrs\|days\|yrs\|min\|hour\|day\|year')

static	dateTimeAge ($tstamp, $prefix=1, $date='')

static	titleAltAttrib ($content)

static	getThumbNail ($thumbScript, $theFile, $tparams='', $size='')

static	titleAttribForPages ($row, $perms_clause='', $includeAttrib=true)

static	getRecordToolTip (array $row, $table='pages')

static	getRecordIconAltText ($row, $table='pages')

static	getLabelFromItemlist ($table, $col, $key)

static	getLabelFromItemListMerged ($pageId, $table, $column, $key)

static	getLabelsFromItemsList ($table, $column, $keyList, array $columnTsConfig=[])

static	getItemLabel ($table, $col, $printAllWrap='')

static	getRecordTitle ($table, $row, $prep=false, $forceResult=true)

static	getRecordTitlePrep ($title, $titleLength=0)

static	getNoRecordTitle ($prep=false)

static	getProcessedValueExtra ($table, $fN, $fV, $fixed_lgd_chars=0, $uid=0, $forceResult=true, $pid=0)

static	getCommonSelectFields ($table, $prefix='', $fields=[])

static	makeConfigForm ($configArray, $defaults, $dataPrefix)

static	helpTextIcon ($table, $field, $_='', $force=false)

static	helpTextArray ($table, $field)

static	cshItem ($table, $field, $_='', $wrap='')

static	editOnClick ($params, $_='', $requestUri='')

static	viewOnClick ($pageUid, $backPath='', $rootLine=null, $anchorSection='', $alternativeUrl='', $additionalGetVars='', $switchFocus=true)

static	wrapClickMenuOnIcon ( $content, $table, $uid=0, $listFrame=true, $addParams='', $enDisItems='', $returnTagParameters=false)

static	getLinkToDataHandlerAction ($parameters, $redirectUrl='')

static	getModTSconfig ($id, $TSref)

static	getFuncMenu ($mainParams, $elementName, $currentValue, $menuItems, $script='', $addParams='')

static	getDropdownMenu ($mainParams, $elementName, $currentValue, $menuItems, $script='', $addParams='')

static	getFuncCheck ($mainParams, $elementName, $currentValue, $script='', $addParams='', $tagParams='')

static	getFuncInput ($mainParams, $elementName, $currentValue, $size=10, $script='', $addParams='')

static	unsetMenuItems ($modTSconfig, $itemArray, $TSref)

static	setUpdateSignal ($set='', $params='')

static	getUpdateSignalCode ()

static	getModuleData ($MOD_MENU, $CHANGED_SETTINGS, $modName, $type='', $dontValidateList='', $setDefaultList='')

static	getUrlToken ($formName='securityToken', $tokenName='formToken')

static	lockRecords ($table='', $uid=0, $pid=0)

static	isRecordLocked ($table, $uid)

static	exec_foreign_table_where_query ($fieldConfig, $field='', $TSconfig=[])

static	replaceMarkersInWhereClause ($whereClause, $table, $field='', $tsConfig=[])

static	getTCEFORM_TSconfig ($table, $row)

static	getTSconfig_pidValue ($table, $uid, $pid)

static	getPidForModTSconfig ($table, $uid, $pid)

static	getTSCpidCached ($table, $uid, $pid)

static	getTSCpid ($table, $uid, $pid)

static	firstDomainRecord ($rootLine)

static	getDomainStartPage ($domain, $path='')

static	RTEsetup ($RTEprop, $table, $field, $type='')

static	RTEgetObj ()

static &	softRefParserObj ($spKey)

static	explodeSoftRefParserList ($parserList)

static	isModuleSetInTBE_MODULES ($modName)

static	referenceCount ($table, $ref, $msg='', $count=null)

static	translationCount ($table, $ref, $msg='')

static	selectVersionsOfRecord ($table, $uid, $fields=' *', $workspace=0, $includeDeletedRecords=false, $row=null)

static	fixVersioningPid ($table, &$rr, $ignoreWorkspaceMatch=false)

static	workspaceOL ($table, &$row, $wsid=-99, $unsetMovePointers=false)

static	movePlhOL ($table, &$row)

static	getWorkspaceVersionOfRecord ($workspace, $table, $uid, $fields=' *')

static	getLiveVersionOfRecord ($table, $uid, $fields=' *')

static	getLiveVersionIdOfRecord ($table, $uid)

static	versioningPlaceholderClause ($table)

static	getWorkspaceWhereClause ($table, $workspaceId=null)

static	countVersionsOfRecordsOnPage ($workspace, $pageId)

static	wsMapId ($table, $uid)

static	getMovePlaceholder ($table, $uid, $fields=' *', $workspace=null)

static	TYPO3_copyRightNotice ()

static	getPathType_web_nonweb ($path)

static	processParams ($params)

static	getBackendScript ($interface='')

static	isTableWorkspaceEnabled ($table)

static	isTableMovePlaceholderAware ($table)

static	getTcaFieldConfiguration ($table, $field)

static	isWebMountRestrictionIgnored ($table)

static	isRootLevelRestrictionIgnored ($table)

static	shortcutExists ($url)

Static Protected Member Functions
static	getPageForRootline ($uid, $clause, $workspaceOL)

static	getRecordsSortedByTitle (array $fields, $table, $titleField, $where='')

static	replaceL10nModeFields ($table, array $row)

static	createPreviewUrl ($pageUid, $rootLine, $anchorSection, $additionalGetVars, $viewScript)

static	buildScriptUrl ($mainParams, $addParams, $script='')

static	getRuntimeCache ()

static	getSignalSlotDispatcher ()

static	emitGetPagesTSconfigPreIncludeSignal (array $TSdataArray, $id, array $rootLine, $returnPartArray)

static	getDatabaseConnection ()

static	getLanguageService ()

static	getBackendUserAuthentication ()

static	getDocumentTemplate ()

Static Protected Attributes
static	$tcaTableTypeConfigurationCache = []

Detailed Description

Standard functions available for the TYPO3 backend. You are encouraged to use this class in your own applications (Backend Modules) Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.

Call ALL methods without making an object! Eg. to get a page-record 51 do this: '::getRecord('pages',51)'

Definition at line 53 of file BackendUtility.php.

Member Function Documentation

◆ BEenableFields()

static TYPO3\CMS\Backend\Utility\BackendUtility::BEenableFields	(	$table,
		$inv = `false`
	)

static

Backend implementation of enableFields() Notice that "fe_groups" is not selected for - only disabled, starttime and endtime. Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition. $GLOBALS["SIM_ACCESS_TIME"] is used for date.

Parameters

string	$table	The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
bool	$inv	Means that the query will select all records NOT VISIBLE records (inverted selection)

Returns: string WHERE clause part

Definition at line 266 of file BackendUtility.php.

References $GLOBALS.

◆ BEgetRootLine()

static TYPO3\CMS\Backend\Utility\BackendUtility::BEgetRootLine	(	$uid,
		$clause = `''`,
		$workspaceOL = `false`
	)

static

Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root. By default deleted pages are filtered. This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.

Parameters

int	$uid	Page id for which to create the root line.
string	$clause	Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
bool	$workspaceOL	If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!

Returns: array Root line array, all the way to the page tree root (or as far as $clause allows!)

Definition at line 334 of file BackendUtility.php.

References $uid.

◆ blindGroupNames()

static TYPO3\CMS\Backend\Utility\BackendUtility::blindGroupNames	(	$groups,
		$groupArray,
		$excludeBlindedFlag = `false`
	)

static

Corresponds to blindUserNames but works for groups instead

Parameters

array	$groups	Group names
array	$groupArray	Group names (reference)
bool	$excludeBlindedFlag	If $excludeBlindedFlag is set, then these records are unset from the array $usernames

Returns: array

Definition at line 1523 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\ArrayUtility\inArray().

◆ blindUserNames()

static TYPO3\CMS\Backend\Utility\BackendUtility::blindUserNames	(	$usernames,
		$groupArray,
		$excludeBlindedFlag = `false`
	)

static

Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!). If $excludeBlindedFlag is set, then these records are unset from the array $usernames Takes $usernames (array made by ::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input

Parameters

array	$usernames	User names
array	$groupArray	Group names
bool	$excludeBlindedFlag	If $excludeBlindedFlag is set, then these records are unset from the array $usernames

Returns: array User names, blinded

Definition at line 1489 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

◆ buildScriptUrl()

static TYPO3\CMS\Backend\Utility\BackendUtility::buildScriptUrl	(	$mainParams,
		$addParams,
		$script = `''`
	)

staticprotected

Builds the URL to the current script with given arguments

Parameters

mixed	$mainParams	$id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$addParams	Additional parameters to pass to the script.
string	$script	The script to send the &id to, if empty it's automatically found

Returns: string The completes script URL

Definition at line 3330 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ calcAge()

static TYPO3\CMS\Backend\Utility\BackendUtility::calcAge	(	$seconds,
		$labels = `' min\| hrs\| days\| yrs\| min\| hour\| day\| year'`
	)

static

Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.

Parameters

int	$seconds	Seconds could be the difference of a certain timestamp and time()
string	$labels	Labels should be something like ' min\| hrs\| days\| yrs\| min\| hour\| day\| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears")

Returns: string Formatted time

Definition at line 1608 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\calcAgeReturnsExpectedValues(), TYPO3\CMS\Backend\History\RecordHistory\displaySettings(), TYPO3\CMS\Backend\Form\Element\NoneElement\formatValue(), TYPO3\CMS\Backend\Controller\Wizard\RteController\getButtons(), TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaRecordTitle\getRecordTitleForInputType(), and TYPO3\CMS\Backend\Controller\PageLayoutController\makeButtons().

◆ countVersionsOfRecordsOnPage()

static TYPO3\CMS\Backend\Utility\BackendUtility::countVersionsOfRecordsOnPage	(	$workspace,
		$pageId
	)

static

Count number of versions on a page

Parameters

int	$workspace	Workspace ID
int	$pageId	Page ID

Returns: array Overview of records

Deprecated:: since TYPO3 CMS 7. Will be removed with TYPO3 CMS 8. Please use ::hasPageRecordVersions to check for record versions.

Definition at line 4595 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

◆ createPreviewUrl()

static TYPO3\CMS\Backend\Utility\BackendUtility::createPreviewUrl	(	$pageUid,
		$rootLine,
		$anchorSection,
		$additionalGetVars,
		$viewScript
	)

staticprotected

Creates the view-on-click preview URL without any alternative URL.

Parameters

int	$pageUid	Page UID
array	$rootLine	If rootline is supplied, the function will look for the first found domain record and use that URL instead
string	$anchorSection	Optional anchor to the URL
string	$additionalGetVars	Additional GET variables.
string	$viewScript	The path to the script used to view the page

Returns: string The preview URL

Definition at line 3077 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\HttpUtility\SCHEME_HTTPS.

◆ cshItem()

static TYPO3\CMS\Backend\Utility\BackendUtility::cshItem	(	$table,
		$field,
		$_ = `''`,
		$wrap = `''`
	)

static

API for getting CSH icons/text for use in backend modules. TCA_DESCR will be loaded if it isn't already

Parameters

string	$table	Table name ('MOD'+module name)
string	$field	Field name (CSH locallang main key)
string	$_	(unused)
string	$wrap	Wrap code for icon-mode, splitted by "\|". Not used for full-text mode.

Returns: string HTML content for help text

See also: helpTextIcon()

Definition at line 2914 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getButtons(), TYPO3\CMS\Backend\Controller\PageTreeNavigationController\getButtons(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Frontend\Controller\PageInformationController\main(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\main(), TYPO3\CMS\InfoPagetsconfig\Controller\InfoPageTyposcriptConfigController\main(), TYPO3\CMS\Backend\Controller\File\CreateFolderController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Form\View\Wizard\WizardView\removeTrailingDotsFromTyposcript(), TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\render(), and TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper\renderStatic().

◆ date()

static TYPO3\CMS\Backend\Utility\BackendUtility::date ( $tstamp )

static

Returns $tstamp formatted as "ddmmyy" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'])

Parameters

int $tstamp Time stamp, seconds

Returns: string Formatted time

Definition at line 1565 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Utility\BackendUtility\datetime(), TYPO3\CMS\Backend\Controller\File\FileController\flattenResultDataValue(), TYPO3\CMS\Filelist\FileList\formatFileList(), TYPO3\CMS\Filelist\FileFacade\getLastModified(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaRecordTitle\getRecordTitleForInputType(), and TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed().

◆ datetime()

static TYPO3\CMS\Backend\Utility\BackendUtility::datetime ( $value )

static

Returns $tstamp formatted as "ddmmyy hhmm" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] AND $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'])

Parameters

int $value Time stamp, seconds

Returns: string Formatted time

Definition at line 1576 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\date().

Referenced by TYPO3\CMS\Backend\History\RecordHistory\displaySettings(), TYPO3\CMS\Workspaces\Service\GridDataService\generateGridListFromVersions(), TYPO3\CMS\Workspaces\ExtDirect\ExtDirectServer\getCommentsForRecord(), TYPO3\CMS\Workspaces\Service\HistoryService\getHistoryEntry(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaRecordTitle\getRecordTitleForInputType(), TYPO3\CMS\Lowlevel\SyslogCommand\main(), TYPO3\CMS\Dbal\Controller\ModuleController\printLogMgm(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\renderPageTitle(), TYPO3\CMS\IndexedSearch\ViewHelpers\Format\DateTimeViewHelper\renderStatic(), and TYPO3\CMS\Recycler\Controller\DeletedRecordsController\transform().

◆ dateTimeAge()

static TYPO3\CMS\Backend\Utility\BackendUtility::dateTimeAge	(	$tstamp,
		$prefix = `1`,
		$date = `''`
	)

static

Returns a formatted timestamp if $tstamp is set. The date/datetime will be followed by the age in parenthesis.

Parameters

int	$tstamp	Time stamp, seconds
int	$prefix	1/-1 depending on polarity of age.
string	$date	$date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm

Returns: string

Definition at line 1638 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getSpecConfPartsSplitsDefaultExtras(), and TYPO3\CMS\SysAction\ActionTask\viewEditRecord().

◆ daysUntil()

static TYPO3\CMS\Backend\Utility\BackendUtility::daysUntil ( $tstamp )

static

Returns the difference in days between input $tstamp and $EXEC_TIME

Parameters

int $tstamp Time stamp, seconds

Returns: int

Definition at line 1553 of file BackendUtility.php.

References $GLOBALS.

◆ deleteClause()

static TYPO3\CMS\Backend\Utility\BackendUtility::deleteClause	(	$table,
		$tableAlias = `''`
	)

static

Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $GLOBALS['TCA'] for the tablename, $table This function should ALWAYS be called in the backend for selection on tables which are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records, even if they are marked deleted (in which case the system must always treat them as non-existent!) In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering on those fields as well in the backend you can use ->BEenableFields() though.

Parameters

string	$table	Table name present in $GLOBALS['TCA']
string	$tableAlias	Table alias if any

Returns: string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0

Definition at line 82 of file BackendUtility.php.

References $GLOBALS.

◆ editOnClick()

static TYPO3\CMS\Backend\Utility\BackendUtility::editOnClick	(	$params,
		$_ = `''`,
		$requestUri = `''`
	)

static

Returns a JavaScript string (for an onClick handler) which will load the EditDocumentController script that shows the form for editing of the record(s) you have send as params. REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)

Parameters

string	$params	Parameters sent along to EditDocumentController. This requires a much more details description which you must seek in Inside TYPO3s documentation of the FormEngine API. And example could be '&edit[pages][123] = edit' which will show edit form for page record 123.
string	$_	(unused)
string	$requestUri	An optional returnUrl you can set - automatically set to REQUEST_URI.

Returns: string

Definition at line 2940 of file BackendUtility.php.

References $params, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Backend\View\PageLayoutView\newContentElementOnClick(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickEvent(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\renderL10nTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), and TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawColHeader().

◆ emitGetPagesTSconfigPreIncludeSignal()

static TYPO3\CMS\Backend\Utility\BackendUtility::emitGetPagesTSconfigPreIncludeSignal	(	array	$TSdataArray,
			$id,
		array	$rootLine,
			$returnPartArray
	)

staticprotected

Emits signal to modify the page TSconfig before include

Parameters

array	$TSdataArray	Current TSconfig data array - Can be modified by slots!
int	$id	Page ID we are handling
array	$rootLine	Rootline array of page
bool	$returnPartArray	Whether TSdata should be parsed by TS parser or returned as plain text

Returns: array Modified Data array

Definition at line 4919 of file BackendUtility.php.

◆ exec_foreign_table_where_query()

static TYPO3\CMS\Backend\Utility\BackendUtility::exec_foreign_table_where_query	(	$fieldConfig,
		$field = `''`,
		$TSconfig = `[]`
	)

static

Returns select statement for MM relations (as used by TCEFORMs etc)

Parameters

array	$fieldConfig	Configuration array for the field, taken from $GLOBALS['TCA']
string	$field	Field name
array	$TSconfig	TSconfig array from which to get further configuration settings for the field name

Returns: string Part of query

Definition at line 3716 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ explodeSoftRefParserList()

static TYPO3\CMS\Backend\Utility\BackendUtility::explodeSoftRefParserList ( $parserList )

static

Returns array of soft parser references

Parameters

string $parserList softRef parser list

Returns: array|bool Array where the parser key is the key and the value is the parameter string, FALSE if no parsers were found

Definition at line 4134 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkStatistics(), TYPO3\CMS\Core\Database\ReferenceIndex\getRelations(), and TYPO3\CMS\Core\Database\ReferenceIndex\getRelations_flexFormCallBack().

◆ firstDomainRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::firstDomainRecord ( $rootLine )

static

Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine

Parameters

array $rootLine Root line array

Returns: string|NULL Domain name or NULL

Definition at line 3986 of file BackendUtility.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\getBrokenUrl(), and TYPO3\CMS\Viewpage\Controller\ViewModuleController\getDomainName().

◆ fixVersioningPid()

static TYPO3\CMS\Backend\Utility\BackendUtility::fixVersioningPid	(		$table,
		&	$rr,
			$ignoreWorkspaceMatch = `false`
	)

static

Find page-tree PID for versionized record Will look if the "pid" value of the input record is -1 and if the table supports versioning - if so, it will translate the -1 PID into the PID of the original record Used whenever you are tracking something back, like making the root line. Will only translate if the workspace of the input record matches that of the current user (unless flag set) Principle; Record offline! => Find online?

If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch.

Parameters

string	$table	Table name
array	$rr	Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
bool	$ignoreWorkspaceMatch	Ignore workspace match

Returns: void

See also: PageRepository::fixVersioningPid()

Definition at line 4327 of file BackendUtility.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\DatabaseEditRow\addData(), TYPO3\CMS\Recycler\Utility\RecyclerUtility\checkAccess(), TYPO3\CMS\Backend\Controller\Wizard\AbstractWizardController\checkEditAccess(), TYPO3\CMS\Core\DataHandling\DataHandler\destNotInsideSelf(), TYPO3\CMS\Core\DataHandling\DataHandler\doesRecordExist(), TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray(), TYPO3\CMS\Recycler\Utility\RecyclerUtility\getRecordPath(), TYPO3\CMS\Core\DataHandling\DataHandler\getRecordPropertiesFromRow(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render(), and TYPO3\CMS\Rtehtmlarea\Form\Resolver\RichTextNodeResolver\resolve().

◆ getBackendScript()

static TYPO3\CMS\Backend\Utility\BackendUtility::getBackendScript ( $interface = '' )

static

Returns the name of the backend script relative to the TYPO3 main directory.

Parameters

string $interface Name of the backend interface (backend, frontend) to look up the script name for. If no interface is given, the interface for the current backend user is used.

Returns: string The name of the backend script relative to the TYPO3 main directory.

Definition at line 4789 of file BackendUtility.php.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule().

◆ getBackendUserAuthentication()

static TYPO3\CMS\Backend\Utility\BackendUtility::getBackendUserAuthentication ( )

staticprotected

Returns: BackendUserAuthentication

Definition at line 4944 of file BackendUtility.php.

References $GLOBALS.

◆ getCommonSelectFields()

static TYPO3\CMS\Backend\Utility\BackendUtility::getCommonSelectFields	(	$table,
		$prefix = `''`,
		$fields = `[]`
	)

static

Returns fields for a table, $table, which would typically be interesting to select This includes uid, the fields defined for title, icon-field. Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)

Parameters

string	$table	Table name, present in $GLOBALS['TCA']
string	$prefix	Table prefix
array	$fields	Preset fields (must include prefix if that is used)

Returns: string List of fields.

Definition at line 2647 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\buildForeignTableQuery(), TYPO3\CMS\Core\Integrity\DatabaseIntegrityCheck\genTree_records(), and TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getCommonSelectFieldsReturnsCorrectFields().

◆ getDatabaseConnection()

static TYPO3\CMS\Backend\Utility\BackendUtility::getDatabaseConnection ( )

staticprotected

Returns: DatabaseConnection

Definition at line 4928 of file BackendUtility.php.

References $GLOBALS.

◆ getDocumentTemplate()

static TYPO3\CMS\Backend\Utility\BackendUtility::getDocumentTemplate ( )

staticprotected

Returns: DocumentTemplate

Definition at line 4952 of file BackendUtility.php.

References $GLOBALS.

◆ getDomainStartPage()

static TYPO3\CMS\Backend\Utility\BackendUtility::getDomainStartPage	(	$domain,
		$path = `''`
	)

static

Returns the sys_domain record for $domain, optionally with $path appended.

Parameters

string	$domain	Domain name
string	$path	Appended path

Returns: array Domain record, if found

Definition at line 4005 of file BackendUtility.php.

◆ getDropdownMenu()

static TYPO3\CMS\Backend\Utility\BackendUtility::getDropdownMenu	(	$mainParams,
		$elementName,
		$currentValue,
		$menuItems,
		$script = `''`,
		$addParams = `''`
	)

static

Returns a selector box to switch the view Requires the JS function jumpToUrl() to be available Based on BackendUtility::getFuncMenu() but done as new function because it has another purpose. Mingling with getFuncMenu would harm the docHeader Menu.

Parameters

mixed	$mainParams	The "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	The form elements name, probably something like "SET[...]
string	$currentValue	The value to be selected currently.
array	$menuItems	An array with the menu items for the selector box
string	$script	The script to send the &id to, if empty it's automatically found
string	$addParams	Additional parameters to pass to the script.

Returns: string HTML code for selector box

Definition at line 3248 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView\func_search(), TYPO3\CMS\Frontend\Controller\PageInformationController\main(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\main(), TYPO3\CMS\InfoPagetsconfig\Controller\InfoPageTyposcriptConfigController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\main(), and TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main().

◆ getExcludeFields()

static TYPO3\CMS\Backend\Utility\BackendUtility::getExcludeFields ( )

static

Returns an array with the exclude-fields as defined in TCA and FlexForms Used for listing the exclude-fields in be_groups forms

Returns: array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 504 of file BackendUtility.php.

References $extConf, $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ getExplicitAuthFieldValues()

static TYPO3\CMS\Backend\Utility\BackendUtility::getExplicitAuthFieldValues ( )

static

Returns an array with explicit Allow/Deny fields. Used for listing these field/value pairs in be_groups forms

Returns: array Array with information from all of $GLOBALS['TCA']

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 587 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getFlexFormDS()

static TYPO3\CMS\Backend\Utility\BackendUtility::getFlexFormDS	(	$conf,
		$row,
		$table,
		$fieldName = `''`,
		$WSOL = `true`,
		$newRecordPidValue = `0`
	)

static

Finds the Data Structure for a FlexForm field

NOTE ON data structures for deleted records: This function may fail to deliver the data structure for a record for a few reasons: a) The data structure could be deleted (either with deleted-flagged or hard-deleted), b) the data structure is fetched using the ds_pointerField_searchParent in which case any deleted record on the route to the final location of the DS will make it fail. In theory, we can solve the problem in the case where records that are deleted-flagged keeps us from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records. However, we generally want the DS lookup to fail for deleted records since for the working website we expect a deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look at it, this may lead to integrity problems of the reference index and even lost files if attached. However, that is not really important considering that a single change to a data structure can instantly invalidate large amounts of the reference index which we do accept as a cost for the flexform features. Other than requiring a reference index update, deletion of/changes in data structure or the failure to look them up when completely deleting records may lead to lost files in the uploads/ folders since those are now without a proper reference.

Parameters

array	$conf	Field config array
array	$row	Record data
string	$table	The table name
string	$fieldName	Optional fieldname passed to hook object
bool	$WSOL	If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a TRUE reflection of how things are in the live workspace.
int	$newRecordPidValue	SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)

Returns: mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.

Todo:: : All those nasty details should be covered with tests, also it is very unfortunate the final $srcPointer is not exposed

Definition at line 1012 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValueForFlex(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaFlexFetch\initializeDataStructure(), TYPO3\CMS\Backend\Form\Wizard\SuggestWizard\overrideFieldNameAndConfigurationForFlexform(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Impexp\Import\remapListedDBRecords_flexFormCallBack(), TYPO3\CMS\Impexp\Import\setFlexFormRelations(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData(), and TYPO3\CMS\Core\DataHandling\DataHandler\versionizeRecord().

◆ getFuncCheck()

static TYPO3\CMS\Backend\Utility\BackendUtility::getFuncCheck	(	$mainParams,
		$elementName,
		$currentValue,
		$script = `''`,
		$addParams = `''`,
		$tagParams = `''`
	)

static

Checkbox function menu. Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.

Parameters

mixed	$mainParams	$id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	The form elements name, probably something like "SET[...]
string	$currentValue	The value to be selected currently.
string	$script	The script to send the &id to, if empty it's automatically found
string	$addParams	Additional parameters to pass to the script.
string	$tagParams	Additional attributes for the checkbox input tag

Returns: string HTML code for checkbox

See also: getFuncMenu()

Definition at line 3285 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Recordlist\RecordList\clearCache(), TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView\func_search(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getBulkSelector(), TYPO3\CMS\Rtehtmlarea\ImageHandler\AddImageHandler\getBulkSelector(), TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getFuncCheckReturnsInputTagWithValueAttribute(), TYPO3\CMS\Filelist\Controller\FileListController\initializeIndexAction(), TYPO3\CMS\InfoPagetsconfig\Controller\InfoPageTyposcriptConfigController\main(), TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerModuleFunctionController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Core\Database\QueryGenerator\makeSelectorTable(), and TYPO3\CMS\Lowlevel\View\ConfigurationView\menuConfig().

◆ getFuncInput()

static TYPO3\CMS\Backend\Utility\BackendUtility::getFuncInput	(	$mainParams,
		$elementName,
		$currentValue,
		$size = `10`,
		$script = `''`,
		$addParams = `''`
	)

static

Input field function menu Works like ->getFuncMenu() / ->getFuncCheck() but displays an input field instead which updates the script "onchange"

Parameters

mixed	$mainParams	$id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	The form elements name, probably something like "SET[...]
string	$currentValue	The value to be selected currently.
int	$size	Relative size of input field, max is 48
string	$script	The script to send the &id to, if empty it's automatically found
string	$addParams	Additional parameters to pass to the script.

Returns: string HTML code for input text field.

See also: getFuncMenu()

Definition at line 3315 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

◆ getFuncMenu()

static TYPO3\CMS\Backend\Utility\BackendUtility::getFuncMenu	(	$mainParams,
		$elementName,
		$currentValue,
		$menuItems,
		$script = `''`,
		$addParams = `''`
	)

static

Returns a selector box "function menu" for a module Requires the JS function jumpToUrl() to be available See Inside TYPO3 for details about how to use / make Function menus

Parameters

mixed	$mainParams	The "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
string	$elementName	The form elements name, probably something like "SET[...]
string	$currentValue	The value to be selected currently.
array	$menuItems	An array with the menu items for the selector box
string	$script	The script to send the &id to, if empty it's automatically found
string	$addParams	Additional parameters to pass to the script.

Returns: string HTML code for selector box

Definition at line 3210 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\linkWrapTemplateTitle(), TYPO3\CMS\Version\Controller\VersionModuleController\main(), and TYPO3\CMS\Backend\Controller\PageLayoutController\main().

◆ getGroupNames()

static TYPO3\CMS\Backend\Utility\BackendUtility::getGroupNames	(		$fields = `'title`,
		uid'	,
			$where = `''`
	)

static

Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title

Parameters

string	$fields	Field list
string	$where	WHERE clause

Returns: array

Definition at line 1417 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Beuser\Controller\PermissionAjaxController\__construct(), TYPO3\CMS\Belog\Controller\AbstractController\createUserAndGroupListForSelectOptions(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), and TYPO3\CMS\Beuser\Controller\PermissionAjaxController\renderGroupSelector().

◆ getInlineLocalizationMode()

static TYPO3\CMS\Backend\Utility\BackendUtility::getInlineLocalizationMode	(	$table,
		$fieldOrConfig
	)

static

Returns the value of the property localizationMode in the given $config array ($GLOBALS['TCA'][

['columns'][<field>]['config']). If the table is prepared for localization and no localizationMode is set, 'select' is returned by default. If the table is not prepared for localization or not defined at all in $GLOBALS['TCA'], FALSE is returned.

Parameters

string	$table	The name of the table to lookup in TCA
mixed	$fieldOrConfig	The fieldname (string) or the configuration of the field to check (array)

Returns: mixed If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, FALSE is returned

Definition at line 715 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\Container\InlineControlContainer\__construct(), TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Backend\Form\InlineStackProcessor\initializeByParsingDomObjectIdString(), TYPO3\CMS\Backend\Form\InlineStackProcessor\injectAjaxConfiguration(), and TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords().

◆ getItemLabel()

static TYPO3\CMS\Backend\Utility\BackendUtility::getItemLabel	(	$table,
		$col,
		$printAllWrap = `''`
	)

static

Returns the label-value for fieldname $col in table, $table If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '|' and the fieldname was 'not_found_field' then the return value would be 'not_found_field'

Parameters

string	$table	Table name, present in $GLOBALS['TCA']
string	$col	Field name
string	$printAllWrap	Wrap value - set function description - this parameter is deprecated since TYPO3 6.2 and is removed two versions later. This parameter is a conceptual failure, as the content can then never be HSCed afterwards (which is how the method is used all the time), and then the code would be HSCed twice.

Returns: string or NULL if $col is not found in the TCA table

Definition at line 2144 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_check(), TYPO3\CMS\Backend\History\RecordHistory\displaySettings(), TYPO3\CMS\Workspaces\Service\HistoryService\getDifferences(), TYPO3\CMS\Workspaces\ExtDirect\ExtDirectServer\getStageActions(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed(), TYPO3\CMS\Backend\History\RecordHistory\renderDiff(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\renderFileInformationAsTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\renderPageTitle().

◆ getLabelFromItemlist()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLabelFromItemlist	(	$table,
		$col,
		$key
	)

static

Returns the label of the first found entry in an "items" array from $GLOBALS'TCA' where the value is $key

Parameters

string	$table	Table name, present in $GLOBALS['TCA']
string	$col	Field name, present in $GLOBALS['TCA']
string	$key	items-array value to match

Returns: string Label for item entry

Definition at line 2040 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getLabelFromItemlistReturnsCorrectFields(), TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeQuickEditMenu(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\printRecordMap().

◆ getLabelFromItemListMerged()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLabelFromItemListMerged	(	$pageId,
		$table,
		$column,
		$key
	)

static

Return the label of a field by additionally checking TsConfig values

Parameters

int	$pageId	Page id
string	$table	Table name
string	$column	Field Name
string	$key	item value

Returns: string Label for item entry

Definition at line 2064 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getLabelFromItemListMergedReturnsCorrectFields(), and TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed().

◆ getLabelsFromItemsList()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLabelsFromItemsList	(		$table,
			$column,
			$keyList,
		array	$columnTsConfig = `[]`
	)

static

Splits the given key with commas and returns the list of all the localized items labels, separated by a comma. NOTE: this does not take itemsProcFunc into account

Parameters

string $table Table name, present in TCA

string $column Field name

string $keyList Key or comma-separated list of keys.

array

$columnTsConfig

page TSConfig for $column (TCEMAIN.

<column>)

Returns: string Comma-separated list of localized labels

Definition at line 2094 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getLabelsFromItemsListReturnsCorrectValue().

◆ getLanguageService()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLanguageService ( )

staticprotected

Returns: LanguageService

Definition at line 4936 of file BackendUtility.php.

References $GLOBALS.

◆ getLinkToDataHandlerAction()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLinkToDataHandlerAction	(	$parameters,
		$redirectUrl = `''`
	)

static

Returns a URL with a command to TYPO3 Datahandler

Parameters

string	$parameters	Set of GET params to send. Example: "&cmd[tt_content][123][move]=456" or "&data[tt_content][123][hidden]=1&data[tt_content][123][title]=Hello%20World
string \| int	$redirectUrl	Redirect URL, default is to use GeneralUtility::getIndpEnv('REQUEST_URI'), -1 means to generate an URL for JavaScript using T3_THIS_LOCATION

Returns: string URL to BackendUtility::getModuleUrl('tce_db') + parameters

Definition at line 3050 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Version\Controller\VersionModuleController\adminLinks(), TYPO3\CMS\Filelist\FileList\formatFileList(), TYPO3\CMS\Backend\Template\DocumentTemplate\issueCommand(), TYPO3\CMS\Backend\Controller\EditDocumentController\languageSwitch(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawHeader(), and TYPO3\CMS\Version\Controller\VersionModuleController\versioningMgm().

◆ getListGroupNames()

static TYPO3\CMS\Backend\Utility\BackendUtility::getListGroupNames	(		$fields = `'title`,
		uid'
	)

static

Returns an array with be_groups records (like ->getGroupNames) but:

if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.

Parameters

string $fields Field list; $fields specify the fields selected (default: title,uid)

Returns: array

Definition at line 1469 of file BackendUtility.php.

Referenced by TYPO3\CMS\Beuser\Controller\PermissionController\editAction().

◆ getLiveVersionIdOfRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLiveVersionIdOfRecord	(	$table,
		$uid
	)

static

Gets the id of the live version of a record.

Parameters

string	$table	Name of the table
int	$uid	Uid of the offline/draft record

Returns: int The id of the live version of the record (or NULL if nothing was found)

Definition at line 4535 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaInline\addInlineFirstPid(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaInline\getLiveDefaultId(), TYPO3\CMS\Core\Database\RelationHandler\getLiveDefaultId(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords_procDBRefs(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\viewSingleRecord().

◆ getLiveVersionOfRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::getLiveVersionOfRecord	(	$table,
		$uid,
		$fields = `'*'`
	)

static

Returns live version of record

Parameters

string	$table	Table name
int	$uid	Record UID of draft, offline version
string	$fields	Field list, default is *

Returns: array|NULL If found, the record, otherwise NULL

Definition at line 4519 of file BackendUtility.php.

References $uid.

Referenced by TYPO3\CMS\Backend\Tree\Pagetree\DataProvider\getRecordWithWorkspaceOverlay(), TYPO3\CMS\Core\DataHandling\DataHandler\getSortNumber(), TYPO3\CMS\Backend\Controller\Wizard\AddController\init(), TYPO3\CMS\Backend\Controller\EditDocumentController\languageSwitch(), TYPO3\CMS\Core\DataHandling\DataHandler\moveRecord(), TYPO3\CMS\Core\DataHandling\DataHandler\placeholderShadowing(), TYPO3\CMS\Version\Hook\DataHandlerHook\processCmdmap_deleteAction(), TYPO3\CMS\Core\DataHandling\DataHandler\resolvePid(), TYPO3\CMS\Version\Hook\DataHandlerHook\version_clearWSID(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\viewSingleRecord().

◆ getModTSconfig()

static TYPO3\CMS\Backend\Utility\BackendUtility::getModTSconfig	(	$id,
		$TSref
	)

static

Returns the merged User/Page TSconfig for page id, $id. Please read details about module programming elsewhere!

Parameters

int	$id	Page uid
string	$TSref	An object string which determines the path of the TSconfig to return.

Returns: array

Definition at line 3185 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ getModuleData()

static TYPO3\CMS\Backend\Utility\BackendUtility::getModuleData	(	$MOD_MENU,
		$CHANGED_SETTINGS,
		$modName,
		$type = `''`,
		$dontValidateList = `''`,
		$setDefaultList = `''`
	)

static

Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module. This is kind of session variable management framework for the backend users. If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array Ultimately, see Inside TYPO3 for how to use this function in relation to your modules.

Parameters

array	$MOD_MENU	MOD_MENU is an array that defines the options in menus.
array	$CHANGED_SETTINGS	CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
string	$modName	modName is the name of this module. Used to get the correct module data.
string	$type	If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
string	$dontValidateList	dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
string	$setDefaultList	List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)

Returns: array The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem

Definition at line 3473 of file BackendUtility.php.

References TYPO3\CMS\Backend\Routing\UriBuilder\ABSOLUTE_PATH, TYPO3\CMS\Backend\Routing\UriBuilder\ABSOLUTE_URL, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Module\AbstractFunctionModule\checkExtObj(), TYPO3\CMS\Backend\Module\BaseScriptClass\checkExtObj(), TYPO3\CMS\Recordlist\Browser\FileBrowser\getBulkSelector(), TYPO3\CMS\Rtehtmlarea\ImageHandler\AddImageHandler\getBulkSelector(), TYPO3\CMS\Backend\Module\AbstractFunctionModule\handleExternalFunctionValue(), TYPO3\CMS\Rtehtmlarea\ImageHandler\AddImageHandler\initialize(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\linkWrapTemplateTitle(), TYPO3\CMS\Dbal\Controller\ModuleController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\main(), TYPO3\CMS\Lowlevel\View\ConfigurationView\menuConfig(), TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView\menuConfig(), TYPO3\CMS\Version\Controller\VersionModuleController\menuConfig(), TYPO3\CMS\Backend\Module\BaseScriptClass\menuConfig(), TYPO3\CMS\Recordlist\RecordList\menuConfig(), TYPO3\CMS\Filelist\Controller\FileListController\menuConfig(), TYPO3\CMS\Backend\Controller\PageLayoutController\menuConfig(), TYPO3\CMS\Recordlist\Browser\FileBrowser\processSessionData(), TYPO3\CMS\Core\Database\QueryView\procesStoreControl(), and TYPO3\CMS\T3editor\Hook\TypoScriptTemplateInfoHook\save().

◆ getMovePlaceholder()

static TYPO3\CMS\Backend\Utility\BackendUtility::getMovePlaceholder	(	$table,
		$uid,
		$fields = `'*'`,
		$workspace = `null`
	)

static

Returns move placeholder of online (live) version

Parameters

string	$table	Table name
int	$uid	Record UID of online version
string	$fields	Field list, default is *
int \| NULL	$workspace	The workspace to be used

Returns: array If found, the record, otherwise nothing.

Definition at line 4658 of file BackendUtility.php.

References $GLOBALS, $uid, and TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\deleteSpecificPage(), TYPO3\CMS\Core\DataHandling\DataHandler\deleteVersionsForRecord(), TYPO3\CMS\Core\DataHandling\DataHandler\getSortNumber(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_wsPlaceholders(), TYPO3\CMS\Version\Hook\DataHandlerHook\processCmdmap_deleteAction(), TYPO3\CMS\Version\Hook\DataHandlerHook\version_clearWSID(), TYPO3\CMS\Version\Hook\DataHandlerHook\versionizePages(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\viewSingleRecord().

◆ getNoRecordTitle()

static TYPO3\CMS\Backend\Utility\BackendUtility::getNoRecordTitle ( $prep = false )

static

Get a localized [No title] string, wrapped in | if $prep is TRUE.

Parameters

bool $prep Wrap result in |

Returns: string Localized [No title] string

Definition at line 2285 of file BackendUtility.php.

References $GLOBALS, $params, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom().

◆ getOriginalTranslationTable()

static TYPO3\CMS\Backend\Utility\BackendUtility::getOriginalTranslationTable ( $table )

static

Gets the original translation pointer table. For e.g. pages_language_overlay this would be pages.

Parameters

string $table Name of the table

Returns: string Pointer table (if any)

Definition at line 681 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords().

◆ getPageForRootline()

static TYPO3\CMS\Backend\Utility\BackendUtility::getPageForRootline	(	$uid,
		$clause,
		$workspaceOL
	)

staticprotected

Gets the cached page record for the rootline

Parameters

int	$uid	Page id for which to create the root line.
string	$clause	Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
bool	$workspaceOL	If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!

Returns: array Cached page record for the rootline

See also: BEgetRootLine

Definition at line 393 of file BackendUtility.php.

References $uid.

◆ getPagesTSconfig()

static TYPO3\CMS\Backend\Utility\BackendUtility::getPagesTSconfig	(	$id,
		$rootLine = `null`,
		$returnPartArray = `false`
	)

static

Returns the Page TSconfig for page with id, $id

Parameters

int	$id	Page uid for which to create Page TSconfig
array	$rootLine	If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
bool	$returnPartArray	If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.

Returns: array Page TSconfig

See also

Definition at line 1280 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\checkIncludeLines_array(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems(), TYPO3\CMS\Backend\Form\FormDataProvider\PageTsConfig\addData(), TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), TYPO3\CMS\Extbase\Persistence\Generic\Storage\Typo3DbBackend\clearPageCache(), TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generatePageTsConfig(), TYPO3\CMS\Backend\Controller\EditDocumentController\generatePreviewCode(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getDomainName(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkHandlers(), TYPO3\CMS\Core\DataHandling\DataHandler\getTCEMAIN_TSconfig(), TYPO3\CMS\Backend\Controller\ContentElement\NewContentElementController\init(), TYPO3\CMS\Rtehtmlarea\Controller\SelectImageController\initVariables(), TYPO3\CMS\Rtehtmlarea\Controller\BrowseLinksController\initVariables(), TYPO3\CMS\InfoPagetsconfig\Controller\InfoPageTyposcriptConfigController\main(), TYPO3\CMS\Rtehtmlarea\Controller\ParseHtmlController\main_parse_html(), TYPO3\CMS\Rtehtmlarea\Controller\UserElementsController\main_user(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Backend\Controller\NewRecordController\regularNew(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render(), TYPO3\CMS\Rtehtmlarea\Form\Resolver\RichTextNodeResolver\resolve(), TYPO3\CMS\Backend\Form\Wizard\SuggestWizard\searchAction(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\viewSingleRecord().

◆ getPathType_web_nonweb()

static TYPO3\CMS\Backend\Utility\BackendUtility::getPathType_web_nonweb ( $path )

static

Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder.

Parameters

string $path Path to evaluate

Returns: bool

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 4724 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getPidForModTSconfig()

static TYPO3\CMS\Backend\Utility\BackendUtility::getPidForModTSconfig	(	$table,
		$uid,
		$pid
	)

static

Return $uid if $table is pages and $uid is int - otherwise the $pid

Parameters

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

Returns: int

Definition at line 3927 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

◆ getProcessedValueExtra()

static TYPO3\CMS\Backend\Utility\BackendUtility::getProcessedValueExtra	(	$table,
		$fN,
		$fV,
		$fixed_lgd_chars = `0`,
		$uid = `0`,
		$forceResult = `true`,
		$pid = `0`
	)

static

Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.

Parameters

string	$table	Table name, present in TCA
string	$fN	Field name
string	$fV	Field value
int	$fixed_lgd_chars	The max amount of characters the value may occupy
int	$uid	Uid of the current record
bool	$forceResult	If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
int	$pid	Optional page uid is used to evaluate page TSConfig for the given field

Returns: string

See also: getProcessedValue()

Definition at line 2619 of file BackendUtility.php.

References $GLOBALS, and $uid.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\renderPageTitle().

◆ getRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecord	(	$table,
		$uid,
		$fields = `'*'`,
		$where = `''`,
		$useDeleteClause = `true`
	)

static

Gets record with uid = $uid from $table You can set $field to a list of fields (default is '*') Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1') Will automatically check if records has been deleted and if so, not return anything. $table must be found in $GLOBALS['TCA']

Parameters

string	$table	Table name present in $GLOBALS['TCA']
int	$uid	UID of record
string	$fields	List of fields to select
string	$where	Additional WHERE clause, eg. " AND blablabla = 0
bool	$useDeleteClause	Use the deleteClause to check if a record is deleted (default TRUE)

Returns: array|NULL Returns the row if found, otherwise NULL

Definition at line 105 of file BackendUtility.php.

References $GLOBALS, and $uid.

◆ getRecordIconAltText()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordIconAltText	(	$row,
		$table = `'pages'`
	)

static

Returns title-attribute information for ANY record (from a table defined in TCA of course) The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included. "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.

Parameters

array	$row	Table row; $row is a row from the table, $table
string	$table	Table name

Returns: string

Definition at line 1981 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER, and TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER_VERSION.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getPageInfo(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getRecordHeader(), TYPO3\CMS\Fluid\ViewHelpers\Be\PageInfoViewHelper\render(), and TYPO3\CMS\Backend\Form\Container\InlineRecordContainer\renderForeignRecordHeader().

◆ getRecordLocalization()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordLocalization	(	$table,
		$uid,
		$language,
		$andWhereClause = `''`
	)

static

Fetches the localization for a given record.

Parameters

string	$table	Table name present in $GLOBALS['TCA']
int	$uid	The uid of the record
int	$language	The uid of the language record in sys_language
string	$andWhereClause	Optional additional WHERE clause (default: '')

Returns: mixed Multidimensional array with selected records; if none exist, FALSE is returned

Definition at line 303 of file BackendUtility.php.

References $GLOBALS, and $uid.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Core\DataHandling\DataHandler\getPreviousLocalizedRecordUid(), and TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords().

◆ getRecordPath()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordPath	(	$uid,
		$clause,
		$titleLimit,
		$fullTitleLimit = `0`
	)

static

Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage" Each part of the path will be limited to $titleLimit characters Deleted pages are filtered out.

Parameters

int	$uid	Page uid for which to create record path
string	$clause	Clause is additional where clauses, eg.
int	$titleLimit	Title limit
int	$fullTitleLimit	Title limit of Full title (typ. set to 1000 or so)

Returns: mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.

Definition at line 470 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Referenced by TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getRootlineNumber(), TYPO3\CMS\Workspaces\Service\GridDataService\generateGridListFromVersions(), TYPO3\CMS\Impexp\Task\ImportExportTask\getOverview(), TYPO3\CMS\Backend\Form\Wizard\SuggestWizardDefaultReceiver\getRecordPath(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\recPath(), TYPO3\CMS\Backend\Form\Container\OuterWrapContainer\render(), and TYPO3\CMS\SysAction\ActionTask\viewEditRecord().

◆ getRecordRaw()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordRaw	(	$table,
		$where = `''`,
		$fields = `'*'`
	)

static

Returns the first record found from $table with $where as WHERE clause This function does NOT check if a record has the deleted flag set. $table does NOT need to be configured in $GLOBALS['TCA'] The query used is simply this: $query = 'SELECT ' . $fields . ' FROM ' . $table . ' WHERE ' . $where;

Parameters

string	$table	Table name (not necessarily in TCA)
string	$where	WHERE clause
string	$fields	$fields is a list of fields to select, default is '*'

Returns: array|bool First row found, if any, FALSE otherwise

Definition at line 161 of file BackendUtility.php.

Referenced by TYPO3\CMS\Lowlevel\MissingRelationsCommand\__construct(), TYPO3\CMS\Core\DataHandling\DataHandler\deleteRecord(), TYPO3\CMS\Core\DataHandling\DataHandler\doesRecordExist(), TYPO3\CMS\Lowlevel\CleanerCommand\genTree_traverse(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Lowlevel\CleanFlexformCommand\main_autoFix(), TYPO3\CMS\Lowlevel\CleanFlexformCommand\main_parseTreeCallBack(), and TYPO3\CMS\Core\Database\ReferenceIndex\updateRefIndexTable().

◆ getRecordsByField()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsByField	(	$theTable,
		$theField,
		$theValue,
		$whereClause = `''`,
		$groupBy = `''`,
		$orderBy = `''`,
		$limit = `''`,
		$useDeleteClause = `true`
	)

static

Returns records from table, $theTable, where a field ($theField) equals the value, $theValue The records are returned in an array If no records were selected, the function returns nothing

Parameters

string	$theTable	Table name present in $GLOBALS['TCA']
string	$theField	Field to select on
string	$theValue	Value that $theField must match
string	$whereClause	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	$groupBy	Optional GROUP BY field(s), if none, supply blank string.
string	$orderBy	Optional ORDER BY field(s), if none, supply blank string.
string	$limit	Optional LIMIT value ([begin,]max), if none, supply blank string.
bool	$useDeleteClause	Use the deleteClause to check if a record is deleted (default TRUE)

Returns: mixed Multidimensional array with selected records (if any is selected)

Definition at line 187 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\canHandleLink(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkFullLanguagesAccess(), TYPO3\CMS\Core\DataHandling\DataHandler\copyL10nOverlayRecords(), TYPO3\CMS\Core\DataHandling\DataHandler\deleteL10nOverlayRecords(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getObjectManager(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getPageIdFromAlias(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getRecordLocalization(), TYPO3\CMS\Core\DataHandling\DataHandler\getRecordsWithSameValue(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Backend\Controller\BackendController\handlePageEditing(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeQuickEditMenu(), TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords(), TYPO3\CMS\Recycler\Domain\Model\DeletedRecords\setData(), and TYPO3\CMS\Core\Html\RteHtmlParser\TS_links_rte().

◆ getRecordsSortedByTitle()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsSortedByTitle	(	array	$fields,
			$table,
			$titleField,
			$where = `''`
	)

staticprotected

Returns an array of all non-deleted records of a table sorted by a given title field. The value of the title field will be replaced by the return value of self::getRecordTitle() before the sorting is performed.

Parameters

array	$fields	Fields to select
string	$table	Table name
string	$titleField	Field that will contain the record title
string	$where	Additional where clause

Returns: array Array of sorted records

Definition at line 1438 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\sortArraysByKey().

◆ getRecordTitle()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordTitle	(	$table,
		$row,
		$prep = `false`,
		$forceResult = `true`
	)

static

Returns the "title"-value in record, $row, from table, $table The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'

Parameters

string	$table	Table name, present in TCA
array	$row	Row from table
bool	$prep	If set, result is prepared for output: The output is cropped to a limited length (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '[No title]' is returned (localized). Further, the output is htmlspecialchars()'ed
bool	$forceResult	If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).

Returns: string

Definition at line 2199 of file BackendUtility.php.

References $GLOBALS, $params, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ getRecordTitlePrep()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordTitlePrep	(	$title,
		$titleLength = `0`
	)

static

Crops a title string to a limited length and if it really was cropped, wrap it in a |, which offers a tooltip with the original title when moving mouse over it.

Parameters

string	$title	The title string to be cropped
int	$titleLength	Crop title after this length - if not set, BE_USER->uc['titleLen'] is used

Returns: string The processed title string, wrapped in | if cropped

Definition at line 2264 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Referenced by TYPO3\CMS\Core\Resource\Service\UserFileInlineLabelService\getInlineLabel(), TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList\linkWrapItems(), TYPO3\CMS\Backend\Form\Container\OuterWrapContainer\render(), and TYPO3\CMS\Backend\Form\Container\InlineRecordContainer\renderForeignRecordHeader().

◆ getRecordToolTip()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordToolTip	(	array	$row,
			$table = `'pages'`
	)

static

Returns the combined markup for Bootstraps tooltips

Parameters

array	$row
string	$table

Returns: string

Definition at line 1965 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct(), TYPO3\CMS\Backend\View\PageLayoutView\getIcon(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\getRecordHeader(), TYPO3\CMS\Backend\Template\Components\MetaInformation\getRecordInformation(), TYPO3\CMS\Backend\Controller\ContentElement\MoveElementController\main(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow().

◆ getRecordWSOL()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRecordWSOL	(	$table,
		$uid,
		$fields = `'*'`,
		$where = `''`,
		$useDeleteClause = `true`,
		$unsetMovePointers = `false`
	)

static

Like getRecord(), but overlays workspace version if any.

Parameters

string	$table	Table name present in $GLOBALS['TCA']
int	$uid	UID of record
string	$fields	List of fields to select
string	$where	Additional WHERE clause, eg. " AND blablabla = 0
bool	$useDeleteClause	Use the deleteClause to check if a record is deleted (default TRUE)
bool	$unsetMovePointers	If TRUE the function does not return a "pointer" row for moved records in a workspace

Returns: array Returns the row if found, otherwise nothing

Definition at line 129 of file BackendUtility.php.

References $uid, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\uniqueList().

◆ getRegisteredFlexForms()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRegisteredFlexForms ( $table = 'tt_content' )

static

Returns all registered FlexForm definitions with title and fields

Parameters

string $table The content table

Returns: array The data structures with speaking extension title

See also: ::getExcludeFields()

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 1154 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveAllSheetsInDS(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

◆ getRuntimeCache()

static TYPO3\CMS\Backend\Utility\BackendUtility::getRuntimeCache ( )

staticprotected

Gets an instance of the runtime cache.

Returns: VariableFrontend

Definition at line 4123 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getSignalSlotDispatcher()

static TYPO3\CMS\Backend\Utility\BackendUtility::getSignalSlotDispatcher ( )

staticprotected

Get the SignalSlot dispatcher

Returns

Definition at line 4905 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getSpecConfParametersFromArray()

static TYPO3\CMS\Backend\Utility\BackendUtility::getSpecConfParametersFromArray ( $pArr )

static

Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value. Better see it in action! Find example in Inside TYPO3

Parameters

array $pArr Array of "[key] = [value]" strings to convert.

Returns: array

Definition at line 968 of file BackendUtility.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\cleanList(), TYPO3\CMS\Core\Html\RteHtmlParser\RTE_transform(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\RTEtsConfigParams(), and TYPO3\CMS\Core\DataHandling\DataHandler\transformRichtextContentToDatabase().

◆ getSpecConfParts()

static TYPO3\CMS\Backend\Utility\BackendUtility::getSpecConfParts	(	$defaultExtrasString,
		$_ = `''`
	)

static

Parses "defaultExtras" of $GLOBALS['TCA'] columns config section to an array. Elements are split by ":" and within those parts, parameters are split by "|".

See unit tests for details.

Parameters

string	$defaultExtrasString	"defaultExtras" string from columns config
string	$_

Definition at line 935 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getSpecConfPartsSplitsDefaultExtras(), TYPO3\CMS\Rsaauth\Form\Element\RsaInputElement\render(), TYPO3\CMS\Backend\Form\Element\SelectMultipleSideBySideElement\render(), TYPO3\CMS\Backend\Form\Element\SelectCheckBoxElement\render(), TYPO3\CMS\Backend\Form\Element\SelectSingleBoxElement\render(), TYPO3\CMS\Backend\Form\Element\TextElement\render(), TYPO3\CMS\Backend\Form\Element\SelectTreeElement\render(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render(), and TYPO3\CMS\Rtehtmlarea\Form\Resolver\RichTextNodeResolver\resolve().

◆ getSQLselectableList()

static TYPO3\CMS\Backend\Utility\BackendUtility::getSQLselectableList	(	$in_list,
		$tablename,
		$default_tablename
	)

static

Returns a list of pure ints based on $in_list being a list of records with table-names prepended. Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.

Parameters

string	$in_list	Input list
string	$tablename	Table name from which ids is returned
string	$default_tablename	$default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)

Returns: string List of ids

Definition at line 236 of file BackendUtility.php.

◆ getTcaFieldConfiguration()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTcaFieldConfiguration	(	$table,
		$field
	)

static

Gets the TCA configuration of a field.

Parameters

string	$table	Name of the table
string	$field	Name of the field

Returns: array

Definition at line 4837 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Version\Dependency\ElementEntityProcessor\createNewDependentElementChildReferenceCallback(), and TYPO3\CMS\Version\Dependency\ElementEntityProcessor\createNewDependentElementParentReferenceCallback().

◆ getTCAtypes()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTCAtypes	(	$table,
		$rec,
		$useFieldNameAsKey = `false`
	)

static

Returns the "types" configuration parsed into an array for the record, $rec, from table, $table

Parameters

string	$table	Table name (present in TCA)
array	$rec	Record from $table
bool	$useFieldNameAsKey	If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.

Returns: array|NULL

Definition at line 778 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray(), and TYPO3\CMS\Backend\Tests\Unit\Utility\BackendUtilityTest\getTCAtypesReturnsCorrectValues().

◆ getTCAtypeValue()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTCAtypeValue	(	$table,
		$row
	)

static

Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $GLOBALS['TCA'] If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used. If zero is not an index in the "types" section of $GLOBALS['TCA'] for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)

Note: This method is very similar to the type determination of FormDataProvider/DatabaseRecordTypeValue, however, it has two differences: 1) The method in TCEForms also takes care of localization (which is difficult to do here as the whole infrastructure for language overlays is only in TCEforms). 2) The $row array looks different in TCEForms, as in there it's not the raw record but the prepared data from other providers is handled, which changes e.g. how "select" and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.

Parameters

string	$table	Table name present in TCA
array	$row	Record from $table

Exceptions

Definition at line 878 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), and TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray().

◆ getTCEFORM_TSconfig()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTCEFORM_TSconfig	(	$table,
		$row
	)

static

Returns TSConfig for the TCEFORM object in Page TSconfig. Used in TCEFORMs

Parameters

string	$table	Table name present in TCA
array	$row	Row from table

Returns: array

Definition at line 3833 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Backend\Form\Utility\FormEngineUtility\getTSconfigForTableRow(), TYPO3\CMS\Backend\Controller\Wizard\AddController\init(), TYPO3\CMS\Backend\Controller\Wizard\ListController\main(), and TYPO3\CMS\Backend\Controller\ContentElement\NewContentElementController\removeInvalidElements().

◆ getThumbNail()

static TYPO3\CMS\Backend\Utility\BackendUtility::getThumbNail	(	$thumbScript,
		$theFile,
		$tparams = `''`,
		$size = `''`
	)

static

Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)

Parameters

string	$thumbScript	Must point to "thumbs.php" relative to the script position
string	$theFile	Must be the proper reference to the file that thumbs.php should show
string	$tparams	The additional attributes for the image tag
string	$size	The size of the thumbnail send along to thumbs.php

Returns: string Image tag

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use the corresponding Resource objects and Processing functionality

Definition at line 1854 of file BackendUtility.php.

References $GLOBALS, $params, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ getTSconfig_pidValue()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTSconfig_pidValue	(	$table,
		$uid,
		$pid
	)

static

Find the real PID of the record (with $uid from $table). This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time). NOTICE: Make sure that the input PID is never negative because the record was an offline version! Therefore, you should always use BackendUtility::fixVersioningPid($table,$row); on the data you input before calling this function!

Parameters

string	$table	Table name
int	$uid	Record uid
int	$pid	Record pid, could be negative then pointing to a record from same table whose pid to find and return

Returns: int

Definition at line 3884 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), and TYPO3\CMS\Core\DataHandling\DataHandler\copyL10nOverlayRecords().

◆ getTSCpid()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTSCpid	(	$table,
		$uid,
		$pid
	)

static

Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication.

Parameters

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

Returns: array Array of two ints; first is the REAL PID of a record and if its a new record negative values are resolved to the true PID, second value is the PID value for TSconfig (uid if table is pages, otherwise the pid)

Definition at line 3971 of file BackendUtility.php.

References $uid.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\deleteRecord(), TYPO3\CMS\Core\DataHandling\DataHandler\getOriginalParentOfRecord(), TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords(), and TYPO3\CMS\Core\DataHandling\DataHandler\moveRecord_raw().

◆ getTSCpidCached()

static TYPO3\CMS\Backend\Utility\BackendUtility::getTSCpidCached	(	$table,
		$uid,
		$pid
	)

static

Return the real pid of a record and caches the result. The non-cached method needs database queries to do the job, so this method can be used if code sometimes calls the same record multiple times to save some queries. This should not be done if the calling code may change the same record meanwhile.

Parameters

string	$table	Tablename
string	$uid	UID value
string	$pid	PID value

Returns: array Array of two integers; first is the real PID of a record, second is the PID value for TSconfig.

Definition at line 3944 of file BackendUtility.php.

References $uid.

Referenced by TYPO3\CMS\Backend\Controller\LinkBrowserController\getCurrentPageId(), and TYPO3\CMS\Rtehtmlarea\Form\Resolver\RichTextNodeResolver\resolve().

◆ getUpdateSignalCode()

static TYPO3\CMS\Backend\Utility\BackendUtility::getUpdateSignalCode ( )

static

Call to update the page tree frame (or something else..?) if this is set by the function setUpdateSignal(). It will return some JavaScript that does the update

Returns: string HTML javascript code

See also: BackendUtility::setUpdateSignal(); ::sectionEnd

Definition at line 3410 of file BackendUtility.php.

References $GLOBALS, $params, and TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\endPage(), and TYPO3\CMS\Backend\Template\ModuleTemplate\renderContent().

◆ getUrlToken()

static TYPO3\CMS\Backend\Utility\BackendUtility::getUrlToken	(	$formName = `'securityToken'`,
		$tokenName = `'formToken'`
	)

static

Generates a token and returns a parameter for the URL

Parameters

string	$formName	Context of the token
string	$tokenName	The name of the token GET variable

Exceptions

Definition at line 3601 of file BackendUtility.php.

References TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

Referenced by TYPO3\CMS\Filelist\ViewHelpers\Uri\DeleteFileViewHelper\render().

◆ getUserNames()

static TYPO3\CMS\Backend\Utility\BackendUtility::getUserNames	(		$fields = `'username`,
		usergroup	,
		usergroup_cached_list	,
		uid'	,
			$where = `''`
	)

static

Returns an array with be_users records of all user NOT DELETED sorted by their username Keys in the array is the be_users uid

Parameters

string	$fields	Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
string	$where	Optional $where clause (fx. "AND username='pete'") can be used to limit query

Returns: array

Definition at line 1400 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Workspaces\Service\HistoryService\__construct(), TYPO3\CMS\Beuser\Controller\PermissionAjaxController\__construct(), TYPO3\CMS\Belog\Controller\AbstractController\createUserAndGroupListForSelectOptions(), TYPO3\CMS\Backend\History\RecordHistory\displaySettings(), TYPO3\CMS\Beuser\Controller\PermissionController\editAction(), TYPO3\CMS\Workspaces\Service\StagesService\getBackendUsers(), TYPO3\CMS\Impexp\Task\ImportExportTask\getOverview(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Beuser\Controller\PermissionAjaxController\renderUserSelector(), TYPO3\CMS\Workspaces\Service\StagesService\resolveBackendUserIds(), and TYPO3\CMS\Setup\Controller\SetupModuleController\simulateUser().

◆ getWorkspaceVersionOfRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::getWorkspaceVersionOfRecord	(	$workspace,
		$table,
		$uid,
		$fields = `'*'`
	)

static

Select the workspace version of a record, if exists

Parameters

int	$workspace	Workspace ID
string	$table	Table name to select from
int	$uid	Record uid for which to find workspace version.
string	$fields	Field list to select

Returns: array If found, return record, otherwise FALSE

Definition at line 4497 of file BackendUtility.php.

References $GLOBALS, $uid, and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Version\Dependency\ElementEntityProcessor\createNewDependentElementCallback(), TYPO3\CMS\Backend\Controller\EditDocumentController\doProcessData(), TYPO3\CMS\Core\DataHandling\DataHandler\getCheckModifyAccessListHookObjects(), TYPO3\CMS\Backend\Controller\EditDocumentController\getRecordForEdit(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaInline\getWorkspacedUids(), TYPO3\CMS\Lowlevel\VersionsCommand\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Backend\Controller\Wizard\RteController\mainAction(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFields(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Version\Hook\DataHandlerHook\processCmdmap_deleteAction(), TYPO3\CMS\Backend\History\RecordHistory\resolveElement(), TYPO3\CMS\Core\DataHandling\DataHandler\versionizeRecord(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\workspaceAllowAutoCreation().

◆ getWorkspaceWhereClause()

static TYPO3\CMS\Backend\Utility\BackendUtility::getWorkspaceWhereClause	(	$table,
		$workspaceId = `null`
	)

static

Get additional where clause to select records of a specific workspace (includes live as well).

Parameters

string	$table	Table name
int	$workspaceId	Workspace ID

Returns: string Workspace where clause

Definition at line 4573 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\currentPageHasSubPages(), TYPO3\CMS\Workspaces\Hook\DataHandlerHook\flushWorkspaceElements(), and TYPO3\CMS\Backend\Search\LiveSearch\LiveSearch\makeQuerySearchByTable().

◆ helpTextArray()

static TYPO3\CMS\Backend\Utility\BackendUtility::helpTextArray	(	$table,
		$field
	)

static

Returns CSH help text (description), if configured for, as an array (title, description)

Parameters

string	$table	Table name
string	$field	Field name

Returns: array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'

Definition at line 2786 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\ContextHelp\Controller\ContextHelpAjaxController\getHelpAction().

◆ helpTextIcon()

static TYPO3\CMS\Backend\Utility\BackendUtility::helpTextIcon	(	$table,
		$field,
		$_ = `''`,
		$force = `false`
	)

static

Returns help-text icon if configured for. TCA_DESCR must be loaded prior to this function

Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way, but to wrap the given text (where before the help icon was, and you could hover over it) Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text) was completely removed.

Parameters

string	$table	Table name
string	$field	Field name
string	$_	UNUSED
bool	$force	Force display of icon no matter BE_USER setting for help

Returns: string HTML content for a help icon/text

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, use cshItem() instead

Definition at line 2770 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ implodeTSParams()

static TYPO3\CMS\Backend\Utility\BackendUtility::implodeTSParams	(	$p,
		$k = `''`
	)

static

Implodes a multi dimensional TypoScript array, $p, into a one-dimensional array (return value)

Parameters

array	$p	TypoScript structure
string	$k	Prefix string

Returns: array Imploded TypoScript objectstring/values

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 1371 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ isModuleSetInTBE_MODULES()

static TYPO3\CMS\Backend\Utility\BackendUtility::isModuleSetInTBE_MODULES ( $modName )

static

Returns TRUE if $modName is set and is found as a main- or submodule in $TBE_MODULES array

Parameters

string $modName Module name

Returns: bool

Definition at line 4175 of file BackendUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Version\Controller\VersionModuleController\adminLinks(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_edit(), TYPO3\CMS\Workspaces\Controller\PreviewController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Version\Controller\VersionModuleController\main(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\modAccess().

◆ isRecordLocked()

static TYPO3\CMS\Backend\Utility\BackendUtility::isRecordLocked	(	$table,
		$uid
	)

static

Returns information about whether the record from table, $table, with uid, $uid is currently locked (edited by another user - which should issue a warning). Notice: Locking is not strictly carried out since locking is abandoned when other backend scripts are activated - which means that a user CAN have a record "open" without having it locked. So this just serves as a warning that counts well in 90% of the cases, which should be sufficient.

Parameters

string	$table	Table name
int	$uid	Record uid

Returns: array

Definition at line 3657 of file BackendUtility.php.

References $GLOBALS, and $uid.

Referenced by TYPO3\CMS\Backend\View\PageTreeView\__construct(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Backend\Controller\EditDocumentController\printContent(), TYPO3\CMS\Backend\Form\Container\InlineRecordContainer\renderForeignRecordHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), and TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawHeader().

◆ isRootLevelRestrictionIgnored()

static TYPO3\CMS\Backend\Utility\BackendUtility::isRootLevelRestrictionIgnored ( $table )

static

Whether to ignore restrictions on root-level records. The regular behaviour is that records on the root-level (page-id 0) only can be accessed by admin users.

Parameters

string $table Name of the table

Returns: bool

Definition at line 4867 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\DatabaseUserPermissionCheck\addData(), TYPO3\CMS\Core\DataHandling\DataHandler\checkRecordInsertAccess(), TYPO3\CMS\Core\DataHandling\DataHandler\doesRecordExist(), TYPO3\CMS\Workspaces\Service\WorkspaceService\isPageAccessibleForCurrentUser(), TYPO3\CMS\Core\DataHandling\DataHandler\isTableAllowedForThisPage(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\selectAllVersionsFromPages().

◆ isTableLocalizable()

static TYPO3\CMS\Backend\Utility\BackendUtility::isTableLocalizable ( $table )

static

Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].

Parameters

string $table The table to check

Returns: bool Whether a table is localizable

Definition at line 696 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\Container\InlineControlContainer\__construct(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkFullLanguagesAccess(), TYPO3\CMS\Workspaces\Service\IntegrityService\checkLocalization(), TYPO3\CMS\Core\DataHandling\DataHandler\copyL10nOverlayRecords(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Core\DataHandling\DataHandler\copySpecificPage(), TYPO3\CMS\Core\DataHandling\DataHandler\deleteL10nOverlayRecords(), TYPO3\CMS\Workspaces\Service\GridDataService\getLanguageValue(), TYPO3\CMS\Backend\Domain\Repository\Localization\LocalizationRepository\getRecordLocalization(), TYPO3\CMS\Workspaces\Service\WorkspaceService\isLanguageAccessibleForCurrentUser(), TYPO3\CMS\Core\DataHandling\PlainDataResolver\isLocalizationEnabled(), TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu(), TYPO3\CMS\Workspaces\Service\WorkspaceService\selectAllVersionsFromPages(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\viewSingleRecord().

◆ isTableMovePlaceholderAware()

static TYPO3\CMS\Backend\Utility\BackendUtility::isTableMovePlaceholderAware ( $table )

static

Determines whether a table is aware of using move placeholders, which means 'versioningWS' is set to 2. As of TYPO3 CMS 7, move placeholders is used as default so the method is obsolete.

Parameters

string $table

Returns: bool

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, use isTableWorkspaceEnabled() directly

Definition at line 4825 of file BackendUtility.php.

◆ isTableWorkspaceEnabled()

static TYPO3\CMS\Backend\Utility\BackendUtility::isTableWorkspaceEnabled ( $table )

static

Determines whether a table is enabled for workspaces.

Parameters

string $table Name of the table to be checked

Returns: bool

Definition at line 4811 of file BackendUtility.php.

References $GLOBALS.

◆ isWebMountRestrictionIgnored()

static TYPO3\CMS\Backend\Utility\BackendUtility::isWebMountRestrictionIgnored ( $table )

static

Whether to ignore restrictions on a web-mount of a table. The regular behaviour is that records to be accessed need to be in a valid user's web-mount.

Parameters

string $table Name of the table

Returns: bool

Definition at line 4854 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\doesRecordExist().

◆ lockRecords()

static TYPO3\CMS\Backend\Utility\BackendUtility::lockRecords	(	$table = `''`,
		$uid = `0`,
		$pid = `0`
	)

static

Unlock or Lock a record from $table with $uid If $table and $uid is not set, then all locking for the current BE_USER is removed!

Parameters

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

Returns: void

Definition at line 3623 of file BackendUtility.php.

References $GLOBALS, $uid, and if.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\logoff(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Recordlist\RecordList\mainAction(), TYPO3\CMS\Backend\Controller\EditDocumentController\mainAction(), and TYPO3\CMS\Backend\Controller\EditDocumentController\printContent().

◆ makeConfigForm()

static TYPO3\CMS\Backend\Utility\BackendUtility::makeConfigForm	(	$configArray,
		$defaults,
		$dataPrefix
	)

static

Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix <form>-tags must be supplied separately Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere.

Parameters

array	$configArray	Field configuration code.
array	$defaults	Defaults
string	$dataPrefix	Prefix for formfields

Returns: string HTML for a form.

Definition at line 2700 of file BackendUtility.php.

References $params.

◆ movePlhOL()

static TYPO3\CMS\Backend\Utility\BackendUtility::movePlhOL	(		$table,
		&	$row
	)

static

Checks if record is a move-placeholder (t3ver_state==VersionState::MOVE_PLACEHOLDER) and if so it will set $row to be the pointed-to live record (and return TRUE)

Parameters

string	$table	Table name
array	$row	Row (passed by reference) - must be online record!

Returns: bool TRUE if overlay is made.

See also: PageRepository::movePlhOl()

Definition at line 4465 of file BackendUtility.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), and TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER.

Referenced by TYPO3\CMS\Lowlevel\VersionsCommand\main().

◆ openPageTree()

static TYPO3\CMS\Backend\Utility\BackendUtility::openPageTree	(	$pid,
		$clearExpansion
	)

static

Opens the page tree to the specified page id

Parameters

int	$pid	Page id.
bool	$clearExpansion	If set, then other open branches are closed.

Returns: void

Definition at line 430 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\handlePageEditing().

◆ processParams()

static TYPO3\CMS\Backend\Utility\BackendUtility::processParams ( $params )

static

Returns an array with key=>values based on input text $params $params is exploded by line-breaks and each line is supposed to be on the syntax [key] = [some value] These pairs will be parsed into an array an returned.

Parameters

string $params String of parameters on multiple lines to parse into key-value pairs (see function description)

Returns: array

Definition at line 4769 of file BackendUtility.php.

References $params.

◆ readPageAccess()

static TYPO3\CMS\Backend\Utility\BackendUtility::readPageAccess	(	$id,
		$perms_clause
	)

static

Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not. If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin. In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)

Parameters

int	$id	Page uid for which to check read-access
string	$perms_clause	This is typically a value generated with static::getBackendUserAuthentication()->getPagePermsClause(1);

Returns: array Returns page record if OK, otherwise FALSE.

Definition at line 745 of file BackendUtility.php.

◆ referenceCount()

static TYPO3\CMS\Backend\Utility\BackendUtility::referenceCount	(	$table,
		$ref,
		$msg = `''`,
		$count = `null`
	)

static

Counting references to a record/file

Parameters

string	$table	Table name (or "_FILE" if its a file)
string	$ref	Reference: If table, then int-uid, if _FILE, then file reference (relative to PATH_site)
string	$msg	Message with s, eg. "There were s records pointing to this file!
string \| NULL	$count	Reference count

Returns: string Output string (or int count value if no msg string specified)

Definition at line 4199 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_delete(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_delete(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Filelist\FileList\makeEdit().

◆ replaceL10nModeFields()

static TYPO3\CMS\Backend\Utility\BackendUtility::replaceL10nModeFields	(		$table,
		array	$row
	)

staticprotected

Replace field values in given row with values from the original language if l10n_mode TCA settings require to do so.

Parameters

string	$table	Table name
array	$row	Row to fill with original language values

Returns: array Row with values from the original language

Definition at line 2167 of file BackendUtility.php.

References $GLOBALS.

◆ replaceMarkersInWhereClause()

static TYPO3\CMS\Backend\Utility\BackendUtility::replaceMarkersInWhereClause	(	$whereClause,
		$table,
		$field = `''`,
		$tsConfig = `[]`
	)

static

Replaces all special markers in a where clause. Special markers are:

Parameters

string	$whereClause	Where clause with markers
string	$table	Name of the table of the current record row
string	$field	Field name
array	$tsConfig	TSconfig array from which to get further configuration settings for the field name

Returns: string

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 3784 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ RTEgetObj()

static TYPO3\CMS\Backend\Utility\BackendUtility::RTEgetObj ( )

static

Returns first possible RTE object if available. Usage: $RTEobj = BackendUtility::RTEgetObj();

Returns: mixed If available, returns RTE object, otherwise an array of messages from possible RTEs

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 4056 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ RTEsetup()

static TYPO3\CMS\Backend\Utility\BackendUtility::RTEsetup	(	$RTEprop,
		$table,
		$field,
		$type = `''`
	)

static

Returns processed RTE setup from an array with TSconfig. Merges table and type specific RTE configuration into 'default.'

Parameters

array	$RTEprop	The properties of Page TSconfig in the key "RTE.
string	$table	Table name
string	$field	Field name
string	$type	Type value of the current record (like from CType of tt_content)

Returns: array Array with the configuration for the RTE

Definition at line 4035 of file BackendUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray(), TYPO3\CMS\Rtehtmlarea\Controller\SelectImageController\initVariables(), TYPO3\CMS\Rtehtmlarea\Controller\BrowseLinksController\initVariables(), TYPO3\CMS\Rtehtmlarea\Controller\ParseHtmlController\main_parse_html(), TYPO3\CMS\Rtehtmlarea\Controller\UserElementsController\main_user(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render(), and TYPO3\CMS\Rtehtmlarea\Form\Resolver\RichTextNodeResolver\resolve().

◆ selectVersionsOfRecord()

static TYPO3\CMS\Backend\Utility\BackendUtility::selectVersionsOfRecord	(	$table,
		$uid,
		$fields = `'*'`,
		$workspace = `0`,
		$includeDeletedRecords = `false`,
		$row = `null`
	)

static

Select all versions of a record, ordered by version id (DESC)

Parameters

string	$table	Table name to select from
int	$uid	Record uid for which to find versions.
string	$fields	Field list to select
int \| NULL	$workspace	Search in workspace ID and Live WS, if 0 search only in LiveWS, if NULL search in all WS.
bool	$includeDeletedRecords	If set, deleted-flagged versions are included! (Only for clean-up script!)
array	$row	The current record

Returns: array|NULL Array of versions of table/uid

Definition at line 4259 of file BackendUtility.php.

References $GLOBALS, and $uid.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\deleteVersionsForRecord(), TYPO3\CMS\Lowlevel\CleanerCommand\genTree_traverse(), TYPO3\CMS\Version\Controller\VersionModuleController\lookForOwnVersions(), TYPO3\CMS\Lowlevel\VersionsCommand\main(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Version\Controller\VersionModuleController\versioningMgm().

◆ setUpdateSignal()

static TYPO3\CMS\Backend\Utility\BackendUtility::setUpdateSignal	(	$set = `''`,
		$params = `''`
	)

static

Call to update the page tree frame (or something else..?) after use 'updatePageTree' as a first parameter will set the page tree to be updated.

Parameters

string	$set	Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
mixed	$params	Additional information for the update signal, used to only refresh a branch of the tree

Returns: void

See also: BackendUtility::getUpdateSignalCode()

Definition at line 3386 of file BackendUtility.php.

References $params.

Referenced by TYPO3\CMS\Recordlist\RecordList\clearCache(), TYPO3\CMS\Backend\Controller\EditDocumentController\closeDocument(), TYPO3\CMS\Backend\Controller\EditDocumentController\doProcessData(), TYPO3\CMS\Backend\Controller\File\FileController\finish(), TYPO3\CMS\Workspaces\Controller\PreviewController\initializeAction(), TYPO3\CMS\Backend\Controller\SimpleDataHandlerController\main(), TYPO3\CMS\Setup\Controller\SetupModuleController\main(), TYPO3\CMS\Backend\Controller\File\FileController\mainAction(), TYPO3\CMS\Impexp\Controller\ImportExportController\makeSaveForm(), TYPO3\CMS\Backend\Controller\EditDocumentController\parseAdditionalGetParameters(), and TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons().

◆ shortcutExists()

static TYPO3\CMS\Backend\Utility\BackendUtility::shortcutExists ( $url )

static

Exists already a shortcut entry for this TYPO3 url?

Parameters

string $url

Returns: bool

Definition at line 4879 of file BackendUtility.php.

References TYPO3\CMS\Core\Database\PreparedStatement\FETCH_ASSOC.

Referenced by TYPO3\CMS\Backend\Template\ModuleTemplate\makeShortcutIcon(), TYPO3\CMS\Backend\Template\DocumentTemplate\makeShortcutIcon(), and TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\tryAddingTheShortcut().

◆ softRefParserObj()

static& TYPO3\CMS\Backend\Utility\BackendUtility::softRefParserObj ( $spKey )

static

Returns soft-reference parser for the softRef processing type Usage: $softRefObj = &BackendUtility::softRefParserObj('[parser key]');

Parameters

string $spKey softRef parser key

Returns: mixed If available, returns Soft link parser object.

Definition at line 4092 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\getLinkStatistics(), TYPO3\CMS\Core\Database\ReferenceIndex\getRelations(), and TYPO3\CMS\Core\Database\ReferenceIndex\getRelations_flexFormCallBack().

◆ splitTable_Uid()

static TYPO3\CMS\Backend\Utility\BackendUtility::splitTable_Uid ( $str )

static

Makes an backwards explode on the $str and returns an array with ($table, $uid). Example: tt_content_45 => array('tt_content', 45)

Parameters

string $str [tablename]_[uid] string to explode

Returns: array

Definition at line 221 of file BackendUtility.php.

References $uid.

Referenced by TYPO3\CMS\Core\Resource\Service\UserFileInlineLabelService\getInlineLabel(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaInputPlaceholders\getRelatedGroupFieldUids(), TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed(), and TYPO3\CMS\Backend\Form\Container\InlineRecordContainer\renderForeignRecordHeader().

◆ time()

static TYPO3\CMS\Backend\Utility\BackendUtility::time	(	$value,
		$withSeconds = `true`
	)

static

Returns $value (in seconds) formatted as hh:mm:ss For instance $value = 3600 + 60*2 + 3 should return "01:02:03"

Parameters

int	$value	Time stamp, seconds
bool	$withSeconds	Output hh:mm:ss. If FALSE: hh:mm

Returns: string Formatted time

Definition at line 1589 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaRecordTitle\getRecordTitleForInputType().

◆ titleAltAttrib()

static TYPO3\CMS\Backend\Utility\BackendUtility::titleAltAttrib ( $content )

static

Returns alt="" and title="" attributes with the value of $content.

Parameters

string $content Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)

Returns: string

Definition at line 1654 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGEPREVIEW, TYPO3\CMS\Core\Resource\AbstractFile\getExtension(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR.

◆ titleAttribForPages()

static TYPO3\CMS\Backend\Utility\BackendUtility::titleAttribForPages	(	$row,
		$perms_clause = `''`,
		$includeAttrib = `true`
	)

static

Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.

Parameters

array	$row	Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
string	$perms_clause	This is used to get the record path of the shortcut page, if any (and doktype==4)
bool	$includeAttrib	If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already

Returns: string

Definition at line 1875 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_LINK, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_MOUNTPOINT, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SHORTCUT, TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER, TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER, TYPO3\CMS\Core\Versioning\VersionState\NEW_PLACEHOLDER_VERSION, and TYPO3\CMS\Frontend\Page\PageRepository\SHORTCUT_MODE_NONE.

Referenced by TYPO3\CMS\Backend\Tree\View\BrowseTreeView\getTitleAttrib().

◆ translationCount()

static TYPO3\CMS\Backend\Utility\BackendUtility::translationCount	(	$table,
		$ref,
		$msg = `''`
	)

static

Counting translations of records

Parameters

string	$table	Table name
string	$ref	Reference: the record's uid
string	$msg	Message with s, eg. "This record has s translation(s) which will be deleted, too!

Returns: string Output string (or int count value if no msg string specified)

Definition at line 4230 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_delete(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawHeader().

◆ TYPO3_copyRightNotice()

static TYPO3\CMS\Backend\Utility\BackendUtility::TYPO3_copyRightNotice ( )

static

Prints TYPO3 Copyright notice for About Modules etc. modules.

Warning: DO NOT prevent this notice from being shown in ANY WAY. According to the GPL license an interactive application must show such a notice on start-up ('If the program is interactive, make it output a short notice... ' - see GPL.txt) Therefore preventing this notice from being properly shown is a violation of the license, regardless of whether you remove it or use a stylesheet to obstruct the display.

Returns: string Text/Image (HTML) for copyright notice.

Definition at line 4693 of file BackendUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\formAction(), TYPO3\CMS\Aboutmodules\Controller\ModulesController\indexAction(), and TYPO3\CMS\Cshmanual\Controller\HelpController\initializeAction().

◆ unsetMenuItems()

static TYPO3\CMS\Backend\Utility\BackendUtility::unsetMenuItems	(	$modTSconfig,
		$itemArray,
		$TSref
	)

static

Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig) See Inside TYPO3 about how to program modules and use this API.

Parameters

array	$modTSconfig	Module TS config array
array	$itemArray	Array of items from which to remove items.
string	$TSref	$TSref points to the "object string" in $modTSconfig

Returns: array The modified $itemArray is returned.

Definition at line 3363 of file BackendUtility.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\makeActionMenu(), TYPO3\CMS\Taskcenter\Controller\TaskModuleController\menuConfig(), and TYPO3\CMS\Backend\Module\BaseScriptClass\menuConfig().

◆ versioningPlaceholderClause()

static TYPO3\CMS\Backend\Utility\BackendUtility::versioningPlaceholderClause ( $table )

static

Will return where clause de-selecting new(/deleted)-versions from other workspaces. If in live-workspace, don't show "MOVE-TO-PLACEHOLDERS" records if versioningWS is 2 (allows moving)

Parameters

string $table Table name

Returns: string Where clause if applicable.

Definition at line 4557 of file BackendUtility.php.

References TYPO3\CMS\Core\Versioning\VersionState\DEFAULT_STATE.

◆ viewOnClick()

static TYPO3\CMS\Backend\Utility\BackendUtility::viewOnClick	(	$pageUid,
		$backPath = `''`,
		$rootLine = `null`,
		$anchorSection = `''`,
		$alternativeUrl = `''`,
		$additionalGetVars = `''`,
		$switchFocus = `true`
	)

static

Returns a JavaScript string for viewing the page id, $id It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open.

Parameters

int	$pageUid	Page UID
string	$backPath	Must point back to TYPO3_mainDir (where the site is assumed to be one level above)
array \| NULL	$rootLine	If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
string	$anchorSection	Optional anchor to the URL
string	$alternativeUrl	An alternative URL that, if set, will ignore other parameters except $switchFocus: It will return the window.open command wrapped around this URL!
string	$additionalGetVars	Additional GET variables.
bool	$switchFocus	If TRUE, then the preview window will gain the focus.

Returns: string

Definition at line 2964 of file BackendUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

◆ workspaceOL()

static TYPO3\CMS\Backend\Utility\BackendUtility::workspaceOL	(		$table,
		&	$row,
			$wsid = `-99`,
			$unsetMovePointers = `false`
	)

static

Workspace Preview Overlay Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis. Principle; Record online! => Find offline? Recently, this function has been modified so it MAY set $row to FALSE. This happens if a version overlay with the move-id pointer is found in which case we would like a backend preview. In other words, you should check if the input record is still an array afterwards when using this function.

Parameters

string	$table	Table name
array	$row	Record array passed by reference. As minimum, the "uid" and "pid" fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up. It would be nice to have fields like "t3ver_state" and "t3ver_mode_id" as well to avoid a new lookup inside movePlhOL().
int	$wsid	Workspace ID, if not specified will use static::getBackendUserAuthentication()->workspace
bool	$unsetMovePointers	If TRUE the function does not return a "pointer" row for moved records in a workspace

Returns: void

See also: fixVersioningPid()

Definition at line 4388 of file BackendUtility.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, and TYPO3\CMS\Core\Versioning\VersionState\MOVE_POINTER.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder(), TYPO3\CMS\Workspaces\Service\WorkspaceService\canCreatePreviewLink(), TYPO3\CMS\Core\DataHandling\DataHandler\deleteL10nOverlayRecords(), TYPO3\CMS\Impexp\Export\export_addRecord(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getAllTemplates(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getFirstTemplate(), TYPO3\CMS\Core\DataHandling\DataHandler\fillInFieldArray(), TYPO3\CMS\Version\Hook\DataHandlerHook\findPageElementsForVersionSwap(), TYPO3\CMS\Version\Hook\DataHandlerHook\findPageIdsForVersionStateChange(), TYPO3\CMS\Backend\Tree\View\AbstractTreeView\getDataNext(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\getLangStatus(), TYPO3\CMS\Backend\Controller\PageLayoutController\getLocalizedPageTitle(), TYPO3\CMS\Backend\View\PageLayoutView\getNonTranslatedTTcontentUids(), TYPO3\CMS\Backend\View\BackendLayoutView\getPage(), TYPO3\CMS\Recycler\Utility\RecyclerUtility\getRecordPath(), TYPO3\CMS\Core\DataHandling\DataHandler\getRecordProperties(), TYPO3\CMS\Backend\View\PageLayoutView\getResult(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Backend\Controller\BackendController\handlePageEditing(), TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeQuickEditMenu(), TYPO3\CMS\Backend\Form\Wizard\SuggestWizardDefaultReceiver\makeWorkspaceOverlay(), TYPO3\CMS\Core\DataHandling\DataHandler\moveL10nOverlayRecords(), TYPO3\CMS\Backend\View\PageLayoutView\pages_getTree(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\printContentElementColumns(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Core\DataHandling\DataHandler\updateFlexFormData(), and TYPO3\CMS\Core\TypoScript\TemplateService\versionOL().

◆ wrapClickMenuOnIcon()

static TYPO3\CMS\Backend\Utility\BackendUtility::wrapClickMenuOnIcon	(	$content,
		$table,
		$uid = `0`,
		$listFrame = `true`,
		$addParams = `''`,
		$enDisItems = `''`,
		$returnTagParameters = `false`
	)

static

Makes click menu link (context sensitive menu)

Returns $str wrapped in a link which will activate the context sensitive menu for the record ($table/$uid) or file ($table = file) The link will load the top frame with the parameter "&item" which is the table, uid and listFrame arguments imploded by "|": rawurlencode($table.'|'.$uid.'|'.$listFr)

Parameters

string	$content	String to be wrapped in link, typ. image tag.
string	$table	Table name/File path. If the icon is for a database record, enter the tablename from $GLOBALS['TCA']. If a file then enter the absolute filepath
int	$uid	If icon is for database record this is the UID for the record from $table
bool	$listFrame	Tells the top frame script that the link is coming from a "list" frame which means a frame from within the backend content frame.
string	$addParams	Additional GET parameters for the link to the ClickMenu AJAX request
string	$enDisItems	Enable / Disable click menu items. Example: "+new,view" will display ONLY these two items (and any spacers in between), "new,view" will display all BUT these two items.
bool	$returnTagParameters	If set, will return only the onclick JavaScript, not the whole link.

Returns: string The link wrapped input string.

Definition at line 3019 of file BackendUtility.php.

References $uid, and TYPO3\CMS\Core\Utility\GeneralUtility\implodeAttributes().

◆ wsMapId()

static TYPO3\CMS\Backend\Utility\BackendUtility::wsMapId	(	$table,
		$uid
	)

static

Performs mapping of new uids to new versions UID in case of import inside a workspace.

Parameters

string	$table	Table name
int	$uid	Record uid (of live record placeholder)

Returns: int Uid of offline version if any, otherwise live uid.

Definition at line 4643 of file BackendUtility.php.

References $uid.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData_travDS(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_raw(), TYPO3\CMS\Core\DataHandling\DataHandler\dbAnalysisStoreExec(), TYPO3\CMS\Impexp\Import\processSoftReferences_substTokens(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Impexp\Import\remapListedDBRecords_flexFormCallBack(), TYPO3\CMS\Impexp\Import\setFlexFormRelations(), and TYPO3\CMS\Impexp\Import\setRelations().

Member Data Documentation

◆ $tcaTableTypeConfigurationCache

TYPO3\CMS\Backend\Utility\BackendUtility::$tcaTableTypeConfigurationCache = []

staticprotected

Definition at line 61 of file BackendUtility.php.

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ BEenableFields()

◆ BEgetRootLine()

◆ blindGroupNames()

◆ blindUserNames()

◆ buildScriptUrl()

◆ calcAge()

◆ countVersionsOfRecordsOnPage()

◆ createPreviewUrl()

◆ cshItem()

◆ date()

◆ datetime()

◆ dateTimeAge()

◆ daysUntil()

◆ deleteClause()

◆ editOnClick()

◆ emitGetPagesTSconfigPreIncludeSignal()

◆ exec_foreign_table_where_query()

◆ explodeSoftRefParserList()

◆ firstDomainRecord()

◆ fixVersioningPid()

◆ getBackendScript()

◆ getBackendUserAuthentication()

◆ getCommonSelectFields()

◆ getDatabaseConnection()

◆ getDocumentTemplate()

◆ getDomainStartPage()

◆ getDropdownMenu()

◆ getExcludeFields()

◆ getExplicitAuthFieldValues()

◆ getFlexFormDS()

◆ getFuncCheck()

◆ getFuncInput()

◆ getFuncMenu()

◆ getGroupNames()

◆ getInlineLocalizationMode()

◆ getItemLabel()

◆ getLabelFromItemlist()

◆ getLabelFromItemListMerged()

◆ getLabelsFromItemsList()

◆ getLanguageService()

◆ getLinkToDataHandlerAction()

◆ getListGroupNames()

◆ getLiveVersionIdOfRecord()

◆ getLiveVersionOfRecord()

◆ getModTSconfig()

◆ getModuleData()

◆ getMovePlaceholder()

◆ getNoRecordTitle()

◆ getOriginalTranslationTable()

◆ getPageForRootline()

◆ getPagesTSconfig()

◆ getPathType_web_nonweb()

◆ getPidForModTSconfig()

◆ getProcessedValueExtra()

◆ getRecord()

◆ getRecordIconAltText()

◆ getRecordLocalization()

◆ getRecordPath()

◆ getRecordRaw()

◆ getRecordsByField()

◆ getRecordsSortedByTitle()

◆ getRecordTitle()

◆ getRecordTitlePrep()

◆ getRecordToolTip()

◆ getRecordWSOL()

◆ getRegisteredFlexForms()

◆ getRuntimeCache()

◆ getSignalSlotDispatcher()

◆ getSpecConfParametersFromArray()

◆ getSpecConfParts()

◆ getSQLselectableList()

◆ getTcaFieldConfiguration()

◆ getTCAtypes()

◆ getTCAtypeValue()

◆ getTCEFORM_TSconfig()