X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FResponse.php;h=48ebca81fe420347e2893d7f086f82ee6e40aa78;hb=9d4cfc9508b03a579dd62a28c0e9e428b5052f9b;hp=efadfb579340db13e0f0590b023efb4676d2585e;hpb=35d2340eea9a168983b8f20d54c399422790f816;p=plcapi.git

diff --git a/src/Response.php b/src/Response.php
index efadfb5..48ebca8 100644
--- a/src/Response.php
+++ b/src/Response.php
@@ -4,6 +4,11 @@ namespace PhpXmlRpc;
 
 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
 {
     /// @todo: do these need to be public?
@@ -18,26 +23,26 @@ 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 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
+     *                        the code guess the correct type.
      *
-     * @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
-     * php val, or a complete xml chunk, depending on usage of Client::send() inside which creator is called...
+     * @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 +53,7 @@ class Response
                 }
             } else {
                 // user declares type of resp value: believe him
-                $this->valtyp = $valtyp;
+                $this->valtyp = $valType;
             }
         }
     }
@@ -74,9 +79,11 @@ class Response
     }
 
     /**
-     * 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 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 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()
     {
@@ -85,12 +92,11 @@ class Response
 
     /**
      * 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
      */
@@ -102,14 +108,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 +129,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 .= "<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>" .
-                Charset::instance()->encode_entities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</string></value>\n</member>\n" .
+                Charset::instance()->encodeEntities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</string></value>\n</member>\n" .
                 "</struct>\n</value>\n</fault>";
         } else {
             if (!is_object($this->val) || !is_a($this->val, 'PhpXmlRpc\Value')) {
@@ -135,11 +142,11 @@ 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" .
-                    $this->val->serialize($charset_encoding) .
+                    $this->val->serialize($charsetEncoding) .
                     "</param>\n</params>";
             }
         }