Public Member Functions
	__construct ()

ResponseInterface	mainAction (ServerRequestInterface $request)

	addCss ($css)

ResponseInterface	getModuleMenu ()

ResponseInterface	getTopbar ()

Protected Member Functions
	initializeToolbarItems ()

string	renderTopbar ()

string	renderToolbar ()

	generateJavascript (ServerRequestInterface $request)

	handlePageEditing (ServerRequestInterface $request)

string	setStartupModule (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

IconFactory	$iconFactory

Typo3Version	$typo3Version

UriBuilder	$uriBuilder

SplObjectStorage	$moduleStorage

ModuleLoader	$moduleLoader

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 ( )

Constructor

Definition at line 93 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\executeHook(), TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Backend\Controller\BackendController\getBackendUser(), TYPO3\CMS\Backend\Controller\BackendController\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\includeLLFile(), and TYPO3\CMS\Backend\Controller\BackendController\initializeToolbarItems().

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 504 of file BackendController.php.

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

◆ determineFirstAvailableBackendModule()

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

protected

Definition at line 480 of file BackendController.php.

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

◆ 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 523 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 337 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\getBackendUser(), TYPO3\CMS\Backend\Controller\BackendController\handlePageEditing(), TYPO3\CMS\Backend\Utility\BackendUtility\isModuleSetInTBE_MODULES(), and TYPO3\CMS\Backend\Controller\BackendController\setStartupModule().

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 537 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 603 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\handlePageEditing(), and TYPO3\CMS\Backend\Controller\BackendController\setStartupModule().

◆ getCollapseStateOfMenu()

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

protected

Definition at line 544 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 578 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 593 of file BackendController.php.

References $GLOBALS.

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

◆ getModuleMenu()

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

Returns the Module menu for the AJAX request

Returns: ‪ResponseInterface

Definition at line 557 of file BackendController.php.

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

◆ getTopbar()

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

Returns the toolbar for the AJAX request

Returns: ‪ResponseInterface

Definition at line 567 of file BackendController.php.

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

◆ handlePageEditing()

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

protected

Checking if the "&edit" variable was sent so we can open it for editing the page.

Definition at line 391 of file BackendController.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\Controller\BackendController\getBackendUser(), TYPO3\CMS\Backend\Controller\BackendController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), TYPO3\CMS\Backend\Utility\BackendUtility\openPageTree(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT.

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

◆ initializeToolbarItems()

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

protected

Initialize toolbar item objects

Exceptions

Definition at line 157 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 192 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\$typo3Version, TYPO3\CMS\Backend\Controller\BackendController\executeHook(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateModuleMenu(), TYPO3\CMS\Backend\Controller\BackendController\getCollapseStateOfMenu(), TYPO3\CMS\Core\Information\Typo3Version\getVersion(), and TYPO3\CMS\Backend\Controller\BackendController\renderTopbar().

◆ 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 275 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 227 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().

◆ setStartupModule()

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

protected

Sets the startup module from either GETvars module and modParams or user configuration.

Parameters

ServerRequestInterface $request

Returns: ‪string the JavaScript code for the startup module

Definition at line 441 of file BackendController.php.

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

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

Member Data Documentation

◆ $backendModuleRepository

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

protected

Definition at line 64 of file BackendController.php.

◆ $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().

◆ $iconFactory

IconFactory TYPO3\CMS\Backend\Controller\BackendController::$iconFactory

protected

Definition at line 72 of file BackendController.php.

◆ $moduleLoader

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

protected

Definition at line 88 of file BackendController.php.

◆ $moduleStorage

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

protected

Definition at line 84 of file BackendController.php.

◆ $pageRenderer

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

protected

Definition at line 68 of file BackendController.php.

◆ $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 76 of file BackendController.php.

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

◆ $uriBuilder

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

protected

Definition at line 80 of file BackendController.php.

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()

◆ getTopbar()

◆ handlePageEditing()

◆ initializeToolbarItems()

◆ mainAction()

◆ renderToolbar()

◆ renderTopbar()

◆ setStartupModule()

Member Data Documentation

◆ $backendModuleRepository

◆ $css

◆ $iconFactory

◆ $moduleLoader

◆ $moduleStorage

◆ $pageRenderer

◆ $partialPath

◆ $templatePath

◆ $toolbarItems

◆ $typo3Version

◆ $uriBuilder