1. class
  2. Comodojo
  3. \
  4. RpcServer
  5. \
  6. Request
  7. \
  8. Parameters

Parameters

class Parameters (View source)

The parameters object

It provides to each RPC method a way to access: - Provided parameters - Supported capabilities - Implemented methods - Predefined errors - Current RPC protocol - Current logger

The parameter object is the only one parameter passed to a RPC method's implementation

Methods

__construct(Capabilities $capabilities, Methods $methods, Errors $errors, LoggerInterface $logger, string $protocol)

Class constructor

Parameters
setParameters(array $parameters = [])

Set provided parameters

Capabilities
capabilities() deprecated

Get capabilities object

Capabilities
getCapabilities() deprecated

Get capabilities object

Methods
methods() deprecated

Get methods object

Methods
getMethods()

Get methods object

Errors
errors() deprecated

Get errors object

Errors
getErrors()

Get errors object

string
protocol() deprecated

Get current RPC protocol

string
getProtocol()

Get current RPC protocol

LoggerInterface
logger() deprecated

Get current logger instance

LoggerInterface
getLogger()

Get current logger instance

mixed
get(string $parameter = null)

Get parameter(s)

Details

at line 89
__construct(Capabilities $capabilities, Methods $methods, Errors $errors, LoggerInterface $logger, string $protocol)

Class constructor

Parameters

Capabilities $capabilities
Methods $methods
Errors $errors
LoggerInterface $logger
string $protocol

at line 116
final Parameters setParameters(array $parameters = [])

Set provided parameters

Parameters

array $parameters

Return Value

Parameters

at line 131
Capabilities capabilities() deprecated

deprecated

Get capabilities object

Return Value

Capabilities

See also

Parameters::getCapabilities

at line 144
Capabilities getCapabilities() deprecated

deprecated

Get capabilities object

Return Value

Capabilities

See also

Parameters::getCapabilities

at line 157
Methods methods() deprecated

deprecated

Get methods object

Return Value

Methods

See also

Parameters::getMethods

at line 168
Methods getMethods()

Get methods object

Return Value

Methods

at line 181
Errors errors() deprecated

deprecated

Get errors object

Return Value

Errors

See also

Parameters::getErrors

at line 192
Errors getErrors()

Get errors object

Return Value

Errors

at line 205
string protocol() deprecated

deprecated

Get current RPC protocol

Return Value

string

See also

Parameters::getProtocol

at line 216
string getProtocol()

Get current RPC protocol

Return Value

string

at line 229
LoggerInterface logger() deprecated

deprecated

Get current logger instance

Return Value

LoggerInterface

See also

Parameters::getLogger

at line 240
LoggerInterface getLogger()

Get current logger instance

Return Value

LoggerInterface

at line 253
mixed get(string $parameter = null)

Get parameter(s)

Parameters

string $parameter (optional) The parameter name (null will return whole array of parameters)

Return Value

mixed