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

Public Member Functions

 __construct (protected readonly string $identifier, protected readonly string $title, protected readonly array $widgetConfig, protected readonly WidgetRegistry $widgetRegistry, protected readonly ContainerInterface $container)
 
 getIdentifier ()
 
 getTitle ()
 
 getWidgetConfig ()
 
array< string, WidgetConfigurationInterfacegetWidgets ()
 
 initializeWidgets (ServerRequestInterface $request)
 
array< string, array > getWidgetOptions ()
 

Protected Member Functions

 getLanguageService ()
 

Protected Attributes

array< string, WidgetConfigurationInterface$widgets = array( )
 
array< string, array > $widgetOptions = array( )
 

Detailed Description

Definition at line 28 of file Dashboard.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Dashboard\Dashboard::__construct ( protected readonly string  $identifier,
protected readonly string  $title,
protected readonly array  $widgetConfig,
protected readonly WidgetRegistry  $widgetRegistry,
protected readonly ContainerInterface  $container 
)
Parameters
array<string,array<string,string>>‪$widgetConfig

Definition at line 41 of file Dashboard.php.

Member Function Documentation

◆ getIdentifier()

◆ getLanguageService()

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

Definition at line 90 of file Dashboard.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Dashboard\Dashboard\getTitle().

◆ getTitle()

TYPO3\CMS\Dashboard\Dashboard::getTitle ( )

Definition at line 54 of file Dashboard.php.

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

◆ getWidgetConfig()

TYPO3\CMS\Dashboard\Dashboard::getWidgetConfig ( )

Definition at line 59 of file Dashboard.php.

◆ getWidgetOptions()

array<string,array> TYPO3\CMS\Dashboard\Dashboard::getWidgetOptions ( )
Returns
‪array<string,array>

Definition at line 98 of file Dashboard.php.

References TYPO3\CMS\Dashboard\Dashboard\$widgetOptions.

◆ getWidgets()

array<string,WidgetConfigurationInterface> TYPO3\CMS\Dashboard\Dashboard::getWidgets ( )
Returns
‪array<string,WidgetConfigurationInterface>

Definition at line 67 of file Dashboard.php.

References TYPO3\CMS\Dashboard\Dashboard\$widgets.

◆ initializeWidgets()

TYPO3\CMS\Dashboard\Dashboard::initializeWidgets ( ServerRequestInterface  $request)

This will return a list of all widgets of the current dashboard object. It will only include available widgets and will add the initialized object of the widget itself

Definition at line 76 of file Dashboard.php.

Member Data Documentation

◆ $widgetOptions

array<string,array> TYPO3\CMS\Dashboard\Dashboard::$widgetOptions = array( )
protected

Definition at line 36 of file Dashboard.php.

Referenced by TYPO3\CMS\Dashboard\Dashboard\getWidgetOptions().

◆ $widgets

array<string,WidgetConfigurationInterface> TYPO3\CMS\Dashboard\Dashboard::$widgets = array( )
protected

Definition at line 32 of file Dashboard.php.

Referenced by TYPO3\CMS\Dashboard\Dashboard\getWidgets().