DocumentTemplate.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Template;
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;
use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Service\MarkerBasedTemplateService;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\HttpUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪DocumentTemplate implements LoggerAwareInterface
{
    use LoggerAwareTrait;
    use ‪PublicPropertyDeprecationTrait;
 
    protected ‪$deprecatedPublicProperties = [
        'hasDocheader' => 'Using $hasDocheader of class DocumentTemplate is discouraged. The property is not evaluated in the TYPO3 core anymore and will be removed in TYPO3 v10.0.'
    ];
 
    // Vars you typically might want to/should set from outside after making instance of this class:
    public ‪$form = '';
 
    public ‪$JScode = '';
 
    public ‪$JScodeArray = ['jumpToUrl' => '
function jumpToUrl(URL) {
    window.location.href = URL;
    return false;
}
    '];
 
    public ‪$postCode = '';
 
    public ‪$moduleTemplate = '';
 
    protected ‪$moduleTemplateFilename = '';
 
    public ‪$scriptID = '';
 
    public ‪$bodyTagId = '';
 
    public ‪$bodyTagAdditions = '';
 
    public ‪$inDocStylesArray = [];
 
    public ‪$styleSheetFile = '';
 
    public ‪$styleSheetFile2 = '';
 
    public ‪$styleSheetFile_post = '';
 
    protected ‪$useCompatibilityTag = false;
 
    protected ‪$xUaCompatibilityVersion = 'IE=edge';
 
    // Skinning
    protected ‪$stylesheetsSkins = [
        'structure' => 'Resources/Public/Css/structure/',
        'visual' => 'Resources/Public/Css/visual/'
    ];
 
    protected ‪$jsFiles = [];
 
    protected ‪$jsFilesNoConcatenation = [];
 
    public ‪$sectionFlag = 0;
 
    public ‪$divClass = '';
 
    public ‪$pageHeaderBlock = '';
 
    public ‪$endOfPageJsBlock = '';
 
    protected ‪$hasDocheader = true;
 
    protected ‪$pageRenderer;
 
    protected ‪$pageHeaderFooterTemplateFile = '';
 
    public ‪$showFlashMessages = true;
 
    protected ‪$iconFactory;
 
    protected ‪$templateService;
 
    public function ‪__construct()
    {
        // Initializes the page rendering object:
        $this->‪initPageRenderer();
 
        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
 
        // initialize Marker Support
        $this->templateService = GeneralUtility::makeInstance(MarkerBasedTemplateService::class);
 
        // Setting default scriptID, trim forward slash from route
        $this->scriptID = ltrim(GeneralUtility::_GET('route'), '/');
        $this->bodyTagId = preg_replace('/[^A-Za-z0-9-]/', '-', $this->scriptID);
        // Individual configuration per script? If so, make a recursive merge of the arrays:
        if (is_array(‪$GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID] ?? false)) {
            // Make copy
            $ovr = ‪$GLOBALS['TBE_STYLES']['scriptIDindex'][‪$this->scriptID];
            // merge styles.
            ‪\TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule(‪$GLOBALS['TBE_STYLES'], $ovr);
            // Have to unset - otherwise the second instantiation will do it again!
            unset(‪$GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID]);
        }
        // Main Stylesheets:
        if (!empty(‪$GLOBALS['TBE_STYLES']['stylesheet'])) {
            $this->styleSheetFile = ‪$GLOBALS['TBE_STYLES']['stylesheet'];
        }
        if (!empty(‪$GLOBALS['TBE_STYLES']['stylesheet2'])) {
            $this->styleSheetFile2 = ‪$GLOBALS['TBE_STYLES']['stylesheet2'];
        }
        if (!empty(‪$GLOBALS['TBE_STYLES']['styleSheetFile_post'])) {
            $this->styleSheetFile_post = ‪$GLOBALS['TBE_STYLES']['styleSheetFile_post'];
        }
        if (!empty(‪$GLOBALS['TBE_STYLES']['inDocStyles_TBEstyle'])) {
            $this->inDocStylesArray['TBEstyle'] = ‪$GLOBALS['TBE_STYLES']['inDocStyles_TBEstyle'];
        }
        // include all stylesheets
        foreach ($this->‪getSkinStylesheetDirectories() as $stylesheetDirectory) {
            $this->‪addStyleSheetDirectory($stylesheetDirectory);
        }
    }
 
    protected function ‪initPageRenderer()
    {
        if ($this->pageRenderer !== null) {
            return;
        }
        $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
        $this->pageRenderer->setLanguage(‪$GLOBALS['LANG']->lang);
        $this->pageRenderer->enableConcatenateCss();
        $this->pageRenderer->enableConcatenateJavascript();
        $this->pageRenderer->enableCompressCss();
        $this->pageRenderer->enableCompressJavascript();
        // Add all JavaScript files defined in $this->jsFiles to the PageRenderer
        foreach ($this->jsFilesNoConcatenation as $file) {
            $this->pageRenderer->addJsFile(
                $file,
                'text/javascript',
                true,
                false,
                '',
                true
            );
        }
        // Add all JavaScript files defined in $this->jsFiles to the PageRenderer
        foreach ($this->jsFiles as $file) {
            $this->pageRenderer->addJsFile($file);
        }
        if ((int)‪$GLOBALS['TYPO3_CONF_VARS']['BE']['debug'] === 1) {
            $this->pageRenderer->enableDebugMode();
        }
    }
 
    /*****************************************
     *
     * EVALUATION FUNCTIONS
     * Various centralized processing
     *
     *****************************************/
 
    public function ‪makeShortcutIcon($gvList, $setList, $modName, $motherModName = '', $classes = '')
    {
        $gvList = 'route,' . $gvList;
        $storeUrl = $this->‪makeShortcutUrl($gvList, $setList);
        $pathInfo = parse_url(GeneralUtility::getIndpEnv('REQUEST_URI'));
        // Fallback for alt_mod. We still pass in the old xMOD... stuff, but TBE_MODULES only knows about "record_edit".
        // We still need to pass the xMOD name to createShortcut below, since this is used for icons.
        $moduleName = $modName === 'xMOD_alt_doc.php' ? 'record_edit' : $modName;
        // Add the module identifier automatically if typo3/index.php is used:
        if (GeneralUtility::_GET('M') !== null) {
            $storeUrl = '&M=' . $moduleName . $storeUrl;
        }
        if ((int)$motherModName === 1) {
            $motherModule = 'top.currentModuleLoaded';
        } elseif ($motherModName) {
            $motherModule = GeneralUtility::quoteJSvalue($motherModName);
        } else {
            $motherModule = '\'\'';
        }
        $confirmationText = GeneralUtility::quoteJSvalue(‪$GLOBALS['LANG']->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.makeBookmark'));
 
        $shortcutUrl = $pathInfo['path'] . '?' . $storeUrl;
        $shortcutRepository = GeneralUtility::makeInstance(ShortcutRepository::class);
        $shortcutExist = $shortcutRepository->shortcutExists($shortcutUrl);
 
        if ($shortcutExist) {
            return '<a class="active ' . htmlspecialchars($classes) . '" title="">' .
            $this->iconFactory->getIcon('actions-system-shortcut-active', ‪Icon::SIZE_SMALL)->render() . '</a>';
        }
        $url = GeneralUtility::quoteJSvalue(rawurlencode($shortcutUrl));
        $onClick = 'top.TYPO3.ShortcutMenu.createShortcut(' . GeneralUtility::quoteJSvalue(rawurlencode($modName)) .
            ', ' . $url . ', ' . $confirmationText . ', ' . $motherModule . ', this);return false;';
 
        return '<a href="#" class="' . htmlspecialchars($classes) . '" onclick="' . htmlspecialchars($onClick) . '" title="' .
        htmlspecialchars(‪$GLOBALS['LANG']->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.makeBookmark')) . '">' .
        $this->iconFactory->getIcon('actions-system-shortcut-new', ‪Icon::SIZE_SMALL)->render() . '</a>';
    }
 
    public function ‪makeShortcutUrl($gvList, $setList)
    {
        $GET = GeneralUtility::_GET();
        $storeArray = array_merge(
            GeneralUtility::compileSelectedGetVarsFromArray($gvList, $GET),
            ['SET' => GeneralUtility::compileSelectedGetVarsFromArray($setList, (array)‪$GLOBALS['SOBE']->MOD_SETTINGS)]
        );
        return ‪HttpUtility::buildQueryString($storeArray, '&');
    }
 
    public function ‪formWidth($size = 48, $textarea = false, $styleOverride = '')
    {
        trigger_error('DocumentTemplate->formWidth() will be removed in TYPO3 10.0 - use responsive code or direct inline styles to format your input fields instead.', E_USER_DEPRECATED);
        return ' style="' . ($styleOverride ?: 'width:' . ceil($size * 9.58) . 'px;') . '"';
    }
 
    public function ‪redirectUrls($thisLocation = '')
    {
        $thisLocation = $thisLocation ? $thisLocation : GeneralUtility::linkThisScript([
            'CB' => '',
            'SET' => '',
            'cmd' => '',
            'popViewId' => ''
        ]);
        $out = '
    var T3_RETURN_URL = ' . GeneralUtility::quoteJSvalue(str_replace('%20', '', rawurlencode(GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GP('returnUrl'))))) . ';
    var T3_THIS_LOCATION = ' . GeneralUtility::quoteJSvalue(str_replace('%20', '', rawurlencode($thisLocation))) . '
        ';
        return $out;
    }
 
    public function ‪useCompatibilityTag(‪$useCompatibilityTag = true)
    {
        $this->‪useCompatibilityTag = (bool)‪$useCompatibilityTag;
    }
 
    /*****************************************
     *
     *  PAGE BUILDING FUNCTIONS.
     *  Use this to build the HTML of your backend modules
     *
     *****************************************/
    public function ‪startPage($title)
    {
        // hook pre start page
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'] ?? [] as $hookFunction) {
            $hookParameters = [
                'title' => &$title
            ];
            GeneralUtility::callUserFunction($hookFunction, $hookParameters, $this);
        }
        // alternative template for Header and Footer
        if ($this->pageHeaderFooterTemplateFile) {
            $file = GeneralUtility::getFileAbsFileName($this->pageHeaderFooterTemplateFile);
            if ($file) {
                $this->pageRenderer->setTemplateFile($file);
            }
        }
 
        // Disable rendering of XHTML tags
        $this->pageRenderer->setRenderXhtml(false);
 
        $languageCode = $this->pageRenderer->getLanguage() === 'default' ? 'en' : $this->pageRenderer->getLanguage();
        $this->pageRenderer->setHtmlTag('<html lang="' . $languageCode . '">');
 
        $headerStart = '<!DOCTYPE html>';
        $this->pageRenderer->setXmlPrologAndDocType($headerStart);
        $this->pageRenderer->setHeadTag('<head>' . LF . '<!-- TYPO3 Script ID: ' . htmlspecialchars($this->scriptID) . ' -->');
        header('Content-Type:text/html;charset=utf-8');
        $this->pageRenderer->setCharSet('utf-8');
        $this->pageRenderer->setMetaTag('name', 'generator', $this->‪generator());
        $this->pageRenderer->setMetaTag('name', 'robots', 'noindex,follow');
        $this->pageRenderer->setMetaTag('name', 'viewport', 'width=device-width, initial-scale=1');
        $this->pageRenderer->setFavIcon($this->‪getBackendFavicon());
        if ($this->‪useCompatibilityTag) {
            $this->pageRenderer->setMetaTag('http-equiv', 'X-UA-Compatible', $this->xUaCompatibilityVersion);
        }
        $this->pageRenderer->setTitle($title);
        // add docstyles
        $this->‪docStyle();
        $this->pageRenderer->addHeaderData($this->JScode);
        foreach ($this->JScodeArray as $name => $code) {
            $this->pageRenderer->addJsInlineCode($name, $code, false);
        }
 
        // Note: please do not reference "bootstrap" outside of the TYPO3 Core (not in your own extensions)
        // as this is preliminary as long as Twitter bootstrap does not support AMD modules
        // this logic will be changed once Twitter bootstrap 4 is included
        // @todo
        $this->pageRenderer->addJsFile('EXT:core/Resources/Public/JavaScript/Contrib/bootstrap/bootstrap.js');
 
        // csh manual require js module & moduleUrl
        if (TYPO3_MODE === 'BE' && $this->‪getBackendUser() && !empty($this->‪getBackendUser()->user)) {
            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
            $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ContextHelp');
            $this->pageRenderer->addInlineSetting(
                'ContextHelp',
                'moduleUrl',
                (string)$uriBuilder->buildUriFromRoute('help_cshmanual', ['action' => 'detail'])
            );
        }
 
        // hook for additional headerData
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preHeaderRenderHook'] ?? [] as $hookFunction) {
            $hookParameters = [
                'pageRenderer' => &‪$this->pageRenderer
            ];
            GeneralUtility::callUserFunction($hookFunction, $hookParameters, $this);
        }
        // Construct page header.
        $str = $this->pageRenderer->render(‪PageRenderer::PART_HEADER);
        $this->JScode = '';
        $this->JScodeArray = [];
        $this->endOfPageJsBlock = $this->pageRenderer->render(‪PageRenderer::PART_FOOTER);
        $str .= $this->‪docBodyTagBegin() . ($this->divClass ? '
 
<!-- Wrapping DIV-section for whole page BEGIN -->
<div class="' . $this->divClass . '">
' : '') . trim($this->form);
        return $str;
    }
 
    public function ‪endPage()
    {
        $str = $this->postCode . GeneralUtility::wrapJS(‪BackendUtility::getUpdateSignalCode()) . ($this->form ? '
</form>' : '');
        // If something is in buffer like debug, put it to end of page
        if (ob_get_contents()) {
            $str .= ob_get_clean();
            if (!headers_sent()) {
                header('Content-Encoding: None');
            }
        }
        $str .= ($this->divClass ? '
 
<!-- Wrapping DIV-section for whole page END -->
</div>' : '') . $this->endOfPageJsBlock;
 
        // Logging: Can't find better place to put it:
        $this->logger->debug('END of BACKEND session', ['_FLUSH' => true]);
        return $str;
    }
 
    public function ‪render($title, $content)
    {
        $pageContent = $this->‪startPage($title);
        $pageContent .= $content;
        $pageContent .= $this->‪endPage();
        return $this->‪insertStylesAndJS($pageContent);
    }
 
    public function ‪docBodyTagBegin()
    {
        return '<body ' . trim($this->bodyTagAdditions . ($this->bodyTagId ? ' id="' . $this->bodyTagId . '"' : '')) . '>';
    }
 
    public function ‪docStyle()
    {
        // Implode it all:
        $inDocStyles = implode(LF, $this->inDocStylesArray);
 
        // Reset styles so they won't be added again in insertStylesAndJS()
        $this->inDocStylesArray = [];
 
        if ($this->styleSheetFile) {
            $this->pageRenderer->addCssFile($this->styleSheetFile);
        }
        if ($this->styleSheetFile2) {
            $this->pageRenderer->addCssFile($this->styleSheetFile2);
        }
 
        if ($inDocStyles !== '') {
            $this->pageRenderer->addCssInlineBlock('inDocStyles', $inDocStyles . LF . '/*###POSTCSSMARKER###*/');
        }
 
        if ($this->styleSheetFile_post) {
            $this->pageRenderer->addCssFile($this->styleSheetFile_post);
        }
    }
 
    public function ‪addStyleSheet($key, $href, $title = '', $relation = 'stylesheet')
    {
        trigger_error('DocumentTemplate->->addStyleSheet() will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);
        $this->pageRenderer->addCssFile($href, $relation, 'screen', $title);
    }
 
    public function ‪addStyleSheetDirectory($path)
    {
        $path = GeneralUtility::getFileAbsFileName($path);
        // Read all files in directory and sort them alphabetically
        $cssFiles = GeneralUtility::getFilesInDir($path, 'css');
        foreach ($cssFiles as $cssFile) {
            $this->pageRenderer->addCssFile(‪PathUtility::getRelativePathTo($path) . $cssFile);
        }
    }
 
    public function ‪insertStylesAndJS($content)
    {
        $styles = LF . implode(LF, $this->inDocStylesArray);
        $content = str_replace('/*###POSTCSSMARKER###*/', $styles, $content);
 
        // Insert accumulated JS
        $jscode = $this->JScode . LF . GeneralUtility::wrapJS(implode(LF, $this->JScodeArray));
        $content = str_replace('<!--###POSTJSMARKER###-->', $jscode, $content);
        return $content;
    }
 
    public function ‪getSkinStylesheetDirectories()
    {
        $stylesheetDirectories = [];
        // Stylesheets from skins
        // merge default css directories ($this->stylesheetsSkin) with additional ones and include them
        if (is_array(‪$GLOBALS['TBE_STYLES']['skins'])) {
            // loop over all registered skins
            foreach (‪$GLOBALS['TBE_STYLES']['skins'] as $skinExtKey => $skin) {
                $skinStylesheetDirs = ‪$this->stylesheetsSkins;
                // Skins can add custom stylesheetDirectories using
                // $GLOBALS['TBE_STYLES']['skins'][$_EXTKEY]['stylesheetDirectories']
                if (is_array($skin['stylesheetDirectories'])) {
                    $skinStylesheetDirs = array_merge($skinStylesheetDirs, $skin['stylesheetDirectories']);
                }
                // Add all registered directories
                foreach ($skinStylesheetDirs as $stylesheetDir) {
                    // for EXT:myskin/stylesheets/ syntax
                    if (strpos($stylesheetDir, 'EXT:') === 0) {
                        list($extKey, $path) = explode('/', substr($stylesheetDir, 4), 2);
                        if (!empty($extKey) && ‪ExtensionManagementUtility::isLoaded($extKey) && !empty($path)) {
                            $stylesheetDirectories[] = ‪ExtensionManagementUtility::extPath($extKey) . $path;
                        }
                    } else {
                        // For relative paths
                        $stylesheetDirectories[] = ‪ExtensionManagementUtility::extPath($skinExtKey) . $stylesheetDir;
                    }
                }
            }
        }
        return $stylesheetDirectories;
    }
 
    public function ‪generator()
    {
        return 'TYPO3 CMS, ' . TYPO3_URL_GENERAL . ', &#169; Kasper Sk&#229;rh&#248;j ' . TYPO3_copyright_year . ', extensions are copyright of their respective owners.';
    }
 
    public function ‪xUaCompatible($content = 'IE=8')
    {
        trigger_error('DocumentTemplate->xUaCompatible() will be removed with TYPO3 v10.0. Use PageRenderer->setMetaTag() instead.', E_USER_DEPRECATED);
        return '<meta http-equiv="X-UA-Compatible" content="' . $content . '" />';
    }
 
    /*****************************************
     *
     * OTHER ELEMENTS
     * Tables, buttons, formatting dimmed/red strings
     *
     ******************************************/
 
    public function ‪getHtmlTemplate($filename)
    {
        // setting the name of the original HTML template
        $this->moduleTemplateFilename = $filename;
        if (‪$GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
            $filename = ‪$GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
        }
        $filename = GeneralUtility::getFileAbsFileName($filename);
        return $filename !== '' ? file_get_contents($filename) : '';
    }
 
    public function ‪setModuleTemplate($filename)
    {
        $this->moduleTemplate = $this->‪getHtmlTemplate($filename);
    }
 
    public function ‪moduleBody($pageRecord = [], $buttons = [], $markerArray = [], $subpartArray = [])
    {
        // Get the HTML template for the module
        $moduleBody = $this->templateService->getSubpart($this->moduleTemplate, '###FULLDOC###');
        // Add CSS
        $this->inDocStylesArray[] = 'html { overflow: hidden; }';
        // Get the page path for the docheader
        $markerArray['PAGEPATH'] = $this->‪getPagePath($pageRecord);
        // Get the page info for the docheader
        $markerArray['PAGEINFO'] = $this->‪getPageInfo($pageRecord);
        // Get all the buttons for the docheader
        $docHeaderButtons = $this->‪getDocHeaderButtons($buttons);
        // Merge docheader buttons with the marker array
        $markerArray = array_merge($markerArray, $docHeaderButtons);
        // replacing subparts
        foreach ($subpartArray as $marker => $content) {
            $moduleBody = $this->templateService->substituteSubpart($moduleBody, $marker, $content);
        }
        // adding flash messages
        if ($this->showFlashMessages) {
            $flashMessages = $this->‪getFlashMessages();
            if (!empty($flashMessages)) {
                $markerArray['FLASHMESSAGES'] = $flashMessages;
                // If there is no dedicated marker for the messages present
                // then force them to appear before the content
                if (strpos($moduleBody, '###FLASHMESSAGES###') === false) {
                    $moduleBody = str_replace('###CONTENT###', '###FLASHMESSAGES######CONTENT###', $moduleBody);
                }
            }
        }
        // Hook for adding more markers/content to the page, like the version selector
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'] ?? [] as $funcRef) {
            $params = [
                'moduleTemplateFilename' => &‪$this->moduleTemplateFilename,
                'moduleTemplate' => &‪$this->moduleTemplate,
                'moduleBody' => &$moduleBody,
                'markers' => &$markerArray,
                'parentObject' => &$this
            ];
            GeneralUtility::callUserFunction($funcRef, $params, $this);
        }
        // Replacing all markers with the finished markers and return the HTML content
        return $this->templateService->substituteMarkerArray($moduleBody, $markerArray, '###|###');
    }
 
    public function ‪getFlashMessages()
    {
        $flashMessageService = GeneralUtility::makeInstance(\‪TYPO3\CMS\Core\Messaging\FlashMessageService::class);
        $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
        return $defaultFlashMessageQueue->renderFlashMessages();
    }
 
    protected function ‪getDocHeaderButtons($buttons)
    {
        $markers = [];
        // Fill buttons for left and right float
        $floats = ['left', 'right'];
        foreach ($floats as $key) {
            // Get the template for each float
            $buttonTemplate = $this->templateService->getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
            // Fill the button markers in this float
            $buttonTemplate = $this->templateService->substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
            // getting the wrap for each group
            $buttonWrap = $this->templateService->getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###');
            // looping through the groups (max 6) and remove the empty groups
            for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) {
                $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
                $buttonGroup = $this->templateService->getSubpart($buttonTemplate, $buttonMarker);
                if (trim($buttonGroup)) {
                    if ($buttonWrap) {
                        $buttonGroup = $this->templateService->substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
                    }
                    $buttonTemplate = $this->templateService->substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
                }
            }
            // Replace the marker with the template and remove all line breaks (for IE compat)
            $markers['BUTTONLIST_' . strtoupper($key)] = str_replace(LF, '', $buttonTemplate);
        }
        // Hook for manipulating docHeaderButtons
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] ?? [] as $funcRef) {
            $params = [
                'buttons' => $buttons,
                'markers' => &$markers,
                'pObj' => &$this
            ];
            GeneralUtility::callUserFunction($funcRef, $params, $this);
        }
        return $markers;
    }
 
    protected function ‪getPagePath($pageRecord)
    {
        // Is this a real page
        if (is_array($pageRecord) && $pageRecord['uid']) {
            $title = substr($pageRecord['_thePathFull'], 0, -1);
            // Remove current page title
            $pos = strrpos($title, $pageRecord['title']);
            if ($pos !== false) {
                $title = substr($title, 0, $pos);
            }
        } else {
            $title = '';
        }
        // Setting the path of the page
        $pagePath = htmlspecialchars(‪$GLOBALS['LANG']->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.path')) . ': <span class="typo3-docheader-pagePath">';
        // crop the title to title limit (or 50, if not defined)
        $cropLength = empty(‪$GLOBALS['BE_USER']->uc['titleLen']) ? 50 : ‪$GLOBALS['BE_USER']->uc['titleLen'];
        $croppedTitle = GeneralUtility::fixed_lgd_cs($title, -$cropLength);
        if ($croppedTitle !== $title) {
            $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
        } else {
            $pagePath .= htmlspecialchars($title);
        }
        $pagePath .= '</span>';
        return $pagePath;
    }
 
    protected function ‪getPageInfo($pageRecord)
    {
        // Add icon with context menu, etc:
        // If there IS a real page
        if (is_array($pageRecord) && $pageRecord['uid']) {
            $alttext = ‪BackendUtility::getRecordIconAltText($pageRecord, 'pages');
            $iconImg = '<span title="' . htmlspecialchars($alttext) . '">' . $this->iconFactory->getIconForRecord('pages', $pageRecord, ‪Icon::SIZE_SMALL)->render() . '</span>';
            // Make Icon:
            $theIcon = ‪BackendUtility::wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
            $uid = $pageRecord['uid'];
            $title = ‪BackendUtility::getRecordTitle('pages', $pageRecord);
        } else {
            // On root-level of page tree
            // Make Icon
            $iconImg = '<span title="' . htmlspecialchars(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename']) . '">' . $this->iconFactory->getIcon('apps-pagetree-root', ‪Icon::SIZE_SMALL)->render() . '</span>';
            if (‪$GLOBALS['BE_USER']->isAdmin()) {
                $theIcon = ‪BackendUtility::wrapClickMenuOnIcon($iconImg, 'pages');
            } else {
                $theIcon = $iconImg;
            }
            $uid = '0';
            $title = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
        }
        // Setting icon with context menu + uid
        $pageInfo = $theIcon . '<strong>' . htmlspecialchars($title) . '&nbsp;[' . $uid . ']</strong>';
        return $pageInfo;
    }
 
    protected function ‪getBackendFavicon()
    {
        $backendFavicon = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get('backend', 'backendFavicon');
        if (!empty($backendFavicon)) {
            $path = $this->‪getUriForFileName($backendFavicon);
        } else {
            $path = ‪ExtensionManagementUtility::extPath('backend') . 'Resources/Public/Icons/favicon.ico';
        }
        return ‪PathUtility::getAbsoluteWebPath($path);
    }
 
    protected function ‪getUriForFileName($filename)
    {
        if (strpos($filename, '://')) {
            return $filename;
        }
        $urlPrefix = '';
        if (strpos($filename, 'EXT:') === 0) {
            $absoluteFilename = GeneralUtility::getFileAbsFileName($filename);
            $filename = '';
            if ($absoluteFilename !== '') {
                $filename = ‪PathUtility::getAbsoluteWebPath($absoluteFilename);
            }
        } elseif (strpos($filename, '/') !== 0) {
            $urlPrefix = GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');
        }
        return $urlPrefix . $filename;
    }
 
    protected function ‪getBackendUser()
    {
        return ‪$GLOBALS['BE_USER'] ?? null;
    }
}