Merge pull request #5889 from kenjis/feat-new-auto-router

feat: new improved auto router
codeigniter4 · May 3, 2022 · ab63c8d · ab63c8d
2 parents cdf427f + 2fe5107
commit ab63c8d
Show file tree

Hide file tree

Showing 23 changed files with 1,233 additions and 76 deletions.
diff --git a/app/Config/Feature.php b/app/Config/Feature.php
@@ -10,7 +10,7 @@
 class Feature extends BaseConfig
 {
     /**
-     * Enable multiple filters for a route or not
+     * Enable multiple filters for a route or not.
      *
      * If you enable this:
      *   - CodeIgniter\CodeIgniter::handleRequest() uses:
@@ -24,4 +24,9 @@ class Feature extends BaseConfig
      * @var bool
      */
     public $multipleFilters = false;
+
+    /**
+     * Use improved new auto routing instead of the default legacy version.
+     */
+    public bool $autoRoutesImproved = false;
 }
diff --git a/phpstan-baseline.neon.dist b/phpstan-baseline.neon.dist
@@ -677,7 +677,7 @@ parameters:
 
 		-
 			message: "#^Call to an undefined method CodeIgniter\\\\Router\\\\RouteCollectionInterface\\:\\:getDefaultNamespace\\(\\)\\.$#"
-			count: 2
+			count: 3
 			path: system/Router/Router.php
 
 		-
@@ -706,8 +706,8 @@ parameters:
 			path: system/Router/Router.php
 
 		-
-			message: "#^Call to an undefined method CodeIgniter\\\\Router\\\\RouteCollectionInterface\\:\\:getRegisteredControllers\\(\\)\\.$#"
-			count: 1
+			message: "#^Call to an undefined method CodeIgniter\\\\Router\\\\RouteCollectionInterface\\:\\:getRegisteredControllers\\(.*\\)\\.$#"
+			count: 2
 			path: system/Router/Router.php
 
 		-

diff --git a/system/Router/AutoRouter.php b/system/Router/AutoRouter.php
@@ -16,44 +16,46 @@
 /**
  * Router for Auto-Routing
  */
-class AutoRouter
+final class AutoRouter implements AutoRouterInterface
 {
     /**
      * List of controllers registered for the CLI verb that should not be accessed in the web.
+     *
+     * @var class-string[]
      */
-    protected array $protectedControllers;
+    private array $protectedControllers;
 
     /**
      * Sub-directory that contains the requested controller class.
      * Primarily used by 'autoRoute'.
      */
-    protected ?string $directory = null;
+    private ?string $directory = null;
 
     /**
      * The name of the controller class.
      */
-    protected string $controller;
+    private string $controller;
 
     /**
      * The name of the method to use.
      */
-    protected string $method;
+    private string $method;
 
     /**
      * Whether dashes in URI's should be converted
      * to underscores when determining method names.
      */
-    protected bool $translateURIDashes;
+    private bool $translateURIDashes;
 
     /**
      * HTTP verb for the request.
      */
-    protected string $httpVerb;
+    private string $httpVerb;
 
     /**
      * Default namespace for controllers.
      */
-    protected string $defaultNamespace;
+    private string $defaultNamespace;
 
     public function __construct(
         array $protectedControllers,
@@ -164,6 +166,8 @@ public function getRoute(string $uri): array
     /**
      * Tells the system whether we should translate URI dashes or not
      * in the URI from a dash to an underscore.
+     *
+     * @deprecated This method should be removed.
      */
     public function setTranslateURIDashes(bool $val = false): self
     {
@@ -179,7 +183,7 @@ public function setTranslateURIDashes(bool $val = false): self
      *
      * @return array returns an array of remaining uri segments that don't map onto a directory
      */
-    protected function scanControllers(array $segments): array
+    private function scanControllers(array $segments): array
     {
         $segments = array_filter($segments, static fn ($segment) => $segment !== '');
         // numerically reindex the array, removing gaps
@@ -234,6 +238,8 @@ private function isValidSegment(string $segment): bool
      * Sets the sub-directory that the controller is in.
      *
      * @param bool $validate if true, checks to make sure $dir consists of only PSR4 compliant segments
+     *
+     * @deprecated This method should be removed.
      */
     public function setDirectory(?string $dir = null, bool $append = false, bool $validate = true)
     {
@@ -263,6 +269,8 @@ public function setDirectory(?string $dir = null, bool $append = false, bool $va
     /**
      * Returns the name of the sub-directory the controller is in,
      * if any. Relative to APPPATH.'Controllers'.
+     *
+     * @deprecated This method should be removed.
      */
     public function directory(): string
     {