Merge pull request #6073 from pjsde/refactor_router_locale_pattern

feat: add routes useSupportedLocalesOnly property

system/Exceptions/PageNotFoundException.php

@@ -45,6 +45,11 @@ public static function forMethodNotFound(string $method)
         return new static(self::lang('HTTP.methodNotFound', [$method]));
     }
 
+    public static function forLocaleNotSupported(string $locale)
+    {
+        return new static(self::lang('HTTP.localeNotSupported', [$locale]));
+    }
+
     /**
      * Get translated system message
      *

system/Language/en/HTTP.php

@@ -52,6 +52,7 @@
     'emptyController'    => 'No Controller specified.',
     'controllerNotFound' => 'Controller or its method is not found: {0}::{1}',
     'methodNotFound'     => 'Controller method is not found: {0}',
+    'localeNotSupported' => 'Locale is not supported: {0}',
 
     // CSRF
     // @deprecated use `Security.disallowedAction`

system/Router/RouteCollection.php

@@ -223,6 +223,11 @@ class RouteCollection implements RouteCollectionInterface
      */
     private ?string $httpHost = null;
 
+    /**
+     * Flag to limit or not the routes with {locale} placeholder to App::$supportedLocales
+     */
+    protected bool $useSupportedLocalesOnly = false;
+
     /**
      * Constructor
      */
@@ -1466,4 +1471,22 @@ public function getRegisteredControllers(?string $verb = '*'): array
 
         return array_unique($controllers);
     }
+
+    /**
+     * Set The flag that limit or not the routes with {locale} placeholder to App::$supportedLocales
+     */
+    public function useSupportedLocalesOnly(bool $useOnly): self
+    {
+        $this->useSupportedLocalesOnly = $useOnly;
+
+        return $this;
+    }
+
+    /**
+     * Get the flag that limit or not the routes with {locale} placeholder to App::$supportedLocales
+     */
+    public function shouldUseSupportedLocalesOnly(): bool
+    {
+        return $this->useSupportedLocalesOnly;
+    }
 }

system/Router/RouteCollectionInterface.php

@@ -184,4 +184,9 @@ public function isRedirect(string $from): bool;
      * Grabs the HTTP status code from a redirecting Route.
      */
     public function getRedirectCode(string $from): int;
+
+    /**
+     * Get the flag that limit or not the routes with {locale} placeholder to App::$supportedLocales
+     */
+    public function shouldUseSupportedLocalesOnly(): bool;
 }

system/Router/Router.php

@@ -439,6 +439,14 @@ protected function checkRoutes(string $uri): bool
                         $matched
                     );
 
+                    if ($this->collection->shouldUseSupportedLocalesOnly()
+                        && ! in_array($matched['locale'], config('App')->supportedLocales, true)) {
+
+                        // Throw exception to prevent the autorouter, if enabled,
+                        // from trying to find a route
+                        throw PageNotFoundException::forLocaleNotSupported($matched['locale']);
+                    }
+
                     $this->detectedLocale = $matched['locale'];
                     unset($matched);
                 }

tests/system/Router/RouteCollectionTest.php

@@ -12,6 +12,7 @@
 namespace CodeIgniter\Router;
 
 use CodeIgniter\Config\Services;
+use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\Test\CIUnitTestCase;
 use Config\Modules;
 use Tests\Support\Controllers\Hello;
@@ -1678,4 +1679,18 @@ public function testGetRegisteredControllersDoesNotReturnClosures()
         $expects = [];
         $this->assertSame($expects, $routes);
     }
+
+    public function testUseSupportedLocalesOnly()
+    {
+        config('App')->supportedLocales = ['en'];
+
+        $routes = $this->getCollector();
+        $routes->useSupportedLocalesOnly(true);
+        $routes->get('{locale}/products', 'Products::list');
+
+        $router = new Router($routes, Services::request());
+
+        $this->expectException(PageNotFoundException::class);
+        $router->handle('fr/products');
+    }
 }

user_guide_src/source/outgoing/localization.rst

@@ -81,8 +81,12 @@ segment will be your locale:
 In this example, if the user tried to visit ``http://example.com/fr/books``, then the locale would be
 set to ``fr``, assuming it was configured as a valid locale.
 
-.. note:: If the value doesn't match a valid locale as defined in the App configuration file, the default
-    locale will be used in it's place.
+If the value doesn't match a valid locale as defined in ``$supportedLocales`` in **app/Config/App.php**, the default
+locale will be used in it's place, unless you set to use only the supported locales defined in the App configuration
+file:
+
+.. literalinclude:: localization/018.php
+
 
 Retrieving the Current Locale
 =============================

user_guide_src/source/outgoing/localization/018.php

@@ -0,0 +1,3 @@
+<?php
+
+$routes->useSupportedLocalesOnly(true);