WidgetItems
in package
implements
JsonSerializable
Interface WidgetItems
This class is used by IAPIWidgetV2 interface. It represents an array of widget items and additional context information that can be provided to clients via the Dashboard API
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $emptyContentMessage : string
- $halfEmptyContentMessage : string
- $items : array<string|int, mixed>
Methods
- __construct() : mixed
- getEmptyContentMessage() : string
- The "half" empty content message to show above the list of items.
- getHalfEmptyContentMessage() : string
- The empty content message to show in case of no items at all
- getItems() : array<string|int, WidgetItem>
- Items to render in the widgets
- jsonSerialize() : array<string|int, mixed>
Properties
$emptyContentMessage
private
string
$emptyContentMessage
= ''
$halfEmptyContentMessage
private
string
$halfEmptyContentMessage
= ''
$items
private
array<string|int, mixed>
$items
= []
Methods
__construct()
public
__construct([mixed $items = [] ][, string $emptyContentMessage = '' ][, string $halfEmptyContentMessage = '' ]) : mixed
Parameters
- $items : mixed = []
-
WidgetItem[]
- $emptyContentMessage : string = ''
- $halfEmptyContentMessage : string = ''
Tags
getEmptyContentMessage()
The "half" empty content message to show above the list of items.
public
getEmptyContentMessage() : string
A non-empty string enables this feature. An empty string hides the message and disables this feature.
Tags
Return values
stringgetHalfEmptyContentMessage()
The empty content message to show in case of no items at all
public
getHalfEmptyContentMessage() : string
Tags
Return values
stringgetItems()
Items to render in the widgets
public
getItems() : array<string|int, WidgetItem>
Tags
Return values
array<string|int, WidgetItem>jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>