bones.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  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="-active">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. </ul>
  84. <article class="phpdocumentor-element -package">
  85. <h2 class="phpdocumentor-content__title">bones</h2>
  86. <h3 id="interfaces_class_traits">
  87. Interfaces, Classes, Traits and Enums
  88. <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
  89. </h3>
  90. <dl class="phpdocumentor-table-of-contents">
  91. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/netico-Bones-Configuration.html"><abbr title="\netico\Bones\Configuration">Configuration</abbr></a></dt>
  92. <dd>The Configuration class retrieves configuration variables from an .ini file.</dd>
  93. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/netico-Bones-Obfuscation.html"><abbr title="\netico\Bones\Obfuscation">Obfuscation</abbr></a></dt>
  94. <dd>String obfuscation.</dd>
  95. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/netico-Bones-SQLite.html"><abbr title="\netico\Bones\SQLite">SQLite</abbr></a></dt>
  96. <dd>SQLite wrapper.</dd>
  97. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/netico-Bones-Template.html"><abbr title="\netico\Bones\Template">Template</abbr></a></dt>
  98. <dd>This basic template system gets you off to a start.</dd>
  99. </dl>
  100. <h3 id="toc">
  101. Table of Contents
  102. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  103. </h3>
  104. <dl class="phpdocumentor-table-of-contents">
  105. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  106. <a href="namespaces/default.html#constant_CONFIG">CONFIG</a>
  107. <span>
  108. &nbsp;= \realpath(&#039;../config/bones.ini&#039;) </span>
  109. </dt>
  110. <dd>Path to the configuration file.</dd>
  111. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  112. <a href="namespaces/default.html#constant_TEMPLATES">TEMPLATES</a>
  113. <span>
  114. &nbsp;= \realpath(&#039;../resources/templates&#039;) </span>
  115. </dt>
  116. <dd>Path to the folder that contains the templates.</dd>
  117. </dl>
  118. <section class="phpdocumentor-constants">
  119. <h3 class="phpdocumentor-elements__header" id="constants">
  120. Constants
  121. <a href="packages/bones.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  122. </h3>
  123. <article class="phpdocumentor-element -constant -public ">
  124. <h4 class="phpdocumentor-element__name" id="constant_CONFIG">
  125. CONFIG
  126. <a href="namespaces/default.html#constant_CONFIG" class="headerlink"><i class="fas fa-link"></i></a>
  127. </h4>
  128. <aside class="phpdocumentor-element-found-in">
  129. <abbr class="phpdocumentor-element-found-in__file" title="src/constants.php"><a href="files/src-constants.html"><abbr title="src/constants.php">constants.php</abbr></a></abbr>
  130. :
  131. <span class="phpdocumentor-element-found-in__line">16</span>
  132. </aside>
  133. <p class="phpdocumentor-summary">Path to the configuration file.</p>
  134. <code class="phpdocumentor-signature phpdocumentor-code ">
  135. <span class="phpdocumentor-signature__visibility">public</span>
  136. <span class="phpdocumentor-signature__type">mixed</span>
  137. <span class="phpdocumentor-signature__name">CONFIG</span>
  138. = <span class="phpdocumentor-signature__default-value">\realpath(&#039;../config/bones.ini&#039;)</span>
  139. </code>
  140. <section class="phpdocumentor-description"></section>
  141. </article>
  142. <article class="phpdocumentor-element -constant -public ">
  143. <h4 class="phpdocumentor-element__name" id="constant_TEMPLATES">
  144. TEMPLATES
  145. <a href="namespaces/default.html#constant_TEMPLATES" class="headerlink"><i class="fas fa-link"></i></a>
  146. </h4>
  147. <aside class="phpdocumentor-element-found-in">
  148. <abbr class="phpdocumentor-element-found-in__file" title="src/constants.php"><a href="files/src-constants.html"><abbr title="src/constants.php">constants.php</abbr></a></abbr>
  149. :
  150. <span class="phpdocumentor-element-found-in__line">20</span>
  151. </aside>
  152. <p class="phpdocumentor-summary">Path to the folder that contains the templates.</p>
  153. <code class="phpdocumentor-signature phpdocumentor-code ">
  154. <span class="phpdocumentor-signature__visibility">public</span>
  155. <span class="phpdocumentor-signature__type">mixed</span>
  156. <span class="phpdocumentor-signature__name">TEMPLATES</span>
  157. = <span class="phpdocumentor-signature__default-value">\realpath(&#039;../resources/templates&#039;)</span>
  158. </code>
  159. <section class="phpdocumentor-description"></section>
  160. </article>
  161. </section>
  162. </article>
  163. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  164. <section class="phpdocumentor-search-results__dialog">
  165. <header class="phpdocumentor-search-results__header">
  166. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  167. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  168. </header>
  169. <section class="phpdocumentor-search-results__body">
  170. <ul class="phpdocumentor-search-results__entries"></ul>
  171. </section>
  172. </section>
  173. </section>
  174. </div>
  175. </div>
  176. <a href="packages/bones.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  177. </main>
  178. <script>
  179. cssVars({});
  180. </script>
  181. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  182. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  183. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  184. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  185. </body>
  186. </html>