class RequestPacket extends Packet

Rpc Request 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 string $method A String containing the name of the method to be invoked.
protected array $params A Structured value that holds the parameter values to be used during the invocation of the method.

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
string
getMethod()

Getter for $method

setMethod(string $method)

Setter for $method

mixed
getParams()

Getter for $params

setParams(array $params)

Setter for $params

validate()

Validates a Rpc Request Packet

static RequestPacket|RequestPacket
build(string $jtlrpc)

Build RequestPacket

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 49
string getMethod()

Getter for $method

Return Value

string

at line 60
Packet setMethod(string $method)

Setter for $method

Parameters

string $method

Return Value

Packet

at line 71
mixed getParams()

Getter for $params

Return Value

mixed

at line 82
Packet setParams(array $params)

Setter for $params

Parameters

array $params | object $params

Return Value

Packet

at line 93
final validate()

Validates a Rpc Request Packet

Exceptions

RpcException

at line 125
static RequestPacket|RequestPacket build(string $jtlrpc)

Build RequestPacket

Parameters

string $jtlrpc

Return Value

RequestPacket|RequestPacket

Exceptions

RpcException