]> git.mxchange.org Git - friendica.git/commitdiff
Implement feedback changes to App\Router
authorHypolite Petovan <hypolite@mrpetovan.com>
Thu, 4 Apr 2019 11:29:26 +0000 (07:29 -0400)
committerHypolite Petovan <hypolite@mrpetovan.com>
Thu, 4 Apr 2019 11:29:26 +0000 (07:29 -0400)
- Add class PhpDoc
- Switch Router->routeCollector scope to protected
- Added getter for Router->routeCollector
- Added EOF new line
- Removed unused use statement
- Improved App->collectRoutes PhpDoc

src/App.php
src/App/Router.php

index d5698bdb769cfd9571546e3cec2b844deb394c2e..da9239c685589da597885f9718a28bbff8b2b220 100644 (file)
@@ -1249,7 +1249,7 @@ class App
                        }
 
                        $router = new App\Router();
-                       $this->collectRoutes($router->routeCollector);
+                       $this->collectRoutes($router->getRouteCollector());
 
                        $this->module_class = $router->getModuleClass($this->cmd);
 
@@ -1507,7 +1507,7 @@ class App
        }
 
        /**
-        * @brief Static declaration of Friendica routes.
+        * Static declaration of Friendica routes.
         *
         * Supports:
         * - Route groups
@@ -1518,6 +1518,7 @@ class App
         *
         * Handler must be the name of a class extending Friendica\BaseModule.
         *
+        * @brief Static declaration of Friendica routes.
         * @param RouteCollector $routeCollector
         * @throws InternalServerErrorException
         */
index 1281001a3b3aeeff95b9b59ca10fd6524b837c86..7753b6bbb9277be4a12229510b071ae1ac9384e0 100644 (file)
@@ -7,12 +7,21 @@ use FastRoute\DataGenerator\GroupCountBased;
 use FastRoute\Dispatcher;\r
 use FastRoute\RouteCollector;\r
 use FastRoute\RouteParser\Std;\r
-use Friendica\Module\Itemsource;\r
 \r
+/**\r
+ * Wrapper for FastRoute\Router\r
+ *\r
+ * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant\r
+ * module class.\r
+ *\r
+ * Actual routes are defined in App->collectRoutes.\r
+ *\r
+ * @package Friendica\App\r
+ */\r
 class Router\r
 {\r
        /** @var RouteCollector */\r
-       public $routeCollector;\r
+       protected $routeCollector;\r
 \r
        public function __construct(RouteCollector $routeCollector = null)\r
        {\r
@@ -23,6 +32,11 @@ class Router
                $this->routeCollector = $routeCollector;\r
        }\r
 \r
+       public function getRouteCollector()\r
+       {\r
+               return $this->routeCollector;\r
+       }\r
+\r
        public function getModuleClass($cmd)\r
        {\r
                $cmd = '/' . ltrim($cmd, '/');\r
@@ -40,4 +54,4 @@ class Router
 \r
                return $moduleClass;\r
        }\r
-}
\ No newline at end of file
+}\r