Entity implements RestEntity
Table of Contents
Interfaces
Properties
- $id : int|null
- $options : array<string|int, mixed>|null
- $order : int|null
- $placement : string|null
- $restApplicationId : int|null
- $title : string|null
Methods
- __construct() : mixed
- getId() : int|null
- Returns the id of the entity
- getRestEntityName() : string
- Returns the name of the entity that will be used in the rest response
- hydrate() : void
- toRestFormat() : array<string|int, mixed>|null
- Returns an array in JSON like format to return the entity as a rest response.
Properties
$id
public
int|null
$id
= null
$options
public
array<string|int, mixed>|null
$options
= null
$order
public
int|null
$order
= null
$placement
public
string|null
$placement
= null
$restApplicationId
public
int|null
$restApplicationId
= null
$title
public
string|null
$title
= null
Methods
__construct()
public
__construct([array<string|int, mixed>|null $fields = null ]) : mixed
Parameters
- $fields : array<string|int, mixed>|null = null
getId()
Returns the id of the entity
public
getId() : int|null
Tags
Return values
int|nullgetRestEntityName()
Returns the name of the entity that will be used in the rest response
public
static getRestEntityName() : string
Tags
Return values
stringhydrate()
public
hydrate(array<string|int, mixed> $fields) : void
Parameters
- $fields : array<string|int, mixed>
toRestFormat()
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> = []