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 Oct 31, 2021
1 parent b34743f commit f5c2960
Show file tree
Hide file tree
Showing 21 changed files with 1,405 additions and 148 deletions.
97 changes: 76 additions & 21 deletions docs/classes/Gac-GoodFoodTracker-Core-App.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
<span class="phpdocumentor-element-found-in__line">16</span>

</aside>

Expand All @@ -127,7 +127,14 @@ <h3 id="toc">
</h3>

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Gac-GoodFoodTracker-Core-App.html#property_session">$session</a>
<span>
&nbsp;: <a href="classes/Gac-GoodFoodTracker-Core-Session-Session.html"><abbr title="\Gac\GoodFoodTracker\Core\Session\Session">Session</abbr></a> </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/Gac-GoodFoodTracker-Core-App.html#property_db">$db</a>
<span>
&nbsp;: <a href="classes/Gac-GoodFoodTracker-Core-DB-Database.html"><abbr title="\Gac\GoodFoodTracker\Core\DB\Database">Database</abbr></a>|null </span>
Expand Down Expand Up @@ -172,9 +179,9 @@ <h3 id="toc">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Gac-GoodFoodTracker-Core-App.html#method_get_instance">get_instance()</a>
<span>
&nbsp;: <a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a>|null </span>
&nbsp;: <a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a> </span>
</dt>
<dd></dd>
<dd>Gets the instance of the App class</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Gac-GoodFoodTracker-Core-App.html#method_get_redis">get_redis()</a>
Expand Down Expand Up @@ -224,6 +231,40 @@ <h3 class="phpdocumentor-elements__header" id="properties">
<a href="classes/Gac-GoodFoodTracker-Core-App.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_session">
$session
<a href="classes/Gac-GoodFoodTracker-Core-App.html#property_session" 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/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type"><a href="classes/Gac-GoodFoodTracker-Core-Session-Session.html"><abbr title="\Gac\GoodFoodTracker\Core\Session\Session">Session</abbr></a></span>
<span class="phpdocumentor-signature__name">$session</span>
</code>

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

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



</article>
<article
class="
phpdocumentor-element
-property
Expand All @@ -239,7 +280,7 @@ <h4 class="phpdocumentor-element__name" id="property_db">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
<span class="phpdocumentor-element-found-in__line">21</span>

</aside>

Expand Down Expand Up @@ -273,7 +314,7 @@ <h4 class="phpdocumentor-element__name" id="property_redis">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
<span class="phpdocumentor-element-found-in__line">19</span>

</aside>

Expand Down Expand Up @@ -307,7 +348,7 @@ <h4 class="phpdocumentor-element__name" id="property_routes">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
<span class="phpdocumentor-element-found-in__line">20</span>

</aside>

Expand Down Expand Up @@ -341,7 +382,7 @@ <h4 class="phpdocumentor-element__name" id="property_instance">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>
<span class="phpdocumentor-element-found-in__line">18</span>

</aside>

Expand Down Expand Up @@ -379,7 +420,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
<span class="phpdocumentor-element-found-in__line">24</span>

</aside>

Expand Down Expand Up @@ -423,7 +464,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_db">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
<span class="phpdocumentor-element-found-in__line">52</span>

</aside>

Expand Down Expand Up @@ -456,22 +497,36 @@ <h4 class="phpdocumentor-element__name" id="method_get_instance">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
<span class="phpdocumentor-element-found-in__line">47</span>

</aside>


<p class="phpdocumentor-summary">Gets the instance of the App class</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_instance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a>|null</span></code>

<section class="phpdocumentor-description"></section>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_instance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a></span></code>




<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Gac-GoodFoodTracker-Core-Exceptions-AppNotInitializedException.html"><abbr title="\Gac\GoodFoodTracker\Core\Exceptions\AppNotInitializedException">AppNotInitializedException</abbr></a></span>


</dd>
</dl>

<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a>|null</span>
<span class="phpdocumentor-signature__response_type"><a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a></span>
&mdash;


Expand All @@ -489,7 +544,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_redis">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">64</span>

</aside>

Expand Down Expand Up @@ -522,7 +577,7 @@ <h4 class="phpdocumentor-element__name" id="method_run">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<span class="phpdocumentor-element-found-in__line">38</span>

</aside>

Expand Down Expand Up @@ -576,7 +631,7 @@ <h4 class="phpdocumentor-element__name" id="method_set_db">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
<span class="phpdocumentor-element-found-in__line">56</span>

</aside>

Expand Down Expand Up @@ -620,7 +675,7 @@ <h4 class="phpdocumentor-element__name" id="method_set_redis">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
<span class="phpdocumentor-element-found-in__line">68</span>

</aside>

Expand Down Expand Up @@ -664,7 +719,7 @@ <h4 class="phpdocumentor-element__name" id="method_set_routes">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/App.php"><a href="files/src-core-app.html"><abbr title="src/Core/App.php">App.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
<span class="phpdocumentor-element-found-in__line">60</span>

</aside>

Expand Down
22 changes: 11 additions & 11 deletions docs/classes/Gac-GoodFoodTracker-Core-Controllers-BaseController.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/Controllers/BaseController.php"><a href="files/src-core-controllers-basecontroller.html"><abbr title="src/Core/Controllers/BaseController.php">BaseController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>
<span class="phpdocumentor-element-found-in__line">15</span>

</aside>

Expand Down Expand Up @@ -143,9 +143,9 @@ <h3 id="toc">

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/Gac-GoodFoodTracker-Core-Controllers-BaseController.html#property_redis">$redis</a>
<a href="classes/Gac-GoodFoodTracker-Core-Controllers-BaseController.html#property_app">$app</a>
<span>
&nbsp;: <abbr title="\Predis\Client">Client</abbr> </span>
&nbsp;: <a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a> </span>
</dt>
<dd></dd>

Expand Down Expand Up @@ -175,28 +175,28 @@ <h3 class="phpdocumentor-elements__header" id="properties">
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_redis">
$redis
<a href="classes/Gac-GoodFoodTracker-Core-Controllers-BaseController.html#property_redis" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_app">
$app
<a href="classes/Gac-GoodFoodTracker-Core-Controllers-BaseController.html#property_app" 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/Core/Controllers/BaseController.php"><a href="files/src-core-controllers-basecontroller.html"><abbr title="src/Core/Controllers/BaseController.php">BaseController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
<span class="phpdocumentor-element-found-in__line">20</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><abbr title="\Predis\Client">Client</abbr></span>
<span class="phpdocumentor-signature__name">$redis</span>
<span class="phpdocumentor-signature__type"><a href="classes/Gac-GoodFoodTracker-Core-App.html"><abbr title="\Gac\GoodFoodTracker\Core\App">App</abbr></a></span>
<span class="phpdocumentor-signature__name">$app</span>
</code>


<section class="phpdocumentor-description"><p>Instance of a redis cache</p>
<section class="phpdocumentor-description"><p>Instance of the app class</p>
</section>


Expand All @@ -222,7 +222,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Core/Controllers/BaseController.php"><a href="files/src-core-controllers-basecontroller.html"><abbr title="src/Core/Controllers/BaseController.php">BaseController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
<span class="phpdocumentor-element-found-in__line">22</span>

</aside>

Expand Down
Loading

0 comments on commit f5c2960

Please sign in to comment.