BookmarksWidget implements WidgetRendererInterface, JavaScriptInterface
Read onlyYes
FinalYes
Widget to display user bookmarks on the dashboard.
The widget renders a custom element that reads bookmark data from the central BookmarkStore in the top frame.
Table of Contents
Interfaces
- WidgetRendererInterface
- The WidgetRendererInterface is the (new) base interface for all kind of widgets.
- JavaScriptInterface
- Provides potential JavaScript declarations to be loaded/initialized for a particular widget.
Methods
- __construct() : mixed
- getJavaScriptModuleInstructions() : array<int, JavaScriptModuleInstruction>
- 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, BackendViewFactory $backendViewFactory, BookmarkService $bookmarkService[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $configuration : WidgetConfigurationInterface
- $backendViewFactory : BackendViewFactory
- $bookmarkService : BookmarkService
- $options : array<string|int, mixed> = []
getJavaScriptModuleInstructions()
public
getJavaScriptModuleInstructions() : array<int, JavaScriptModuleInstruction>
Return values
array<int, JavaScriptModuleInstruction>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