Skip to content

Commit f28d370

Browse files
committed
Update documentation
1 parent 2edb99e commit f28d370

29 files changed

+1853
-748
lines changed

.gitignore

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
/.idea/
21
composer.lock
32
composer.phar
4-
/tests/Private
3+
4+
.idea/
55
*.iml
6+
67
vendor/
7-
/build
8+
build

docs/classes/LINEAPI.html

100644100755
Lines changed: 393 additions & 376 deletions
Large diffs are not rendered by default.

docs/classes/LINEMSG-FlexContainer.html

100644100755
Lines changed: 108 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
1616
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
18+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
1819
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
1920
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
2021
<script src="js/search.js"></script>
@@ -51,13 +52,12 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">lin
5152
Menu
5253
</label>
5354
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
54-
55-
<section class="phpdocumentor-sidebar__category">
56-
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
57-
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
58-
</section>
55+
<section class="phpdocumentor-sidebar__category">
56+
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
57+
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
5958

60-
59+
</section>
60+
6161
<section class="phpdocumentor-sidebar__category">
6262
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
6363
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
@@ -73,23 +73,30 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
7373

7474
<div class="phpdocumentor-column -eight phpdocumentor-content">
7575
<ul class="phpdocumentor-breadcrumbs">
76-
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
76+
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
7777
</ul>
7878

7979
<article class="phpdocumentor-element -class">
8080
<h2 class="phpdocumentor-content__title">
8181
LINEMSG_FlexContainer
8282

8383

84+
<div class="phpdocumentor-element__package">
85+
in package
86+
<ul class="phpdocumentor-breadcrumbs">
87+
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
88+
</ul>
89+
</div>
8490

8591

8692
</h2>
8793

8894
<aside class="phpdocumentor-element-found-in">
8995
<abbr class="phpdocumentor-element-found-in__file" title="api.php"><a href="files/api.html"><abbr title="api.php">api.php</abbr></a></abbr>
9096
:
91-
<span class="phpdocumentor-element-found-in__line">1596</span>
92-
</aside>
97+
<span class="phpdocumentor-element-found-in__line">1607</span>
98+
99+
</aside>
93100

94101
<p class="phpdocumentor-summary">LINEMSG_FlexContainer</p>
95102

@@ -178,8 +185,9 @@ <h4 class="phpdocumentor-element__name" id="property_object">
178185
<aside class="phpdocumentor-element-found-in">
179186
<abbr class="phpdocumentor-element-found-in__file" title="api.php"><a href="files/api.html"><abbr title="api.php">api.php</abbr></a></abbr>
180187
:
181-
<span class="phpdocumentor-element-found-in__line">1601</span>
182-
</aside>
188+
<span class="phpdocumentor-element-found-in__line">1612</span>
189+
190+
</aside>
183191

184192

185193
<code class="phpdocumentor-code phpdocumentor-signature ">
@@ -188,8 +196,8 @@ <h4 class="phpdocumentor-element__name" id="property_object">
188196
<span class="phpdocumentor-signature__name">$object</span>
189197
</code>
190198

191-
<section class="phpdocumentor-description"></section>
192-
199+
200+
193201

194202

195203
</article>
@@ -213,23 +221,26 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
213221
<aside class="phpdocumentor-element-found-in">
214222
<abbr class="phpdocumentor-element-found-in__file" title="api.php"><a href="files/api.html"><abbr title="api.php">api.php</abbr></a></abbr>
215223
:
216-
<span class="phpdocumentor-element-found-in__line">1603</span>
217-
</aside>
224+
<span class="phpdocumentor-element-found-in__line">1614</span>
225+
226+
</aside>
218227

219228

220229
<code class="phpdocumentor-code phpdocumentor-signature ">
221230
<span class="phpdocumentor-signature__visibility">public</span>
222231
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
223232

224-
233+
<section class="phpdocumentor-description"></section>
234+
225235
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
226236
<dl class="phpdocumentor-argument-list">
227237
<dt class="phpdocumentor-argument-list__entry">
228238
<span class="phpdocumentor-signature__argument__name">$container</span>
229239
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
230240
</dt>
231241
<dd class="phpdocumentor-argument-list__definition">
232-
242+
<section class="phpdocumentor-description"></section>
243+
233244
</dd>
234245
</dl>
235246

@@ -238,8 +249,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
238249
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
239250
<span class="phpdocumentor-signature__response_type">mixed</span>
240251
&mdash;
241-
<section class="phpdocumentor-description"></section>
242-
252+
243253

