chillerlan-QRCode-Data-AlphaNum.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  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. AlphaNum
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">23</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :</p>
  109. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.3.3
  110. ISO/IEC 18004:2000 Section 8.4.3</p>
  111. </section>
  112. <h3 id="toc">
  113. Table of Contents
  114. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  115. </h3>
  116. <dl class="phpdocumentor-table-of-contents">
  117. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  118. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD">CHAR_TO_ORD</a>
  119. <span>
  120. &nbsp;= [&#039;0&#039; =&gt; 0, &#039;1&#039; =&gt; 1, &#039;2&#039; =&gt; 2, &#039;3&#039; =&gt; 3, &#039;4&#039; =&gt; 4, &#039;5&#039; =&gt; 5, &#039;6&#039; =&gt; 6, &#039;7&#039; =&gt; 7, &#039;8&#039; =&gt; 8, &#039;9&#039; =&gt; 9, &#039;A&#039; =&gt; 10, &#039;B&#039; =&gt; 11, &#039;C&#039; =&gt; 12, &#039;D&#039; =&gt; 13, &#039;E&#039; =&gt; 14, &#039;F&#039; =&gt; 15, &#039;G&#039; =&gt; 16, &#039;H&#039; =&gt; 17, &#039;I&#039; =&gt; 18, &#039;J&#039; =&gt; 19, &#039;K&#039; =&gt; 20, &#039;L&#039; =&gt; 21, &#039;M&#039; =&gt; 22, &#039;N&#039; =&gt; 23, &#039;O&#039; =&gt; 24, &#039;P&#039; =&gt; 25, &#039;Q&#039; =&gt; 26, &#039;R&#039; =&gt; 27, &#039;S&#039; =&gt; 28, &#039;T&#039; =&gt; 29, &#039;U&#039; =&gt; 30, &#039;V&#039; =&gt; 31, &#039;W&#039; =&gt; 32, &#039;X&#039; =&gt; 33, &#039;Y&#039; =&gt; 34, &#039;Z&#039; =&gt; 35, &#039; &#039; =&gt; 36, &#039;$&#039; =&gt; 37, &#039;%&#039; =&gt; 38, &#039;*&#039; =&gt; 39, &#039;+&#039; =&gt; 40, &#039;-&#039; =&gt; 41, &#039;.&#039; =&gt; 42, &#039;/&#039; =&gt; 43, &#039;:&#039; =&gt; 44] </span>
  121. </dt>
  122. <dd>ISO/IEC 18004:2000 Table 5</dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  124. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  125. <span>
  126. &nbsp;: string </span>
  127. </dt>
  128. <dd>The data to write</dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  130. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#property_datamode">$datamode</a>
  131. <span>
  132. &nbsp;: int </span>
  133. </dt>
  134. <dd>the current data mode: Num, Alphanum, Kanji, Byte</dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  136. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  137. <span>
  138. &nbsp;: mixed </span>
  139. </dt>
  140. <dd>QRDataModeAbstract constructor.</dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_decodeSegment">decodeSegment()</a>
  143. <span>
  144. &nbsp;: string </span>
  145. </dt>
  146. <dd></dd>
  147. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  148. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode">getDataMode()</a>
  149. <span>
  150. &nbsp;: int </span>
  151. </dt>
  152. <dd>returns the current data mode constant</dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  154. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits">getLengthInBits()</a>
  155. <span>
  156. &nbsp;: int </span>
  157. </dt>
  158. <dd></dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  160. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString">validateString()</a>
  161. <span>
  162. &nbsp;: bool </span>
  163. </dt>
  164. <dd></dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  166. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write">write()</a>
  167. <span>
  168. &nbsp;: void </span>
  169. </dt>
  170. <dd></dd>
  171. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  172. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  173. <span>
  174. &nbsp;: int </span>
  175. </dt>
  176. <dd>returns the character count of the $data string</dd>
  177. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  178. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a>
  179. <span>
  180. &nbsp;: int </span>
  181. </dt>
  182. <dd>shortcut</dd>
  183. </dl>
  184. <section class="phpdocumentor-constants">
  185. <h3 class="phpdocumentor-elements__header" id="constants">
  186. Constants
  187. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  188. </h3>
  189. <article class="phpdocumentor-element -constant -private ">
  190. <h4 class="phpdocumentor-element__name" id="constant_CHAR_TO_ORD">
  191. CHAR_TO_ORD
  192. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD" class="headerlink"><i class="fas fa-link"></i></a>
  193. </h4>
  194. <aside class="phpdocumentor-element-found-in">
  195. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  196. :
  197. <span class="phpdocumentor-element-found-in__line">30</span>
  198. </aside>
  199. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Table 5</p>
  200. <code class="phpdocumentor-signature phpdocumentor-code ">
  201. <span class="phpdocumentor-signature__visibility">private</span>
  202. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  203. <span class="phpdocumentor-signature__name">CHAR_TO_ORD</span>
  204. = <span class="phpdocumentor-signature__default-value">[&#039;0&#039; =&gt; 0, &#039;1&#039; =&gt; 1, &#039;2&#039; =&gt; 2, &#039;3&#039; =&gt; 3, &#039;4&#039; =&gt; 4, &#039;5&#039; =&gt; 5, &#039;6&#039; =&gt; 6, &#039;7&#039; =&gt; 7, &#039;8&#039; =&gt; 8, &#039;9&#039; =&gt; 9, &#039;A&#039; =&gt; 10, &#039;B&#039; =&gt; 11, &#039;C&#039; =&gt; 12, &#039;D&#039; =&gt; 13, &#039;E&#039; =&gt; 14, &#039;F&#039; =&gt; 15, &#039;G&#039; =&gt; 16, &#039;H&#039; =&gt; 17, &#039;I&#039; =&gt; 18, &#039;J&#039; =&gt; 19, &#039;K&#039; =&gt; 20, &#039;L&#039; =&gt; 21, &#039;M&#039; =&gt; 22, &#039;N&#039; =&gt; 23, &#039;O&#039; =&gt; 24, &#039;P&#039; =&gt; 25, &#039;Q&#039; =&gt; 26, &#039;R&#039; =&gt; 27, &#039;S&#039; =&gt; 28, &#039;T&#039; =&gt; 29, &#039;U&#039; =&gt; 30, &#039;V&#039; =&gt; 31, &#039;W&#039; =&gt; 32, &#039;X&#039; =&gt; 33, &#039;Y&#039; =&gt; 34, &#039;Z&#039; =&gt; 35, &#039; &#039; =&gt; 36, &#039;$&#039; =&gt; 37, &#039;%&#039; =&gt; 38, &#039;*&#039; =&gt; 39, &#039;+&#039; =&gt; 40, &#039;-&#039; =&gt; 41, &#039;.&#039; =&gt; 42, &#039;/&#039; =&gt; 43, &#039;:&#039; =&gt; 44]</span>
  205. </code>
  206. </article>
  207. </section>
  208. <section class="phpdocumentor-properties">
  209. <h3 class="phpdocumentor-elements__header" id="properties">
  210. Properties
  211. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  212. </h3>
  213. <article
  214. class="
  215. phpdocumentor-element
  216. -property
  217. -protected
  218. "
  219. >
  220. <h4 class="phpdocumentor-element__name" id="property_data">
  221. $data
  222. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  223. <span class="phpdocumentor-element__modifiers">
  224. </span>
  225. </h4>
  226. <aside class="phpdocumentor-element-found-in">
  227. <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>
  228. :
  229. <span class="phpdocumentor-element-found-in__line">27</span>
  230. </aside>
  231. <p class="phpdocumentor-summary">The data to write</p>
  232. <code class="phpdocumentor-code phpdocumentor-signature ">
  233. <span class="phpdocumentor-signature__visibility">protected</span>
  234. <span class="phpdocumentor-signature__type">string</span>
  235. <span class="phpdocumentor-signature__name">$data</span>
  236. </code>
  237. <section class="phpdocumentor-description"></section>
  238. </article>
  239. <article
  240. class="
  241. phpdocumentor-element
  242. -property
  243. -protected
  244. -static "
  245. >
  246. <h4 class="phpdocumentor-element__name" id="property_datamode">
  247. $datamode
  248. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#property_datamode" class="headerlink"><i class="fas fa-link"></i></a>
  249. <span class="phpdocumentor-element__modifiers">
  250. </span>
  251. </h4>
  252. <aside class="phpdocumentor-element-found-in">
  253. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  254. :
  255. <span class="phpdocumentor-element-found-in__line">42</span>
  256. </aside>
  257. <p class="phpdocumentor-summary">the current data mode: Num, Alphanum, Kanji, Byte</p>
  258. <code class="phpdocumentor-code phpdocumentor-signature ">
  259. <span class="phpdocumentor-signature__visibility">protected</span>
  260. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
  261. <span class="phpdocumentor-signature__name">$datamode</span>
  262. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::ALPHANUM</span></code>
  263. <section class="phpdocumentor-description"></section>
  264. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  265. Tags
  266. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  267. </h5>
  268. <dl class="phpdocumentor-tag-list">
  269. <dt class="phpdocumentor-tag-list__entry">
  270. <span class="phpdocumentor-tag__name">inheritDoc</span>
  271. </dt>
  272. <dd class="phpdocumentor-tag-list__definition">
  273. </dd>
  274. </dl>
  275. </article>
  276. </section>
  277. <section class="phpdocumentor-methods">
  278. <h3 class="phpdocumentor-elements__header" id="methods">
  279. Methods
  280. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  281. </h3>
  282. <article
  283. class="phpdocumentor-element
  284. -method
  285. -public
  286. "
  287. >
  288. <h4 class="phpdocumentor-element__name" id="method___construct">
  289. __construct()
  290. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  291. </h4>
  292. <aside class="phpdocumentor-element-found-in">
  293. <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>
  294. :
  295. <span class="phpdocumentor-element-found-in__line">34</span>
  296. </aside>
  297. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  298. <code class="phpdocumentor-code phpdocumentor-signature ">
  299. <span class="phpdocumentor-signature__visibility">public</span>
  300. <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>
  301. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  302. <dl class="phpdocumentor-argument-list">
  303. <dt class="phpdocumentor-argument-list__entry">
  304. <span class="phpdocumentor-signature__argument__name">$data</span>
  305. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  306. </dt>
  307. <dd class="phpdocumentor-argument-list__definition">
  308. <section class="phpdocumentor-description"></section>
  309. </dd>
  310. </dl>
  311. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  312. Tags
  313. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  314. </h5>
  315. <dl class="phpdocumentor-tag-list">
  316. <dt class="phpdocumentor-tag-list__entry">
  317. <span class="phpdocumentor-tag__name">throws</span>
  318. </dt>
  319. <dd class="phpdocumentor-tag-list__definition">
  320. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  321. </dd>
  322. </dl>
  323. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  324. <span class="phpdocumentor-signature__response_type">mixed</span>
  325. &mdash;
  326. </article>
  327. <article
  328. class="phpdocumentor-element
  329. -method
  330. -public
  331. -static "
  332. >
  333. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  334. decodeSegment()
  335. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">93</span>
  341. </aside>
  342. <code class="phpdocumentor-code phpdocumentor-signature ">
  343. <span class="phpdocumentor-signature__visibility">public</span>
  344. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">decodeSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionNumber</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  345. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  346. <dl class="phpdocumentor-argument-list">
  347. <dt class="phpdocumentor-argument-list__entry">
  348. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  349. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  350. </dt>
  351. <dd class="phpdocumentor-argument-list__definition">
  352. <section class="phpdocumentor-description"></section>
  353. </dd>
  354. <dt class="phpdocumentor-argument-list__entry">
  355. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  356. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  357. </dt>
  358. <dd class="phpdocumentor-argument-list__definition">
  359. <section class="phpdocumentor-description"></section>
  360. </dd>
  361. </dl>
  362. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  363. Tags
  364. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  365. </h5>
  366. <dl class="phpdocumentor-tag-list">
  367. <dt class="phpdocumentor-tag-list__entry">
  368. <span class="phpdocumentor-tag__name">inheritDoc</span>
  369. </dt>
  370. <dd class="phpdocumentor-tag-list__definition">
  371. </dd>
  372. <dt class="phpdocumentor-tag-list__entry">
  373. <span class="phpdocumentor-tag__name">throws</span>
  374. </dt>
  375. <dd class="phpdocumentor-tag-list__definition">
  376. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  377. </dd>
  378. </dl>
  379. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  380. <span class="phpdocumentor-signature__response_type">string</span>
  381. &mdash;
  382. </article>
  383. <article
  384. class="phpdocumentor-element
  385. -method
  386. -public
  387. "
  388. >
  389. <h4 class="phpdocumentor-element__name" id="method_getDataMode">
  390. getDataMode()
  391. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode" class="headerlink"><i class="fas fa-link"></i></a>
  392. </h4>
  393. <aside class="phpdocumentor-element-found-in">
  394. <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>
  395. :
  396. <span class="phpdocumentor-element-found-in__line">53</span>
  397. </aside>
  398. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  399. <code class="phpdocumentor-code phpdocumentor-signature ">
  400. <span class="phpdocumentor-signature__visibility">public</span>
  401. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  402. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  403. Tags
  404. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  405. </h5>
  406. <dl class="phpdocumentor-tag-list">
  407. <dt class="phpdocumentor-tag-list__entry">
  408. <span class="phpdocumentor-tag__name">inheritDoc</span>
  409. </dt>
  410. <dd class="phpdocumentor-tag-list__definition">
  411. </dd>
  412. </dl>
  413. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  414. <span class="phpdocumentor-signature__response_type">int</span>
  415. &mdash;
  416. </article>
  417. <article
  418. class="phpdocumentor-element
  419. -method
  420. -public
  421. "
  422. >
  423. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  424. getLengthInBits()
  425. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  426. </h4>
  427. <aside class="phpdocumentor-element-found-in">
  428. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  429. :
  430. <span class="phpdocumentor-element-found-in__line">47</span>
  431. </aside>
  432. <code class="phpdocumentor-code phpdocumentor-signature ">
  433. <span class="phpdocumentor-signature__visibility">public</span>
  434. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  435. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  436. Tags
  437. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  438. </h5>
  439. <dl class="phpdocumentor-tag-list">
  440. <dt class="phpdocumentor-tag-list__entry">
  441. <span class="phpdocumentor-tag__name">inheritDoc</span>
  442. </dt>
  443. <dd class="phpdocumentor-tag-list__definition">
  444. </dd>
  445. </dl>
  446. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  447. <span class="phpdocumentor-signature__response_type">int</span>
  448. &mdash;
  449. </article>
  450. <article
  451. class="phpdocumentor-element
  452. -method
  453. -public
  454. -static "
  455. >
  456. <h4 class="phpdocumentor-element__name" id="method_validateString">
  457. validateString()
  458. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  459. </h4>
  460. <aside class="phpdocumentor-element-found-in">
  461. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  462. :
  463. <span class="phpdocumentor-element-found-in__line">54</span>
  464. </aside>
  465. <code class="phpdocumentor-code phpdocumentor-signature ">
  466. <span class="phpdocumentor-signature__visibility">public</span>
  467. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">validateString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  468. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  469. <dl class="phpdocumentor-argument-list">
  470. <dt class="phpdocumentor-argument-list__entry">
  471. <span class="phpdocumentor-signature__argument__name">$string</span>
  472. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  473. </dt>
  474. <dd class="phpdocumentor-argument-list__definition">
  475. <section class="phpdocumentor-description"></section>
  476. </dd>
  477. </dl>
  478. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  479. Tags
  480. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  481. </h5>
  482. <dl class="phpdocumentor-tag-list">
  483. <dt class="phpdocumentor-tag-list__entry">
  484. <span class="phpdocumentor-tag__name">inheritDoc</span>
  485. </dt>
  486. <dd class="phpdocumentor-tag-list__definition">
  487. </dd>
  488. </dl>
  489. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  490. <span class="phpdocumentor-signature__response_type">bool</span>
  491. &mdash;
  492. </article>
  493. <article
  494. class="phpdocumentor-element
  495. -method
  496. -public
  497. "
  498. >
  499. <h4 class="phpdocumentor-element__name" id="method_write">
  500. write()
  501. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  502. </h4>
  503. <aside class="phpdocumentor-element-found-in">
  504. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  505. :
  506. <span class="phpdocumentor-element-found-in__line">68</span>
  507. </aside>
  508. <code class="phpdocumentor-code phpdocumentor-signature ">
  509. <span class="phpdocumentor-signature__visibility">public</span>
  510. <span class="phpdocumentor-signature__name">write</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionNumber</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  511. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  512. <dl class="phpdocumentor-argument-list">
  513. <dt class="phpdocumentor-argument-list__entry">
  514. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  515. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  516. </dt>
  517. <dd class="phpdocumentor-argument-list__definition">
  518. <section class="phpdocumentor-description"></section>
  519. </dd>
  520. <dt class="phpdocumentor-argument-list__entry">
  521. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  522. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  523. </dt>
  524. <dd class="phpdocumentor-argument-list__definition">
  525. <section class="phpdocumentor-description"></section>
  526. </dd>
  527. </dl>
  528. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  529. Tags
  530. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  531. </h5>
  532. <dl class="phpdocumentor-tag-list">
  533. <dt class="phpdocumentor-tag-list__entry">
  534. <span class="phpdocumentor-tag__name">inheritDoc</span>
  535. </dt>
  536. <dd class="phpdocumentor-tag-list__definition">
  537. </dd>
  538. </dl>
  539. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  540. <span class="phpdocumentor-signature__response_type">void</span>
  541. &mdash;
  542. </article>
  543. <article
  544. class="phpdocumentor-element
  545. -method
  546. -protected
  547. "
  548. >
  549. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  550. getCharCount()
  551. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  552. </h4>
  553. <aside class="phpdocumentor-element-found-in">
  554. <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>
  555. :
  556. <span class="phpdocumentor-element-found-in__line">46</span>
  557. </aside>
  558. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  559. <code class="phpdocumentor-code phpdocumentor-signature ">
  560. <span class="phpdocumentor-signature__visibility">protected</span>
  561. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  562. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  563. <span class="phpdocumentor-signature__response_type">int</span>
  564. &mdash;
  565. </article>
  566. <article
  567. class="phpdocumentor-element
  568. -method
  569. -protected
  570. -static "
  571. >
  572. <h4 class="phpdocumentor-element__name" id="method_getLengthBits">
  573. getLengthBits()
  574. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <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>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">60</span>
  580. </aside>
  581. <p class="phpdocumentor-summary">shortcut</p>
  582. <code class="phpdocumentor-code phpdocumentor-signature ">
  583. <span class="phpdocumentor-signature__visibility">protected</span>
  584. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getLengthBits</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionNumber</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  585. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  586. <dl class="phpdocumentor-argument-list">
  587. <dt class="phpdocumentor-argument-list__entry">
  588. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  589. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  590. </dt>
  591. <dd class="phpdocumentor-argument-list__definition">
  592. <section class="phpdocumentor-description"></section>
  593. </dd>
  594. </dl>
  595. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  596. <span class="phpdocumentor-signature__response_type">int</span>
  597. &mdash;
  598. </article>
  599. </section>
  600. <script type="text/javascript">
  601. function loadExternalCodeSnippets(line) {
  602. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  603. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  604. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  605. var language = 'php';
  606. var code = document.createElement('code');
  607. code.className = 'language-' + language;
  608. pre.textContent = '';
  609. pre.setAttribute('data-line', line)
  610. code.textContent = 'Loading…';
  611. pre.appendChild(code);
  612. var xhr = new XMLHttpRequest();
  613. xhr.open('GET', src, true);
  614. xhr.onreadystatechange = function () {
  615. if (xhr.readyState == 4) {
  616. if (xhr.status < 400 && xhr.responseText) {
  617. code.textContent = xhr.responseText;
  618. Prism.highlightElement(code);
  619. }
  620. else if (xhr.status >= 400) {
  621. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  622. }
  623. else {
  624. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  625. }
  626. }
  627. };
  628. xhr.send(null);
  629. });
  630. }
  631. var modals = document.querySelectorAll("[data-modal]");
  632. modals.forEach(function (trigger) {
  633. trigger.addEventListener("click", function (event) {
  634. //event.preventDefault();
  635. const modal = document.getElementById(trigger.dataset.modal);
  636. modal.classList.add("phpdocumentor-modal__open");
  637. loadExternalCodeSnippets(trigger.dataset.line)
  638. const exits = modal.querySelectorAll("[data-exit-button]");
  639. exits.forEach(function (exit) {
  640. exit.addEventListener("click", function (event) {
  641. event.preventDefault();
  642. modal.classList.remove("phpdocumentor-modal__open");
  643. });
  644. });
  645. });
  646. });
  647. </script>
  648. </article>
  649. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  650. <section class="phpdocumentor-search-results__dialog">
  651. <header class="phpdocumentor-search-results__header">
  652. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  653. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  654. </header>
  655. <section class="phpdocumentor-search-results__body">
  656. <ul class="phpdocumentor-search-results__entries"></ul>
  657. </section>
  658. </section>
  659. </section>
  660. </div>
  661. </div>
  662. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  663. </main>
  664. <script>
  665. cssVars({});
  666. </script>
  667. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  668. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  669. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  670. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  671. </body>
  672. </html>