add new method rest() for quick registration RESTful resources routes

Author: inhere

examples/Controllers/RestController.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: inhere
+ * Date: 2017-12-04
+ * Time: 14:58
+ */
+
+namespace Inhere\Route\Examples\Controllers;
+
+/**
+ * Class RestController
+ * @package Inhere\Route\Examples\Controllers
+ */
+class RestController
+{
+    public function indexAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+
+    public function viewAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+
+    public function createAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+
+    public function updateAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+
+    public function patchAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+
+    public function deleteAction()
+    {
+        echo __METHOD__ . PHP_EOL;
+    }
+}

examples/cached.php

@@ -13,6 +13,7 @@
 
 use Inhere\Route\Dispatcher;
 use Inhere\Route\CachedRouter;
+use Inhere\Route\Examples\Controllers\RestController;
 
 require __DIR__ . '/simple-loader.php';
 
@@ -48,6 +49,7 @@ function dump_routes() {
 }
 
 $router->get('/routes', 'dump_routes');
+$router->rest('/rest', RestController::class);
 
 /** @var array $routes */
 $routes = require __DIR__ . '/some-routes.php';

examples/object.php

@@ -12,6 +12,7 @@
  */
 
 use Inhere\Route\Dispatcher;
+use Inhere\Route\Examples\Controllers\RestController;
 use Inhere\Route\ORouter;
 
 require __DIR__ . '/simple-loader.php';
@@ -35,7 +36,9 @@
     'controllerSuffix' => 'Controller',
 ]);
 
-$router->get('/routes', function() use($router) {
+$router->get('/routes', function() {
+    global $router;
+
     echo "<h1>All Routes.</h1><pre><h2>StaticRoutes:</h2>\n";
     print_r($router->getStaticRoutes());
     echo "<h2>RegularRoutes:</h2>\n";
@@ -64,6 +67,8 @@
     $router->map($route[0], $route[1], $route[2], isset($route[3]) ? $route[3] : []);
 }
 
+$router->rest('/rest', RestController::class);
+
 $router->any('*', function () {
     echo "This is fallback handler\n";
 });

src/AbstractRouter.php

@@ -253,14 +253,14 @@ public function parseParamRoute($route, array $params, array $conf)
     /**
      * handle auto route match, when config `'autoRoute' => true`
      * @param string $path The route path
-     * @param string $controllerNamespace controller namespace. eg: 'app\\controllers'
-     * @param string $controllerSuffix controller suffix. eg: 'Controller'
+     * @internal string $cnp controller namespace. eg: 'app\\controllers'
+     * @internal string $sfx controller suffix. eg: 'Controller'
      * @return bool|callable
      */
-    public function matchAutoRoute($path, $controllerNamespace, $controllerSuffix = '')
+    public function matchAutoRoute($path)
     {
-        $cnp = trim($controllerNamespace);
-        $sfx = trim($controllerSuffix);
+        $cnp = trim($this->config['controllerNamespace']);
+        $sfx = trim($this->config['controllerSuffix']);
         $tmp = trim($path, '/- ');
 
         // one node. eg: 'home'

src/ORouter.php

@@ -300,7 +300,6 @@ public function map($methods, $route, $handler, array $opts = [])
         }
 
         $params = $this->getAvailableParams(isset($opts['params']) ? $opts['params'] : []);
-
         list($first, $conf) = $this->parseParamRoute($route, $params, $conf);
 
         // route string have regular
@@ -316,6 +315,56 @@ public function map($methods, $route, $handler, array $opts = [])
         return $this;
     }
 
+    /**
+     * register a group restful routes for the controller class.
+     * ```php
+     * $router->rest('/users', UserController::class);
+     * ```
+     * @param string $prefix eg '/users'
+     * @param string $controllerClass
+     * @param array $map You can append or change default map list.
+     * [
+     *      'index' => null, // set value is empty to delete.
+     *      'list' => 'get', // add new route
+     * ]
+     * @param array $opts Common options
+     * @return ORouter
+     */
+    public function rest($prefix, $controllerClass, array $map = [], array $opts = [])
+    {
+        $map = array_merge([
+            'index' => ['GET'],
+            'create' => ['POST'],
+            'view' => ['GET', '{id}', ['id' => '[1-9]\d*']],
+            'update' => ['PUT', '{id}', ['id' => '[1-9]\d*']],
+            'patch' => ['PATCH', '{id}', ['id' => '[1-9]\d*']],
+            'delete' => ['DELETE', '{id}', ['id' => '[1-9]\d*']],
+        ], $map);
+        //$opts = array_merge([], $opts);
+
+        foreach ($map as $action => $conf) {
+            if (!$conf || !$action) {
+                continue;
+            }
+
+            $route = $prefix;
+
+            // '/users/{id}'
+            if (isset($conf[1]) && ($subPath = trim($conf[1]))) {
+                // allow define a abs route. '/user-other-info'. it's not prepend prefix.
+                $route = $subPath[0] === '/' ? $subPath : $prefix . '/' . $subPath;
+            }
+
+            if (isset($conf[2])) {
+                $opts['params'] = $conf[2];
+            }
+
+            $this->map($conf[0], $route, $controllerClass . '@' . $action, $opts);
+        }
+
+        return $this;
+    }
+
     /*******************************************************************************
      * route match
      ******************************************************************************/
@@ -379,10 +428,7 @@ public function match($path, $method = 'GET')
         }
 
         // handle Auto Route
-        if (
-            $this->config['autoRoute'] &&
-            ($handler = $this->matchAutoRoute($path, $this->config['controllerNamespace'], $this->config['controllerSuffix']))
-        ) {
+        if ($this->config['autoRoute'] && ($handler = $this->matchAutoRoute($path))) {
             return [self::FOUND, $path, [
                 'handler' => $handler,
                 'option' => [],

src/RouterInterface.php

@@ -14,15 +14,15 @@
  */
 interface RouterInterface
 {
-    // match result status
+    /** match result status list */
     const FOUND = 1;
     const NOT_FOUND = 2;
     const METHOD_NOT_ALLOWED = 3;
 
     const FAV_ICON = '/favicon.ico';
     const DEFAULT_REGEX = '[^/]+';
 
-    // supported method list
+    /** supported method list */
     const ANY = 'ANY';
 
     const GET = 'GET';
@@ -32,22 +32,25 @@ interface RouterInterface
     const DELETE = 'DELETE';
     const OPTIONS = 'OPTIONS';
     const HEAD = 'HEAD';
+
+    const COPY = 'COPY';
+    const PURGE = 'PURGE';
+    const LINK = 'LINK';
+    const UNLINK = 'UNLINK';
+    const LOCK = 'LOCK';
+    const UNLOCK = 'UNLOCK';
     const SEARCH = 'SEARCH';
     const CONNECT = 'CONNECT';
     const TRACE = 'TRACE';
 
-    /**
-     * supported methods
-     * @var array
-     */
+    /** @var array supported methods */
     const SUPPORTED_METHODS = [
         'ANY',
-        'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD', 'SEARCH', 'CONNECT', 'TRACE',
+        'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD',
+        'COPY', 'PURGE', 'LINK', 'UNLINK', 'LOCK', 'UNLOCK', 'VIEW', 'SEARCH', 'CONNECT', 'TRACE',
     ];
 
-    /**
-     * the matched result index key
-     */
+    /** the matched result index key */
     const INDEX_STATUS = 0;
     const INDEX_PATH = 1;
     const INDEX_INFO = 2;