1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
<?php
/**
* @author Robin J. Rogge <rrogge@bigpoint.net>
* @link http://www.pradosoft.com/
* @copyright 2010 Bigpoint GmbH
* @license http://www.pradosoft.com/license/
* @since 3.2
* @package System.Util
*/
/**
* TJsonRpcClient class
*
* Note: When using setIsNotification(true), *every* following request is also
* considered to be a notification until you use setIsNotification(false).
*
* Usage:
* <pre>
* $_rpcClient = new TJsonRpcClient('http://host/server');
* $_result = $_rpcClient->remoteMethod($param, $otherParam);
* // or
* $_result = TJsonRpcClient::create('http://host/server')->remoteMethod($param, $otherParam);
* </pre>
*
* @author Robin J. Rogge <rrogge@bigpoint.net>
* @version $Id$
* @package System.Util
* @since 3.2
*/
class TJsonRpcClient extends TRpcClient
{
// magics
/**
* @param string RPC method name
* @param array RPC method parameters
* @return mixed RPC request result
* @throws TRpcClientRequestException if the client fails to connect to the server
* @throws TRpcClientResponseException if the response represents an RPC fault
*/
public function __call($method, $parameters)
{
// send request
$_response = $this->performRequest($this->getServerUrl(), $this->encodeRequest($method, $parameters), 'application/json');
// skip response handling if the request was just a notification request
if($this->isNotification)
return true;
// decode response
if(($_response = json_decode($_response, true)) === null)
throw new TRpcClientResponseException('Empty response received');
// handle error response
if(!is_null($_response['error']))
throw new TRpcClientResponseException($_response['error']);
return $_response['result'];
}
// methods
/**
* @param string method name
* @param array method parameters
*/
public function encodeRequest($method, $parameters)
{
static $_requestId;
$_requestId = ($_requestId === null) ? 1 : $_requestId + 1;
return json_encode(array(
'method' => $method,
'params' => $parameters,
'id' => $this->isNotification ? null : $_requestId
));
}
/**
* Creates an instance of TJsonRpcClient
* @param string url of the rpc server
* @param boolean whether the requests are considered to be notifications (completely ignoring the response) (default: false)
*/
public static function create($type, $serverUrl, $isNotification = false)
{
return new self($serverUrl, $isNotification);
}
}
|
