BackendController

Class for rendering the TYPO3 backend

Table of Contents

Properties

$backendModuleRepository  : BackendModuleRepository
$css  : string
$moduleLoader  : ModuleLoader
$moduleStorage  : SplObjectStorage
$moduleTemplateFactory  : ModuleTemplateFactory
$pageRenderer  : PageRenderer
$partialPath  : string
$templatePath  : string
$toolbarItems  : array<string|int, mixed>
$typo3Version  : Typo3Version
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
addCss()  : mixed
Adds a css snippet to the backend
getModuleMenu()  : ResponseInterface
Returns the Module menu for the AJAX request
getTopbar()  : ResponseInterface
Returns the toolbar for the AJAX request
mainAction()  : ResponseInterface
Main function generating the BE scaffolding
determineFirstAvailableBackendModule()  : string
executeHook()  : mixed
Executes defined hooks functions for the given identifier.
generateJavascript()  : mixed
Generates the JavaScript code for the backend.
generateModuleMenu()  : string
loads all modules from the repository and renders it with a template
getBackendUser()  : BackendUserAuthentication
Returns the current BE user.
getCollapseStateOfMenu()  : bool
getFluidTemplateObject()  : StandaloneView
returns a new standalone view, shorthand function
getLanguageService()  : LanguageService
Returns LanguageService
getStartupModule()  : array<string|int, mixed>
Sets the startup module from either "redirect" GET parameters or user configuration.
initializeToolbarItems()  : mixed
Initialize toolbar item objects
renderToolbar()  : string
Renders the items in the top toolbar
renderTopbar()  : string
Renders the topbar, containing the backend logo, sitename etc.

Properties

$moduleStorage

protected SplObjectStorage $moduleStorage

$partialPath

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

$templatePath

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

$toolbarItems

protected array<string|int, mixed> $toolbarItems = []

Methods

addCss()

Adds a css snippet to the backend

public addCss(string $css) : mixed
Parameters
$css : string

Css snippet

Tags
throws
InvalidArgumentException

getModuleMenu()

Returns the Module menu for the AJAX request

public getModuleMenu() : ResponseInterface
Return values
ResponseInterface

getTopbar()

Returns the toolbar for the AJAX request

public getTopbar() : ResponseInterface
Return values
ResponseInterface

mainAction()

Main function generating the BE scaffolding

public mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface —

the response with the content

determineFirstAvailableBackendModule()

protected determineFirstAvailableBackendModule() : string
Return values
string

executeHook()

Executes defined hooks functions for the given identifier.

protected executeHook(string $identifier[, array<string|int, mixed> $hookConfiguration = [] ]) : mixed

These hook identifiers are valid:

  • constructPostProcess
  • renderPreProcess
  • renderPostProcess
Parameters
$identifier : string

Specific hook identifier

$hookConfiguration : array<string|int, mixed> = []

Additional configuration passed to hook functions

generateJavascript()

Generates the JavaScript code for the backend.

protected generateJavascript(ServerRequestInterface $request) : mixed
Parameters
$request : ServerRequestInterface

generateModuleMenu()

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

protected generateModuleMenu() : string
Return values
string

getCollapseStateOfMenu()

protected getCollapseStateOfMenu() : bool
Return values
bool

getFluidTemplateObject()

returns a new standalone view, shorthand function

protected getFluidTemplateObject([string $templatePathAndFileName = null ]) : StandaloneView
Parameters
$templatePathAndFileName : string = null

optional the path to set the template path and filename

Return values
StandaloneView

getStartupModule()

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

protected getStartupModule(ServerRequestInterface $request) : array<string|int, mixed>
Parameters
$request : ServerRequestInterface
Return values
array<string|int, mixed>

initializeToolbarItems()

Initialize toolbar item objects

protected initializeToolbarItems() : mixed
Tags
throws
RuntimeException

renderToolbar()

Renders the items in the top toolbar

protected renderToolbar() : string
Return values
string —

top toolbar elements as HTML

renderTopbar()

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

protected renderTopbar() : string
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results