Skip to content

Commit

Permalink
[AUTO] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gigili
gigili committed Aug 8, 2022
1 parent 6ae9b20 commit e99b86a
Show file tree
Hide file tree
Showing 3 changed files with 129 additions and 19 deletions.
136 changes: 118 additions & 18 deletions docs/classes/Gac-Routing-Routes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,13 @@ <h3 id="toc">
<span>
&nbsp;: <a href="classes/Gac-Routing-Request.html"><abbr title="\Gac\Routing\Request">Request</abbr></a> </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Gac-Routing-Routes.html#property_currentRoute">$currentRoute</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -property -private">
Expand Down Expand Up @@ -320,6 +327,13 @@ <h3 id="toc">
</dt>
<dd>Method which returns the current path the user is trying to access</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Gac-Routing-Routes.html#method_get_route_arguments">get_route_arguments()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Gac-Routing-Routes.html#method_setup_callback">setup_callback()</a>
<span>
Expand Down Expand Up @@ -523,6 +537,40 @@ <h4 class="phpdocumentor-element__name" id="property_request">



</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_currentRoute">
$currentRoute
<a href="classes/Gac-Routing-Routes.html#property_currentRoute" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
<span class="phpdocumentor-signature__name">$currentRoute</span>
= <span class="phpdocumentor-signature__default-value">NULL</span></code>


<section class="phpdocumentor-description"><p>Array of the current route being processed for eas of access in other methods</p>
</section>



</article>
<article
class="
Expand Down Expand Up @@ -680,7 +728,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
<span class="phpdocumentor-element-found-in__line">81</span>

</aside>

Expand Down Expand Up @@ -713,7 +761,7 @@ <h4 class="phpdocumentor-element__name" id="method_add">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
<span class="phpdocumentor-element-found-in__line">92</span>

</aside>

Expand Down Expand Up @@ -776,7 +824,7 @@ <h4 class="phpdocumentor-element__name" id="method_append">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">506</span>
<span class="phpdocumentor-element-found-in__line">524</span>

</aside>

Expand Down Expand Up @@ -823,7 +871,7 @@ <h4 class="phpdocumentor-element__name" id="method_delete">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">470</span>
<span class="phpdocumentor-element-found-in__line">488</span>

</aside>

Expand Down Expand Up @@ -879,7 +927,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">418</span>
<span class="phpdocumentor-element-found-in__line">436</span>

</aside>

Expand Down Expand Up @@ -935,7 +983,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_routes">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">406</span>
<span class="phpdocumentor-element-found-in__line">424</span>

</aside>

Expand Down Expand Up @@ -970,7 +1018,7 @@ <h4 class="phpdocumentor-element__name" id="method_handle">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
<span class="phpdocumentor-element-found-in__line">187</span>

</aside>

Expand Down Expand Up @@ -1029,7 +1077,7 @@ <h4 class="phpdocumentor-element__name" id="method_middleware">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">494</span>
<span class="phpdocumentor-element-found-in__line">512</span>

</aside>

Expand Down Expand Up @@ -1076,7 +1124,7 @@ <h4 class="phpdocumentor-element__name" id="method_patch">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">457</span>
<span class="phpdocumentor-element-found-in__line">475</span>

</aside>

Expand Down Expand Up @@ -1132,7 +1180,7 @@ <h4 class="phpdocumentor-element__name" id="method_post">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">431</span>
<span class="phpdocumentor-element-found-in__line">449</span>

</aside>

Expand Down Expand Up @@ -1188,7 +1236,7 @@ <h4 class="phpdocumentor-element__name" id="method_prefix">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">482</span>
<span class="phpdocumentor-element-found-in__line">500</span>

</aside>

Expand Down Expand Up @@ -1235,7 +1283,7 @@ <h4 class="phpdocumentor-element__name" id="method_put">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">444</span>
<span class="phpdocumentor-element-found-in__line">462</span>

</aside>

Expand Down Expand Up @@ -1291,7 +1339,7 @@ <h4 class="phpdocumentor-element__name" id="method_route">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">106</span>
<span class="phpdocumentor-element-found-in__line">110</span>

</aside>

Expand Down Expand Up @@ -1356,7 +1404,7 @@ <h4 class="phpdocumentor-element__name" id="method_save">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
<span class="phpdocumentor-element-found-in__line">154</span>

</aside>

Expand Down Expand Up @@ -1401,7 +1449,7 @@ <h4 class="phpdocumentor-element__name" id="method_execute_middleware">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">319</span>
<span class="phpdocumentor-element-found-in__line">331</span>

</aside>

Expand Down Expand Up @@ -1462,7 +1510,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_all_arguments">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">361</span>
<span class="phpdocumentor-element-found-in__line">379</span>

</aside>

Expand Down Expand Up @@ -1507,7 +1555,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_path">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">304</span>
<span class="phpdocumentor-element-found-in__line">316</span>

</aside>

Expand All @@ -1528,6 +1576,58 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
</section>


</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_get_route_arguments">
get_route_arguments()
<a href="classes/Gac-Routing-Routes.html#method_get_route_arguments" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">243</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">get_route_arguments</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$route</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>

<section class="phpdocumentor-description"></section>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$route</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>

</dd>
</dl>



<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;


</article>
<article
class="phpdocumentor-element
Expand All @@ -1542,7 +1642,7 @@ <h4 class="phpdocumentor-element__name" id="method_setup_callback">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">268</span>
<span class="phpdocumentor-element-found-in__line">280</span>

</aside>

Expand Down
10 changes: 10 additions & 0 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ Search.appendIndex(
"name": "handle",
"summary": "Method\u0020used\u0020to\u0020handle\u0020execution\u0020of\u0020routes\u0020and\u0020middlewares",
"url": "classes/Gac-Routing-Routes.html#method_handle"
}, {
"fqsen": "\\Gac\\Routing\\Routes\u003A\u003Aget_route_arguments\u0028\u0029",
"name": "get_route_arguments",
"summary": "",
"url": "classes/Gac-Routing-Routes.html#method_get_route_arguments"
}, {
"fqsen": "\\Gac\\Routing\\Routes\u003A\u003Asetup_callback\u0028\u0029",
"name": "setup_callback",
Expand Down Expand Up @@ -205,6 +210,11 @@ Search.appendIndex(
"name": "tmpRoutes",
"summary": "",
"url": "classes/Gac-Routing-Routes.html#property_tmpRoutes"
}, {
"fqsen": "\\Gac\\Routing\\Routes\u003A\u003A\u0024currentRoute",
"name": "currentRoute",
"summary": "",
"url": "classes/Gac-Routing-Routes.html#property_currentRoute"
}, {
"fqsen": "\\",
"name": "\\",
Expand Down
2 changes: 1 addition & 1 deletion docs/reports/markers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3><abbr title="src/Routes.php">Routes.php</abbr></h3>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">200</td>
<td class="phpdocumentor-cell">204</td>
<td class="phpdocumentor-cell">Find a way to not check the number of / as it seems a bit hacky</td>
</tr>
</tbody>
Expand Down

0 comments on commit e99b86a

Please sign in to comment.