‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\Controller\BackendController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\BackendController:
TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait

Public Member Functions

 __construct (protected readonly Typo3Version $typo3Version, protected readonly UriBuilder $uriBuilder, protected readonly PageRenderer $pageRenderer, protected readonly ModuleProvider $moduleProvider, protected readonly ToolbarItemsRegistry $toolbarItemsRegistry, protected readonly ExtensionConfiguration $extensionConfiguration, protected readonly BackendViewFactory $viewFactory, protected readonly EventDispatcherInterface $eventDispatcher, protected readonly FlashMessageService $flashMessageService, protected readonly BackendEntryPointResolver $backendEntryPointResolver,)
 
 mainAction (ServerRequestInterface $request)
 
 getModuleMenu (ServerRequestInterface $request)
 
 getTopbar (ServerRequestInterface $request)
 

Protected Member Functions

 assignTopbarDetailsToView (ServerRequestInterface $request, ViewInterface $view)
 
ToolbarItemInterface[] getToolbarItems (ServerRequestInterface $request)
 
 getStartupModule (ServerRequestInterface $request)
 
 getModulesInformation ()
 
 getCollapseStateOfMenu ()
 
 enqueueRedirectMessage (ModuleInterface $requestedModule, ModuleInterface $redirectedModule)
 
 isSpecialNoModuleRoute (string $routeIdentifier)
 
 getBackendUser ()
 
 getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait
 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)
 

Protected Attributes

array $modules
 

Detailed Description

Class for rendering the TYPO3 backend. This is the backend outer main frame with topbar and module menu.

Definition at line 60 of file BackendController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\BackendController::__construct ( protected readonly Typo3Version  $typo3Version,
protected readonly UriBuilder  $uriBuilder,
protected readonly PageRenderer  $pageRenderer,
protected readonly ModuleProvider  $moduleProvider,
protected readonly ToolbarItemsRegistry  $toolbarItemsRegistry,
protected readonly ExtensionConfiguration  $extensionConfiguration,
protected readonly BackendViewFactory  $viewFactory,
protected readonly EventDispatcherInterface  $eventDispatcher,
protected readonly FlashMessageService  $flashMessageService,
protected readonly BackendEntryPointResolver  $backendEntryPointResolver 
)

Member Function Documentation

◆ assignTopbarDetailsToView()

TYPO3\CMS\Backend\Controller\BackendController::assignTopbarDetailsToView ( ServerRequestInterface  $request,
ViewInterface  $view 
)
protected

◆ enqueueRedirectMessage()

◆ getBackendUser()

◆ getCollapseStateOfMenu()

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

◆ getLanguageService()

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

◆ getModuleMenu()

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

Returns the main module menu as json encoded HTML string. Used when "update signals" request a menu reload, e.g. when an extension is loaded that brings new main modules.

Definition at line 177 of file BackendController.php.

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

◆ getModulesInformation()

TYPO3\CMS\Backend\Controller\BackendController::getModulesInformation ( )
protected

Returns information for each registered and allowed module. Used by various JS components.

Definition at line 338 of file BackendController.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Backend\Controller\BackendController\$modules.

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

◆ getStartupModule()

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

◆ getToolbarItems()

ToolbarItemInterface [] TYPO3\CMS\Backend\Controller\BackendController::getToolbarItems ( ServerRequestInterface  $request)
protected

◆ getTopbar()

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

Returns the toolbar as json encoded HTML string. Used when "update signals" request a toolbar reload, e.g. when an extension is loaded.

Definition at line 191 of file BackendController.php.

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

◆ isSpecialNoModuleRoute()

TYPO3\CMS\Backend\Controller\BackendController::isSpecialNoModuleRoute ( string  $routeIdentifier)
protected

Check if given route identifier is a special "no module" route

Definition at line 385 of file BackendController.php.

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

◆ mainAction()

Member Data Documentation

◆ $modules

array TYPO3\CMS\Backend\Controller\BackendController::$modules
protected