Skip to content

Commit 6d8edba

Browse files
committed
docs: level up "Global Options"
1 parent eb776e8 commit 6d8edba

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

user_guide_src/source/incoming/routing.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ available from the command line:
319319
See the :doc:`../cli/spark_commands` page for detailed information.
320320

321321
Global Options
322-
==============
322+
**************
323323

324324
All of the methods for creating a route (``get()``, ``post()``, :doc:`resource() <restful>` etc) can take an array of options that
325325
can modify the generated routes, or further restrict them. The ``$options`` array is always the last parameter:
@@ -329,7 +329,7 @@ can modify the generated routes, or further restrict them. The ``$options`` arra
329329
.. _applying-filters:
330330

331331
Applying Filters
332-
----------------
332+
================
333333

334334
You can alter the behavior of specific routes by supplying filters to run before or after the controller. This is especially handy during authentication or api logging.
335335
The value for the filter can be a string or an array of strings:
@@ -347,7 +347,7 @@ See :doc:`Controller filters <filters>` for more information on setting up filte
347347
See :ref:`use-defined-routes-only` to disable auto-routing.
348348

349349
Alias Filter
350-
^^^^^^^^^^^^
350+
------------
351351

352352
You specify an alias defined in **app/Config/Filters.php** for the filter value:
353353

@@ -358,7 +358,7 @@ You may also supply arguments to be passed to the alias filter's ``before()`` an
358358
.. literalinclude:: routing/035.php
359359

360360
Classname Filter
361-
^^^^^^^^^^^^^^^^
361+
----------------
362362

363363
.. versionadded:: 4.1.5
364364

@@ -367,7 +367,7 @@ You specify a filter classname for the filter value:
367367
.. literalinclude:: routing/036.php
368368

369369
Multiple Filters
370-
^^^^^^^^^^^^^^^^
370+
----------------
371371

372372
.. versionadded:: 4.1.5
373373

@@ -380,7 +380,7 @@ You specify an array for the filter value:
380380
.. _assigning-namespace:
381381

382382
Assigning Namespace
383-
-------------------
383+
===================
384384

385385
While a :ref:`routing-default-namespace` will be prepended to the generated controllers, you can also specify
386386
a different namespace to be used in any options array, with the ``namespace`` option. The value should be the
@@ -393,7 +393,7 @@ For any methods that create multiple routes, the new namespace is attached to al
393393
or, in the case of ``group()``, all routes generated while in the closure.
394394

395395
Limit to Hostname
396-
-----------------
396+
=================
397397

398398
You can restrict groups of routes to function only in certain domain or sub-domains of your application
399399
by passing the "hostname" option along with the desired domain to allow it on as part of the options array:
@@ -404,7 +404,7 @@ This example would only allow the specified hosts to work if the domain exactly
404404
It would not work under the main site at **example.com**.
405405

406406
Limit to Subdomains
407-
-------------------
407+
===================
408408

409409
When the ``subdomain`` option is present, the system will restrict the routes to only be available on that
410410
sub-domain. The route will only be matched if the subdomain is the one the application is being viewed through:
@@ -421,7 +421,7 @@ that does not have any subdomain present, this will not be matched:
421421
to separate suffixes or www) can potentially lead to false positives.
422422

423423
Offsetting the Matched Parameters
424-
---------------------------------
424+
=================================
425425

426426
You can offset the matched parameters in your route by any numeric value with the ``offset`` option, with the
427427
value being the number of segments to offset.

0 commit comments

Comments
 (0)