TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait:

Protected Member Functions
	setUpBasicPageRendererForBackend (PageRenderer $pageRenderer, ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request, LanguageService $languageService,)
	loadStylesheets (PageRenderer $pageRenderer)
	getBackendFavicon (ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request)
string	getUriForFileName (ServerRequestInterface $request, string $filename)
	getNormalizedParams (ServerRequestInterface $request)

Detailed Description

This is an internal helper trait to DRY basic PageRenderer backend setup code in the backend. It configures the PageRenderer for general backend use (charset, favicon, ...). Most prominent use is ModuleTemplate - The View used to render backend modules that have doc headers. It's also used in controllers that render backend things that have no doc header: For instance the login, the main frame and link handlers - the iframes within modals. The PageRenderer in general is more on the "maybe we can get rid of it soon" side. This trait exists to simplify a possible refactoring. In general, controllers should strive to do as little PageRenderer calls as possible and move existing calls to templates using f:be.pageRenderer ViewHelper. This will simplify substituting PageRenderer with a slim dedicated backend solution.

helper. Do not use in extensions.

Definition at line 44 of file PageRendererBackendSetupTrait.php.

Member Function Documentation

getBackendFavicon()

TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait::getBackendFavicon ( ExtensionConfiguration  $extensionConfiguration, ServerRequestInterface  $request  )

protected

Retrieves configured favicon for backend with fallback.

Definition at line 91 of file PageRendererBackendSetupTrait.php.

References TYPO3\CMS\Core\Configuration\ExtensionConfiguration\get(), TYPO3\CMS\Core\Utility\PathUtility\getPublicResourceWebPath(), and TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\getUriForFileName().

Referenced by TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\setUpBasicPageRendererForBackend().

getNormalizedParams()

TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait::getNormalizedParams ( ServerRequestInterface  $request )

protected

Definition at line 122 of file PageRendererBackendSetupTrait.php.

Referenced by TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\getUriForFileName().

getUriForFileName()

string TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait::getUriForFileName ( ServerRequestInterface  $request, string  $filename  )

protected

Returns the uri of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the project root of the TYPO3 installation

Parameters

string

$filename

‪The input filename/filepath to evaluate

Returns

‪string Returns the filename of $filename if valid, otherwise blank string.

Definition at line 108 of file PageRendererBackendSetupTrait.php.

References TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\getNormalizedParams(), TYPO3\CMS\Core\Utility\PathUtility\getPublicResourceWebPath(), TYPO3\CMS\Core\Utility\PathUtility\hasProtocolAndScheme(), and TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath().

Referenced by TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\getBackendFavicon().

loadStylesheets()

TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait::loadStylesheets ( PageRenderer  $pageRenderer )

protected

Load all registered stylesheets from $GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets']

Definition at line 69 of file PageRendererBackendSetupTrait.php.

References $GLOBALS, and TYPO3\CMS\Core\Page\PageRenderer\addCssFile().

Referenced by TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\setUpBasicPageRendererForBackend().

setUpBasicPageRendererForBackend()

TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait::setUpBasicPageRendererForBackend ( PageRenderer  $pageRenderer, ExtensionConfiguration  $extensionConfiguration, ServerRequestInterface  $request, LanguageService  $languageService  )

protected

Sets mandatory parameters for the PageRenderer.

Definition at line 49 of file PageRendererBackendSetupTrait.php.

References TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\getBackendFavicon(), TYPO3\CMS\Core\Localization\LanguageService\getLocale(), TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait\loadStylesheets(), TYPO3\CMS\Core\Page\PageRenderer\setApplyNonceHint(), TYPO3\CMS\Core\Page\PageRenderer\setFavIcon(), TYPO3\CMS\Core\Page\PageRenderer\setLanguage(), TYPO3\CMS\Core\Page\PageRenderer\setMetaTag(), and TYPO3\CMS\Core\Page\PageRenderer\setNonce().

Referenced by TYPO3\CMS\Backend\Controller\MfaController\authAction(), TYPO3\CMS\Backend\Controller\LoginController\init(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\initialize(), TYPO3\CMS\Backend\Controller\ResetPasswordController\initialize(), TYPO3\CMS\Backend\Controller\Page\MovePageController\mainAction(), TYPO3\CMS\Backend\Controller\BackendController\mainAction(), TYPO3\CMS\Backend\Controller\MfaSetupController\renderSelectionView(), and TYPO3\CMS\Backend\Controller\MfaSetupController\renderSetupView().