Merge pull request #8340 from kenjis/docs-improve-routing

docs: improve routing

Author: kenjis

user_guide_src/source/incoming/routing.rst

@@ -200,11 +200,19 @@ For example the route:
 
 will match **product/123**, **product/123/456**, **product/123/456/789** and so on.
 
+In the above example, if the ``$1`` placeholder contains a slash
+(``/``), it will still be split into multiple parameters when passed to
+``Catalog::productLookup()``.
+
 The implementation in the
 Controller should take into account the maximum parameters:
 
 .. literalinclude:: routing/011.php
 
+Or you can use `variable-length argument lists <https://www.php.net/manual/en/functions.arguments.php#functions.variable-arg-list>`_:
+
+.. literalinclude:: routing/068.php
+
 .. important:: Do not put any placeholder after ``(:any)``. Because the number of
     parameters passed to the controller method may change.
 
@@ -249,6 +257,10 @@ redirect them back to the same page after they log in, you may find this example
 
 .. literalinclude:: routing/019.php
 
+In the above example, if the ``$1`` placeholder contains a slash
+(``/``), it will still be split into multiple parameters when passed to
+``Auth::login()``.
+
 For those of you who don't know regular expressions and want to learn more about them,
 `regular-expressions.info <https://www.regular-expressions.info/>`_ might be a good starting point.
 

user_guide_src/source/incoming/routing/011.php

@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-class ProductController extends BaseController
+class Catalog extends BaseController
 {
     public function productLookup($seg1 = false, $seg2 = false, $seg3 = false)
     {

user_guide_src/source/incoming/routing/045.php

@@ -8,6 +8,7 @@ class Routing extends BaseRouting
     // ...
 }
 
+// In app/Config/Routes.php
 // Controller is \Users
 $routes->get('users', 'Users::index');
 

user_guide_src/source/incoming/routing/046.php

@@ -1,6 +1,6 @@
 <?php
 
-// This can be overridden in the Routes file
+// This can be overridden in app/Config/Routes.php
 $routes->setDefaultNamespace('App');
 
 // Controller is \App\Users

user_guide_src/source/incoming/routing/049.php

@@ -8,5 +8,5 @@ class Routing extends BaseRouting
     // ...
 }
 
-// This can be overridden in the Routes file
+// This can be overridden in app/Config/Routes.php
 $routes->setTranslateURIDashes(true);

user_guide_src/source/incoming/routing/050.php

@@ -8,5 +8,5 @@ class Routing extends BaseRouting
     // ...
 }
 
-// This can be overridden in the Routes file
+// This can be overridden in app/Config/Routes.php
 $routes->setAutoRoute(false);

user_guide_src/source/incoming/routing/051.php

@@ -8,6 +8,7 @@ class Routing extends BaseRouting
     // ...
 }
 
+// In app/Config/Routes.php
 // Would execute the show404 method of the App\Errors class
 $routes->set404Override('App\Errors::show404');
 

user_guide_src/source/incoming/routing/052.php

@@ -1,5 +1,14 @@
 <?php
 
+// In app/Config/Routing.php
+class Routing extends BaseRouting
+{
+    // ...
+    public bool $prioritize = true;
+    // ...
+}
+
+// In app/Config/Routes.php
 // to enable
 $routes->setPrioritize();
 

user_guide_src/source/incoming/routing/068.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Controllers;
+
+class Catalog extends BaseController
+{
+    public function productLookup(...$params)
+    {
+        echo $params[0] ?? null; // Will be 123 in all examples
+        echo $params[1] ?? null; // null in first, 456 in second and third example
+        echo $params[2] ?? null; // null in first and second, 789 in third
+    }
+}