chillerlan-QRCode-Data-QRDataModeAbstract.html 22 KB

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