blob: b200fe2ebeb5061bf50f7f570b58e3a83f217188 (
plain)
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<?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 Prado\Web\Services
*/
namespace Prado\Web\Services;
/**
* TXmlRpcProtocol class
*
* TXmlRpcProtocol is a class that implements XML-Rpc protocol in {@link TRpcService}.
* It's basically a wrapper to the xmlrpc_server_* family of php methods.
*
* @author Robin J. Rogge <rrogge@bigpoint.net>
* @package Prado\Web\Services
* @since 3.2
*/
class TXmlRpcProtocol extends TRpcProtocol
{
/**
* @var XML RPC server resource
*/
private $_xmlrpcServer;
// magics
/**
* Constructor
*/
public function __construct()
{
$this->_xmlrpcServer = xmlrpc_server_create();
}
/**
* Destructor
*/
public function __destruct()
{
xmlrpc_server_destroy($this->_xmlrpcServer);
}
// methods
/**
* Registers a new RPC method and handler details
* @param string $methodName
* @param array $handlerDetails containing the callback handler
*/
public function addMethod($methodName, $methodDetails)
{
parent::addMethod($methodName, $methodDetails);
xmlrpc_server_register_method($this->_xmlrpcServer, $methodName, array($this, 'callApiMethod'));
}
// methods
/**
* Handles the RPC request
* @param string $requestPayload
* @return string XML RPC response
*/
public function callMethod($requestPayload)
{
try
{
return xmlrpc_server_call_method($this->_xmlrpcServer, $requestPayload, null);
}
catch(TRpcException $e)
{
return $this->createErrorResponse($e);
}
catch(THttpException $e)
{
throw $e;
}
catch(Exception $e)
{
return $this->createErrorResponse(new TRpcException('An internal error occured'));
}
}
/**
* Turns the given exception into an XML RPC fault
* @param TRpcException $exception
* @return string XML RPC fault
*/
public function createErrorResponse(TRpcException $exception)
{
return $this->encode(array(
'faultCode' => $exception->getCode(),
'faultString' => $exception->getMessage()
));
}
/**
* Sets the correct response headers
* @param THttpResponse $response
*/
public function createResponseHeaders($response)
{
$response->setContentType('text/xml');
$response->setCharset('UTF-8');
}
/**
* Decodes XML encoded data into PHP data
* @param string $data in XML format
* @return array PHP data
*/
public function decode($data)
{
return xmlrpc_decode($data);
}
/**
* Encodes PHP data into XML data
* @param mixed PHP data
* @return string XML encoded PHP data
*/
public function encode($data)
{
return xmlrpc_encode($data);
}
}
|
