NumberWithIconWidget implements WidgetRendererInterface
Concrete Number with Icon implementation
The widget will show widget with an icon, a number, a title and a subtitle. The number is provided by a data provider.
The following options are available during registration:
- icon string The icon-identifier of the icon that should be shown in the widget. You should register your icon with the Icon API
- title string The main title that will be shown in the widget as an explanation of the shown number. You can either enter a normal string or a translation string (eg. LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title)
- subtitle string The subtitle that will give some additional information about the number and title. You can either enter a normal string or a translation string (eg. LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.subtitle)
Tags
Table of Contents
Interfaces
- WidgetRendererInterface
- The WidgetRendererInterface is the (new) base interface for all kind of widgets.
Methods
- __construct() : mixed
- getSettingsDefinitions() : array<string|int, SettingDefinition>
- renderWidget() : WidgetResult
- This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
Methods
__construct()
public
__construct(WidgetConfigurationInterface $configuration, NumberWithIconDataProviderInterface $dataProvider, BackendViewFactory $backendViewFactory[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $configuration : WidgetConfigurationInterface
- $dataProvider : NumberWithIconDataProviderInterface
- $backendViewFactory : BackendViewFactory
- $options : array<string|int, mixed> = []
getSettingsDefinitions()
public
getSettingsDefinitions() : array<string|int, SettingDefinition>
Return values
array<string|int, SettingDefinition>renderWidget()
This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
public
renderWidget(WidgetContext $context) : WidgetResult
Be aware of XSS and ensure that the content is well encoded.
Parameters
- $context : WidgetContext