1. class
  2. Comodojo
  3. \
  4. RpcClient
  5. \
  6. RpcRequest

RpcRequest

class RpcRequest (View source)

Methods

__construct()

No description

string
getUniqueId()

Get request's unique id

string|null
getMethod()

Get rpc method

RpcRequest
setMethod(string $method)

Set rpc method

array
getParameters()

Get parameters

RpcRequest
setParameters(array $params = [])

Set parameters

array
getSpecialTypes()

Get values marked as special type

RpcRequest
setSpecialType(string $value, string $type)

Set values as special type

int|bool|null
getId()

Get request's id

RpcRequest
setId(int|bool|null $id = null)

Set request's id

array
toArray()

Export request as an array

static RpcRequest
create(string $method, array $parameters = [], int|bool|null $id = true)

Static constructor

Details

at line 58
__construct()

at line 69
string getUniqueId()

Get request's unique id

Return Value

string

at line 80
string|null getMethod()

Get rpc method

Return Value

string|null

at line 93
RpcRequest setMethod(string $method)

Set rpc method

Parameters

string $method

Return Value

RpcRequest

Exceptions

InvalidArgumentException

at line 108
array getParameters()

Get parameters

Return Value

array

at line 120
RpcRequest setParameters(array $params = [])

Set parameters

Parameters

array $params

Return Value

RpcRequest

at line 133
array getSpecialTypes()

Get values marked as special type

Return Value

array

at line 147
RpcRequest setSpecialType(string $value, string $type)

Set values as special type

Parameters

string $value
string $type

Return Value

RpcRequest

Exceptions

InvalidArgumentException

at line 166
int|bool|null getId()

Get request's id

Return Value

int|bool|null

at line 179
RpcRequest setId(int|bool|null $id = null)

Set request's id

Parameters

int|bool|null $id

Return Value

RpcRequest

Exceptions

InvalidArgumentException

at line 205
array toArray()

Export request as an array

Return Value

array

at line 226
static RpcRequest create(string $method, array $parameters = [], int|bool|null $id = true)

Static constructor

Parameters

string $method
array $parameters
int|bool|null $id

Return Value

RpcRequest

Exceptions

Exception