DashboardController extends AbstractController

Internal

Table of Contents

Constants

MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER  = 'dashboard/current_dashboard/'

Properties

$currentDashboard  : Dashboard
$dashboardInitializationService  : DashboardInitializationService
$dashboardPresetRepository  : DashboardPresetRegistry
$dashboardRepository  : DashboardRepository
$moduleTemplateFactory  : ModuleTemplateFactory
$pageRenderer  : PageRenderer
$uriBuilder  : UriBuilder
$view  : StandaloneView
$widgetGroupInitializationService  : WidgetGroupInitializationService

Methods

__construct()  : mixed
handleRequest()  : ResponseInterface
Main entry method: Dispatch to other actions - those method names that end with "Action".
addDashboardAction()  : ResponseInterface
addFrontendResources()  : void
Adds CSS and JS files that are necessary for widgets to the page renderer
addWidgetAction()  : ResponseInterface
configureDashboardAction()  : ResponseInterface
deleteDashboardAction()  : ResponseInterface
getBackendUser()  : BackendUserAuthentication
getLanguageService()  : LanguageService
initializeView()  : void
Sets up the Fluid View.
loadCurrentDashboard()  : string
mainAction()  : void
This action is responsible for the main view of the dashboard and is just adding all collected data to the view
preparePageRenderer()  : void
Add the CSS and JS of the dashboard module to the page renderer
removeWidgetAction()  : ResponseInterface
saveCurrentDashboard()  : void
setActiveDashboardAction()  : ResponseInterface

Constants

MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER

protected mixed MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER = 'dashboard/current_dashboard/'

Properties

Methods

__construct()

public __construct(PageRenderer $pageRenderer, UriBuilder $uriBuilder, DashboardPresetRegistry $dashboardPresetRepository, DashboardRepository $dashboardRepository, DashboardInitializationService $dashboardInitializationService, WidgetGroupInitializationService $widgetGroupInitializationService, ModuleTemplateFactory $moduleTemplateFactory) : mixed
Parameters
$pageRenderer : PageRenderer
$uriBuilder : UriBuilder
$dashboardPresetRepository : DashboardPresetRegistry
$dashboardRepository : DashboardRepository
$dashboardInitializationService : DashboardInitializationService
$widgetGroupInitializationService : WidgetGroupInitializationService
$moduleTemplateFactory : ModuleTemplateFactory

handleRequest()

Main entry method: Dispatch to other actions - those method names that end with "Action".

public handleRequest(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface

the current request

Return values
ResponseInterface —

the response with the content

addDashboardAction()

protected addDashboardAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
ResponseInterface

addFrontendResources()

Adds CSS and JS files that are necessary for widgets to the page renderer

protected addFrontendResources() : void

configureDashboardAction()

protected configureDashboardAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
ResponseInterface

initializeView()

Sets up the Fluid View.

protected initializeView(string $templateName) : void
Parameters
$templateName : string

loadCurrentDashboard()

protected loadCurrentDashboard() : string
Return values
string

mainAction()

This action is responsible for the main view of the dashboard and is just adding all collected data to the view

protected mainAction() : void
Tags
throws
RouteNotFoundException

preparePageRenderer()

Add the CSS and JS of the dashboard module to the page renderer

protected preparePageRenderer() : void

removeWidgetAction()

protected removeWidgetAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
ResponseInterface

saveCurrentDashboard()

protected saveCurrentDashboard(string $identifier) : void
Parameters
$identifier : string

setActiveDashboardAction()

protected setActiveDashboardAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RouteNotFoundException
Return values
ResponseInterface 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results