1. class
  2. Comodojo
  3. \
  4. RpcServer
  5. \
  6. RpcMethod

RpcMethod

class RpcMethod (View source)

RPC Method object

It create a method's object ready to inject into RpcServer.

Constants

FETCH_ASSOC

FETCH_NUMERIC

Properties

static array $rpcvalues Generic-to-RPC values map

Methods

__construct($name, callable $callback, ...$arguments)

Class constructor

string
getName()

Get the method's name

callable
getCallback()

Get the method's callback

RpcMethod
setDescription(string $description = null)

Set the method's description

string|null
getDescription()

Get the method's method

array
getArguments()

Get additional arguments to forward to callback

RpcMethod
addSignature()

Add a signature and switch internal pointer

array
getSignatures(bool $compact = true)

Get the method's signatures

array
getSignature(bool $compact = true)

Get the current method's signature

bool
deleteSignature(integer $signature)

Delete a signature

RpcMethod
selectSignature(integer $signature)

Select a signature

RpcMethod
setReturnType(string $type)

Set the current signature's return type

string
getReturnType()

Get the current signature's return type

RpcMethod
addParameter(string $type, string $name)

Add a parameter to current signature

RpcMethod
deleteParameter(string $name)

Delete a parameter from current signature

array
getParameters(string $format = self::FETCH_ASSOC)

Get current signature's parameters

static RpcMethod
create($name, callable $callback, ...$arguments)

Static class constructor - create an RpcMethod object

Details

at line 107
__construct($name, callable $callback, ...$arguments)

Class constructor

Parameters

$name
callable $callback
...$arguments

Exceptions

InvalidArgumentException

at line 128
string getName()

Get the method's name

Return Value

string

at line 139
callable getCallback()

Get the method's callback

Return Value

callable

at line 153
RpcMethod setDescription(string $description = null)

Set the method's description

Parameters

string $description

Return Value

RpcMethod

Exceptions

InvalidArgumentException

at line 170
string|null getDescription()

Get the method's method

Return Value

string|null

at line 181
array getArguments()

Get additional arguments to forward to callback

Return Value

array

at line 192
RpcMethod addSignature()

Add a signature and switch internal pointer

Return Value

RpcMethod

at line 214
array getSignatures(bool $compact = true)

Get the method's signatures

Parameters

bool $compact (default) Compact signatures in a format compatible with system.methodSignature

Return Value

array

at line 243
array getSignature(bool $compact = true)

Get the current method's signature

Parameters

bool $compact (default) Compact signatures in a format compatible with system.methodSignature

Return Value

array

at line 265
bool deleteSignature(integer $signature)

Delete a signature

Parameters

integer $signature The signature's ID

Return Value

bool

Exceptions

InvalidArgumentException

at line 287
RpcMethod selectSignature(integer $signature)

Select a signature

Parameters

integer $signature The signature's ID

Return Value

RpcMethod

Exceptions

Exception

at line 309
RpcMethod setReturnType(string $type)

Set the current signature's return type

Parameters

string $type

Return Value

RpcMethod

Exceptions

InvalidArgumentException

at line 324
string getReturnType()

Get the current signature's return type

Return Value

string

at line 339
RpcMethod addParameter(string $type, string $name)

Add a parameter to current signature

Parameters

string $type
string $name

Return Value

RpcMethod

Exceptions

InvalidArgumentException

at line 359
RpcMethod deleteParameter(string $name)

Delete a parameter from current signature

Parameters

string $name

Return Value

RpcMethod

Exceptions

Exception

at line 376
array getParameters(string $format = self::FETCH_ASSOC)

Get current signature's parameters

Parameters

string $format The output array format (ASSOC|NUMERIC)

Return Value

array

at line 393
static RpcMethod create($name, callable $callback, ...$arguments)

Static class constructor - create an RpcMethod object

Parameters

$name
callable $callback
...$arguments

Return Value

RpcMethod

Exceptions

Exception