docs: update documentation
This commit is contained in:
parent
fbb00fab2f
commit
8b2f98184d
118 changed files with 59971 additions and 8570 deletions
|
|
@ -8,12 +8,16 @@
|
|||
<link rel="icon" href="images/favicon.ico"/>
|
||||
<link rel="stylesheet" href="css/normalize.css">
|
||||
<link rel="stylesheet" href="css/base.css">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
||||
<link rel="stylesheet" href="css/template.css">
|
||||
<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" />
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
||||
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
|
||||
<script src="js/search.js"></script>
|
||||
<script defer src="js/searchIndex.js"></script>
|
||||
</head>
|
||||
|
|
@ -48,10 +52,11 @@
|
|||
Menu
|
||||
</label>
|
||||
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
||||
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
||||
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
|
||||
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
|
||||
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
|
||||
<ul class="phpdocumentor-list">
|
||||
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
|
||||
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
||||
|
|
@ -61,8 +66,7 @@
|
|||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
|
||||
<ul class="phpdocumentor-list">
|
||||
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
||||
</ul>
|
||||
|
|
@ -95,7 +99,7 @@
|
|||
<div class="phpdocumentor-element__package">
|
||||
in package
|
||||
<ul class="phpdocumentor-breadcrumbs">
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -106,11 +110,11 @@
|
|||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">20</span>
|
||||
</aside>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Class providing variable type and value conversion functions.</p>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
|
|
@ -124,8 +128,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -215,8 +218,9 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">112</span>
|
||||
</aside>
|
||||
<span class="phpdocumentor-element-found-in__line">111</span>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Displays a variable.</p>
|
||||
|
||||
|
|
@ -224,8 +228,7 @@
|
|||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">debug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$p_mixed_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -251,8 +254,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
|
|
@ -268,8 +270,7 @@
|
|||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">void</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
<article
|
||||
|
|
@ -285,8 +286,9 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">84</span>
|
||||
</aside>
|
||||
<span class="phpdocumentor-element-found-in__line">86</span>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Get an HTML array short code depending on Arrow-Array key index.</p>
|
||||
|
||||
|
|
@ -294,8 +296,7 @@
|
|||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_arrow</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|array<string|int, string></span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -321,8 +322,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.3.2</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
|
|
@ -366,7 +366,8 @@
|
|||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">31</span>
|
||||
</aside>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer into the user-defined counter style for the footnotes.</p>
|
||||
|
||||
|
|
@ -374,8 +375,7 @@
|
|||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">index</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$convert_style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'arabic_plain'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -410,8 +410,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -437,7 +436,8 @@
|
|||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">58</span>
|
||||
</aside>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts a string depending on its value to a boolean.</p>
|
||||
|
||||
|
|
@ -445,8 +445,7 @@
|
|||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_bool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -472,8 +471,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0-beta</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
|
|
@ -507,8 +505,9 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">180</span>
|
||||
</aside>
|
||||
<span class="phpdocumentor-element-found-in__line">179</span>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer to a leading-0 integer.</p>
|
||||
|
||||
|
|
@ -516,8 +515,7 @@
|
|||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_arabic_leading</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -543,8 +541,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0-gamma</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
|
|
@ -578,8 +575,9 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">149</span>
|
||||
</aside>
|
||||
<span class="phpdocumentor-element-found-in__line">148</span>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer into Latin ASCII characters, either lower or upper-case.</p>
|
||||
|
||||
|
|
@ -625,8 +623,7 @@ gootnotes per Page).</p>
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0-gamma</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
|
|
@ -642,8 +639,7 @@ gootnotes per Page).</p>
|
|||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">string</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
<article
|
||||
|
|
@ -659,8 +655,9 @@ gootnotes per Page).</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">195</span>
|
||||
</aside>
|
||||
<span class="phpdocumentor-element-found-in__line">194</span>
|
||||
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer to a Roman numeral.</p>
|
||||
|
||||
|
|
@ -668,8 +665,7 @@ gootnotes per Page).</p>
|
|||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_roman</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
|
|
@ -704,20 +700,80 @@ gootnotes per Page).</p>
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0-gamma</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">string</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
function loadExternalCodeSnippets(line) {
|
||||
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
||||
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
|
||||
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
||||
var language = 'php';
|
||||
|
||||
var code = document.createElement('code');
|
||||
code.className = 'language-' + language;
|
||||
|
||||
pre.textContent = '';
|
||||
|
||||
pre.setAttribute('data-line', line)
|
||||
code.textContent = 'Loading…';
|
||||
|
||||
pre.appendChild(code);
|
||||
|
||||
var xhr = new XMLHttpRequest();
|
||||
|
||||
xhr.open('GET', src, true);
|
||||
|
||||
xhr.onreadystatechange = function () {
|
||||
if (xhr.readyState == 4) {
|
||||
|
||||
if (xhr.status < 400 && xhr.responseText) {
|
||||
code.textContent = xhr.responseText;
|
||||
|
||||
Prism.highlightElement(code);
|
||||
}
|
||||
else if (xhr.status >= 400) {
|
||||
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
||||
}
|
||||
else {
|
||||
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
xhr.send(null);
|
||||
});
|
||||
}
|
||||
|
||||
var modals = document.querySelectorAll("[data-modal]");
|
||||
|
||||
modals.forEach(function (trigger) {
|
||||
trigger.addEventListener("click", function (event) {
|
||||
//event.preventDefault();
|
||||
const modal = document.getElementById(trigger.dataset.modal);
|
||||
modal.classList.add("phpdocumentor-modal__open");
|
||||
loadExternalCodeSnippets(trigger.dataset.line)
|
||||
const exits = modal.querySelectorAll("[data-exit-button]");
|
||||
exits.forEach(function (exit) {
|
||||
exit.addEventListener("click", function (event) {
|
||||
event.preventDefault();
|
||||
modal.classList.remove("phpdocumentor-modal__open");
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
</script>
|
||||
|
||||
</article>
|
||||
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
||||
<section class="phpdocumentor-search-results__dialog">
|
||||
|
|
@ -739,5 +795,9 @@ gootnotes per Page).</p>
|
|||
<script>
|
||||
cssVars({});
|
||||
</script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Reference in a new issue