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 May 4, 2024
1 parent d6a02d7 commit 17a56a9
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 11 deletions.
74 changes: 66 additions & 8 deletions docs/classes/Gac-Routing-Request.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,13 @@ <h4 id="toc-methods">
</dt>
<dd>Private method used for parsing request body data for PUT and PATCH requests</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Gac-Routing-Request.html#method_parse_raw_form_data">parse_raw_form_data()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Parse raw form input data back into an array</dd>

</dl>


Expand Down Expand Up @@ -328,7 +335,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
<span class="phpdocumentor-element-found-in__line">46</span>

</aside>

Expand Down Expand Up @@ -380,7 +387,7 @@ <h4 class="phpdocumentor-element__name" id="method_getAllData">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
<span class="phpdocumentor-element-found-in__line">56</span>

</aside>

Expand Down Expand Up @@ -420,7 +427,7 @@ <h4 class="phpdocumentor-element__name" id="method_header">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
<span class="phpdocumentor-element-found-in__line">134</span>

</aside>

Expand Down Expand Up @@ -498,7 +505,7 @@ <h4 class="phpdocumentor-element__name" id="method_headers">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<span class="phpdocumentor-element-found-in__line">69</span>

</aside>

Expand Down Expand Up @@ -552,7 +559,7 @@ <h4 class="phpdocumentor-element__name" id="method_send">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
<span class="phpdocumentor-element-found-in__line">156</span>

</aside>

Expand Down Expand Up @@ -622,7 +629,7 @@ <h4 class="phpdocumentor-element__name" id="method_status">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">107</span>
<span class="phpdocumentor-element-found-in__line">116</span>

</aside>

Expand Down Expand Up @@ -700,7 +707,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_request_headers">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
<span class="phpdocumentor-element-found-in__line">87</span>

</aside>

Expand Down Expand Up @@ -740,7 +747,7 @@ <h4 class="phpdocumentor-element__name" id="method_parse_patch_and_put_request_d
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">157</span>
<span class="phpdocumentor-element-found-in__line">169</span>

</aside>

Expand All @@ -765,6 +772,56 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>

</section>

</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_parse_raw_form_data">
parse_raw_form_data()
<a href="classes/Gac-Routing-Request.html#method_parse_raw_form_data" 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/Request.php"><a href="files/src-request.html"><abbr title="src/Request.php">Request.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">258</span>

</aside>

<p class="phpdocumentor-summary">Parse raw form input data back into an array</p>

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

<div class="phpdocumentor-label-line">
</div>

<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">$input</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

</dd>
</dl>



<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Returns parsed raw form data into an array</p>
</section>

</section>

</article>
</section>

Expand Down Expand Up @@ -895,6 +952,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<li><a href="classes/Gac-Routing-Request.html#method_status">status()</a></li>
<li><a href="classes/Gac-Routing-Request.html#method_get_request_headers">get_request_headers()</a></li>
<li><a href="classes/Gac-Routing-Request.html#method_parse_patch_and_put_request_data">parse_patch_and_put_request_data()</a></li>
<li><a href="classes/Gac-Routing-Request.html#method_parse_raw_form_data">parse_raw_form_data()</a></li>
</ul>
</li>
</ul>
Expand Down
5 changes: 5 additions & 0 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ Search.appendIndex(
"name": "parse_patch_and_put_request_data",
"summary": "Private\u0020method\u0020used\u0020for\u0020parsing\u0020request\u0020body\u0020data\u0020for\u0020PUT\u0020and\u0020PATCH\u0020requests",
"url": "classes/Gac-Routing-Request.html#method_parse_patch_and_put_request_data"
}, {
"fqsen": "\\Gac\\Routing\\Request\u003A\u003Aparse_raw_form_data\u0028\u0029",
"name": "parse_raw_form_data",
"summary": "Parse\u0020raw\u0020form\u0020input\u0020data\u0020back\u0020into\u0020an\u0020array",
"url": "classes/Gac-Routing-Request.html#method_parse_raw_form_data"
}, {
"fqsen": "\\Gac\\Routing\\Request\u003A\u003A\u0024data",
"name": "data",
Expand Down
6 changes: 3 additions & 3 deletions docs/reports/deprecated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,21 +114,21 @@ <h3><abbr title="src/Request.php">Request.php</abbr></h3>
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">107</td>
<td class="phpdocumentor-cell">116</td>
<td class="phpdocumentor-cell"><a href="classes/Gac-Routing-Request.html#method_status"><abbr title="\Gac\Routing\Request::status()">Request::status()</abbr></a></td>
<td class="phpdocumentor-cell"><p>Soon this option will be removed and should be replaced with a call to the Response class
New way of using the Response class: Response::withStatus(401, 'Not Authorized');</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">124</td>
<td class="phpdocumentor-cell">134</td>
<td class="phpdocumentor-cell"><a href="classes/Gac-Routing-Request.html#method_header"><abbr title="\Gac\Routing\Request::header()">Request::header()</abbr></a></td>
<td class="phpdocumentor-cell"><p>Soon this option will be removed and should be replaced with a call to the Response class
New way of using the Response class: Response::withHeader('header-key', 'header-value');</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">145</td>
<td class="phpdocumentor-cell">156</td>
<td class="phpdocumentor-cell"><a href="classes/Gac-Routing-Request.html#method_send"><abbr title="\Gac\Routing\Request::send()">Request::send()</abbr></a></td>
<td class="phpdocumentor-cell"><p>Soon this option will be removed and should be replaced with a call to the Response class
New way of using the Response class: Response::status(200, 'OK')::setBody($output);</p>
Expand Down

0 comments on commit 17a56a9

Please sign in to comment.