ReactionPopupItem implements PopupDataItem, PopupDataAggregatable
Table of Contents
Interfaces
- PopupDataItem
- PopupDataAggregatable
- An interface for classes that have entities within them that should be taken to the top level of a REST response.
Methods
- __construct() : mixed
- getPopupData() : PopupData
- Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- merge() : $this
- toRestFormat() : array<string|int, mixed>|null
- Returns an array in JSON like format to return the entity as a rest response.
Methods
__construct()
public
__construct([ReactionMessage|ReactionMessages|null $reactions = null ]) : mixed
Parameters
- $reactions : ReactionMessage|ReactionMessages|null = null
getPopupData()
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
public
getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData
Parameters
- $excludedList : array<string|int, mixed> = []
Return values
PopupDatagetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
static getRestEntityName() : string
Return values
stringmerge()
public
merge(PopupDataItem $item) : $this
Parameters
- $item : PopupDataItem
Return values
$thistoRestFormat()
Returns an array in JSON like format to return the entity as a rest response.
public
toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
- $option : array<string|int, mixed> = []