| 1271 |
ariadna |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html lang="en">
|
|
|
3 |
<head>
|
|
|
4 |
<meta charset="utf-8">
|
|
|
5 |
<title>Documentation</title>
|
|
|
6 |
|
|
|
7 |
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
8 |
<base href="../">
|
|
|
9 |
<link rel="icon" href="images/favicon.ico"/>
|
|
|
10 |
<link rel="stylesheet" href="css/normalize.css">
|
|
|
11 |
<link rel="stylesheet" href="css/base.css">
|
|
|
12 |
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
|
13 |
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
|
14 |
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
|
15 |
<link rel="stylesheet" href="css/template.css">
|
|
|
16 |
<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" />
|
|
|
17 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
|
18 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
|
19 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
|
20 |
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
|
21 |
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
|
22 |
<script src="js/template.js"></script>
|
|
|
23 |
<script src="js/search.js"></script>
|
|
|
24 |
<script defer src="js/searchIndex.js"></script>
|
|
|
25 |
</head>
|
|
|
26 |
<body id="top">
|
|
|
27 |
<header class="phpdocumentor-header phpdocumentor-section">
|
|
|
28 |
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
|
29 |
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
|
30 |
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
|
31 |
<i class="fas fa-bars"></i>
|
|
|
32 |
</label>
|
|
|
33 |
<section data-search-form class="phpdocumentor-search">
|
|
|
34 |
<label>
|
|
|
35 |
<span class="visually-hidden">Search for</span>
|
|
|
36 |
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
|
37 |
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
|
38 |
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
|
39 |
</svg>
|
|
|
40 |
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
|
41 |
</label>
|
|
|
42 |
</section>
|
|
|
43 |
|
|
|
44 |
<nav class="phpdocumentor-topnav">
|
|
|
45 |
<ul class="phpdocumentor-topnav__menu">
|
|
|
46 |
</ul>
|
|
|
47 |
</nav>
|
|
|
48 |
</header>
|
|
|
49 |
|
|
|
50 |
<main class="phpdocumentor">
|
|
|
51 |
<div class="phpdocumentor-section">
|
|
|
52 |
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
|
53 |
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
|
54 |
Menu
|
|
|
55 |
</label>
|
|
|
56 |
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
|
|
|
57 |
|
|
|
58 |
<section class="phpdocumentor-sidebar__category -reports">
|
|
|
59 |
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
|
60 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
|
61 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
|
62 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
|
63 |
</section>
|
|
|
64 |
|
|
|
65 |
<section class="phpdocumentor-sidebar__category -indices">
|
|
|
66 |
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
|
67 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
|
68 |
</section>
|
|
|
69 |
</aside>
|
|
|
70 |
|
|
|
71 |
<div class="phpdocumentor-column -nine phpdocumentor-content">
|
|
|
72 |
<section>
|
|
|
73 |
<ul class="phpdocumentor-breadcrumbs">
|
|
|
74 |
</ul>
|
|
|
75 |
|
|
|
76 |
<article class="phpdocumentor-element -package">
|
|
|
77 |
<h2 class="phpdocumentor-content__title">API Documentation</h2>
|
|
|
78 |
|
|
|
79 |
|
|
|
80 |
<h3 id="toc">
|
|
|
81 |
Table of Contents
|
|
|
82 |
<a href="packages/default.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
83 |
|
|
|
84 |
</h3>
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
|
|
|
88 |
|
|
|
89 |
|
|
|
90 |
|
|
|
91 |
|
|
|
92 |
|
|
|
93 |
|
|
|
94 |
|
|
|
95 |
|
|
|
96 |
|
|
|
97 |
|
|
|
98 |
|
|
|
99 |
|
|
|
100 |
<div class="phpdocumentor-modal" id="source-view">
|
|
|
101 |
<div class="phpdocumentor-modal-bg" data-exit-button></div>
|
|
|
102 |
<div class="phpdocumentor-modal-container">
|
|
|
103 |
<div class="phpdocumentor-modal-content">
|
|
|
104 |
<pre style="max-height: 500px; overflow-y: scroll" data-src="" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
|
105 |
</div>
|
|
|
106 |
<button data-exit-button class="phpdocumentor-modal__close">×</button>
|
|
|
107 |
</div>
|
|
|
108 |
</div>
|
|
|
109 |
|
|
|
110 |
<script type="text/javascript">
|
|
|
111 |
(function () {
|
|
|
112 |
function loadExternalCodeSnippet(el, url, line) {
|
|
|
113 |
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
|
114 |
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
|
|
|
115 |
const language = 'php';
|
|
|
116 |
|
|
|
117 |
const code = document.createElement('code');
|
|
|
118 |
code.className = 'language-' + language;
|
|
|
119 |
pre.textContent = '';
|
|
|
120 |
pre.setAttribute('data-line', line)
|
|
|
121 |
code.textContent = 'Loading…';
|
|
|
122 |
pre.appendChild(code);
|
|
|
123 |
|
|
|
124 |
var xhr = new XMLHttpRequest();
|
|
|
125 |
|
|
|
126 |
xhr.open('GET', src, true);
|
|
|
127 |
|
|
|
128 |
xhr.onreadystatechange = function () {
|
|
|
129 |
if (xhr.readyState !== 4) {
|
|
|
130 |
return;
|
|
|
131 |
}
|
|
|
132 |
|
|
|
133 |
if (xhr.status < 400 && xhr.responseText) {
|
|
|
134 |
code.textContent = xhr.responseText;
|
|
|
135 |
Prism.highlightElement(code);
|
|
|
136 |
return;
|
|
|
137 |
}
|
|
|
138 |
|
|
|
139 |
if (xhr.status === 404) {
|
|
|
140 |
code.textContent = '✖ Error: File could not be found';
|
|
|
141 |
return;
|
|
|
142 |
}
|
|
|
143 |
|
|
|
144 |
if (xhr.status >= 400) {
|
|
|
145 |
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
146 |
return;
|
|
|
147 |
}
|
|
|
148 |
|
|
|
149 |
code.textContent = '✖ Error: An unknown error occurred';
|
|
|
150 |
};
|
|
|
151 |
|
|
|
152 |
xhr.send(null);
|
|
|
153 |
});
|
|
|
154 |
}
|
|
|
155 |
|
|
|
156 |
const modalButtons = document.querySelectorAll("[data-modal]");
|
|
|
157 |
const openedAsLocalFile = window.location.protocol === 'file:';
|
|
|
158 |
if (modalButtons.length > 0 && openedAsLocalFile) {
|
|
|
159 |
console.warn(
|
|
|
160 |
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
|
|
|
161 |
'browsers block XHR requests when a page is opened this way'
|
|
|
162 |
);
|
|
|
163 |
}
|
|
|
164 |
|
|
|
165 |
modalButtons.forEach(function (trigger) {
|
|
|
166 |
if (openedAsLocalFile) {
|
|
|
167 |
trigger.setAttribute("hidden", "hidden");
|
|
|
168 |
}
|
|
|
169 |
|
|
|
170 |
trigger.addEventListener("click", function (event) {
|
|
|
171 |
event.preventDefault();
|
|
|
172 |
const modal = document.getElementById(trigger.dataset.modal);
|
|
|
173 |
if (!modal) {
|
|
|
174 |
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
|
|
|
175 |
return;
|
|
|
176 |
}
|
|
|
177 |
modal.classList.add("phpdocumentor-modal__open");
|
|
|
178 |
|
|
|
179 |
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
|
|
|
180 |
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
|
181 |
exits.forEach(function (exit) {
|
|
|
182 |
exit.addEventListener("click", function (event) {
|
|
|
183 |
event.preventDefault();
|
|
|
184 |
modal.classList.remove("phpdocumentor-modal__open");
|
|
|
185 |
});
|
|
|
186 |
});
|
|
|
187 |
});
|
|
|
188 |
});
|
|
|
189 |
})();
|
|
|
190 |
</script>
|
|
|
191 |
|
|
|
192 |
</article>
|
|
|
193 |
</section>
|
|
|
194 |
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
195 |
|
|
|
196 |
<section class="phpdocumentor-on-this-page__content">
|
|
|
197 |
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
198 |
|
|
|
199 |
<ul class="phpdocumentor-list -clean">
|
|
|
200 |
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
|
201 |
<li>
|
|
|
202 |
<ul class="phpdocumentor-list -clean">
|
|
|
203 |
</ul>
|
|
|
204 |
</li>
|
|
|
205 |
|
|
|
206 |
|
|
|
207 |
</ul>
|
|
|
208 |
</section>
|
|
|
209 |
|
|
|
210 |
</section>
|
|
|
211 |
</div>
|
|
|
212 |
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
|
213 |
<section class="phpdocumentor-search-results__dialog">
|
|
|
214 |
<header class="phpdocumentor-search-results__header">
|
|
|
215 |
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
|
216 |
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
|
217 |
</header>
|
|
|
218 |
<section class="phpdocumentor-search-results__body">
|
|
|
219 |
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
|
220 |
</section>
|
|
|
221 |
</section>
|
|
|
222 |
</section>
|
|
|
223 |
</div>
|
|
|
224 |
<a href="packages/default.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
225 |
|
|
|
226 |
</main>
|
|
|
227 |
|
|
|
228 |
<script>
|
|
|
229 |
cssVars({});
|
|
|
230 |
</script>
|
|
|
231 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
|
232 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
|
233 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
|
234 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
|
235 |
</body>
|
|
|
236 |
</html>
|