63 * Standard functions available for the TYPO3 backend.
65 * Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
67 * Call ALL methods without making an object!
81 * Will automatically check if records has been deleted and if so, not return anything.
125 * Like getRecord(), but overlays workspace version if any.
162 * Purges computed properties starting with underscore character ('_').
179 * Purges computed property names starting with underscore character ('_').
195 * Makes an backwards explode on the $str and returns an array with ($table, $uid).
209 * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
210 * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
211 * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
213 * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
269 * Fetches the localization for a given record.
322 * ($uid) and back to the root.
323 * By default deleted pages are filtered.
325 * from the frontend where the rootline stops when a root-template is found.
327 * @param int $uid Page id for which to create the root line.
329 * stops the process if we meet a page, the user has no reading access to.
331 * usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
403 * @param int $uid Page id for which to create the root line.
404 * @param 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.
405 * @param 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!
549 * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].
565 * 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.
566 * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
571 * @return array|bool Returns page record if OK, otherwise FALSE.
598 * If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used.
603 * 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).
604 * 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"
605 * and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.
657 // Force to string. Necessary for eg '-1' to be recognized as a type value.
711 // contain the cached content.
751 $includeTsConfigFileAndPath = ExtensionManagementUtility::extPath($includeTsConfigFileExtensionKey) .
810 * Returns an array of all non-deleted records of a table sorted by a given title field.
812 * of self::getRecordTitle() before the sorting is performed.
854 * Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
960 * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
972 * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
1000 * Returns a formatted timestamp if $tstamp is set.
1001 * The date/datetime will be followed by the age in parenthesis.
1004 * @param int $prefix 1/-1 depending on polarity of age.
1019 * Resolves file references for a given record.
1084 * Thumbsnails are linked to the show_item.php script which will display further details.
1086 * @param array $row Row is the database row from the table, $table.
1094 * @param int|string $size Optional: $size is [w]x[h] of the thumbnail. 64 is default.
1096 * @return string Thumbnail image tag.
1200 // instead of a file.
1255 * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
1374 * 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.
1375 * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
1493 * Splits the given key with commas and returns the list of all the localized items labels, separated by a comma.
1498 * @param string $keyList Key or comma-separated list of keys.
1568 * @param bool $forceResult If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
1637 * which offers a tooltip with the original title when moving mouse over it.
1659 * Get a localized [No title] string, wrapped in <em>|</em> if $prep is TRUE.
1666 $noTitle = '[' .
1677 * For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc.
1686 * @param bool $noRecordLookup If set, no records will be looked up, UIDs are just shown.
1688 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
1712 // Depending on the fields configuration, make a meaningful output value.
2110 * 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.
2117 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
2137 // Fetches the path with no regard to the users permissions to select pages.
2149 * This includes uid, the fields defined for title, icon-field.
2155 * @return string List of fields.
2316 * API for getting CSH icons/text for use in backend modules.
2322 * @param string $wrap Wrap code for icon-mode, splitted by "|". Not used for full-text mode.
2346 * @param 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] = edit' which will show edit form for page record 123.
2348 * @param string $requestUri An optional returnUrl you can set - automatically set to REQUEST_URI.
2365 * It will re-use any window already open.
2371 * @param 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!
2372 * @param string $additionalGetVars Additional GET variables.
2373 * @param bool $switchFocus If TRUE, then the preview window will gain the focus.
2405 * It will detect the correct domain name if needed and provide the link with the right back path.
2411 * @param 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!
2412 * @param string $additionalGetVars Additional GET variables.
2413 * @param bool $switchFocus If TRUE, then the preview window will gain the focus.
2445 // If there is an alternative URL or the URL has been modified by a hook, use that one.
2503 * @param string $content String to be wrapped in link, typ. image tag.
2515 * @return string The link wrapped input string.
2559 * Creates the view-on-click preview URL without any alternative URL.
2564 * @param string $additionalGetVars Additional GET variables.
2586 // Choose if set.
2592 // All allowed since no lang. are listed.
2652 // available sys_domain record.
2681 * @param string $currentValue The value to be selected currently.
2684 * @param string $addParams Additional parameters to pass to the script.
2726 * Based on BackendUtility::getFuncMenu() but done as new function because it has another purpose.
2727 * Mingling with getFuncMenu would harm the docHeader Menu.
2731 * @param string $currentValue The value to be selected currently.
2734 * @param string $addParams Additional parameters to pass to the script.
2774 * Checkbox function menu.
2775 * Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
2779 * @param string $currentValue The value to be selected currently.
2781 * @param string $addParams Additional parameters to pass to the script.
2801 ' name="' . $elementName . '"' .
2802 ($currentValue ? ' checked="checked"' : '') .
2803 ' onclick="' . htmlspecialchars($onClick) . '"' .
2804 ($tagParams ? ' ' . $tagParams : '') .
2811 * Works like ->getFuncMenu() / ->getFuncCheck() but displays an input field instead which updates the script "onchange"
2815 * @param string $currentValue The value to be selected currently.
2818 * @param string $addParams Additional parameters to pass to the script.
2819 * @return string HTML code for input text field.
2865 * use 'updatePageTree' as a first parameter will set the page tree to be updated.
2867 * @param 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.