244254
</article>
245255
<article
@@ -255,23 +265,24 @@ <h4 class="phpdocumentor-element__name" id="method_out">
255265
<aside class="phpdocumentor-element-found-in">
256266
<abbr class="phpdocumentor-element-found-in__file" title="api.php"><a href="files/api.html"><abbr title="api.php">api.php</abbr></a></abbr>
257267
:
258-
<span class="phpdocumentor-element-found-in__line">1640</span>
259-
</aside>
268+
<span class="phpdocumentor-element-found-in__line">1651</span>
269+
270+
</aside>
260271

261272

262273
<code class="phpdocumentor-code phpdocumentor-signature ">
263274
<span class="phpdocumentor-signature__visibility">public</span>
264275
<span class="phpdocumentor-signature__name">out</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
265276

266-
277+
<section class="phpdocumentor-description"></section>
278+
267279

268280

269281

270282
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
271283
<span class="phpdocumentor-signature__response_type">mixed</span>
272284
&mdash;
273-
<section class="phpdocumentor-description"></section>
274-
285+
275286

276287
</article>
277288
<article
@@ -287,30 +298,34 @@ <h4 class="phpdocumentor-element__name" id="method_set">
287298
<aside class="phpdocumentor-element-found-in">
288299
<abbr class="phpdocumentor-element-found-in__file" title="api.php"><a href="files/api.html"><abbr title="api.php">api.php</abbr></a></abbr>
289300
:
290-
<span class="phpdocumentor-element-found-in__line">1628</span>
291-
</aside>
301+
<span class="phpdocumentor-element-found-in__line">1639</span>
302+
303+
</aside>
292304

293305

294306
<code class="phpdocumentor-code phpdocumentor-signature ">
295307
<span class="phpdocumentor-signature__visibility">public</span>
296308
<span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$var</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
297309

298-
310+
<section class="phpdocumentor-description"></section>
311+
299312
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
300313
<dl class="phpdocumentor-argument-list">
301314
<dt class="phpdocumentor-argument-list__entry">
302315
<span class="phpdocumentor-signature__argument__name">$var</span>
303316
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
304317
</dt>
305318
<dd class="phpdocumentor-argument-list__definition">
306-
319+
<section class="phpdocumentor-description"></section>
320+
307321
</dd>
308322
<dt class="phpdocumentor-argument-list__entry">
309323
<span class="phpdocumentor-signature__argument__name">$value</span>
310324
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
311325
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
312326
<dd class="phpdocumentor-argument-list__definition">
313-
327+
<section class="phpdocumentor-description"></section>
328+
314329
</dd>
315330
</dl>
316331

@@ -319,12 +334,73 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
319334
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
320335
<span class="phpdocumentor-signature__response_type">mixed</span>
321336
&mdash;
322-
<section class="phpdocumentor-description"></section>
323-
337+
324338

325339
</article>
326340
</section>
327341

342+
343+
<script type="text/javascript">
344+
function loadExternalCodeSnippets(line) {
345+
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
346+
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
347+
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
348+
var language = 'php';
349+
350+
var code = document.createElement('code');
351+
code.className = 'language-' + language;
352+
353+
pre.textContent = '';
354+
355+
pre.setAttribute('data-line', line)
356+
code.textContent = 'Loading…';
357+
358+
pre.appendChild(code);
359+
360+
var xhr = new XMLHttpRequest();
361+
362+
xhr.open('GET', src, true);
363+
364+
xhr.onreadystatechange = function () {
365+
if (xhr.readyState == 4) {
366+
367+
if (xhr.status < 400 && xhr.responseText) {
368+
code.textContent = xhr.responseText;
369+
370+
Prism.highlightElement(code);
371+
}
372+
else if (xhr.status >= 400) {
373+
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
374+
}
375+
else {
376+
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
377+
}
378+
}
379+
};
380+
381+
xhr.send(null);
382+
});
383+
}
384+
385+
var modals = document.querySelectorAll("[data-modal]");
386+
387+
modals.forEach(function (trigger) {
388+
trigger.addEventListener("click", function (event) {
389+
//event.preventDefault();
390+
const modal = document.getElementById(trigger.dataset.modal);
391+
modal.classList.add("phpdocumentor-modal__open");
392+
loadExternalCodeSnippets(trigger.dataset.line)
393+
const exits = modal.querySelectorAll("[data-exit-button]");
394+
exits.forEach(function (exit) {
395+
exit.addEventListener("click", function (event) {
396+
event.preventDefault();
397+
modal.classList.remove("phpdocumentor-modal__open");
398+
});
399+
});
400+
});
401+
});
402+
</script>
403+
328404
</article>
329405
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
330406
<section class="phpdocumentor-search-results__dialog">
@@ -349,5 +425,6 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
349425
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
350426
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
351427
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
428+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
352429
</body>
353430
</html>

0 commit comments

Comments
 (0)