‪TYPO3CMS  ‪main
TYPO3\CMS\Dashboard\Controller\DashboardController Class Reference

Public Member Functions

 __construct (protected readonly PageRenderer $pageRenderer, protected readonly UriBuilder $uriBuilder, protected readonly DashboardPresetRegistry $dashboardPresetRepository, protected readonly DashboardRepository $dashboardRepository, protected readonly DashboardInitializationService $dashboardInitializationService, protected readonly WidgetGroupInitializationService $widgetGroupInitializationService, protected readonly ModuleTemplateFactory $moduleTemplateFactory,)
 
 handleRequest (ServerRequestInterface $request)
 

Protected Member Functions

 mainAction (ServerRequestInterface $request)
 
 configureDashboardAction (ServerRequestInterface $request)
 
 setActiveDashboardAction (ServerRequestInterface $request)
 
 addDashboardAction (ServerRequestInterface $request)
 
 deleteDashboardAction ()
 
 addWidgetAction (ServerRequestInterface $request)
 
 removeWidgetAction (ServerRequestInterface $request)
 
 addFrontendResources ()
 
 preparePageRenderer ()
 
 saveCurrentDashboard (string $identifier)
 
 getBackendUser ()
 
 getLanguageService ()
 

Protected Attributes

Dashboard $currentDashboard
 

Detailed Description

Definition at line 41 of file DashboardController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Dashboard\Controller\DashboardController::__construct ( protected readonly PageRenderer  $pageRenderer,
protected readonly UriBuilder  $uriBuilder,
protected readonly DashboardPresetRegistry  $dashboardPresetRepository,
protected readonly DashboardRepository  $dashboardRepository,
protected readonly DashboardInitializationService  $dashboardInitializationService,
protected readonly WidgetGroupInitializationService  $widgetGroupInitializationService,
protected readonly ModuleTemplateFactory  $moduleTemplateFactory 
)

Definition at line 45 of file DashboardController.php.

Member Function Documentation

◆ addDashboardAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::addDashboardAction ( ServerRequestInterface  $request)
protected

◆ addFrontendResources()

TYPO3\CMS\Dashboard\Controller\DashboardController::addFrontendResources ( )
protected

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

Definition at line 163 of file DashboardController.php.

Referenced by TYPO3\CMS\Dashboard\Controller\DashboardController\mainAction().

◆ addWidgetAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::addWidgetAction ( ServerRequestInterface  $request)
protected

Definition at line 133 of file DashboardController.php.

◆ configureDashboardAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::configureDashboardAction ( ServerRequestInterface  $request)
protected

◆ deleteDashboardAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::deleteDashboardAction ( )
protected

Definition at line 127 of file DashboardController.php.

◆ getBackendUser()

◆ getLanguageService()

TYPO3\CMS\Dashboard\Controller\DashboardController::getLanguageService ( )
protected

◆ handleRequest()

TYPO3\CMS\Dashboard\Controller\DashboardController::handleRequest ( ServerRequestInterface  $request)

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

Definition at line 58 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\DashboardController\getBackendUser().

◆ mainAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::mainAction ( ServerRequestInterface  $request)
protected

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

Definition at line 69 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\DashboardController\addFrontendResources(), TYPO3\CMS\Dashboard\Controller\DashboardController\getLanguageService(), and TYPO3\CMS\Dashboard\Controller\DashboardController\preparePageRenderer().

◆ preparePageRenderer()

TYPO3\CMS\Dashboard\Controller\DashboardController::preparePageRenderer ( )
protected

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

Definition at line 180 of file DashboardController.php.

Referenced by TYPO3\CMS\Dashboard\Controller\DashboardController\mainAction().

◆ removeWidgetAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::removeWidgetAction ( ServerRequestInterface  $request)
protected

Definition at line 147 of file DashboardController.php.

◆ saveCurrentDashboard()

TYPO3\CMS\Dashboard\Controller\DashboardController::saveCurrentDashboard ( string  $identifier)
protected

◆ setActiveDashboardAction()

TYPO3\CMS\Dashboard\Controller\DashboardController::setActiveDashboardAction ( ServerRequestInterface  $request)
protected

Member Data Documentation

◆ $currentDashboard

Dashboard TYPO3\CMS\Dashboard\Controller\DashboardController::$currentDashboard
protected