use PhpXmlRpc\Helper\Charset;
+/**
+ * This class provides the representation of the response of an XML-RPC server.
+ * Server-side, a server method handler will construct a Response and pass it as its return value.
+ * An identical Response object will be returned by the result of an invocation of the send() method of the Client class.
+ */
class Response
{
+ protected static $charsetEncoder;
+
/// @todo: do these need to be public?
+ /** @internal */
public $val = 0;
- public $valType;
+ /** @internal */
+ public $valtyp;
+ /** @internal */
public $errno = 0;
+ /** @internal */
public $errstr = '';
public $payload;
+ public $content_type = 'text/xml';
public $hdrs = array();
public $_cookies = array();
- public $content_type = 'text/xml';
public $raw_data = '';
+ public function getCharsetEncoder()
+ {
+ if (self::$charsetEncoder === null) {
+ self::$charsetEncoder = Charset::instance();
+ }
+ return self::$charsetEncoder;
+ }
+
+ public function setCharsetEncoder($charsetEncoder)
+ {
+ self::$charsetEncoder = $charsetEncoder;
+ }
+
/**
- * @param mixed $val either an xmlrpc value obj, a php value or the xml serialization of an xmlrpc value (a string)
- * @param integer $fCode set it to anything but 0 to create an error response
+ * @param Value|string|mixed $val either a Value object, a php value or the xml serialization of an xmlrpc value (a string)
+ * @param integer $fCode set it to anything but 0 to create an error response. In that case, $val is discarded
* @param string $fString the error string, in case of an error response
- * @param string $valType either 'xmlrpcvals', 'phpvals' or 'xml'
+ * @param string $valType The type of $val passed in. Either 'xmlrpcvals', 'phpvals' or 'xml'. Leave empty to let
+ * the code guess the correct type.
*
* @todo add check that $val / $fCode / $fString is of correct type???
- * NB: as of now we do not do it, since it might be either an xmlrpc value or a plain
- * php val, or a complete xml chunk, depending on usage of Client::send() inside which creator is called...
+ * NB: as of now we do not do it, since it might be either an xmlrpc value or a plain php val, or a complete
+ * xml chunk, depending on usage of Client::send() inside which creator is called...
*/
public function __construct($val, $fCode = 0, $fString = '', $valType = '')
{
// error response
$this->errno = $fCode;
$this->errstr = $fString;
- //$this->errstr = htmlspecialchars($fString); // XXX: encoding probably shouldn't be done here; fix later.
} else {
// successful response
$this->val = $val;
}
/**
- * Returns the value received by the server.
+ * Returns the value received by the server. If the Response's faultCode is non-zero then the value returned by this
+ * method should not be used (it may not even be an object).
*
- * @return mixed the xmlrpc value object returned by the server. Might be an xml string or php value if the response has been created by specially configured Client objects
+ * @return Value|string|mixed the Value object returned by the server. Might be an xml string or plain php value
+ * depending on the convention adopted when creating the Response
*/
public function value()
{
/**
* Returns an array with the cookies received from the server.
- * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)
+ * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 => $val2, ...)
* with attributes being e.g. 'expires', 'path', domain'.
- * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
- * are still present in the array. It is up to the user-defined code to decide
- * how to use the received cookies, and whether they have to be sent back with the next
- * request to the server (using Client::setCookie) or not.
+ * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) are still present in the array.
+ * It is up to the user-defined code to decide how to use the received cookies, and whether they have to be sent back
+ * with the next request to the server (using Client::setCookie) or not.
*
- * @return array array of cookies received from the server
+ * @return array[] array of cookies received from the server
*/
public function cookies()
{
/**
* Returns xml representation of the response. XML prologue not included.
*
- * @param string $charsetEncoding the charset to be used for serialization. if null, US-ASCII is assumed
+ * @param string $charsetEncoding the charset to be used for serialization. If null, US-ASCII is assumed
*
* @return string the xml representation of the response
*
$result = "<methodResponse>\n";
}
if ($this->errno) {
- // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
- // by xml-encoding non ascii chars
+ // Let non-ASCII response messages be tolerated by clients by xml-encoding non ascii chars
$result .= "<fault>\n" .
"<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
"</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
$this->val .
"</param>\n</params>";
} else {
- /// @todo try to build something serializable?
+ /// @todo try to build something serializable using the Encoder...
throw new \Exception('cannot serialize xmlrpc response objects whose content is native php values');
}
} else {
git://git.onelab.eu / plcapi.git / blobdiff