Public Member Functions
	__construct (Typo3Version $typo3Version, UriBuilder $uriBuilder, PageRenderer $pageRenderer, ModuleLoader $moduleLoader, BackendModuleRepository $backendModuleRepository, ModuleTemplateFactory $moduleTemplateFactory)

ResponseInterface	mainAction (ServerRequestInterface $request)

	addCss ($css)

ResponseInterface	getModuleMenu ()

ResponseInterface	getTopbar ()

Protected Member Functions
	initializeToolbarItems ()

string	renderTopbar ()

string	renderToolbar ()

	generateJavascript (ServerRequestInterface $request)

array	getStartupModule (ServerRequestInterface $request)

	determineFirstAvailableBackendModule ()

	executeHook ($identifier, array $hookConfiguration=[])

string	generateModuleMenu ()

	getCollapseStateOfMenu ()

TYPO3 CMS Fluid View StandaloneView	getFluidTemplateObject ($templatePathAndFileName=null)

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUser ()

Protected Attributes
string	$css = ''

array	$toolbarItems = array( )

string	$templatePath = 'EXT:backend/Resources/Private/Templates/'

string	$partialPath = 'EXT:backend/Resources/Private/Partials/'

BackendModuleRepository	$backendModuleRepository

PageRenderer	$pageRenderer

Typo3Version	$typo3Version

UriBuilder	$uriBuilder

ModuleLoader	$moduleLoader

ModuleTemplateFactory	$moduleTemplateFactory

SplObjectStorage	$moduleStorage

Detailed Description

Class for rendering the TYPO3 backend

Definition at line 44 of file BackendController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\BackendController::__construct	(	Typo3Version	$typo3Version,
		UriBuilder	$uriBuilder,
		PageRenderer	$pageRenderer,
		ModuleLoader	$moduleLoader,
		BackendModuleRepository	$backendModuleRepository,
		ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 73 of file BackendController.php.

Member Function Documentation

◆ addCss()

TYPO3\CMS\Backend\Controller\BackendController::addCss ( $css )

Adds a css snippet to the backend

Parameters

string $css ‪Css snippet

Exceptions

Definition at line 431 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\$css.

◆ determineFirstAvailableBackendModule()

TYPO3\CMS\Backend\Controller\BackendController::determineFirstAvailableBackendModule ( )

protected

Definition at line 407 of file BackendController.php.

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

◆ executeHook()

TYPO3\CMS\Backend\Controller\BackendController::executeHook	(		$identifier,
		array	$hookConfiguration = `[]`
	)

protected

Executes defined hooks functions for the given identifier.

These hook identifiers are valid:

‪constructPostProcess
‪renderPreProcess
‪renderPostProcess

Parameters

string	$identifier	‪Specific hook identifier
array	$hookConfiguration	‪Additional configuration passed to hook functions

Definition at line 450 of file BackendController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct(), and TYPO3\CMS\Backend\Controller\BackendController\mainAction().

◆ generateJavascript()

TYPO3\CMS\Backend\Controller\BackendController::generateJavascript ( ServerRequestInterface $request )

protected

Generates the JavaScript code for the backend.

Parameters

ServerRequestInterface $request

Definition at line 334 of file BackendController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\BackendController\getBackendUser().

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

◆ generateModuleMenu()

string TYPO3\CMS\Backend\Controller\BackendController::generateModuleMenu ( )

protected

loads all modules from the repository and renders it with a template

Returns: ‪string

Definition at line 464 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\getFluidTemplateObject().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\getModuleMenu(), and TYPO3\CMS\Backend\Controller\BackendController\mainAction().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Controller\BackendController::getBackendUser ( )

protected

Returns the current BE user.

Returns: ‪BackendUserAuthentication

Definition at line 530 of file BackendController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\getCollapseStateOfMenu(), TYPO3\CMS\Backend\Controller\BackendController\getStartupModule(), and TYPO3\CMS\Backend\Controller\BackendController\mainAction().

◆ getCollapseStateOfMenu()

TYPO3\CMS\Backend\Controller\BackendController::getCollapseStateOfMenu ( )

protected

Definition at line 471 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\getBackendUser().

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

◆ getFluidTemplateObject()

TYPO3 CMS Fluid View StandaloneView TYPO3\CMS\Backend\Controller\BackendController::getFluidTemplateObject ( $templatePathAndFileName = null )

protected

returns a new standalone view, shorthand function

Parameters

string $templatePathAndFileName ‪optional the path to set the template path and filename

Returns: ‪\TYPO3\CMS\Fluid\View\StandaloneView

Definition at line 505 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\generateModuleMenu(), and TYPO3\CMS\Backend\Controller\BackendController\renderTopbar().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\Controller\BackendController::getLanguageService ( )

protected

Returns LanguageService

Returns: ‪LanguageService

Definition at line 520 of file BackendController.php.

References $GLOBALS.

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

◆ getModuleMenu()

ResponseInterface TYPO3\CMS\Backend\Controller\BackendController::getModuleMenu ( )

Returns the Module menu for the AJAX request

Returns: ‪ResponseInterface

Definition at line 484 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\generateModuleMenu().

◆ getStartupModule()

array TYPO3\CMS\Backend\Controller\BackendController::getStartupModule ( ServerRequestInterface $request )

protected

Sets the startup module from either "redirect" GET parameters or user configuration.

Parameters

ServerRequestInterface $request

Returns: ‪array

Definition at line 356 of file BackendController.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), TYPO3\CMS\Backend\Controller\BackendController\determineFirstAvailableBackendModule(), and TYPO3\CMS\Backend\Controller\BackendController\getBackendUser().

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

