PingRequest extends Request
FinalYes
A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.
Tags
Table of Contents
Properties
Methods
- fromArray() : static
- getId() : string|int
- getMeta() : array<string, mixed>|null
- getMethod() : string
- jsonSerialize() : RequestData
- requiresJsonTypes() : bool
- Whether the request cannot be served from params that lost the difference between `{}` and `[]`.
- withId() : static
- withMeta() : static
- fromParams() : static
- getParams() : array<non-empty-string, mixed>|null
- paramsToArray() : array<string, mixed>
Properties
$id
protected
string|int
$id
$meta
protected
array<string, mixed>|null
$meta
= null
Methods
fromArray()
public
static fromArray(RequestData $data) : static
Parameters
- $data : RequestData
Return values
staticgetId()
public
getId() : string|int
Return values
string|intgetMeta()
public
getMeta() : array<string, mixed>|null
Return values
array<string, mixed>|nullgetMethod()
public
static getMethod() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : RequestData
Return values
RequestDatarequiresJsonTypes()
Whether the request cannot be served from params that lost the difference between `{}` and `[]`.
public
static requiresJsonTypes() : bool
Return values
boolwithId()
public
withId(string|int $id) : static
Parameters
- $id : string|int
Return values
staticwithMeta()
public
withMeta(array<string, mixed>|null $meta) : static
Parameters
- $meta : array<string, mixed>|null
Return values
staticfromParams()
protected
static fromParams(array<string|int, mixed>|null $params) : static
Parameters
- $params : array<string|int, mixed>|null
Return values
staticgetParams()
protected
getParams() : array<non-empty-string, mixed>|null
Return values
array<non-empty-string, mixed>|nullparamsToArray()
protected
static paramsToArray(stdClass $params) : array<string, mixed>
Parameters
- $params : stdClass