Inheritance diagram for TYPO3\CMS\Backend\Controller\BackendController:

Public Member Functions
	__construct ()

ResponseInterface	mainAction ()

	addCss ($css)

ResponseInterface	getModuleMenu ()

ResponseInterface	getTopbar ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

Protected Member Functions
	initializeToolbarItems ()

	render ()

string	renderTopbar ()

string	renderToolbar ()

	generateJavascript ()

	handlePageEditing ()

string	setStartupModule ()

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

string	generateModuleMenu ()

	getCollapseStateOfMenu ()

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

TYPO3 CMS Core Localization LanguageService	getLanguageService ()

TYPO3 CMS Core Authentication BackendUserAuthentication	getBackendUser ()

TYPO3 CMS Backend Template DocumentTemplate	getDocumentTemplate ()

Protected Attributes
string	$content = ''

string	$css = ''

array	$cssFiles = array( )

string	$js = ''

array	$jsFiles = array( )

array	$toolbarItems = array( )

bool	$debug

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

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

TYPO3 CMS Backend Domain Repository Module BackendModuleRepository	$backendModuleRepository

TYPO3 CMS Backend Module ModuleLoader	$moduleLoader

PageRenderer	$pageRenderer

IconFactory	$iconFactory

Private Attributes
array	$deprecatedPublicMethods

Detailed Description

Class for rendering the TYPO3 backend

Definition at line 42 of file BackendController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

Definition at line 106 of file BackendController.php.

References $GLOBALS, debug(), 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 548 of file BackendController.php.

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

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

References $GLOBALS.

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

◆ generateJavascript()

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

protected

Generates the JavaScript code for the backend.

Definition at line 381 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\render().

◆ 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 581 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\render().

◆ getBackendUser()

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

protected

Returns the current BE user.

Returns: ‪\TYPO3\CMS\Core\Authentication\BackendUserAuthentication

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

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

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

◆ getDocumentTemplate()

TYPO3 CMS Backend Template DocumentTemplate TYPO3\CMS\Backend\Controller\BackendController::getDocumentTemplate ( )

protected

Returns an instance of DocumentTemplate

Returns: ‪\TYPO3\CMS\Backend\Template\DocumentTemplate

Definition at line 660 of file BackendController.php.

References $GLOBALS.

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

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

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

◆ getLanguageService()

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

protected

Returns LanguageService

Returns: ‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 640 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 604 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 614 of file BackendController.php.

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

◆ handlePageEditing()

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

protected

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

Definition at line 431 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(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

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

◆ initializeToolbarItems()

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

protected

Initialize toolbar item objects

Exceptions

Definition at line 188 of file BackendController.php.

References $GLOBALS.

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

◆ mainAction()

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

Injects the request object for the current request or subrequest As this controller goes only through the render() method, it is rather simple for now

Returns: ‪ResponseInterface the response with the content

Definition at line 223 of file BackendController.php.

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

◆ render()

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

protected

Main function generating the BE scaffolding

Definition at line 232 of file BackendController.php.

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

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

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 275 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\render().

◆ setStartupModule()

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

protected

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

Returns: ‪string the JavaScript code for the startup module

Definition at line 505 of file BackendController.php.

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

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

Member Data Documentation

◆ $backendModuleRepository

TYPO3 CMS Backend Domain Repository Module BackendModuleRepository TYPO3\CMS\Backend\Controller\BackendController::$backendModuleRepository

protected

Definition at line 89 of file BackendController.php.

◆ $content

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

protected

Definition at line 53 of file BackendController.php.

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

◆ $css

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

protected

Definition at line 57 of file BackendController.php.

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

◆ $cssFiles

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

protected

Definition at line 61 of file BackendController.php.

◆ $debug

bool TYPO3\CMS\Backend\Controller\BackendController::$debug

protected

Definition at line 77 of file BackendController.php.

◆ $deprecatedPublicMethods

array TYPO3\CMS\Backend\Controller\BackendController::$deprecatedPublicMethods

private

Initial value:

= array( 
        'render' => 'Using BackendController::render() is deprecated and will not be possible anymore in TYPO3 v10.0.',
     )

Definition at line 47 of file BackendController.php.

◆ $iconFactory

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

protected

Definition at line 101 of file BackendController.php.

◆ $js

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

protected

Definition at line 65 of file BackendController.php.

◆ $jsFiles

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

protected

Definition at line 69 of file BackendController.php.

◆ $moduleLoader

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

protected

Object for loading backend modules

Definition at line 93 of file BackendController.php.

◆ $pageRenderer

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

protected

Definition at line 97 of file BackendController.php.

◆ $partialPath

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

protected

Definition at line 85 of file BackendController.php.

◆ $templatePath

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

protected

Definition at line 81 of file BackendController.php.

◆ $toolbarItems

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

protected

Definition at line 73 of file BackendController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCss()

◆ executeHook()

◆ generateJavascript()

◆ generateModuleMenu()

◆ getBackendUser()

◆ getCollapseStateOfMenu()

◆ getDocumentTemplate()

◆ getFluidTemplateObject()

◆ getLanguageService()

◆ getModuleMenu()

◆ getTopbar()

◆ handlePageEditing()

◆ initializeToolbarItems()

◆ mainAction()

◆ render()

◆ renderToolbar()

◆ renderTopbar()

◆ setStartupModule()

Member Data Documentation

◆ $backendModuleRepository

◆ $content

◆ $css

◆ $cssFiles

◆ $debug

◆ $deprecatedPublicMethods

◆ $iconFactory

◆ $js

◆ $jsFiles

◆ $moduleLoader

◆ $pageRenderer

◆ $partialPath

◆ $templatePath

◆ $toolbarItems