make it possible to retrieve from Response error http codes; introduce custom excepti...

[plcapi.git] / src / Response.php

diff --git a/src/Response.php b/src/Response.php
index e634ce5..f814d7b 100644 (file)
--- a/src/Response.php
+++ b/src/Response.php
@@ -8,6 +8,10 @@ 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.
+ *
+ * @property array $hdrs deprecated, use $httpResponse['headers']
+ * @property array _cookies deprecated, use $httpResponse['cookies']
+ * @property string $raw_data deprecated, use $httpResponse['raw_data']
  */
 class Response
 {
@@ -24,9 +28,7 @@ class Response
     public $errstr = '';
     public $payload;
     public $content_type = 'text/xml';
-    public $hdrs = array();
-    public $_cookies = array();
-    public $raw_data = '';
+    protected $httpResponse = array('headers' => array(), 'cookies' => array(), 'raw_data' => '', 'status_code' => null);
 
     public function getCharsetEncoder()
     {
@@ -47,12 +49,13 @@ class Response
      * @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.
+     * @param array|null $httpResponse
      *
      * @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, $fString = '', $valType = '')
+    public function __construct($val, $fCode = 0, $fString = '', $valType = '', $httpResponse = null)
     {
         if ($fCode != 0) {
             // error response
@@ -75,6 +78,10 @@ class Response
                 $this->valtyp = $valType;
             }
         }
+
+        if (is_array($httpResponse)) {
+            $this->httpResponse = array_merge(array('headers' => array(), 'cookies' => array(), 'raw_data' => '', 'status_code' => null), $httpResponse);
+        }
     }
 
     /**
@@ -121,7 +128,15 @@ class Response
      */
     public function cookies()
     {
-        return $this->_cookies;
+        return $this->httpResponse['cookies'];
+    }
+
+    /**
+     * @return array array with keys 'headers', 'cookies', 'raw_data' and 'status_code'
+     */
+    public function httpResponse()
+    {
+        return $this->httpResponse;
     }
 
     /**
@@ -173,4 +188,76 @@ class Response
 
         return $result;
     }
+
+    // BC layer
+
+    public function __get($name)
+    {
+        //trigger_error('getting property Response::' . $name . ' is deprecated', E_USER_DEPRECATED);
+
+        switch($name) {
+            case 'hdrs':
+                return $this->httpResponse['headers'];
+            case '_cookies':
+                return $this->httpResponse['cookies'];
+            case 'raw_data':
+                return $this->httpResponse['raw_data'];
+            default:
+                $trace = debug_backtrace();
+                trigger_error('Undefined property via __get(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);
+                return null;
+        }
+    }
+
+    public function __set($name, $value)
+    {
+        //trigger_error('setting property Response::' . $name . ' is deprecated', E_USER_DEPRECATED);
+
+        switch($name) {
+            case 'hdrs':
+                $this->httpResponse['headers'] = $value;
+                break;
+            case '_cookies':
+                $this->httpResponse['cookies'] = $value;
+                break;
+            case 'raw_data':
+                $this->httpResponse['raw_data'] = $value;
+                break;
+            default:
+                $trace = debug_backtrace();
+                trigger_error('Undefined property via __set(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);
+        }
+    }
+
+    public function __isset($name)
+    {
+        switch($name) {
+            case 'hdrs':
+                return isset($this->httpResponse['headers']);
+            case '_cookies':
+                return isset($this->httpResponse['cookies']);
+            case 'raw_data':
+                return isset($this->httpResponse['raw_data']);
+            default:
+                return false;
+        }
+    }
+
+    public function __unset($name)
+    {
+        switch($name) {
+            case 'hdrs':
+                unset($this->httpResponse['headers']);
+                break;
+            case '_cookies':
+                unset($this->httpResponse['cookies']);
+                break;
+            case 'raw_data':
+                unset($this->httpResponse['raw_data']);
+                break;
+            default:
+                $trace = debug_backtrace();
+                trigger_error('Undefined property via __unset(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);
+        }
+    }
 }