Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
@alddesign
alddesign committed Apr 9, 2023
1 parent 96eae3f commit 44e8a1e
Show file tree
Hide file tree
Showing 65 changed files with 3,783 additions and 3,815 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
api-doc/** linguist-documentation
make-api-doc/** linguist-documentation
38 changes: 19 additions & 19 deletions api-doc/dev/classes/Alddesign-Crudkit-Classes-AuthHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
<span class="phpdocumentor-element-found-in__line">8</span>

</aside>

Expand Down Expand Up @@ -286,7 +286,7 @@ <h4 class="phpdocumentor-element__name" id="property_callbacks">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
<span class="phpdocumentor-element-found-in__line">20</span>

</aside>

Expand Down Expand Up @@ -333,7 +333,7 @@ <h4 class="phpdocumentor-element__name" id="property_users">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
<span class="phpdocumentor-element-found-in__line">14</span>

</aside>

Expand Down Expand Up @@ -382,7 +382,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<span class="phpdocumentor-element-found-in__line">29</span>

</aside>

Expand Down Expand Up @@ -440,7 +440,7 @@ <h4 class="phpdocumentor-element__name" id="method_addUser">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
<span class="phpdocumentor-element-found-in__line">75</span>

</aside>

Expand Down Expand Up @@ -525,7 +525,7 @@ <h4 class="phpdocumentor-element__name" id="method_addUserObject">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">50</span>

</aside>

Expand Down Expand Up @@ -583,7 +583,7 @@ <h4 class="phpdocumentor-element__name" id="method_checkAuth">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
<span class="phpdocumentor-element-found-in__line">224</span>

</aside>

Expand Down Expand Up @@ -664,7 +664,7 @@ <h4 class="phpdocumentor-element__name" id="method_checkCookies">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
<span class="phpdocumentor-element-found-in__line">202</span>

</aside>

Expand Down Expand Up @@ -697,7 +697,7 @@ <h4 class="phpdocumentor-element__name" id="method_checkStartpage">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">177</span>
<span class="phpdocumentor-element-found-in__line">172</span>

</aside>

Expand Down Expand Up @@ -742,7 +742,7 @@ <h4 class="phpdocumentor-element__name" id="method_getUserId">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">134</span>
<span class="phpdocumentor-element-found-in__line">129</span>

</aside>

Expand Down Expand Up @@ -775,7 +775,7 @@ <h4 class="phpdocumentor-element__name" id="method_getUsers">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<span class="phpdocumentor-element-found-in__line">60</span>

</aside>

Expand Down Expand Up @@ -808,7 +808,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAdmin">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
<span class="phpdocumentor-element-found-in__line">119</span>

</aside>

Expand Down Expand Up @@ -841,7 +841,7 @@ <h4 class="phpdocumentor-element__name" id="method_isLoggedIn">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">109</span>

</aside>

Expand Down Expand Up @@ -874,7 +874,7 @@ <h4 class="phpdocumentor-element__name" id="method_onAfterLogin">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">152</span>
<span class="phpdocumentor-element-found-in__line">147</span>

</aside>

Expand Down Expand Up @@ -943,7 +943,7 @@ <h4 class="phpdocumentor-element__name" id="method_triggerEvent">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">163</span>
<span class="phpdocumentor-element-found-in__line">158</span>

</aside>

Expand Down Expand Up @@ -1001,7 +1001,7 @@ <h4 class="phpdocumentor-element__name" id="method_userHasAccessTo">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
<span class="phpdocumentor-element-found-in__line">87</span>

</aside>

Expand Down Expand Up @@ -1067,7 +1067,7 @@ <h4 class="phpdocumentor-element__name" id="method_checkPermissions">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">276</span>
<span class="phpdocumentor-element-found-in__line">270</span>

</aside>

Expand Down Expand Up @@ -1131,7 +1131,7 @@ <h4 class="phpdocumentor-element__name" id="method_loginFailed">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">267</span>
<span class="phpdocumentor-element-found-in__line">261</span>

</aside>

Expand Down Expand Up @@ -1187,7 +1187,7 @@ <h4 class="phpdocumentor-element__name" id="method_performLogin">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/AuthHelper.php"><a href="files/classes-authhelper.html"><abbr title="Classes/AuthHelper.php">AuthHelper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">293</span>
<span class="phpdocumentor-element-found-in__line">287</span>

</aside>

Expand Down
55 changes: 28 additions & 27 deletions ...ign-Crudkit-Classes-ExceptionHandler.html → ...Alddesign-Crudkit-Classes-CException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,11 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil

<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
ExceptionHandler
CException

<span class="phpdocumentor-element__extends">
extends <abbr title="\Exception">Exception</abbr>
</span>

<div class="phpdocumentor-element__package">
in package
Expand All @@ -110,16 +113,14 @@ <h2 class="phpdocumentor-content__title">
</h2>

<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/ExceptionHandler.php"><a href="files/classes-exceptionhandler.html"><abbr title="Classes/ExceptionHandler.php">ExceptionHandler.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="Classes/CException.php"><a href="files/classes-cexception.html"><abbr title="Classes/CException.php">CException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
<span class="phpdocumentor-element-found-in__line">11</span>

</aside>

<p class="phpdocumentor-summary">I forgot the purpose of this class... Should replace default error handling or so.</p>
<p class="phpdocumentor-summary">Custom Exception which indicates its from CRUDKit itself. .</p>

<section class="phpdocumentor-description"><p>Take a look at /app/Exceptions/Handler.php -&gt; render(). Best way is to return a view.</p>
</section>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Expand Down Expand Up @@ -148,11 +149,11 @@ <h3 id="toc">

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Alddesign-Crudkit-Classes-ExceptionHandler.html#method_render">render()</a>
<a href="classes/Alddesign-Crudkit-Classes-CException.html#method___construct">__construct()</a>
<span>
&nbsp;: <abbr title="\Illuminate\Http\Response">Response</abbr> </span>
&nbsp;: mixed </span>
</dt>
<dd>Replaces Handler.php -&gt; render()</dd>
<dd>Creates new CrudkitException. Can be usesd like `sprintf()`;</dd>

</dl>

Expand All @@ -165,56 +166,56 @@ <h3 id="toc">
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Alddesign-Crudkit-Classes-ExceptionHandler.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
<a href="classes/Alddesign-Crudkit-Classes-CException.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
"
>
<h4 class="phpdocumentor-element__name" id="method_render">
render()
<a href="classes/Alddesign-Crudkit-Classes-ExceptionHandler.html#method_render" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/Alddesign-Crudkit-Classes-CException.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Classes/ExceptionHandler.php"><a href="files/classes-exceptionhandler.html"><abbr title="Classes/ExceptionHandler.php">ExceptionHandler.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="Classes/CException.php"><a href="files/classes-cexception.html"><abbr title="Classes/CException.php">CException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
<span class="phpdocumentor-element-found-in__line">19</span>

</aside>

<p class="phpdocumentor-summary">Replaces Handler.php -&gt; render()</p>
<p class="phpdocumentor-summary">Creates new CrudkitException. Can be usesd like `sprintf()`;</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">render</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Illuminate\Support\Facades\Request">Request</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Exception">Exception</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$exception</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Illuminate\Http\Response">Response</abbr></span></code>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$message</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__variadic-operator">...</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>


<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">$request</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Illuminate\Support\Facades\Request">Request</abbr></span>
<span class="phpdocumentor-signature__argument__name">$message</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>The message with placeholders like <code class="prettyprint">%s</code></p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$exception</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Exception">Exception</abbr></span>
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><abbr title="\Illuminate\Http\Response">Response</abbr></span>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;


Expand Down Expand Up @@ -297,7 +298,7 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
</section>
</div>
</div>
<a href="classes/Alddesign-Crudkit-Classes-ExceptionHandler.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
<a href="classes/Alddesign-Crudkit-Classes-CException.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>

</main>

Expand Down
Loading

0 comments on commit 44e8a1e

Please sign in to comment.