Base Request and Response off of base class Message

Message.inc.php

@@ -0,0 +1,141 @@
+<?php
+
+namespace wellrested;
+
+/**
+ * Common base class for the Request and Response classes.
+ *
+ * @property string body       Entity body of the message
+ * @property array headers     Associative array of HTTP headers
+ */
+abstract class Message {
+
+    /**
+     * Entity body of the message
+     *
+     * @var string
+     */
+    protected $body;
+
+    /**
+     * Associative array of HTTP headers
+     *
+     * @var array
+     */
+    protected $headers;
+
+    // -------------------------------------------------------------------------
+    // !Accessors
+
+    /**
+     * @param string $name
+     * @return array|string
+     * @throws \Exception
+     */
+    public function __get($name) {
+
+        switch ($name) {
+            case 'body':
+                return $this->getBody();
+            case 'headers':
+                return $this->getHeaders();
+            default:
+                throw new \Exception('Property ' . $name . ' does not exist.');
+        }
+
+    }
+
+    /**
+     * @param string $name
+     * @param mixed $value
+     * @throws \Exception
+     */
+    public function __set($name, $value) {
+
+        switch ($name) {
+            case 'body':
+                $this->setBody($value);
+                return;
+            default:
+                throw new \Exception('Property ' . $name . 'does not exist or is read-only.');
+        }
+
+    }
+
+    /**
+     * Return the body payload of the instance.
+     *
+     * @return string
+     */
+    public function getBody() {
+        return $this->body;
+    }
+
+    /**
+     * Set the body for the request.
+     *
+     * @param string $body
+     */
+    public function setBody($body) {
+        $this->body = $body;
+    }
+
+    /**
+     * Return an associative array of all set headers.
+     *
+     * @return array
+     */
+    public function getHeaders() {
+        return $this->headers;
+    }
+
+    /**
+     * Return the value of a given header, or false if it does not exist.
+     *
+     * @param string $header
+     * @return string|bool
+     */
+    public function getHeader($header) {
+
+        if ($this->hasHeader($header)) {
+            return $this->headers[$header];
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Add or update a header to a given value
+     *
+     * @param string $header
+     * @param string $value
+     */
+    public function setHeader($header, $value) {
+        $this->headers[$header] = $value;
+    }
+
+    /**
+     * Return if the response contains a header with the given key.
+     *
+     * @param string $header
+     * @return bool
+     */
+    public function hasHeader($header) {
+        return isset($this->headers[$header]);
+    }
+
+    /**
+     * Remove a header. This method does nothing if the header does not exist.
+     *
+     * @param string $header
+     */
+    public function unsetHeader($header) {
+        if ($this->hasHeader($header)) {
+            unset($this->headers[$header]);
+        }
+    }
+
+}
+
+?>

Request.inc.php

@@ -2,10 +2,12 @@
 
 namespace wellrested;
 
+require_once(dirname(__FILE__) . '/Message.inc.php');
 require_once(dirname(__FILE__) . '/Response.inc.php');
 require_once(dirname(__FILE__) . '/exceptions/CurlException.inc.php');
 
 // !TODO: Include port in the URI
+// !TODO: This and Response both have protocol members, but they are different.
 
 /**
  * A Request instance represents an HTTP request. This class has two main uses:
@@ -17,10 +19,6 @@ require_once(dirname(__FILE__) . '/exceptions/CurlException.inc.php');
  * Second, you can create a custom Request and use it to obtain a Response
  * from a server through cURL.
  *
- * @property string body       Entity body of the request
- * @property array headers     Associative array of HTTP headers
- * @property array hostname    The Hostname for the request (e.g., google.com)
- * @property string method     HTTP method or verb for the request
  * @property string path       Path component of the URI for the request
  * @property string pathParts  Fragments of the path, delimited by slashes
  * @property array query       Associative array of query parameters
@@ -28,21 +26,7 @@ require_once(dirname(__FILE__) . '/exceptions/CurlException.inc.php');
  *
  * @package WellRESTed
  */
-class Request {
+class Request extends Message {
-
-    /**
-     * Entity body of the request
-     *
-     * @var string
-     */
-    protected $body;
-
-    /**
-     * Associative array of HTTP headers
-     *
-     * @var array
-     */
-    protected $headers;
 
     /**
      * The Hostname for the request (e.g., www.google.com)
@@ -72,13 +56,6 @@ class Request {
      */
     protected $pathParts;
 
-    /**
-     * Protocal for the request (e.g., http, https)
-     *
-     * @var string
-     */
-    protected $protocol = 'http';
-
     /**
      * Associative array of query parameters
      *
@@ -94,6 +71,12 @@ class Request {
      */
     static protected $theRequest;
 
+    /**
+     * Protocal for the request (e.g., http, https)
+     *
+     * @var string
+     */
+    public $protocol = 'http';
 
     // -------------------------------------------------------------------------
     // !Accessors
@@ -106,10 +89,6 @@ class Request {
     public function __get($name) {
 
         switch ($name) {
-            case 'body':
-                return $this->getBody();
-            case 'headers':
-                return $this->getHeaders();
             case 'hostname':
                 return $this->getHostname();
             case 'method':
@@ -118,14 +97,12 @@ class Request {
                 return $this->getPath();
             case 'pathParts':
                 return $this->getPathParts();
-            case 'protocol':
-                return $this->getProtocol();
             case 'query':
                 return $this->getQuery();
             case 'uri':
                 return $this->getUri();
             default:
-                throw new \Exception('Property ' . $name . ' does not exist.');
+                return parent::__get($name);
         }
 
     } // __get()
@@ -138,9 +115,6 @@ class Request {
     public function __set($name, $value) {
 
         switch ($name) {
-            case 'body':
-                $this->setBody($value);
-                return;
             case 'hostname':
                 $this->setHostname($value);
                 return;
@@ -150,9 +124,6 @@ class Request {
             case 'path':
                 $this->setPath($value);
                 return;
-            case 'protocol':
-                $this->setProtocol($value);
-                return;
             case 'query':
                 $this->setQuery($value);
                 return;
@@ -160,41 +131,26 @@ class Request {
                 $this->setUri($value);
                 return;
             default:
-                throw new \Exception('Property ' . $name . 'does not exist.');
+                parent::__set($name, $value);
         }
 
     }
 
     /**
-     * Return the body payload of the instance.
-     *
      * @return string
      */
-    public function getBody() {
-        return $this->body;
-    }
-
-    /**
-     * Return an associative array of all set headers.
-     *
-     * @return array
-     */
-    public function getHeaders() {
-        return $this->headers;
-    }
-
-    /**
-     * Return the hostname set for the instance.
-     *
-     * @return array
-     */
     public function getHostname() {
         return $this->hostname;
     }
 
     /**
-     * Return the HTTP method (e.g., GET, POST, PUT, DELETE)
+     * @param string $hostname
-     *
+     */
+    public function setHostname($hostname) {
+        $this->hostname = $hostname;
+    }
+
+    /**
      * @return string
      */
     public function getMethod() {
@@ -202,12 +158,10 @@ class Request {
     }
 
     /**
-     * Return the protocol (e.g., http, https)
+     * @param string $method
-     *
-     * @return string
      */
-    public function getProtocol() {
+    public function setMethod($method) {
-        return $this->protocol;
+        $this->method = $method;
     }
 
     /**
@@ -219,6 +173,16 @@ class Request {
         return $this->path;
     }
 
+    /**
+     * Set the path and pathParts members.
+     *
+     * @param string $path
+     */
+    public function setPath($path) {
+        $this->path = $path;
+        $this->pathParts = explode('/', substr($path, 1));
+    }
+
     /**
      * Return an array of the sections of the path delimited by slashes.
      *
@@ -238,96 +202,9 @@ class Request {
     }
 
     /**
-     * Return the full URI includeing protocol, hostname, path, and query.
+     * Set the query. The value passed can be a query string of key-value pairs
+     * joined by ampersands or it can be an associative array.
      *
-     * @return array
-     */
-    public function getUri() {
-
-        $uri = $this->protocol . '://' . $this->hostname . $this->path;
-
-        if ($this->query) {
-            $uri .= '?' . http_build_query($this->query);
-        }
-
-        return $uri;
-
-    }
-
-    /**
-     * Set the body for the request.
-     *
-     * @param string $body
-     */
-    public function setBody($body) {
-        $this->body = $body;
-    }
-
-    /**
-     * Add or update a header to a given value
-     *
-     * @param string $header
-     * @param string $value
-     */
-    public function setHeader($header, $value) {
-        $this->headers[$header] = $value;
-    }
-
-    /**
-     * Return if the response contains a header with the given key.
-     *
-     * @param string $header
-     * @return bool
-     */
-    public function hasHeader($header) {
-        return isset($this->headers[$header]);
-    }
-
-    /**
-     * Set the hostname for the request and update the URI.
-     *
-     * @param string $hostname
-     */
-    public function setHostname($hostname) {
-        $this->hostname = $hostname;
-    }
-
-    /**
-     * Set the method for the request.
-     *
-     * @param string $method
-     * @throws \InvalidArgumentException
-     */
-    public function setMethod($method) {
-
-        if (!is_string($method)) {
-            throw new \InvalidArgumentException('method must be a string.');
-        }
-
-        $this->method = $method;
-
-    }
-
-    /**
-     * Set the path and pathParts members.
-     *
-     * @param string $path
-     */
-    public function setPath($path) {
-        $this->path = $path;
-        $this->pathParts = explode('/', substr($path, 1));
-    }
-
-    /**
-     * Set the protocol for the request and update the URI.
-     *
-     * @param string $protocol
-     */
-    public function setProtocol($protocol) {
-        $this->protocol = $protocol;
-    }
-
-    /**
      * @param string|array $query
      * @throws \InvalidArgumentException
      */
@@ -347,8 +224,25 @@ class Request {
     }
 
     /**
-     * Set the URI for the Request. This method also sets the path, pathParts,
+     * Return the full URI includeing protocol, hostname, path, and query.
-     * and query.
+     *
+     * @return array
+     */
+    public function getUri() {
+
+        $uri = $this->protocol . '://' . $this->hostname . $this->path;
+
+        if ($this->query) {
+            $uri .= '?' . http_build_query($this->query);
+        }
+
+        return $uri;
+
+    }
+
+    /**
+     * Set the URI for the Request. This sets the other members, such as path,
+     * hostname, etc.
      *
      * @param string $uri
      */

Response.inc.php

@@ -2,6 +2,8 @@
 
 namespace wellrested;
 
+require_once(dirname(__FILE__) . '/Message.inc.php');
+
 /*******************************************************************************
  * Response
  *
@@ -16,19 +18,7 @@ namespace wellrested;
  * @property string body  Entity body of the response
  * @property array headers  Associative array of headers
  */
-class Response {
+class Response extends Message {
-
-    /**
-     * Entity body of the response
-     * @var string
-     */
-    protected $body;
-
-    /**
-     * Associative array of headers
-     * @var array
-     */
-    protected $headers;
 
     /**
      * The protocol. Set this to the protocol you wish to use, such as
@@ -65,39 +55,6 @@ class Response {
     // -------------------------------------------------------------------------
     // !Accessors
 
-    public function __get($name) {
-
-        switch ($name) {
-        case 'body':
-            return $this->getBody();
-        case 'headers':
-            return $this->getHeaders();
-        default:
-            throw new \Exception('Property ' . $name . ' does not exist.');
-        }
-
-    } // __get()
-
-    public function __set($name, $value) {
-
-        switch ($name) {
-        case 'body':
-            $this->setBody($value);
-            break;
-        default:
-            throw new \Exception('Property ' . $name . ' does not exist or is read only.');
-        }
-
-    } // __set()
-
-    public function getBody() {
-        return $this->body;
-    }
-
-    public function getHeaders() {
-        return $this->headers;
-    }
-
     /**
      * Provide a new entity body for the respone.
      * This method also updates the content-length header based on the length
@@ -116,55 +73,6 @@ class Response {
 
     } // setBody()
 
-    /**
-     * Add or update a header to a given value
-     *
-     * @param string $header
-     * @param string $value
-     */
-    public function setHeader($header, $value) {
-        $this->headers[$header] = $value;
-    }
-
-    /**
-     * Return if the response contains a header with the given key.
-     *
-     * @param string $header
-     * @return bool
-     */
-    public function hasHeader($header) {
-        return isset($this->headers[$header]);
-    }
-
-    /**
-     * Return the value of a given header, or false if it does not exist.
-     *
-     * @param string $header
-     * @return string|bool
-     */
-    public function getHeader($header) {
-
-        if ($this->hasHeader($header)) {
-            return $this->headers[$header];
-        }
-
-        return false;
-
-    }
-
-    /**
-     * Remove a header. This method does nothing if the header does not exist.
-     *
-     * @param string $header
-     */
-    public function unsetHeader($header) {
-
-        if ($this->hasHeader($header)) {
-            unset($this->headers[$header]);
-        }
-
-    }
-
     // -------------------------------------------------------------------------
 
     /**