Skip to content

Commit 2b2dcb3

Browse files
maicol07maicol07
committed
docs: 📝 Updated docs
1 parent 6c262d8 commit 2b2dcb3

File tree

9 files changed

+231
-69
lines changed

9 files changed

+231
-69
lines changed

‎docs/Maicol07/SSO/Addons/Core.html‎

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ <h1 class="flarum-title navbar-brand"></h1>
2626
<li class="nav-item"><a class="nav-link" href="https://flarum.org">Flarum</a></li>
2727
<li class="nav-item"><a class="nav-link"
2828
href="https://discuss.flarum.org/d/21666-php-and-wordpress-single-sign-on-sso"
29-
target="_blank">Thread</a></li>
29+
target="_blank">Thread</a>
30+
</li>
3031
<li class="nav-item"><a class="nav-link" href="https://docs.maicol07.it/en/flarum-sso/plugins/php"
3132
target="_blank">Docs</a></li>
3233
<li class="nav-item"><a class="nav-link icon icon-github-circled"
33-
href="https://github.com/maicol07/flarum-sso-php-plugin" target="_blank"></a>
34-
</li>
34+
href="https://github.com/maicol07/flarum-sso-php-plugin"
35+
target="_blank"></a></li>
3536
</ul>
3637
</div>
3738
</nav>
@@ -94,7 +95,7 @@ <h2>Properties</h2>
9495
<td class="last"></td>
9596
<td></td>
9697
<td width="24px"><a
97-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L14"
98+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L15"
9899
target="_blank">
99100
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
100101
</a>
@@ -108,7 +109,7 @@ <h2>Properties</h2>
108109
<td class="last"></td>
109110
<td></td>
110111
<td width="24px"><a
111-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L17"
112+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L18"
112113
target="_blank">
113114
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
114115
</a>
@@ -122,7 +123,21 @@ <h2>Properties</h2>
122123
<td class="last"></td>
123124
<td></td>
124125
<td width="24px"><a
125-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L20"
126+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L21"
127+
target="_blank">
128+
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
129+
</a>
130+
</td>
131+
</tr>
132+
<tr>
133+
<td class="type" id="property_required">
134+
protected
135+
</td>
136+
<td>$required</td>
137+
<td class="last"></td>
138+
<td></td>
139+
<td width="24px"><a
140+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L24"
126141
target="_blank">
127142
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
128143
</a>
@@ -136,7 +151,7 @@ <h2>Properties</h2>
136151
<td class="last"></td>
137152
<td></td>
138153
<td width="24px"><a
139-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L23"
154+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L27"
140155
target="_blank">
141156
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
142157
</a>
@@ -161,7 +176,7 @@ <h2>Methods</h2>
161176
</div>
162177
<div class="col-md-2"></div>
163178
<div class="col-md-2 text-right" style="padding-right: 5px;">
164-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L25"
179+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L29"
165180
target="_blank">
166181
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
167182
</a>
@@ -180,7 +195,7 @@ <h2>Methods</h2>
180195
</div>
181196
<div class="col-md-2"></div>
182197
<div class="col-md-2 text-right" style="padding-right: 5px;">
183-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L37"
198+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L41"
184199
target="_blank">
185200
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
186201
</a>
@@ -199,7 +214,7 @@ <h2>Methods</h2>
199214
</div>
200215
<div class="col-md-2"></div>
201216
<div class="col-md-2 text-right" style="padding-right: 5px;">
202-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L65"
217+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Addons/Core.php#L80"
203218
target="_blank">
204219
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
205220
</a>
@@ -216,9 +231,9 @@ <h2>Details</h2>
216231
<h3 id="method___construct">
217232
<div class="location">
218233
at <a
219-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L25"
234+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L29"
220235
target="_blank">
221-
line 25
236+
line 29
222237
</a>
223238
</div>
224239
<code>
@@ -256,9 +271,9 @@ <h4>Parameters</h4>
256271
<h3 id="method_load">
257272
<div class="location">
258273
at <a
259-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L37"
274+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L41"
260275
target="_blank">
261-
line 37
276+
line 41
262277
</a>
263278
</div>
264279
<code> <a href="../../../Maicol07/SSO/Addons/Core.html"><abbr
@@ -290,9 +305,9 @@ <h4>Return Value</h4>
290305
<h3 id="method_unload">
291306
<div class="location">
292307
at <a
293-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L65"
308+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Addons/Core.php#L80"
294309
target="_blank">
295-
line 65
310+
line 80
296311
</a>
297312
</div>
298313
<code> <a href="../../../Maicol07/SSO/Addons/Core.html"><abbr
@@ -326,11 +341,12 @@ <h4>Return Value</h4>
326341
</div>
327342
<div id="footer">
328343
<p>Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and
329-
fork of Sami</a>.</p>
344+
fork of
345+
Sami</a>.</p>
330346
<p>Created by <a href="https://github.com/datitisev">@datitisev</a>. Modified by <a
331-
href="https://maicol07.it">@maicol07</a> (<a href="https://github.com/maicol07">Github</a>).
332-
Source code can be found on <a href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.
333-
</p>
347+
href="https://maicol07.it">@maicol07</a>
348+
(<a href="https://github.com/maicol07">Github</a>). Source code can be found on <a
349+
href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.</p>
334350
</div>
335351

336352
</div>

‎docs/Maicol07/SSO/Traits/Addons.html‎

