‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
TYPO3\CMS\Dashboard\Controller\DashboardController Class Reference
Inheritance diagram for TYPO3\CMS\Dashboard\Controller\DashboardController:
TYPO3\CMS\Dashboard\Controller\AbstractController

Public Member Functions

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

Protected Member Functions

 mainAction ()
 
ResponseInterface configureDashboardAction (ServerRequestInterface $request)
 
ResponseInterface setActiveDashboardAction (ServerRequestInterface $request)
 
ResponseInterface addDashboardAction (ServerRequestInterface $request)
 
ResponseInterface deleteDashboardAction ()
 
ResponseInterface addWidgetAction (ServerRequestInterface $request)
 
ResponseInterface removeWidgetAction (ServerRequestInterface $request)
 
 initializeView (string $templateName)
 
 addFrontendResources ()
 
 preparePageRenderer ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Dashboard\Controller\AbstractController
 getBackendUser ()
 
 getLanguageService ()
 
 loadCurrentDashboard ()
 
 saveCurrentDashboard (string $identifier)
 

Protected Attributes

PageRenderer $pageRenderer
 
UriBuilder $uriBuilder
 
Dashboard $currentDashboard
 
DashboardPresetRegistry $dashboardPresetRepository
 
DashboardRepository $dashboardRepository
 
DashboardInitializationService $dashboardInitializationService
 
WidgetGroupInitializationService $widgetGroupInitializationService
 
ModuleTemplateFactory $moduleTemplateFactory
 
StandaloneView $view
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Dashboard\Controller\AbstractController
const MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER = 'dashboard/current_dashboard/'
 

Private Attributes

ModuleTemplate $moduleTemplate = null
 

Detailed Description

Definition at line 44 of file DashboardController.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 58 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\DashboardController\$dashboardInitializationService, TYPO3\CMS\Dashboard\Controller\DashboardController\$dashboardPresetRepository, TYPO3\CMS\Dashboard\Controller\DashboardController\$dashboardRepository, TYPO3\CMS\Dashboard\Controller\DashboardController\$moduleTemplateFactory, TYPO3\CMS\Dashboard\Controller\DashboardController\$pageRenderer, TYPO3\CMS\Dashboard\Controller\DashboardController\$uriBuilder, TYPO3\CMS\Dashboard\Controller\DashboardController\$widgetGroupInitializationService, and TYPO3\CMS\Dashboard\Controller\AbstractController\getBackendUser().

Member Function Documentation

◆ addDashboardAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::addDashboardAction ( ServerRequestInterface  $request)
protected
Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias

Definition at line 164 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\AbstractController\getBackendUser(), and TYPO3\CMS\Dashboard\Controller\AbstractController\saveCurrentDashboard().

◆ 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 251 of file DashboardController.php.

References TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\forRequireJS().

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

◆ addWidgetAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::addWidgetAction ( ServerRequestInterface  $request)
protected
Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias
RequiredArgumentMissingException

Definition at line 200 of file DashboardController.php.

◆ configureDashboardAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::configureDashboardAction ( ServerRequestInterface  $request)
protected
Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias

Definition at line 134 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\DashboardController\$currentDashboard, and TYPO3\CMS\Backend\Routing\UriBuilder\ABSOLUTE_URL.

◆ deleteDashboardAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::deleteDashboardAction ( )
protected
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias

Definition at line 188 of file DashboardController.php.

◆ handleRequest()

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

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

Parameters
ServerRequestInterface$request‪the current request
Returns
‪ResponseInterface the response with the content

Definition at line 113 of file DashboardController.php.

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

◆ initializeView()

TYPO3\CMS\Dashboard\Controller\DashboardController::initializeView ( string  $templateName)
protected

Sets up the Fluid View.

Parameters
string$templateName

Definition at line 241 of file DashboardController.php.

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

◆ mainAction()

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

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

Exceptions
RouteNotFoundExceptionAlias

Definition at line 88 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\AbstractController\getLanguageService().

◆ preparePageRenderer()

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

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

Definition at line 278 of file DashboardController.php.

References TYPO3\CMS\Core\Utility\PathUtility\getPublicResourceWebPath().

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

◆ removeWidgetAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::removeWidgetAction ( ServerRequestInterface  $request)
protected
Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias

Definition at line 222 of file DashboardController.php.

◆ setActiveDashboardAction()

ResponseInterface TYPO3\CMS\Dashboard\Controller\DashboardController::setActiveDashboardAction ( ServerRequestInterface  $request)
protected
Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface
Exceptions
RouteNotFoundExceptionAlias

Definition at line 152 of file DashboardController.php.

References TYPO3\CMS\Dashboard\Controller\AbstractController\saveCurrentDashboard().

Member Data Documentation

◆ $currentDashboard

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

Definition at line 48 of file DashboardController.php.

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

◆ $dashboardInitializationService

DashboardInitializationService TYPO3\CMS\Dashboard\Controller\DashboardController::$dashboardInitializationService
protected

Definition at line 51 of file DashboardController.php.

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

◆ $dashboardPresetRepository

DashboardPresetRegistry TYPO3\CMS\Dashboard\Controller\DashboardController::$dashboardPresetRepository
protected

Definition at line 49 of file DashboardController.php.

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

◆ $dashboardRepository

DashboardRepository TYPO3\CMS\Dashboard\Controller\DashboardController::$dashboardRepository
protected

Definition at line 50 of file DashboardController.php.

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

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Dashboard\Controller\DashboardController::$moduleTemplate = null
private

Definition at line 55 of file DashboardController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Dashboard\Controller\DashboardController::$moduleTemplateFactory
protected

Definition at line 53 of file DashboardController.php.

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

◆ $pageRenderer

PageRenderer TYPO3\CMS\Dashboard\Controller\DashboardController::$pageRenderer
protected

Definition at line 46 of file DashboardController.php.

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

◆ $uriBuilder

UriBuilder TYPO3\CMS\Dashboard\Controller\DashboardController::$uriBuilder
protected

Definition at line 47 of file DashboardController.php.

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

◆ $view

StandaloneView TYPO3\CMS\Dashboard\Controller\DashboardController::$view
protected

Definition at line 56 of file DashboardController.php.

◆ $widgetGroupInitializationService

WidgetGroupInitializationService TYPO3\CMS\Dashboard\Controller\DashboardController::$widgetGroupInitializationService
protected

Definition at line 52 of file DashboardController.php.

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