PageRendererBackendSetupTrait.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Backend\Template;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use ‪TYPO3\CMS\Core\Http\NormalizedParams;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
trait ‪PageRendererBackendSetupTrait
{
    protected function ‪setUpBasicPageRendererForBackend(
        ‪PageRenderer $pageRenderer,
        ‪ExtensionConfiguration $extensionConfiguration,
        ServerRequestInterface $request,
        ‪LanguageService $languageService,
    ): void {
        $pageRenderer->‪setLanguage($languageService->‪getLocale());
        $pageRenderer->‪setMetaTag('name', 'viewport', 'width=device-width, initial-scale=1');
        $pageRenderer->‪setFavIcon($this->getBackendFavicon($extensionConfiguration, $request));
        $nonce = $request->getAttribute('nonce');
        if ($nonce !== null) {
            $pageRenderer->‪setNonce($nonce);
            $pageRenderer->‪setApplyNonceHint(true);
        }
        $this->loadStylesheets($pageRenderer);
    }
 
    protected function ‪loadStylesheets(‪PageRenderer $pageRenderer): void
    {
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets'] ?? [] as $path) {
            $path = GeneralUtility::getFileAbsFileName($path);
            if (!$path) {
                continue;
            }
            if (is_dir($path)) {
                // Path like 'EXT:my_extension/Resources/Public/Css/Backend'
                foreach (GeneralUtility::getFilesInDir($path, 'css', true) as $cssFile) {
                    $pageRenderer->‪addCssFile($cssFile);
                }
            } elseif (file_exists($path)) {
                // A single file 'EXT:my_extension/Resources/Public/Css/Backend/main.css' or just a single file
                $pageRenderer->‪addCssFile($path);
            }
        }
    }
 
    protected function ‪getBackendFavicon(‪ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request): string
    {
        $backendFavicon = $extensionConfiguration->‪get('backend', 'backendFavicon');
        if (!empty($backendFavicon)) {
            return $this->getUriForFileName($request, $backendFavicon);
        }
        return ‪PathUtility::getPublicResourceWebPath('EXT:backend/Resources/Public/Icons/favicon.ico');
    }
 
    protected function ‪getUriForFileName(ServerRequestInterface $request, string $filename): string
    {
        if (‪PathUtility::hasProtocolAndScheme($filename)) {
            return $filename;
        }
        $urlPrefix = '';
        if (‪PathUtility::isExtensionPath($filename)) {
            $filename = ‪PathUtility::getPublicResourceWebPath($filename);
        } elseif (!str_starts_with($filename, '/')) {
            $urlPrefix = $this->getNormalizedParams($request)->getSitePath();
        }
        return $urlPrefix . $filename;
    }
 
    protected function ‪getNormalizedParams(ServerRequestInterface $request): ‪NormalizedParams
    {
        return $request->getAttribute('normalizedParams');
    }
}