netico-Bones-Template.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <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" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <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">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/netico.html" class="">netico</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/netico-bones.html" class="">Bones</a>
  61. </li>
  62. </ul>
  63. </section>
  64. <section class="phpdocumentor-sidebar__category">
  65. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  66. <h4 class="phpdocumentor-sidebar__root-namespace">
  67. <a href="packages/bones.html" class="">bones</a>
  68. </h4>
  69. </section>
  70. <section class="phpdocumentor-sidebar__category">
  71. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  74. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  75. </section>
  76. <section class="phpdocumentor-sidebar__category">
  77. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  78. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  79. </section>
  80. </aside>
  81. <div class="phpdocumentor-column -eight phpdocumentor-content">
  82. <ul class="phpdocumentor-breadcrumbs">
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/netico.html">netico</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/netico-bones.html">Bones</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. Template
  89. <div class="phpdocumentor-element__package">
  90. in package
  91. <ul class="phpdocumentor-breadcrumbs">
  92. <li class="phpdocumentor-breadcrumb"><a href="packages/bones.html">bones</a></li>
  93. </ul>
  94. </div>
  95. </h2>
  96. <aside class="phpdocumentor-element-found-in">
  97. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  98. :
  99. <span class="phpdocumentor-element-found-in__line">17</span>
  100. </aside>
  101. <p class="phpdocumentor-summary">This basic template system gets you off to a start.</p>
  102. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  103. Tags
  104. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  105. </h5>
  106. <dl class="phpdocumentor-tag-list">
  107. <dt class="phpdocumentor-tag-list__entry">
  108. <span class="phpdocumentor-tag__name">link</span>
  109. </dt>
  110. <dd class="phpdocumentor-tag-list__definition">
  111. <a class="phpdocumentor-tag-link" href="https://git.lattuga.net/netico/code-library/src/master/Framework"> https://git.lattuga.net/netico/code-library/src/master/Framework </a>
  112. </dd>
  113. <dt class="phpdocumentor-tag-list__entry">
  114. <span class="phpdocumentor-tag__name">copyright</span>
  115. </dt>
  116. <dd class="phpdocumentor-tag-list__definition">
  117. <section class="phpdocumentor-description"><p>Copyright (c) 2016, 2022 netico <a href="mailto:netico@riseup.net">netico@riseup.net</a></p>
  118. </section>
  119. </dd>
  120. <dt class="phpdocumentor-tag-list__entry">
  121. <span class="phpdocumentor-tag__name">license</span>
  122. </dt>
  123. <dd class="phpdocumentor-tag-list__definition">
  124. <section class="phpdocumentor-description"><p>https://www.gnu.org/licenses/gpl-3.0.en.html GNU General Public License</p>
  125. </section>
  126. </dd>
  127. <dt class="phpdocumentor-tag-list__entry">
  128. <span class="phpdocumentor-tag__name">author</span>
  129. </dt>
  130. <dd class="phpdocumentor-tag-list__definition">
  131. <section class="phpdocumentor-description"><p>netico <a href="mailto:netico@riseup.net">netico@riseup.net</a></p>
  132. </section>
  133. </dd>
  134. </dl>
  135. <h3 id="toc">
  136. Table of Contents
  137. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  138. </h3>
  139. <dl class="phpdocumentor-table-of-contents">
  140. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  141. <a href="classes/netico-Bones-Template.html#method___construct">__construct()</a>
  142. <span>
  143. &nbsp;: void </span>
  144. </dt>
  145. <dd>It requires the path to the template file.</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  147. <a href="classes/netico-Bones-Template.html#method_add">add()</a>
  148. <span>
  149. &nbsp;: void </span>
  150. </dt>
  151. <dd>The method adds a variable to the template.</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  153. <a href="classes/netico-Bones-Template.html#method_output">output()</a>
  154. <span>
  155. &nbsp;: void </span>
  156. </dt>
  157. <dd>This method prints the HTML code.</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  159. <a href="classes/netico-Bones-Template.html#method_rs">rs()</a>
  160. <span>
  161. &nbsp;: void </span>
  162. </dt>
  163. <dd>This method also provides support for repeating sections.</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  165. <a href="classes/netico-Bones-Template.html#method_section">section()</a>
  166. <span>
  167. &nbsp;: void </span>
  168. </dt>
  169. <dd>This method provides support for repeating sections.</dd>
  170. </dl>
  171. <section class="phpdocumentor-methods">
  172. <h3 class="phpdocumentor-elements__header" id="methods">
  173. Methods
  174. <a href="classes/netico-Bones-Template.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  175. </h3>
  176. <article
  177. class="phpdocumentor-element
  178. -method
  179. -public
  180. "
  181. >
  182. <h4 class="phpdocumentor-element__name" id="method___construct">
  183. __construct()
  184. <a href="classes/netico-Bones-Template.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  185. </h4>
  186. <aside class="phpdocumentor-element-found-in">
  187. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  188. :
  189. <span class="phpdocumentor-element-found-in__line">31</span>
  190. </aside>
  191. <p class="phpdocumentor-summary">It requires the path to the template file.</p>
  192. <code class="phpdocumentor-code phpdocumentor-signature ">
  193. <span class="phpdocumentor-signature__visibility">public</span>
  194. <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">$template</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  195. <section class="phpdocumentor-description"><p>You can refer to the TEMPLATES constant.</p>
  196. </section>
  197. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  198. <dl class="phpdocumentor-argument-list">
  199. <dt class="phpdocumentor-argument-list__entry">
  200. <span class="phpdocumentor-signature__argument__name">$template</span>
  201. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  202. </dt>
  203. <dd class="phpdocumentor-argument-list__definition">
  204. <section class="phpdocumentor-description"><p>File path to template file.</p>
  205. </section>
  206. </dd>
  207. </dl>
  208. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  209. <span class="phpdocumentor-signature__response_type">void</span>
  210. &mdash;
  211. </article>
  212. <article
  213. class="phpdocumentor-element
  214. -method
  215. -public
  216. "
  217. >
  218. <h4 class="phpdocumentor-element__name" id="method_add">
  219. add()
  220. <a href="classes/netico-Bones-Template.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
  221. </h4>
  222. <aside class="phpdocumentor-element-found-in">
  223. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  224. :
  225. <span class="phpdocumentor-element-found-in__line">61</span>
  226. </aside>
  227. <p class="phpdocumentor-summary">The method adds a variable to the template.</p>
  228. <code class="phpdocumentor-code phpdocumentor-signature ">
  229. <span class="phpdocumentor-signature__visibility">public</span>
  230. <span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  231. <section class="phpdocumentor-description"><p>This example describes how variables can be used within templates.</p>
  232. <p>PHP code:</p>
  233. <pre class="prettyprint"><code class="prettyprint"> $t = new template(&quot;template.tpl&quot;);
  234. $t-&gt;add(&quot;foo&quot;, &quot;Barletta&quot;);
  235. $t-&gt;output();
  236. </code></pre>
  237. <p>HTML code:</p>
  238. <pre class="prettyprint"><code class="prettyprint"> I love {foo}
  239. </code></pre>
  240. <p>Output:</p>
  241. <pre class="prettyprint"><code class="prettyprint"> I love Barletta
  242. </code></pre>
  243. </section>
  244. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  245. <dl class="phpdocumentor-argument-list">
  246. <dt class="phpdocumentor-argument-list__entry">
  247. <span class="phpdocumentor-signature__argument__name">$key</span>
  248. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  249. </dt>
  250. <dd class="phpdocumentor-argument-list__definition">
  251. </dd>
  252. <dt class="phpdocumentor-argument-list__entry">
  253. <span class="phpdocumentor-signature__argument__name">$value</span>
  254. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  255. </dt>
  256. <dd class="phpdocumentor-argument-list__definition">
  257. </dd>
  258. </dl>
  259. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  260. <span class="phpdocumentor-signature__response_type">void</span>
  261. &mdash;
  262. </article>
  263. <article
  264. class="phpdocumentor-element
  265. -method
  266. -public
  267. "
  268. >
  269. <h4 class="phpdocumentor-element__name" id="method_output">
  270. output()
  271. <a href="classes/netico-Bones-Template.html#method_output" class="headerlink"><i class="fas fa-link"></i></a>
  272. </h4>
  273. <aside class="phpdocumentor-element-found-in">
  274. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  275. :
  276. <span class="phpdocumentor-element-found-in__line">132</span>
  277. </aside>
  278. <p class="phpdocumentor-summary">This method prints the HTML code.</p>
  279. <code class="phpdocumentor-code phpdocumentor-signature ">
  280. <span class="phpdocumentor-signature__visibility">public</span>
  281. <span class="phpdocumentor-signature__name">output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  282. <section class="phpdocumentor-description"><p>Read https://stackoverflow.com/questions/6225351/how-to-minify-php-page-html-output,
  283. that explains how to minify HTML code.</p>
  284. </section>
  285. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  286. <dl class="phpdocumentor-argument-list">
  287. <dt class="phpdocumentor-argument-list__entry">
  288. <span class="phpdocumentor-signature__argument__name">$mime</span>
  289. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  290. </dt>
  291. <dd class="phpdocumentor-argument-list__definition">
  292. </dd>
  293. </dl>
  294. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  295. <span class="phpdocumentor-signature__response_type">void</span>
  296. &mdash;
  297. </article>
  298. <article
  299. class="phpdocumentor-element
  300. -method
  301. -public
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="method_rs">
  305. rs()
  306. <a href="classes/netico-Bones-Template.html#method_rs" class="headerlink"><i class="fas fa-link"></i></a>
  307. </h4>
  308. <aside class="phpdocumentor-element-found-in">
  309. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  310. :
  311. <span class="phpdocumentor-element-found-in__line">169</span>
  312. </aside>
  313. <p class="phpdocumentor-summary">This method also provides support for repeating sections.</p>
  314. <code class="phpdocumentor-code phpdocumentor-signature ">
  315. <span class="phpdocumentor-signature__visibility">public</span>
  316. <span class="phpdocumentor-signature__name">rs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$res</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$section</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  317. <section class="phpdocumentor-description"><p>The first parameter is an array constructed from the results of an SQL query.
  318. The second parameter indicates the section with the name used in the template.</p>
  319. <p>PHP code:</p>
  320. <pre class="prettyprint"><code class="prettyprint"> $db = new \netico\Bones\SQLite();
  321. $db-&gt;sql(&quot;SELECT [id], [title], [text] FROM pages ORDER BY [id] ASC;&quot;);
  322. $s-&gt;rs($db-&gt;data, &quot;pages&quot;);
  323. </code></pre>
  324. <p>HTML code:</p>
  325. <pre class="prettyprint"><code class="prettyprint"> &lt;!-- open(pages) --&gt;
  326. &lt;h2&gt;&lt;a name=&quot;{id}&quot;&gt;{id}. {title}&lt;/a&gt;&lt;/h2&gt;
  327. &lt;div&gt;{text}&lt;/div&gt;
  328. &lt;!-- close(pages) --&gt;
  329. </code></pre>
  330. </section>
  331. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  332. <dl class="phpdocumentor-argument-list">
  333. <dt class="phpdocumentor-argument-list__entry">
  334. <span class="phpdocumentor-signature__argument__name">$res</span>
  335. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  336. </dt>
  337. <dd class="phpdocumentor-argument-list__definition">
  338. </dd>
  339. <dt class="phpdocumentor-argument-list__entry">
  340. <span class="phpdocumentor-signature__argument__name">$section</span>
  341. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  342. </dt>
  343. <dd class="phpdocumentor-argument-list__definition">
  344. </dd>
  345. </dl>
  346. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  347. <span class="phpdocumentor-signature__response_type">void</span>
  348. &mdash;
  349. </article>
  350. <article
  351. class="phpdocumentor-element
  352. -method
  353. -public
  354. "
  355. >
  356. <h4 class="phpdocumentor-element__name" id="method_section">
  357. section()
  358. <a href="classes/netico-Bones-Template.html#method_section" class="headerlink"><i class="fas fa-link"></i></a>
  359. </h4>
  360. <aside class="phpdocumentor-element-found-in">
  361. <abbr class="phpdocumentor-element-found-in__file" title="src/Classes/Template.php"><a href="files/src-classes-template.html"><abbr title="src/Classes/Template.php">Template.php</abbr></a></abbr>
  362. :
  363. <span class="phpdocumentor-element-found-in__line">103</span>
  364. </aside>
  365. <p class="phpdocumentor-summary">This method provides support for repeating sections.</p>
  366. <code class="phpdocumentor-code phpdocumentor-signature ">
  367. <span class="phpdocumentor-signature__visibility">public</span>
  368. <span class="phpdocumentor-signature__name">section</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  369. <section class="phpdocumentor-description"><p>PHP code:</p>
  370. <pre class="prettyprint"><code class="prettyprint"> $t-&gt;section(&quot;planets&quot;);
  371. $t-&gt;add(&quot;planets.name&quot;, &quot;Neptune&quot;);
  372. $t-&gt;add(&quot;planets.group&quot;, &quot;Gas giant&quot;);
  373. $t-&gt;section(&quot;planets&quot;);
  374. $t-&gt;add(&quot;planets.name&quot;, &quot;Saturn&quot;);
  375. $t-&gt;add(&quot;planets.group&quot;, &quot;Gas giant&quot;);
  376. </code></pre>
  377. <p>HTML code</p>
  378. <pre class="prettyprint"><code class="prettyprint"> &lt;!-- open(planets) --&gt;;
  379. &lt;p&gt;Name: {name} - Group: {group}&lt;/p&gt;
  380. &lt;!-- close(planets) --&gt;;
  381. </code></pre>
  382. <p>Output:</p>
  383. <pre class="prettyprint"><code class="prettyprint"> Name: Neptune - Group: Gas giant
  384. Name: Saturn - Group: Gas giant
  385. </code></pre>
  386. </section>
  387. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  388. <dl class="phpdocumentor-argument-list">
  389. <dt class="phpdocumentor-argument-list__entry">
  390. <span class="phpdocumentor-signature__argument__name">$key</span>
  391. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  392. </dt>
  393. <dd class="phpdocumentor-argument-list__definition">
  394. </dd>
  395. </dl>
  396. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  397. <span class="phpdocumentor-signature__response_type">void</span>
  398. &mdash;
  399. </article>
  400. </section>
  401. <script type="text/javascript">
  402. function loadExternalCodeSnippets(line) {
  403. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  404. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  405. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  406. var language = 'php';
  407. var code = document.createElement('code');
  408. code.className = 'language-' + language;
  409. pre.textContent = '';
  410. pre.setAttribute('data-line', line)
  411. code.textContent = 'Loading…';
  412. pre.appendChild(code);
  413. var xhr = new XMLHttpRequest();
  414. xhr.open('GET', src, true);
  415. xhr.onreadystatechange = function () {
  416. if (xhr.readyState == 4) {
  417. if (xhr.status < 400 && xhr.responseText) {
  418. code.textContent = xhr.responseText;
  419. Prism.highlightElement(code);
  420. }
  421. else if (xhr.status >= 400) {
  422. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  423. }
  424. else {
  425. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  426. }
  427. }
  428. };
  429. xhr.send(null);
  430. });
  431. }
  432. var modals = document.querySelectorAll("[data-modal]");
  433. modals.forEach(function (trigger) {
  434. trigger.addEventListener("click", function (event) {
  435. //event.preventDefault();
  436. const modal = document.getElementById(trigger.dataset.modal);
  437. modal.classList.add("phpdocumentor-modal__open");
  438. loadExternalCodeSnippets(trigger.dataset.line)
  439. const exits = modal.querySelectorAll("[data-exit-button]");
  440. exits.forEach(function (exit) {
  441. exit.addEventListener("click", function (event) {
  442. event.preventDefault();
  443. modal.classList.remove("phpdocumentor-modal__open");
  444. });
  445. });
  446. });
  447. });
  448. </script>
  449. </article>
  450. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  451. <section class="phpdocumentor-search-results__dialog">
  452. <header class="phpdocumentor-search-results__header">
  453. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  454. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  455. </header>
  456. <section class="phpdocumentor-search-results__body">
  457. <ul class="phpdocumentor-search-results__entries"></ul>
  458. </section>
  459. </section>
  460. </section>
  461. </div>
  462. </div>
  463. <a href="classes/netico-Bones-Template.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  464. </main>
  465. <script>
  466. cssVars({});
  467. </script>
  468. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  469. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  470. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  471. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  472. </body>
  473. </html>