chillerlan-QRCode-Data-AlphaNum.html 42 KB

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