Dashboard
Table of Contents
Properties
- $container : ContainerInterface
- $identifier : string
- $title : string
- $widgetConfig : array<string|int, mixed>
- $widgetPositions : object|null
- $widgetRegistry : WidgetRegistry
- $widgets : array<string, DashboardEntry>
- $widgetSettingsFactory : WidgetSettingsFactory
Methods
- __construct() : mixed
- getIdentifier() : string
- getTitle() : string
- getTransferData() : Dashboard
- getWidget() : DashboardEntry|null
- getWidgetConfig() : array<string|int, mixed>
- getWidgetPositions() : object
- getWidgets() : array<string, DashboardEntry>
- initializeWidgets() : void
- 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
- getLanguageService() : LanguageService
Properties
$container read-only
protected
ContainerInterface
$container
$identifier read-only
protected
string
$identifier
$title read-only
protected
string
$title
$widgetConfig read-only
protected
array<string|int, mixed>
$widgetConfig
$widgetPositions
protected
object|null
$widgetPositions
= null
$widgetRegistry read-only
protected
WidgetRegistry
$widgetRegistry
$widgets
protected
array<string, DashboardEntry>
$widgets
= []
$widgetSettingsFactory read-only
protected
WidgetSettingsFactory
$widgetSettingsFactory
Methods
__construct()
public
__construct(string $identifier, string $title, array<string, array<string, string|array<string|int, mixed>>> $widgetConfig, WidgetRegistry $widgetRegistry, WidgetSettingsFactory $widgetSettingsFactory, ContainerInterface $container) : mixed
Parameters
- $identifier : string
- $title : string
- $widgetConfig : array<string, array<string, string|array<string|int, mixed>>>
- $widgetRegistry : WidgetRegistry
- $widgetSettingsFactory : WidgetSettingsFactory
- $container : ContainerInterface
getIdentifier()
public
getIdentifier() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringgetTransferData()
public
getTransferData() : Dashboard
Return values
DashboardgetWidget()
public
getWidget(string $identifier) : DashboardEntry|null
Parameters
- $identifier : string
Return values
DashboardEntry|nullgetWidgetConfig()
public
getWidgetConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getWidgetPositions()
public
getWidgetPositions() : object
Return values
objectgetWidgets()
public
getWidgets() : array<string, DashboardEntry>
Return values
array<string, DashboardEntry>initializeWidgets()
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
public
initializeWidgets(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface
getLanguageService()
protected
getLanguageService() : LanguageService