Release version 1.1.0

 - Request supports body params
 - Optimize Controller with supporting routes

Author: yidas

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nick Tsai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -58,10 +58,16 @@ public function update($resourceID, $requestData=null) {
 
     $this->db->where('id', $resourceID)
         ->update('table', $requestData);
-    return $this->json(null, true);
+    return $this->json(false, true);
 }
 ```
 
+Output:
+
+```json
+{"code":200}
+```
+
 ---
 
 REQUIREMENTS
@@ -122,20 +128,21 @@ The base RESTful API controller is `yidas\rest\Controller`, the following table
 |GET        |/photos/{photo}|show     |Retrieve an addressed member of the collection.|
 |PUT/PATCH  |/photos/{photo}|update   |Update the addressed member of the collection. |
 |DELETE     |/photos/{photo}|delete   |Delete the addressed member of the collection. |
-|DELETE     |/photos        |deleteAll|Delete the entire collection.                  |
+|DELETE     |/photos        |delete   |Delete the entire collection.                  |
 
 
 ### Overrided Methods:
 
+You could make a resource controller by referring the [Template of Resource Controller](https://github.com/yidas/codeigniter-rest/blob/dev/examples/RestController.php).
+
 The following methods with arguments could be overrided when you need to defind response and open it:
 
 ```php
 public function index() {}
-public function store($requestData=null) {}
-public function show($resourceID) {}
-public function update($resourceID, $requestData=null) {}
-public function delete($resourceID) {}
-public function deleteAll() {}
+protected function store($requestData=null) {}
+protected function show($resourceID) {}
+protected function update($resourceID, $requestData=null) {}
+protected function delete($resourceID=null) {}
 ```
 
 > `$requestData` is the raw body from request

composer.json

@@ -4,7 +4,7 @@
     "keywords": ["codeIgniter", "api", "controller", "authorization"],
     "homepage": "https://github.com/yidas/codeigniter-api-controller",
     "type": "library",
-    "license": "BSD-3-Clause",
+    "license": "MIT",
     "support": {
         "issues": "https://github.com/yidas/codeigniter-api-controller/issues",
         "source": "https://github.com/yidas/codeigniter-api-controller"

examples/RestController.php

@@ -0,0 +1,40 @@
+<?php
+
+class RestController extends \yidas\rest\Controller
+{
+    /**
+     * Action: Index
+     * 
+     * This method could be `public` property for none-routes usage
+     */
+    public function index() {}
+        
+    /**
+     * Action: Store
+     * 
+     * @param array $requestData
+     */
+    protected function store($requestData=null) {}
+
+    /**
+     * Action: Show
+     * 
+     * @param int|string $resourceID
+     */
+    protected function show($resourceID) {}
+
+    /**
+     * Action: Update
+     * 
+     * @param int|string $resourceID
+     * @param array $requestData
+     */
+    protected function update($resourceID, $requestData=null) {}
+
+    /**
+     * Action: Delete
+     * 
+     * @param int|string $resourceID
+     */
+    protected function delete($resourceID) {}    
+}

src/http/Request.php

@@ -6,7 +6,7 @@
  * Request Component
  * 
  * @author  Nick Tsai <myintaer@gmail.com>
- * @since   0.1.0
+ * @since   1.1.0
  * @todo    Psr\Http\Message\RequestInterface
  */
 class Request
@@ -44,12 +44,29 @@ public function getRawBody()
         return $this->_rawBody;
     }
 
+    /**
+     * Returns the request parameters given in the request body.
+     *
+     * Request parameters are determined using the parsers configured in [[parsers]] property.
+     * If no parsers are configured for the current [[contentType]] it uses the PHP function `mb_parse_str()`
+     * to parse the [[rawBody|request body]].
+     * 
+     * @todo   Cache
+     * @return array the request parameters given in the request body.
+     */
+    public function getBodyParams()
+    {
+        mb_parse_str($this->getRawBody(), $bodyParams);
+
+        return $bodyParams;
+    }
+
     /**
      * Alias of getRawBody()
      */
     public function input()
     {
-        return $this->getRawBody();
+        return $this->getBodyParams();
     }
 
     /**

src/rest/Controller.php

@@ -9,7 +9,9 @@
  * RESTful API Controller
  * 
  * @author  Nick Tsai <myintaer@gmail.com>
- * @version 1.0.1
+ * @version 1.1.0
+ * @link    https://github.com/yidas/codeigniter-rest/
+ * @see     https://github.com/yidas/codeigniter-rest/blob/master/examples/RestController.php
  * 
  * Controller extending:
  * ```php
@@ -24,11 +26,6 @@
  */
 class Controller extends \CI_Controller
 {
-    /**
-     * @var bool Close the default actions without implement
-     */
-    const CLOSE_DEFAULT_ACTIONS = true;
-
     /**
      * @var array Standard format
      */
@@ -39,10 +36,38 @@ class Controller extends \CI_Controller
     ];
 
     /**
+     * RESTful API resource routes
+     * 
+     * public function index() {}
+     * protected function store($requestData=null) {}
+     * protected function show($resourceID) {}
+     * protected function update($resourceID, $requestData=null) {}
+     * protected function delete($resourceID=null) {}
+     * 
+     * @var array RESTful API table of routes & actions
+     */
+    protected $routes = [
+        'index' => 'index',
+        'store' => 'store',
+        'show' => 'show',
+        'update' => 'update',
+        'delete' => 'delete',
+    ];
+
+    /**
+     * Pre-setting format
+     * 
      * @var string yidas\http\Response format
      */
     protected $format;
 
