diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst index c2f5977384a2..a1bb81726b14 100644 --- a/user_guide_src/source/incoming/routing.rst +++ b/user_guide_src/source/incoming/routing.rst @@ -1044,3 +1044,12 @@ This method returns a list of filters that are currently active for the route be .. note:: The ``getFilters()`` method returns only the filters defined for the specific route. It does not include global filters or those specified in the **app/Config/Filters.php** file. +Getting Matched Route Options for the Current Route +=================================================== + +When we're defining routes, they may have optional parameters: ``filter``, ``namespace``, ``hostname``, ``subdomain``, ``offset``, ``priority``, ``as``. All of them were described earlier above. +Additionally, if we use ``addRedirect()`` we can also expect the ``redirect`` key. +To access the values of these parameters, we can call ``Router::getMatchedRouteOptions()``. Here is an example of the returned array: + +.. literalinclude:: routing/074.php + diff --git a/user_guide_src/source/incoming/routing/074.php b/user_guide_src/source/incoming/routing/074.php new file mode 100644 index 000000000000..74eaeaf7e353 --- /dev/null +++ b/user_guide_src/source/incoming/routing/074.php @@ -0,0 +1,23 @@ +getMatchedRouteOptions(); + +echo 'Route name: ' . $options['as']; + +print_r($options); + +// Route name: api:auth +// +// Array +// ( +// [filter] => api-auth +// [namespace] => App\API\v1 +// [hostname] => example.com +// [subdomain] => api +// [offset] => 1 +// [priority] => 1 +// [as] => api:auth +// )