moaction/jsonrpc-common

Jsonrpc通用库

v1.5 2013-12-18 09:32 UTC

This package is not auto-updated.

Last update: 2024-09-24 02:08:34 UTC


README

JSON-Rpc 2.0协议实现的通用库

http://www.jsonrpc.org/specification

库在jsonrpc-client和jsonrpc-server中使用

请求

class \Moaction\Jsonrpc\Common\Request

字段(字段的获取器和设置器)

  • 方法
  • id
  • params

方法

  • 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();

响应

class \Moaction\Jsonrpc\Common\Response

字段(字段的获取器和设置器)

  • result
  • error
  • id

方法

  • fromArray()
  • hasError()

正常响应

// 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);

错误响应

// 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();

错误

class \Moaction\Jsonrpc\Common\Error

错误对象。请参阅响应示例。

异常

class \Moaction\Jsonrpc\Common\Exception

在jsonrpc库中使用的异常