+    /**
+     * Body Format usage switch
+     * 
+     * @var bool Default $bodyFormat for json()
+     */
+    protected $bodyFormat = false;
+
     /**
      * @var object yidas\http\Request;
      */
@@ -81,33 +106,41 @@ public function route($resourceID=NULL)
         switch ($this->request->getMethod()) {
             case 'POST':
                 if (!$resourceID) {
-                    $this->store($this->request->getRawBody());
+                    return $this->_action(['delete', $this->request->getBodyParams()]);
                 }
                 break;
             case 'PUT':
             case 'PATCH':
                 if ($resourceID) {
-                    $this->update($this->request->getRawBody(), $resourceID);
+                    return $this->_action(['update', $resourceID, $this->request->getBodyParams()]);
                 }
                 break;
             case 'DELETE':
                 if ($resourceID) {
-                    $this->delete($resourceID);
+                    return $this->_action(['delete', $resourceID]);
                 } else {
-                    $this->deleteAll();
+                    return $this->_action(['delete']);
                 }
                 break;
             case 'GET':
             default:
                 if ($resourceID) {
-                    $this->show($resourceID);
+                    return $this->_action(['show', $resourceID]);
                 } else {
-                    $this->index();
+                    return $this->_action(['index']);
                 }
                 break;
         }
     }
 
+    /**
+     * Alias of route()
+     */
+    public function ajax($resourceID=NULL)
+    {
+        return $this->route($resourceID);
+    }
+
     /**
      * Output by JSON format with optinal body format
      * 
@@ -117,13 +150,16 @@ public function route($resourceID=NULL)
      * @param string Callback status text
      * @return string Response body data
      */
-    protected function json($data, $bodyFormat=false, $statusCode=null, $statusText=null)
+    protected function json($data, $bodyFormat=null, $statusCode=null, $statusText=null)
     {
         $this->response->setFormat(Response::FORMAT_JSON);
+
+        // Check default Body Format setting if not assigning
+        $bodyFormat = ($bodyFormat!==null) ? $bodyFormat : $this->bodyFormat;
 
         if ($bodyFormat) {
             // Pack data
-            $data = $this->format($statusCode, $statusText, $data);
+            $data = $this->_format($statusCode, $statusText, $data);
         }
 
         return $this->response
@@ -139,7 +175,7 @@ protected function json($data, $bodyFormat=false, $statusCode=null, $statusText=
      * @param array|mixed|bool Callback data body, false will remove body key 
      * @return array Formated array data
      */
-    protected function format($statusCode=null, $statusText=null, $body=false)
+    protected function _format($statusCode=null, $statusText=null, $body=false)
     {
         $format = [];
         // Status Code
@@ -160,72 +196,37 @@ protected function format($statusCode=null, $statusText=null, $body=false)
     /**
      * Default Action
      */
-    private function _defaultAction()
+    protected function _defaultAction()
     {
         /* Response sample code */
         // $response->data = ['foo'=>'bar'];
 		// $response->setStatusCode(401);
 
-        if (static::CLOSE_DEFAULT_ACTIONS) {
-            // Codeigniter 404 Error Handling
-            show_404();
-        }
+        // Codeigniter 404 Error Handling
+        show_404();
     }
 
     /**
-     * Action: Index
-     */
-    public function index()
-    {
-        $this->_defaultAction();
-    }
-
-    /**
-     * Action: Store
+     * Action processor for route
      * 
-     * @param array $requestData
+     * @param array Elements contains method for first and params for others 
      */
-    public function store($requestData=null)
+    private function _action($params)
     {
-        $this->_defaultAction();
-    }
+        // Shift and get the method
+        $method = array_shift($params);
 
-    /**
-     * Action: Show
-     * 
-     * @param int|string $resourceID
-     */
-    public function show($resourceID)
-    {
-        $this->_defaultAction();
-    }
+        if (!isset($this->routes[$method])) {
+            $this->_defaultAction();
+        }
 
-    /**
-     * Action: Update
-     * 
-     * @param int|string $resourceID
-     * @param array $requestData
-     */
-    public function update($resourceID, $requestData=null)
-    {
-        $this->_defaultAction();
-    }
+        // Get corresponding method name
+        $method = $this->routes[$method];
 
-    /**
-     * Action: Delete
-     * 
-     * @param int|string $resourceID
-     */
-    public function delete($resourceID)
-    {
-        $this->_defaultAction();
-    }
+        if (!method_exists($this, $method)) {
+            $this->_defaultAction();
+        }
 
-    /**
-     * Action: Delete All
-     */
-    public function deleteAll()
-    {
-        $this->_defaultAction();
+        return call_user_func_array([$this, $method], $params);
     }
 }