ActionPayload
in package
implements
JsonSerializable
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- $data : array<string|int, mixed>|object|null
- $error : ActionError|null
- $pagination : Pagination|null
- $statusCode : int
- __construct() : mixed
- getData() : array<string|int, mixed>|object|null
- get data of the payload
- getError() : ActionError|null
- get error of the action
- getStatusCode() : int
- get satus code of the payload
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
Properties
$data
private
array<string|int, mixed>|object|null
$data
$error
private
ActionError|null
$error
$pagination
private
Pagination|null
$pagination
$statusCode
private
int
$statusCode
Methods
__construct()
public
__construct([int $statusCode = 200 ][, mixed $data = NULL ][, ActionError|null $error = NULL ][, Pagination|null $pagination = NULL ]) : mixed
Parameters
- $statusCode : int = 200
- $data : mixed = NULL
- $error : ActionError|null = NULL
- $pagination : Pagination|null = NULL
Return values
mixed —getData()
get data of the payload
public
getData() : array<string|int, mixed>|object|null
Return values
array<string|int, mixed>|object|null —getError()
get error of the action
public
getError() : ActionError|null
Return values
ActionError|null —getStatusCode()
get satus code of the payload
public
getStatusCode() : int
Return values
int —jsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>