class ResponsePacket extends Packet

Rpc Response Packet

Constants

SINGLE_MODE

Single Mode

BATCH_MODE

Batch Mode

Properties

protected string $jtlrpc A String specifying the version of the JSON-RPC protocol. from Packet
protected string $id An identifier established by the Client that MUST contain a String, Number, or NULL value if included. from Packet
protected integer $result This member is REQUIRED on success.
protected Error $error This member is REQUIRED on error This member MUST NOT exist if there was no error triggered during invocation.

Methods

__construct(stdClass $object = null)

Constructor

from Model
multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from Model
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from Model
toJson()

No description

from Model
string
getJtlrpc()

Getter for $jtlrpc

from Packet
setJtlrpc(string $jtlrpc)

Setter for $jtlrpc

from Packet
string
getId()

Getter for $id

from Packet
setId(string $id)

Setter for $id

from Packet
integer
getResult()

Getter for $result

setResult(integer $result)

Setter for $result

getError()

Getter for $error

setError(Error $error = null)

Setter for $error

validate()

Validates a Rpc Response Packet

Details

in Model at line 23
__construct(stdClass $object = null)

Constructor

Parameters

stdClass $object

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in Model at line 45
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in Model at line 82
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in Packet at line 63
string getJtlrpc()

Getter for $jtlrpc

Return Value

string

in Packet at line 74
Packet setJtlrpc(string $jtlrpc)

Setter for $jtlrpc

Parameters

string $jtlrpc

Return Value

Packet

in Packet at line 85
string getId()

Getter for $id

Return Value

string

in Packet at line 96
Packet setId(string $id)

Setter for $id

Parameters

string $id | number | NULL $id

Return Value

Packet

at line 45
integer getResult()

Getter for $result

Return Value

integer | array | string | NULL

at line 56
Packet setResult(integer $result)

Setter for $result

Parameters

integer $result | array | string | NULL $result

Return Value

Packet

at line 67
Error getError()

Getter for $error

Return Value

Error

at line 78
Packet setError(Error $error = null)

Setter for $error

Parameters

Error $error

Return Value

Packet

at line 89
final validate()

Validates a Rpc Response Packet

Exceptions

RpcException