Update User Guide

Author: actions-user

incoming/routing.html

@@ -394,6 +394,7 @@ <h1>URI Routing<a class="headerlink" href="#uri-routing" title="Permalink to thi
 <ul>
 <li><p><a class="reference internal" href="#retrieving-the-current-controller-method-names" id="id74">Retrieving the Current Controller/Method Names</a></p></li>
 <li><p><a class="reference internal" href="#getting-active-filters-for-the-current-route" id="id75">Getting Active Filters for the Current Route</a></p></li>
+<li><p><a class="reference internal" href="#getting-matched-route-options-for-the-current-route" id="id76">Getting Matched Route Options for the Current Route</a></p></li>
 </ul>
 </li>
 </ul>
@@ -1747,6 +1748,37 @@ <h3><a class="toc-backref" href="#id75" role="doc-backlink">Getting Active Filte
 It does not include global filters or those specified in the <strong>app/Config/Filters.php</strong> file.</p>
 </div>
 </section>
+<section id="getting-matched-route-options-for-the-current-route">
+<h3><a class="toc-backref" href="#id76" role="doc-backlink">Getting Matched Route Options for the Current Route</a><a class="headerlink" href="#getting-matched-route-options-for-the-current-route" title="Permalink to this heading"></a></h3>
+<p>When we’re defining routes, they may have optional parameters: <code class="docutils literal notranslate"><span class="pre">filter</span></code>, <code class="docutils literal notranslate"><span class="pre">namespace</span></code>, <code class="docutils literal notranslate"><span class="pre">hostname</span></code>, <code class="docutils literal notranslate"><span class="pre">subdomain</span></code>, <code class="docutils literal notranslate"><span class="pre">offset</span></code>, <code class="docutils literal notranslate"><span class="pre">priority</span></code>, <code class="docutils literal notranslate"><span class="pre">as</span></code>. All of them were described earlier above.
+Additionally, if we use <code class="docutils literal notranslate"><span class="pre">addRedirect()</span></code> we can also expect the <code class="docutils literal notranslate"><span class="pre">redirect</span></code> key.
+To access the values of these parameters, we can call <code class="docutils literal notranslate"><span class="pre">Router::getMatchedRouteOptions()</span></code>. Here is an example of the returned array:</p>
+<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
+
+<span class="c1">// Get the router instance.</span>
+<span class="sd">/** @var \CodeIgniter\Router\Router $router */</span>
+<span class="nv">$router</span>  <span class="o">=</span> <span class="nx">service</span><span class="p">(</span><span class="s1">&#39;router&#39;</span><span class="p">);</span>
+<span class="nv">$options</span> <span class="o">=</span> <span class="nv">$router</span><span class="o">-&gt;</span><span class="na">getMatchedRouteOptions</span><span class="p">();</span>
+
+<span class="k">echo</span> <span class="s1">&#39;Route name: &#39;</span> <span class="o">.</span> <span class="nv">$options</span><span class="p">[</span><span class="s1">&#39;as&#39;</span><span class="p">];</span>
+
+<span class="nb">print_r</span><span class="p">(</span><span class="nv">$options</span><span class="p">);</span>
+
+<span class="c1">// Route name: api:auth</span>
+<span class="c1">//</span>
+<span class="c1">// Array</span>
+<span class="c1">// (</span>
+<span class="c1">//     [filter] =&gt; api-auth</span>
+<span class="c1">//     [namespace] =&gt; App\API\v1</span>
+<span class="c1">//     [hostname] =&gt; example.com</span>
+<span class="c1">//     [subdomain] =&gt; api</span>
+<span class="c1">//     [offset] =&gt; 1</span>
+<span class="c1">//     [priority] =&gt; 1</span>
+<span class="c1">//     [as] =&gt; api:auth</span>
+<span class="c1">// )</span>
+</pre></div>
+</div>
+</section>
 </section>
 </section>