X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FResponse.php;h=6ed243aca5866b41cc3980ca1d5a0f5d283ec39f;hb=4a15ca01cea275528e059ca31474b927f613837a;hp=efadfb579340db13e0f0590b023efb4676d2585e;hpb=35d2340eea9a168983b8f20d54c399422790f816;p=plcapi.git diff --git a/src/Response.php b/src/Response.php index efadfb5..6ed243a 100644 --- a/src/Response.php +++ b/src/Response.php @@ -8,7 +8,7 @@ class Response { /// @todo: do these need to be public? public $val = 0; - public $valtyp; + public $valType; public $errno = 0; public $errstr = ''; public $payload; @@ -18,26 +18,25 @@ class Response public $raw_data = ''; /** - * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string) - * @param integer $fcode set it to anything but 0 to create an error response - * @param string $fstr the error string, in case of an error response - * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml' + * @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 string $fString the error string, in case of an error response + * @param string $valType either 'xmlrpcvals', 'phpvals' or 'xml' * - * @todo add check that $val / $fcode / $fstr is of correct type??? - * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain + * @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... */ - public function __construct($val, $fcode = 0, $fstr = '', $valtyp = '') + public function __construct($val, $fCode = 0, $fString = '', $valType = '') { - if ($fcode != 0) { + if ($fCode != 0) { // error response - $this->errno = $fcode; - $this->errstr = $fstr; - //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later. + $this->errno = $fCode; + $this->errstr = $fString; } else { // successful response $this->val = $val; - if ($valtyp == '') { + if ($valType == '') { // user did not declare type of response value: try to guess it if (is_object($this->val) && is_a($this->val, 'PhpXmlRpc\Value')) { $this->valtyp = 'xmlrpcvals'; @@ -48,7 +47,7 @@ class Response } } else { // user declares type of resp value: believe him - $this->valtyp = $valtyp; + $this->valtyp = $valType; } } } @@ -76,7 +75,7 @@ class Response /** * Returns the value received by the server. * - * @return mixed the xmlrpcval 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 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 */ public function value() { @@ -102,14 +101,16 @@ class Response /** * Returns xml representation of the response. XML prologue not included. * - * @param string $charset_encoding 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 + * + * @throws \Exception */ - public function serialize($charset_encoding = '') + public function serialize($charsetEncoding = '') { - if ($charset_encoding != '') { - $this->content_type = 'text/xml; charset=' . $charset_encoding; + if ($charsetEncoding != '') { + $this->content_type = 'text/xml; charset=' . $charsetEncoding; } else { $this->content_type = 'text/xml'; } @@ -121,11 +122,10 @@ class Response if ($this->errno) { // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients // by xml-encoding non ascii chars - $charsetEncoder = $result .= "\n" . "\nfaultCode\n" . $this->errno . "\n\n\nfaultString\n" . - Charset::instance()->encode_entities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "\n\n" . + Charset::instance()->encodeEntities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n\n" . "\n\n"; } else { if (!is_object($this->val) || !is_a($this->val, 'PhpXmlRpc\Value')) { @@ -135,11 +135,11 @@ class Response "\n"; } else { /// @todo try to build something serializable? - die('cannot serialize xmlrpc response objects whose content is native php values'); + throw new \Exception('cannot serialize xmlrpc response objects whose content is native php values'); } } else { $result .= "\n\n" . - $this->val->serialize($charset_encoding) . + $this->val->serialize($charsetEncoding) . "\n"; } }