Adding some code documentation and adding in body parsing for the request object

Author: guahanweb

src/GuahanWeb/Http/request.php

@@ -24,6 +24,8 @@ public function __construct() {
     }
 
     public function __get($k) {
+        static $body;
+
         switch ($k) {
             case 'method':
             case 'headers':
@@ -32,6 +34,13 @@ public function __get($k) {
                 return $this->$k;
                 break;
 
+            case 'body':
+                if (is_null($body)) {
+                    $body = $this->parseBody();
+                }
+                return $body;
+                break;
+
             default:
                 return isset($this->params[$k]) ? $this->params[$k] : null;
         }
@@ -51,5 +60,24 @@ protected function getAllHeaders() {
         }
         return $headers;
     }
+
+    protected function parseBody() {
+        // no body allowed for GET or DELETE requests
+        if ($this->method == 'GET' || $this->method == 'DELETE') {
+            return '';
+        }
+
+        // Process POST and PUT appropriately
+        $data = null;
+        if (isset($this->headers['Content-Type']) && $this->headers['Content-Type'] == 'multipart/form-data') {
+            $data = $_POST;
+        } else {
+            // handle raw body, and parse if content-type if application/json
+            $data = file_get_contents('php://input');
+            if (isset($this->headers['Content-Type']) && $this->headers['Content-Type'] == 'application/json') {
+                $data = json_decode(trim($data));
+            }
+        }
+    }
 }
 

src/GuahanWeb/Http/response.php

@@ -4,21 +4,53 @@
 class Response {
     protected $headers;
 
+    /**
+     * Initialize a new response object, defaulting to HTML type
+     *
+     * @constructor
+     */
     public function __construct() {
-        $this->headers = array();
+        $this->headers = array(
+            'content-type' => 'text/html'
+        );
     }
 
+    /**
+     * Set a header to be sent with the response
+     *
+     * @param {string} The header name
+     * @param {string} The header value
+     * @return void
+     */
     public function setHeader($k, $v) {
         $this->headers[$k] = $v;
     }
 
+    /**
+     * Set multiple headers to be sent with the response
+     *
+     * @param {array} A list of headers to be applied
+     * @return void
+     */
     public function setHeaders($headers) {
         foreach ($headers as $k => $v) {
             $this->setHeader($k, $v);
         }
     }
 
+    /**
+     * Send the response to the consumer
+     *
+     * @param {*} $body The content to send. If the content is an array or object, it will be treated as a JSON payload
+     * @return void
+     */
     public function send($body, $code = 200) {
+        // Handle JSON payloads
+        if (is_array($body) || is_object($body)) {
+            $this->setHeader('content-type', 'application/json');
+            $body = json_encode($body);
+        }
+
         foreach ($this->headers as $k => $v) {
             header($k . ': ' . $v);
         }

src/GuahanWeb/Http/router.php

@@ -1,16 +1,18 @@
 <?php
 namespace GuahanWeb\Http;
 
+class RouterException extends \Exception {}
+
 class Router {
     protected $routes;
+    protected $supported_methods;
 
     protected function __construct() {
-        $this->routes = array(
-            'GET' => array(),
-            'POST' => array(),
-            'PUT' => array(),
-            'DELETE' => array()
-        );
+        $this->supported_methods = array('GET', 'POST', 'PUT', 'DELETE');
+        $this->routes = array();
+        foreach ($this->supported_methods as $method) {
+            $this->routes[$method] = array();
+        }
     }
 
     static public function instance() {
@@ -58,10 +60,80 @@ protected function match($method, $uri, &$params = null) {
         return false;
     }
 
+    /**
+     * Registers a new route
+     *
+     * @param {string|array} $method The HTTP method(s) this route supports
+     * @param {string} $route The route pattern to register
+     * @param {function} $handler The handler to execute when route and method matches
+     * @return void
+     */
+    public function route($method, $route, $handler) {
+        if (is_array($method)) {
+            foreach ($method as $m) {
+                $this->route($m, $route, $handler);
+            }
+        } elseif ($method == '*') {
+            foreach ($this->supported_methods as $m) {
+                $this->route($m, $route, $handler);
+            }
+        } elseif (in_array($method, strtoupper($this->supported_methods))) {
+            $this->routes[strtoupper($method)][$route] = $handler;
+        } else {
+            throw new RouterException(sprintf('Unsupported HTTP verb provided for route: %s', $method));
+        }
+    }
+
+    /**
+     * Shorthand to register GET handlers
+     *
+     * @param {string} $route The route pattern to register
+     * @param {function} $handler The handler to execute when route matches
+     * @return void
+     */
     public function get($route, $handler) {
-        $this->routes['GET'][$route] = $handler;
+        $this->route('GET', $route, $handler);
+    }
+
+    /**
+     * Shorthand to register POST handlers
+     *
+     * @param {string} $route The route pattern to register
+     * @param {function} $handler The handler to execute when route matches
+     * @return void
+     */
+    public function post($route, $handler) {
+        $this->route('POST', $route, $handler);
+    }
+
+    /**
+     * Shorthand to register PUT handlers
+     *
+     * @param {string} $route The route pattern to register
+     * @param {function} $handler The handler to execute when route matches
+     * @return void
+     */
+    public function put($route, $handler) {
+        $this->route('PUT', $route, $handler);
+    }
+
+    /**
+     * Shorthand to register DELETE handlers
+     *
+     * @param {string} $route The route pattern to register
+     * @param {function} $handler The handler to execute when route matches
+     * @return void
+     */
+    public function delete($route, $handler) {
+        $this->route('DELETE', $route, $handler);
     }
 
+    /**
+     * Activates the router to begin handling the HTTP request. If no matching routes are found,
+     * we will automatically send a 404.
+     *
+     * @return void
+     */
     public function process() {
         $request = new Request();
         $response = new Response();