chillerlan-QRCode-Data-AlphaNum.html 41 KB

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