Comments fixing
[plcapi.git] / src / Response.php
index 54e8db4..6ed243a 100644 (file)
@@ -18,13 +18,13 @@ 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 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 / $fString is of correct type???
-     * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
+     * 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 = '')
@@ -33,7 +33,6 @@ class Response
             // 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;
@@ -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()
     {
@@ -105,6 +104,8 @@ class Response
      * @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($charsetEncoding = '')
     {
@@ -134,7 +135,7 @@ class Response
                         "</param>\n</params>";
                 } 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 .= "<params>\n<param>\n" .