RouteCollection revised to use new centralized auto-discovery mechanism.

Author: lonnieezell

application/Config/Modules.php

@@ -3,6 +3,17 @@
 // Cannot extend BaseConfig or looping resources occurs.
 class Modules
 {
+	/*
+	 |--------------------------------------------------------------------------
+	 | Auto-Discovery Enabled?
+	 |--------------------------------------------------------------------------
+	 |
+	 | If true, then auto-discovery will happen across all elements listed in
+	 | $activeExplorers below. If false, no auto-discovery will happen at all,
+	 | giving a slight performance boost.
+	 */
+	public $enabled = true;
+
 	/*
 	|--------------------------------------------------------------------------
 	| Auto-discover Rules
@@ -12,9 +23,8 @@ class Modules
 	| and used during the current application request. If it is not
 	| listed here, only the base application elements will be used.
 	*/
-	public $enabled = [
+	public $activeExplorers = [
 		'events',
-		'helpers',
 		'registrars',
 		'routes',
 		'services',
@@ -39,7 +49,6 @@ class Modules
 	 *
 	 * Valid values are:
 	 *  - events
-	 *  - helpers
 	 *  - registrars
 	 *  - routes
 	 *  - services
@@ -51,8 +60,10 @@ class Modules
 	 */
 	public function shouldDiscover(string $alias)
 	{
+		if (! $this->enabled) return false;
+
 		$alias = strtolower($alias);
 
-		return in_array($alias, $this->enabled);
+		return in_array($alias, $this->activeExplorers);
 	}
 }

application/Config/Routes.php

@@ -64,7 +64,6 @@
 $routes->setTranslateURIDashes(false);
 $routes->set404Override();
 $routes->setAutoRoute(true);
-$routes->discoverLocal(false);
 
 /**
  * --------------------------------------------------------------------

system/Config/Services.php

@@ -598,7 +598,7 @@ public static function routes($getShared = true)
 			return self::getSharedInstance('routes');
 		}
 
-		return new \CodeIgniter\Router\RouteCollection(self::locator());
+		return new \CodeIgniter\Router\RouteCollection(self::locator(), config('Modules'));
 	}
 
 	//--------------------------------------------------------------------

system/Router/RouteCollection.php

@@ -188,34 +188,37 @@ class RouteCollection implements RouteCollectionInterface
 	protected $currentOptions = null;
 
 	/**
-	 * Determines whether locally specified, PSR4
-	 * compatible code is automatically scanned
-	 * for addition routes in a {namespace}/Config/Routes.php file.
-	 *
+	 * A little performance booster.
 	 * @var bool
 	 */
-	protected $discoverLocal = false;
+	protected $didDiscover = false;
 
 	/**
-	 * A little performance booster.
-	 * @var bool
+	 * @var \CodeIgniter\Autoloader\FileLocator
 	 */
-	protected $didDiscover = false;
 	protected $fileLocator;
 
+	/**
+	 * @var \Config\Modules
+	 */
+	protected $moduleConfig;
+
 	//--------------------------------------------------------------------
 
 	/**
 	 * Constructor
 	 *
-	 * @param FileLocator $locator
+	 * @param FileLocator    $locator
+	 * @param Config/Modules $moduleConfig
 	 */
-	public function __construct(FileLocator $locator)
+	public function __construct(FileLocator $locator, $moduleConfig)
 	{
 		// Get HTTP verb
 		$this->HTTPVerb = strtolower($_SERVER['REQUEST_METHOD'] ?? 'cli');
 
 		$this->fileLocator = $locator;
+
+		$this->moduleConfig = $moduleConfig;
 	}
 
 	//--------------------------------------------------------------------
@@ -373,33 +376,14 @@ public function get404Override()
 
 	//--------------------------------------------------------------------
 
-	/**
-	 * If true, will attempt to auto-discover new route files
-	 * based on any PSR4 namespaces that have been set
-	 * in Config/Autoload.php.
-	 *
-	 * @param bool $discover
-	 *
-	 * @return $this
-	 */
-	public function discoverLocal(bool $discover)
-	{
-		$this->discoverLocal = $discover;
-
-		return $this;
-	}
-
-	//--------------------------------------------------------------------
-
 	/**
 	 * Will attempt to discover any additional routes, either through
 	 * the local PSR4 namespaces, or through selected Composer packages.
 	 * (Composer coming soon...)
 	 */
 	protected function discoverRoutes()
 	{
-		if ($this->didDiscover)
-			return;
+		if ($this->didDiscover) return;
 
 		// We need this var in local scope
 		// so route files can access it.
@@ -408,7 +392,7 @@ protected function discoverRoutes()
 		/*
 		 * Discover Local Files
 		 */
-		if ($this->discoverLocal === true)
+		if ($this->moduleConfig->shouldDiscover('routes'))
 		{
 			$files = $this->fileLocator->search('Config/Routes.php');
 

tests/system/Router/RouteCollectionTest.php

@@ -14,7 +14,7 @@ public function tearDown()
 
 	//--------------------------------------------------------------------
 
-	protected function getCollector(array $config=[], array $files=[])
+	protected function getCollector(array $config=[], array $files=[], $moduleConfig = null)
 	{
 		$defaults = [
 			'Config'        => APPPATH.'Config',
@@ -28,7 +28,13 @@ protected function getCollector(array $config=[], array $files=[])
 		$loader = new MockFileLocator($autoload);
 		$loader->setFiles($files);
 
-		return new RouteCollection($loader);
+		if ($moduleConfig === null)
+		{
+			$moduleConfig = new \Config\Modules();
+			$moduleConfig->enabled = false;
+		}
+
+		return new RouteCollection($loader, $moduleConfig);
 	}
 
 	public function testBasicAdd()
@@ -772,8 +778,10 @@ public function testWillDiscoverLocal()
 			'SampleSpace' => TESTPATH .'_support'
 		];
 
-		$routes = $this->getCollector($config);
-		$routes->discoverLocal(true);
+		$moduleConfig = new \Config\Modules();
+		$moduleConfig->enabled = true;
+
+		$routes = $this->getCollector($config, [], $moduleConfig);
 
 		$match = $routes->getRoutes();
 
@@ -789,8 +797,10 @@ public function testDiscoverLocalAllowsConfigToOverridePackages()
 			'SampleSpace' => TESTPATH .'_support'
 		];
 
-		$routes = $this->getCollector($config);
-		$routes->discoverLocal(true);
+		$moduleConfig = new \Config\Modules();
+		$moduleConfig->enabled = true;
+
+		$routes = $this->getCollector($config, [], $moduleConfig);
 
 		$routes->add('testing', 'MainRoutes::index');
 

tests/system/Router/RouterTest.php

@@ -20,7 +20,9 @@ public function setUp()
 	{
 		parent::setUp();
 
-		$this->collection = new RouteCollection(new MockFileLocator(new \Config\Autoload()));
+		$moduleConfig = new \Config\Modules;
+		$moduleConfig->enabled = false;
+		$this->collection = new RouteCollection(new MockFileLocator(new \Config\Autoload()), $moduleConfig);
 
 		$routes = [
 			'users'                        => 'Users::index',

user_guide_src/source/general/routing.rst

@@ -540,13 +540,3 @@ a valid class/method pair, just like you would show in any route, or a Closure::
     {
         echo view('my_errors/not_found.html');
     });
-
-Discovering Module Routes
--------------------------
-
-If you are using :doc:`modular code </general/modules>`, then this setting will specify whether or not additional
-Routes files should be scanned for within each of the PSR4 namespaces defined in **/application/Config/Autoload.php**.
-
-::
-
-    $routes->discoverLocal(false);