◆ getTopbar()

ResponseInterface TYPO3\CMS\Backend\Controller\BackendController::getTopbar ( )

Returns the toolbar for the AJAX request

Returns: ‪ResponseInterface

Definition at line 494 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\renderTopbar().

◆ initializeToolbarItems()

TYPO3\CMS\Backend\Controller\BackendController::initializeToolbarItems ( )

protected

Initialize toolbar item objects

Exceptions

Definition at line 147 of file BackendController.php.

References $GLOBALS.

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

◆ mainAction()

ResponseInterface TYPO3\CMS\Backend\Controller\BackendController::mainAction ( ServerRequestInterface $request )

Main function generating the BE scaffolding

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface the response with the content

Definition at line 182 of file BackendController.php.

◆ renderToolbar()

string TYPO3\CMS\Backend\Controller\BackendController::renderToolbar ( )

protected

Renders the items in the top toolbar

Returns: ‪string top toolbar elements as HTML

Definition at line 272 of file BackendController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\camelCaseToLowerCaseUnderscored(), and TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToLowerCamelCase().

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

◆ renderTopbar()

string TYPO3\CMS\Backend\Controller\BackendController::renderTopbar ( )

protected

Renders the topbar, containing the backend logo, sitename etc.

Returns: ‪string

Definition at line 225 of file BackendController.php.

References $extConf, $GLOBALS, TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Backend\Controller\BackendController\getFluidTemplateObject(), and TYPO3\CMS\Backend\Controller\BackendController\renderToolbar().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\getTopbar(), and TYPO3\CMS\Backend\Controller\BackendController\mainAction().

Member Data Documentation

◆ $backendModuleRepository

BackendModuleRepository TYPO3\CMS\Backend\Controller\BackendController::$backendModuleRepository

protected

Definition at line 62 of file BackendController.php.

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

◆ $css

string TYPO3\CMS\Backend\Controller\BackendController::$css = ''

protected

Definition at line 48 of file BackendController.php.

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

◆ $moduleLoader

ModuleLoader TYPO3\CMS\Backend\Controller\BackendController::$moduleLoader

protected

Definition at line 66 of file BackendController.php.

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

◆ $moduleStorage

SplObjectStorage TYPO3\CMS\Backend\Controller\BackendController::$moduleStorage

protected

Definition at line 71 of file BackendController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Backend\Controller\BackendController::$moduleTemplateFactory

protected

Definition at line 67 of file BackendController.php.

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

◆ $pageRenderer

PageRenderer TYPO3\CMS\Backend\Controller\BackendController::$pageRenderer

protected

Definition at line 63 of file BackendController.php.

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

◆ $partialPath

string TYPO3\CMS\Backend\Controller\BackendController::$partialPath = 'EXT:backend/Resources/Private/Partials/'

protected

Definition at line 60 of file BackendController.php.

◆ $templatePath

string TYPO3\CMS\Backend\Controller\BackendController::$templatePath = 'EXT:backend/Resources/Private/Templates/'

protected

Definition at line 56 of file BackendController.php.

◆ $toolbarItems

array TYPO3\CMS\Backend\Controller\BackendController::$toolbarItems = array( )

protected

Definition at line 52 of file BackendController.php.

◆ $typo3Version

Typo3Version TYPO3\CMS\Backend\Controller\BackendController::$typo3Version

protected

Definition at line 64 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct(), and TYPO3\CMS\Backend\Controller\BackendController\mainAction().

◆ $uriBuilder

UriBuilder TYPO3\CMS\Backend\Controller\BackendController::$uriBuilder

protected

Definition at line 65 of file BackendController.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCss()

◆ determineFirstAvailableBackendModule()

◆ executeHook()

◆ generateJavascript()

◆ generateModuleMenu()

◆ getBackendUser()

◆ getCollapseStateOfMenu()

◆ getFluidTemplateObject()

◆ getLanguageService()

◆ getModuleMenu()

◆ getStartupModule()

◆ getTopbar()

◆ initializeToolbarItems()

◆ mainAction()

◆ renderToolbar()

◆ renderTopbar()

Member Data Documentation

◆ $backendModuleRepository

◆ $css

◆ $moduleLoader

◆ $moduleStorage

◆ $moduleTemplateFactory

◆ $pageRenderer

◆ $partialPath

◆ $templatePath

◆ $toolbarItems

◆ $typo3Version

◆ $uriBuilder