chillerlan-QRCode-Data-QRDataModeAbstract.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  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/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRDataModeAbstract
  93. <div class="phpdocumentor-element__package">
  94. in package
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. <span class="phpdocumentor-element__implements">
  100. implements
  101. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a> </span>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">15</span>
  107. </aside>
  108. <h3 id="interfaces_class_traits">
  109. Interfaces, Classes, Traits and Enums
  110. <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
  111. </h3>
  112. <dl class="phpdocumentor-table-of-contents">
  113. <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></dt>
  114. <dd>Specifies the methods reqired for the data modules (Number, Alphanum, Byte and Kanji)</dd>
  115. </dl>
  116. <h3 id="toc">
  117. Table of Contents
  118. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  119. </h3>
  120. <dl class="phpdocumentor-table-of-contents">
  121. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  122. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  123. <span>
  124. &nbsp;: string </span>
  125. </dt>
  126. <dd>The data to write</dd>
  127. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  128. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_datamode">$datamode</a>
  129. <span>
  130. &nbsp;: int </span>
  131. </dt>
  132. <dd>the current data mode: Num, Alphanum, Kanji, Byte</dd>
  133. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  134. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  135. <span>
  136. &nbsp;: mixed </span>
  137. </dt>
  138. <dd>QRDataModeAbstract constructor.</dd>
  139. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  140. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode">getDataMode()</a>
  141. <span>
  142. &nbsp;: int </span>
  143. </dt>
  144. <dd>returns the current data mode constant</dd>
  145. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  146. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  147. <span>
  148. &nbsp;: int </span>
  149. </dt>
  150. <dd>returns the character count of the $data string</dd>
  151. </dl>
  152. <section class="phpdocumentor-properties">
  153. <h3 class="phpdocumentor-elements__header" id="properties">
  154. Properties
  155. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  156. </h3>
  157. <article
  158. class="
  159. phpdocumentor-element
  160. -property
  161. -protected
  162. "
  163. >
  164. <h4 class="phpdocumentor-element__name" id="property_data">
  165. $data
  166. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  167. <span class="phpdocumentor-element__modifiers">
  168. </span>
  169. </h4>
  170. <aside class="phpdocumentor-element-found-in">
  171. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  172. :
  173. <span class="phpdocumentor-element-found-in__line">25</span>
  174. </aside>
  175. <p class="phpdocumentor-summary">The data to write</p>
  176. <code class="phpdocumentor-code phpdocumentor-signature ">
  177. <span class="phpdocumentor-signature__visibility">protected</span>
  178. <span class="phpdocumentor-signature__type">string</span>
  179. <span class="phpdocumentor-signature__name">$data</span>
  180. </code>
  181. <section class="phpdocumentor-description"></section>
  182. </article>
  183. <article
  184. class="
  185. phpdocumentor-element
  186. -property
  187. -protected
  188. -static "
  189. >
  190. <h4 class="phpdocumentor-element__name" id="property_datamode">
  191. $datamode
  192. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_datamode" class="headerlink"><i class="fas fa-link"></i></a>
  193. <span class="phpdocumentor-element__modifiers">
  194. </span>
  195. </h4>
  196. <aside class="phpdocumentor-element-found-in">
  197. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  198. :
  199. <span class="phpdocumentor-element-found-in__line">20</span>
  200. </aside>
  201. <p class="phpdocumentor-summary">the current data mode: Num, Alphanum, Kanji, Byte</p>
  202. <code class="phpdocumentor-code phpdocumentor-signature ">
  203. <span class="phpdocumentor-signature__visibility">protected</span>
  204. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
  205. <span class="phpdocumentor-signature__name">$datamode</span>
  206. </code>
  207. <section class="phpdocumentor-description"></section>
  208. </article>
  209. </section>
  210. <section class="phpdocumentor-methods">
  211. <h3 class="phpdocumentor-elements__header" id="methods">
  212. Methods
  213. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  214. </h3>
  215. <article
  216. class="phpdocumentor-element
  217. -method
  218. -public
  219. "
  220. >
  221. <h4 class="phpdocumentor-element__name" id="method___construct">
  222. __construct()
  223. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  224. </h4>
  225. <aside class="phpdocumentor-element-found-in">
  226. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  227. :
  228. <span class="phpdocumentor-element-found-in__line">32</span>
  229. </aside>
  230. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  231. <code class="phpdocumentor-code phpdocumentor-signature ">
  232. <span class="phpdocumentor-signature__visibility">public</span>
  233. <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">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  234. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  235. <dl class="phpdocumentor-argument-list">
  236. <dt class="phpdocumentor-argument-list__entry">
  237. <span class="phpdocumentor-signature__argument__name">$data</span>
  238. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  239. </dt>
  240. <dd class="phpdocumentor-argument-list__definition">
  241. <section class="phpdocumentor-description"></section>
  242. </dd>
  243. </dl>
  244. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  245. Tags
  246. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  247. </h5>
  248. <dl class="phpdocumentor-tag-list">
  249. <dt class="phpdocumentor-tag-list__entry">
  250. <span class="phpdocumentor-tag__name">throws</span>
  251. </dt>
  252. <dd class="phpdocumentor-tag-list__definition">
  253. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  254. </dd>
  255. </dl>
  256. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  257. <span class="phpdocumentor-signature__response_type">mixed</span>
  258. &mdash;
  259. </article>
  260. <article
  261. class="phpdocumentor-element
  262. -method
  263. -public
  264. "
  265. >
  266. <h4 class="phpdocumentor-element__name" id="method_getDataMode">
  267. getDataMode()
  268. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode" class="headerlink"><i class="fas fa-link"></i></a>
  269. </h4>
  270. <aside class="phpdocumentor-element-found-in">
  271. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  272. :
  273. <span class="phpdocumentor-element-found-in__line">51</span>
  274. </aside>
  275. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  276. <code class="phpdocumentor-code phpdocumentor-signature ">
  277. <span class="phpdocumentor-signature__visibility">public</span>
  278. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  279. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  280. Tags
  281. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  282. </h5>
  283. <dl class="phpdocumentor-tag-list">
  284. <dt class="phpdocumentor-tag-list__entry">
  285. <span class="phpdocumentor-tag__name">inheritDoc</span>
  286. </dt>
  287. <dd class="phpdocumentor-tag-list__definition">
  288. </dd>
  289. </dl>
  290. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  291. <span class="phpdocumentor-signature__response_type">int</span>
  292. &mdash;
  293. </article>
  294. <article
  295. class="phpdocumentor-element
  296. -method
  297. -protected
  298. "
  299. >
  300. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  301. getCharCount()
  302. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  303. </h4>
  304. <aside class="phpdocumentor-element-found-in">
  305. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  306. :
  307. <span class="phpdocumentor-element-found-in__line">44</span>
  308. </aside>
  309. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  310. <code class="phpdocumentor-code phpdocumentor-signature ">
  311. <span class="phpdocumentor-signature__visibility">protected</span>
  312. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  313. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  314. <span class="phpdocumentor-signature__response_type">int</span>
  315. &mdash;
  316. </article>
  317. </section>
  318. <script type="text/javascript">
  319. function loadExternalCodeSnippets(line) {
  320. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  321. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  322. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  323. var language = 'php';
  324. var code = document.createElement('code');
  325. code.className = 'language-' + language;
  326. pre.textContent = '';
  327. pre.setAttribute('data-line', line)
  328. code.textContent = 'Loading…';
  329. pre.appendChild(code);
  330. var xhr = new XMLHttpRequest();
  331. xhr.open('GET', src, true);
  332. xhr.onreadystatechange = function () {
  333. if (xhr.readyState == 4) {
  334. if (xhr.status < 400 && xhr.responseText) {
  335. code.textContent = xhr.responseText;
  336. Prism.highlightElement(code);
  337. }
  338. else if (xhr.status >= 400) {
  339. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  340. }
  341. else {
  342. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  343. }
  344. }
  345. };
  346. xhr.send(null);
  347. });
  348. }
  349. var modals = document.querySelectorAll("[data-modal]");
  350. modals.forEach(function (trigger) {
  351. trigger.addEventListener("click", function (event) {
  352. //event.preventDefault();
  353. const modal = document.getElementById(trigger.dataset.modal);
  354. modal.classList.add("phpdocumentor-modal__open");
  355. loadExternalCodeSnippets(trigger.dataset.line)
  356. const exits = modal.querySelectorAll("[data-exit-button]");
  357. exits.forEach(function (exit) {
  358. exit.addEventListener("click", function (event) {
  359. event.preventDefault();
  360. modal.classList.remove("phpdocumentor-modal__open");
  361. });
  362. });
  363. });
  364. });
  365. </script>
  366. </article>
  367. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  368. <section class="phpdocumentor-search-results__dialog">
  369. <header class="phpdocumentor-search-results__header">
  370. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  371. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  372. </header>
  373. <section class="phpdocumentor-search-results__body">
  374. <ul class="phpdocumentor-search-results__entries"></ul>
  375. </section>
  376. </section>
  377. </section>
  378. </div>
  379. </div>
  380. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  381. </main>
  382. <script>
  383. cssVars({});
  384. </script>
  385. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  386. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  387. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  388. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  389. </body>
  390. </html>