moaction/jsonrpc-common

Jsonrpc common libraries

Jsonrpc-common

Common libraries for JSON-Rpc 2.0 protocol implementation, _(*1)

http://www.jsonrpc.org/specification, _(*2)

Libraries are used in jsonrpc-client and jsonrpc-server, _(*3)

Request

class \Moaction\Jsonrpc\Common\Request, _(*4)

Fields (getters and setters for fields):

• method
• id
• params

Methods

• toArray()

$request = new \Moaction\Jsonrpc\Common\Request
$request->setId(1);
$request->setMethod('getUserData');
$request->setParams(array('userId' => 4, 'field' => 'email'));
// here you get valid jsonrpc 2.0 request object ready for json_encode
// \InvalidArgumentException can be thrown when Request object is misconfigured (method is not set).
$data = $request->toArray();

Response

class \Moaction\Jsonrpc\Common\Response, _(*5)

Fields (getters and setters for fields):

• result
• error
• id

Methods

• fromArray()
• hasError()

Normal response

// decoded array with jsonrpc 2.0 response
$data = array(
    'id'     => 1,
    'result' => array(
        'email' => 'user@example.com',
    ),
);
// \Moaction\Jsonrpc\Common\Exception can be thrown when object is not valid jsonrpc response
$response = new \Moaction\Jsonrpc\Common\Response::fromArray($data);

Error response

// decoded array with jsonrpc 2.0 response
$data = array(
    'id'     => 1,
    'error' => array(
        'code' => '20',
        'message' => 'User not found',
        'data' => array('userId' => 4),
    ),
);
$response = new \Moaction\Jsonrpc\Common\Response::fromArray($data);
// \Moaction\Jsonrpc\Common\Error object
$error = $response->getError();

Error

class \Moaction\Jsonrpc\Common\Error, _(*6)

Error object. See response for example., _(*7)

Exception

class \Moaction\Jsonrpc\Common\Exception, _(*8)

Exception for using in jsonrpc libraries, _(*9)