Skip to content

docs: Add info about Router::getMatchedRouteOptions() #9441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions user_guide_src/source/incoming/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/routing/074.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

// Get the router instance.
/** @var \CodeIgniter\Router\Router $router */
$router = service('router');
$options = $router->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
// )