comment

[plcapi.git] / src / Response.php

diff --git a/src/Response.php b/src/Response.php
index 16ff0a8..cc33ebf 100644 (file)
--- a/src/Response.php
+++ b/src/Response.php
@@ -5,25 +5,29 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\Charset;
 
 /**
- * This class is used to contain responses to XML-RPC requests.
+ * 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
 {
     /// @todo: do these need to be public?
+    /** @internal */
     public $val = 0;
+    /** @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 = '';
 
     /**
-     * @param mixed $val either a Value object, a php value or the xml serialization of an xmlrpc value (a string)
+     * @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 The type of $val passed in. Either 'xmlrpcvals', 'phpvals' or 'xml'. Leave empty to let
@@ -98,7 +102,7 @@ class Response
      * 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()
     {
@@ -127,8 +131,7 @@ class 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>" .
@@ -141,7 +144,7 @@ class Response
                         $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 {