This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
Response.php
224 lines (201 loc) · 5.32 KB
/
Response.php
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\XmlRpc;
use ZendXml\Security as XmlSecurity;
/**
* XmlRpc Response
*
* Container for accessing an XMLRPC return value and creating the XML response.
*/
class Response
{
/**
* Return value
* @var mixed
*/
protected $return;
/**
* Return type
* @var string
*/
protected $type;
/**
* Response character encoding
* @var string
*/
protected $encoding = 'UTF-8';
/**
* Fault, if response is a fault response
* @var null|\Zend\XmlRpc\Fault
*/
protected $fault = null;
/**
* Constructor
*
* Can optionally pass in the return value and type hinting; otherwise, the
* return value can be set via {@link setReturnValue()}.
*
* @param mixed $return
* @param string $type
*/
public function __construct($return = null, $type = null)
{
$this->setReturnValue($return, $type);
}
/**
* Set encoding to use in response
*
* @param string $encoding
* @return \Zend\XmlRpc\Response
*/
public function setEncoding($encoding)
{
$this->encoding = $encoding;
AbstractValue::setEncoding($encoding);
return $this;
}
/**
* Retrieve current response encoding
*
* @return string
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Set the return value
*
* Sets the return value, with optional type hinting if provided.
*
* @param mixed $value
* @param string $type
* @return void
*/
public function setReturnValue($value, $type = null)
{
$this->return = $value;
$this->type = (string) $type;
}
/**
* Retrieve the return value
*
* @return mixed
*/
public function getReturnValue()
{
return $this->return;
}
/**
* Retrieve the XMLRPC value for the return value
*
* @return \Zend\XmlRpc\AbstractValue
*/
protected function _getXmlRpcReturn()
{
return AbstractValue::getXmlRpcValue($this->return);
}
/**
* Is the response a fault response?
*
* @return bool
*/
public function isFault()
{
return $this->fault instanceof Fault;
}
/**
* Returns the fault, if any.
*
* @return null|\Zend\XmlRpc\Fault
*/
public function getFault()
{
return $this->fault;
}
/**
* Load a response from an XML response
*
* Attempts to load a response from an XMLRPC response, autodetecting if it
* is a fault response.
*
* @param string $response
* @throws Exception\ValueException if invalid XML
* @return bool True if a valid XMLRPC response, false if a fault
* response or invalid input
*/
public function loadXml($response)
{
if (!is_string($response)) {
$this->fault = new Fault(650);
$this->fault->setEncoding($this->getEncoding());
return false;
}
try {
$xml = XmlSecurity::scan($response);
} catch (\ZendXml\Exception\RuntimeException $e) {
$this->fault = new Fault(651);
$this->fault->setEncoding($this->getEncoding());
return false;
}
if (!empty($xml->fault)) {
// fault response
$this->fault = new Fault();
$this->fault->setEncoding($this->getEncoding());
$this->fault->loadXml($response);
return false;
}
if (empty($xml->params)) {
// Invalid response
$this->fault = new Fault(652);
$this->fault->setEncoding($this->getEncoding());
return false;
}
try {
if (!isset($xml->params) || !isset($xml->params->param) || !isset($xml->params->param->value)) {
throw new Exception\ValueException('Missing XML-RPC value in XML');
}
$valueXml = $xml->params->param->value->asXML();
$value = AbstractValue::getXmlRpcValue($valueXml, AbstractValue::XML_STRING);
} catch (Exception\ValueException $e) {
$this->fault = new Fault(653);
$this->fault->setEncoding($this->getEncoding());
return false;
}
$this->setReturnValue($value->getValue());
return true;
}
/**
* Return response as XML
*
* @return string
*/
public function saveXml()
{
$value = $this->_getXmlRpcReturn();
$generator = AbstractValue::getGenerator();
$generator->openElement('methodResponse')
->openElement('params')
->openElement('param');
$value->generateXml();
$generator->closeElement('param')
->closeElement('params')
->closeElement('methodResponse');
return $generator->flush();
}
/**
* Return XML response
*
* @return string
*/
public function __toString()
{
return $this->saveXML();
}
}