Merge pull request #3 from cherry-framework/develope

Develope

Author: ABGEO

CHANGELOG.md

@@ -1,6 +1,20 @@
 # Cherry-router 
 
-## [v1.0.1](https://github.com/ABGEO07/cherry-router/releases/tag/v1.0.1 "v1.0.1") (2019-03-29)
+## [v1.1.0](https://github.com/cherry-framework/router/releases/tag/v1.1.0 "v1.1.0") (2019-04-05)
+
+- Remove namespace part form route action. Now you can use this syntax:
+
+    ```json
+    {
+      ...
+      "action": "DefaultController::index",
+      ...
+    }
+    ```
+
+- Lock Cherry Request dependency to 1.0.x version.
+
+## [v1.0.1](https://github.com/cherry-framework/router/releases/tag/v1.0.1 "v1.0.1") (2019-03-29)
 
 - Change Namespace
 
@@ -15,10 +29,10 @@
 - Use call_user_func_array function in method calling 
 
 
-## [v1.0.0](https://github.com/ABGEO07/cherry-router/releases/tag/v1.0.0 "v1.0.0") (2019-03-07)
+## [v1.0.0](https://github.com/cherry-framework/router/releases/tag/v1.0.0 "v1.0.0") (2019-03-07)
 #### The first stable version
 
-- Package available on: `composer require cherry-project/router`;
+- Package available on: `composer require cherry-framework/router`;
 - Router path has placeholder support;
 - Router has all HTTP Methods support;
-- Router has caching feature;
+- Router has caching feature;

README.md

@@ -60,7 +60,7 @@ Each route must have **path**, **method** and **action** keys. Homepage route ex
   "homepage": {
       "path": "/",
       "method": "GET",
-      "action": "Cherry\\Controller\\DefaultController::index"
+      "action": "DefaultController::index"
   }
 }
 ```
@@ -71,7 +71,7 @@ Each route must have **path**, **method** and **action** keys. Homepage route ex
     "[RouteName]": {
         "path": "[URL]",
         "method": "[HTTP_Method]",
-        "action": "[Namespace]\\[Controller]::[Method]"
+        "action": "[Controller]::[Method]"
     }
 }
 ```
@@ -81,8 +81,8 @@ Definitions for router keys:
 - **path** - Route url. (Ex.: For address http://www.example.com/homepage [URL] is *homepage*);
 - **method** - Route HTTP Method. Allowed all [HTTP methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods "HTTP methods");
 - **action** - Route callback action. The firs part of action (before *::*) is your controller (stored in **CONTROLLERS_PATH**).
-Controller is a simple [PHP Class](http://php.net/manual/en/language.oop5.php "PHP Class") where [Namespace] is his Namespace and 
-[Controller] Class name (Class name and class filename must have same names (Ex.: **[Controller].php**)).
+Controller is a simple [PHP Class](http://php.net/manual/en/language.oop5.php "PHP Class") where
+[Controller] is Class name (Class name and class filename must have same names (Ex.: **[Controller].php**)).
 The second part of action key (after ::) is controllers (class) public method;
 
 Your route path can use **Placeholders**. Placeholder is a template of your route.
@@ -93,7 +93,7 @@ Route example with placeholder:
     "homepage": {
         "path": "/hello/{name}",
         "method": "GET",
-        "action": "Cherry\\Controller\\DefaultController::sayHello"
+        "action": "DefaultController::sayHello"
     }
 }
 ```

composer.json

@@ -3,7 +3,7 @@
     "description": "Cherry-project Router",
     "type": "library",
     "keywords": ["cherry","router"],
-    "homepage": "https://github.com/ABGEO07/cherry-router",
+    "homepage": "https://github.com/cherry-framework/router",
     "license": "MIT",
     "authors": [
         {
@@ -16,7 +16,7 @@
     "minimum-stability": "dev",
     "require": {
         "php": ">=5.6.0",
-        "cherry-project/request": "v1.0.1",
+        "cherry-project/request": "1.0.1",
         "ext-json": "*"
     },
     "autoload": {

composer.lock

@@ -2,6 +2,6 @@
   "homepage": {
     "path": "/",
     "method": "GET",
-    "action": "Cherry\\Controller\\DefaultController::index"
+    "action": "DefaultController::index"
   }
-}
+}

examples/config/routes.json

@@ -7,8 +7,8 @@
  * @category Library
  * @package  Cherry
  * @author   Temuri Takalandze <[email protected]>
- * @license  https://github.com/ABGEO07/cherry-router/blob/master/LICENSE MIT
- * @link     https://github.com/ABGEO07/cherry-router
+ * @license  https://github.com/cherry-framework/router/blob/master/LICENSE MIT
+ * @link     https://github.com/cherry-framework/router
  */
 
 namespace Cherry\Routing;
@@ -21,27 +21,34 @@
  * @category Library
  * @package  Cherry
  * @author   Temuri Takalandze <[email protected]>
- * @license  https://github.com/ABGEO07/cherry-router/blob/master/LICENSE MIT
- * @link     https://github.com/ABGEO07/cherry-router
+ * @license  https://github.com/cherry-framework/router/blob/master/LICENSE MIT
+ * @link     https://github.com/cherry-framework/router
  */
 class Router
 {
     /**
-     * Path to routes file
+     * Path to routes file.
      *
      * @var string
      */
     private $_routesFile;
 
     /**
-     * Path to controllers folder
+     * Path to controllers folder.
      *
      * @var string
      */
     private $_controllersPath;
 
     /**
-     * Application routes
+     * Cherry Controller default namespace.
+     *
+     * @var string
+     */
+    private $_ControllerNamespace = "Cherry\\Controller";
+
+    /**
+     * Application routes.
      *
      * @var array
      */
@@ -60,7 +67,7 @@ public function __construct()
     }
 
     /**
-     * Get routes from routes file
+     * Get routes from routes file.
      *
      * @return array Application routes
      */
@@ -91,7 +98,7 @@ private function _getRoutes()
     }
 
     /**
-     * Check if current request url math with
+     * Check if current request url math with any route.
      *
      * @return void
      */
@@ -122,7 +129,9 @@ private function _checkRoute()
                 $routeFound = true;
                 unset($match[0]);
 
-                $action = explode('::', $route['action']);
+                $routeAction = $this->_ControllerNamespace.'\\'.$route['action'];
+
+                $action = explode('::', $routeAction);
                 $controller = explode('\\', $action[0]);
                 $controllerFile = $controllersPath . '/' .
                     $controller[count($controller) - 1] . '.php';
@@ -160,10 +169,10 @@ private function _checkRoute()
     }
 
     /**
-     * Cache the routes
+     * Cache the routes.
      *
      * @param string $routesCacheFile Cache file location.
-     * @param array  $routes          Application routes
+     * @param array  $routes          Application routes.
      *
      * @return void
      */
@@ -182,11 +191,11 @@ private function _cacheRoutes($routesCacheFile, $routes)
     }
 
     /**
-     * Convert route to regular expression
+     * Convert route to regular expression.
      *
-     * @param string $plainText Router template for converting
+     * @param string $plainText Router template for converting.
      *
-     * @return string converted to Regular Expression route
+     * @return string converted to Regular Expression route.
      */
     private function _convertToRE($plainText)
     {
@@ -206,4 +215,4 @@ private function _convertToRE($plainText)
 
         return "@^{$plainText}$@D";
     }
-}
+}