NumberWithIconWidget implements WidgetInterface, RequestAwareWidgetInterface
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
- WidgetInterface
- The WidgetInterface is the base interface for all kind of widgets.
- RequestAwareWidgetInterface
- Interface for widgets that need the ServerRequestInterface Request.
Properties
- $view : StandaloneView|null
Methods
- __construct() : mixed
- getOptions() : array<string|int, mixed>
- This method returns the options of the widget as set in the registration.
- renderWidgetContent() : string
- This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
- setRequest() : void
Properties
$view read-only
protected
StandaloneView|null
$view
= null
Methods
__construct()
public
__construct(WidgetConfigurationInterface $configuration, NumberWithIconDataProviderInterface $dataProvider, BackendViewFactory $backendViewFactory[, StandaloneView|null $view = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $configuration : WidgetConfigurationInterface
- $dataProvider : NumberWithIconDataProviderInterface
- $backendViewFactory : BackendViewFactory
- $view : StandaloneView|null = null
- $options : array<string|int, mixed> = []
getOptions()
This method returns the options of the widget as set in the registration.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>renderWidgetContent()
This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
public
renderWidgetContent() : string
Be aware of XSS and ensure that the content is well encoded.
Return values
stringsetRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface