DashboardEntry
Read onlyYes
FinalYes
Dashboard entry representing a widget instance within a dashboard.
This class encapsulates a dashboard widget instance, providing access to its context, configuration, settings, and rendering capabilities. It serves as a bridge between the dashboard system and individual widget implementations, handling both legacy WidgetInterface and new WidgetRendererInterface widgets.
Each dashboard entry maintains its own widget context with instance-specific settings and provides methods for rendering and configuration management.
Table of Contents
Properties
Methods
- __construct() : mixed
- getDescription() : string
- getEventData() : array<string|int, mixed>
- getHeight() : string
- getIconIdentifier() : string
- getIdentifier() : string
- getRawConfig() : array<string|int, mixed>
- getRequest() : ServerRequestInterface
- getSettings() : SettingsInterface
- getSettingsDefinitions() : array<string|int, SettingDefinition>
- getTitle() : string
- getTransferWidgetConfiguration() : WidgetConfiguration
- getTransferWidgetData() : WidgetData
- getType() : string
- getWidth() : string
- getLanguageService() : LanguageService
- render() : WidgetResult
Properties
$context
protected
WidgetContext
$context
$renderer
protected
WidgetRendererInterface|WidgetInterface
$renderer
Methods
__construct()
public
__construct(WidgetContext $context, WidgetRendererInterface|WidgetInterface $renderer) : mixed
Parameters
- $context : WidgetContext
- $renderer : WidgetRendererInterface|WidgetInterface
getDescription()
public
getDescription() : string
Return values
stringgetEventData()
public
getEventData() : array<string|int, mixed>
Return values
array<string|int, mixed>getHeight()
public
getHeight() : string
Return values
stringgetIconIdentifier()
public
getIconIdentifier() : string
Return values
stringgetIdentifier()
public
getIdentifier() : string
Return values
stringgetRawConfig()
public
getRawConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getRequest()
public
getRequest() : ServerRequestInterface
Return values
ServerRequestInterfacegetSettings()
public
getSettings() : SettingsInterface
Return values
SettingsInterfacegetSettingsDefinitions()
public
getSettingsDefinitions() : array<string|int, SettingDefinition>
Return values
array<string|int, SettingDefinition>getTitle()
public
getTitle() : string
Return values
stringgetTransferWidgetConfiguration()
public
getTransferWidgetConfiguration() : WidgetConfiguration
Return values
WidgetConfigurationgetTransferWidgetData()
public
getTransferWidgetData() : WidgetData
Return values
WidgetDatagetType()
public
getType() : string
Return values
stringgetWidth()
public
getWidth() : string
Return values
stringgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicerender()
protected
render() : WidgetResult