Lines changed: 78 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ <h1 class="flarum-title navbar-brand"></h1>
2626
<li class="nav-item"><a class="nav-link" href="https://flarum.org">Flarum</a></li>
2727
<li class="nav-item"><a class="nav-link"
2828
href="https://discuss.flarum.org/d/21666-php-and-wordpress-single-sign-on-sso"
29-
target="_blank">Thread</a></li>
29+
target="_blank">Thread</a>
30+
</li>
3031
<li class="nav-item"><a class="nav-link" href="https://docs.maicol07.it/en/flarum-sso/plugins/php"
3132
target="_blank">Docs</a></li>
3233
<li class="nav-item"><a class="nav-link icon icon-github-circled"
33-
href="https://github.com/maicol07/flarum-sso-php-plugin" target="_blank"></a>
34-
</li>
34+
href="https://github.com/maicol07/flarum-sso-php-plugin"
35+
target="_blank"></a></li>
3536
</ul>
3637
</div>
3738
</nav>
@@ -134,7 +135,25 @@ <h2>Methods</h2>
134135
</div>
135136
<div class="col-md-2"></div>
136137
<div class="col-md-2 text-right" style="padding-right: 5px;">
137-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L43"
138+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L50"
139+
target="_blank">
140+
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
141+
</a>
142+
143+
</div>
144+
</div>
145+
<div class="row">
146+
<div class="col-md-2 type">
147+
bool
148+
</div>
149+
<div class="col-md-6 type">
150+
<a href="#method_isAddonLoaded">isAddonLoaded</a>(string $addon)
151+
152+
<p class="no-description">No description</p>
153+
</div>
154+
<div class="col-md-2"></div>
155+
<div class="col-md-2 text-right" style="padding-right: 5px;">
156+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L65"
138157
target="_blank">
139158
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
140159
</a>
@@ -152,7 +171,7 @@ <h2>Methods</h2>
152171
</div>
153172
<div class="col-md-2"></div>
154173
<div class="col-md-2 text-right" style="padding-right: 5px;">
155-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L58"
174+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L76"
156175
target="_blank">
157176
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
158177
</a>
@@ -170,7 +189,7 @@ <h2>Methods</h2>
170189
</div>
171190
<div class="col-md-2"></div>
172191
<div class="col-md-2 text-right" style="padding-right: 5px;">
173-
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L81"
192+
<a href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/Traits/Addons.php#L99"
174193
target="_blank">
175194
<img alt="See the code on Github" height="18" src="../../../assets/img/code.svg"/>
176195
</a>
@@ -273,9 +292,9 @@ <h4>Return Value</h4>
273292
<h3 id="method_setAddonProperties">
274293
<div class="location">
275294
at <a
276-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L43"
295+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L50"
277296
target="_blank">
278-
line 43
297+
line 50
279298
</a>
280299
</div>
281300
<code> <a href="../../../Maicol07/SSO/Traits/Addons.html"><abbr
@@ -317,14 +336,56 @@ <h4>Return Value</h4>
317336
</div>
318337
</div>
319338

339+
</div>
340+
<div class="method-item">
341+
<h3 id="method_isAddonLoaded">
342+
<div class="location">
343+
at <a
344+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L65"
345+
target="_blank">
346+
line 65
347+
</a>
348+
</div>
349+
<code> bool
350+
<strong>isAddonLoaded</strong>(string $addon)
351+
</code>
352+
</h3>
353+
<div class="details">
354+
355+
356+
<div class="tags">
357+
<h4>Parameters</h4>
358+
359+
<table class="table table-condensed">
360+
<tr>
361+
<td>string</td>
362+
<td>$addon</td>
363+
<td></td>
364+
</tr>
365+
</table>
366+
367+
368+
<h4>Return Value</h4>
369+
370+
<table class="table table-condensed">
371+
<tr>
372+
<td>bool</td>
373+
<td></td>
374+
</tr>
375+
</table>
376+
377+
378+
</div>
379+
</div>
380+
320381
</div>
321382
<div class="method-item">
322383
<h3 id="method_action_hook">
323384
<div class="location">
324385
at <a
325-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L58"
386+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L76"
326387
target="_blank">
327-
line 58
388+
line 76
328389
</a>
329390
</div>
330391
<code> int|null
@@ -364,9 +425,9 @@ <h4>Return Value</h4>
364425
<h3 id="method_filter_hook">
365426
<div class="location">
366427
at <a
367-
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L81"
428+
href="https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/SSO/Traits/Addons.php#L99"
368429
target="_blank">
369-
line 81
430+
line 99
370431
</a>
371432
</div>
372433
<code>
@@ -403,11 +464,12 @@ <h4>Parameters</h4>
403464
</div>
404465
<div id="footer">
405466
<p>Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and
406-
fork of Sami</a>.</p>
467+
fork of
468+
Sami</a>.</p>
407469
<p>Created by <a href="https://github.com/datitisev">@datitisev</a>. Modified by <a
408-
href="https://maicol07.it">@maicol07</a> (<a href="https://github.com/maicol07">Github</a>).
409-
Source code can be found on <a href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.
410-
</p>
470+
href="https://maicol07.it">@maicol07</a>
471+
(<a href="https://github.com/maicol07">Github</a>). Source code can be found on <a
472+
href="https://github.com/maicol07/flarum-sso-php-plugin">GitHub</a>.</p>
411473
</div>
412474

413475
</div>

0 commit comments

Comments
 (0)