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 Apr 7, 2023
1 parent 1938865 commit f76d478
Show file tree
Hide file tree
Showing 4 changed files with 209 additions and 53 deletions.
60 changes: 52 additions & 8 deletions docs/classes/Gac-Routing-Request.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ <h3 id="toc">
<span>
&nbsp;: array&lt;string|int, mixed&gt;|string|null </span>
</dt>
<dd>Returns list of all the header items or a value of a specific item</dd>
<dd>Returns list of all the header items or a value of a specified key.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Gac-Routing-Request.html#method_send">send()</a>
Expand All @@ -180,6 +180,13 @@ <h3 id="toc">
</dt>
<dd>Sets the header status code for the response</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Gac-Routing-Request.html#method_get_request_headers">get_request_headers()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Method used for getting all request headers</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Gac-Routing-Request.html#method_parse_patch_and_put_request_data">parse_patch_and_put_request_data()</a>
<span>
Expand Down Expand Up @@ -333,7 +340,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">78</span>
<span class="phpdocumentor-element-found-in__line">109</span>

</aside>

Expand Down Expand Up @@ -389,17 +396,19 @@ <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">52</span>
<span class="phpdocumentor-element-found-in__line">53</span>

</aside>

<p class="phpdocumentor-summary">Returns list of all the header items or a value of a specific item</p>
<p class="phpdocumentor-summary">Returns list of all the header items or a value of a specified key.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">headers</span><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">$key</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|string|null</span></code>


<section class="phpdocumentor-description"><p>It will return NULL if the specified key can't be found.</p>
</section>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand Down Expand Up @@ -436,7 +445,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">96</span>
<span class="phpdocumentor-element-found-in__line">127</span>

</aside>

Expand Down Expand Up @@ -490,7 +499,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">65</span>
<span class="phpdocumentor-element-found-in__line">95</span>

</aside>

Expand Down Expand Up @@ -532,6 +541,41 @@ <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_request_headers">
get_request_headers()
<a href="classes/Gac-Routing-Request.html#method_get_request_headers" 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">70</span>

</aside>

<p class="phpdocumentor-summary">Method used for getting all request headers</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">get_request_headers</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>





<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>It will return an array containing all the header values or an empty array</p>
</section>


</article>
<article
class="phpdocumentor-element
Expand All @@ -546,7 +590,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">108</span>
<span class="phpdocumentor-element-found-in__line">139</span>

</aside>

Expand Down
Loading

0 comments on commit f76d478

Please sign in to comment.