chillerlan-QRCode-Data-AlphaNum.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  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. <li class="phpdocumentor-topnav__menu-item -menu">
  44. <a href="https://php-qrcode.readthedocs.io">
  45. <span>
  46. User Manual
  47. </span>
  48. </a>
  49. </li>
  50. <li class="phpdocumentor-topnav__menu-item -social">
  51. <a href="https://github.com/chillerlan/php-qrcode">
  52. <span>
  53. <i class="fab fa-github"></i>
  54. </span>
  55. </a>
  56. </li>
  57. </ul>
  58. </nav>
  59. </header>
  60. <main class="phpdocumentor">
  61. <div class="phpdocumentor-section">
  62. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  63. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  64. Menu
  65. </label>
  66. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  71. </h4>
  72. <ul class="phpdocumentor-list">
  73. <li>
  74. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  75. </li>
  76. <li>
  77. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  78. </li>
  79. </ul>
  80. </section>
  81. <section class="phpdocumentor-sidebar__category">
  82. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  83. <h4 class="phpdocumentor-sidebar__root-namespace">
  84. <a href="packages/Application.html" class="">Application</a>
  85. </h4>
  86. </section>
  87. <section class="phpdocumentor-sidebar__category">
  88. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  89. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  92. </section>
  93. <section class="phpdocumentor-sidebar__category">
  94. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  96. </section>
  97. </aside>
  98. <div class="phpdocumentor-column -eight phpdocumentor-content">
  99. <ul class="phpdocumentor-breadcrumbs">
  100. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  101. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  103. </ul>
  104. <article class="phpdocumentor-element -class">
  105. <h2 class="phpdocumentor-content__title">
  106. AlphaNum
  107. <span class="phpdocumentor-element__extends">
  108. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  109. </span>
  110. <div class="phpdocumentor-element__package">
  111. in package
  112. <ul class="phpdocumentor-breadcrumbs">
  113. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  114. </ul>
  115. </div>
  116. </h2>
  117. <aside class="phpdocumentor-element-found-in">
  118. <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>
  119. :
  120. <span class="phpdocumentor-element-found-in__line">23</span>
  121. </aside>
  122. <p class="phpdocumentor-summary">Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :</p>
  123. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.3.3
  124. ISO/IEC 18004:2000 Section 8.4.3</p>
  125. </section>
  126. <h3 id="toc">
  127. Table of Contents
  128. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  129. </h3>
  130. <dl class="phpdocumentor-table-of-contents">
  131. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  132. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_DATAMODE">DATAMODE</a>
  133. <span>
  134. &nbsp;= \chillerlan\QRCode\Common\Mode::ALPHANUM </span>
  135. </dt>
  136. <dd></dd>
  137. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  138. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD">CHAR_TO_ORD</a>
  139. <span>
  140. &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>
  141. </dt>
  142. <dd>ISO/IEC 18004:2000 Table 5</dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  144. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  145. <span>
  146. &nbsp;: string </span>
  147. </dt>
  148. <dd>The data to write</dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  150. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  151. <span>
  152. &nbsp;: mixed </span>
  153. </dt>
  154. <dd>QRDataModeAbstract constructor.</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  156. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding">convertEncoding()</a>
  157. <span>
  158. &nbsp;: string </span>
  159. </dt>
  160. <dd>encoding conversion helper</dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  162. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_decodeSegment">decodeSegment()</a>
  163. <span>
  164. &nbsp;: string </span>
  165. </dt>
  166. <dd></dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  168. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits">getLengthInBits()</a>
  169. <span>
  170. &nbsp;: int </span>
  171. </dt>
  172. <dd></dd>
  173. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  174. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString">validateString()</a>
  175. <span>
  176. &nbsp;: bool </span>
  177. </dt>
  178. <dd></dd>
  179. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  180. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write">write()</a>
  181. <span>
  182. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a> </span>
  183. </dt>
  184. <dd></dd>
  185. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  186. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  187. <span>
  188. &nbsp;: int </span>
  189. </dt>
  190. <dd>returns the character count of the $data string</dd>
  191. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  192. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a>
  193. <span>
  194. &nbsp;: int </span>
  195. </dt>
  196. <dd>shortcut</dd>
  197. </dl>
  198. <section class="phpdocumentor-constants">
  199. <h3 class="phpdocumentor-elements__header" id="constants">
  200. Constants
  201. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  202. </h3>
  203. <article class="phpdocumentor-element -constant -public ">
  204. <h4 class="phpdocumentor-element__name" id="constant_DATAMODE">
  205. DATAMODE
  206. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_DATAMODE" class="headerlink"><i class="fas fa-link"></i></a>
  207. </h4>
  208. <aside class="phpdocumentor-element-found-in">
  209. <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>
  210. :
  211. <span class="phpdocumentor-element-found-in__line">42</span>
  212. </aside>
  213. <code class="phpdocumentor-signature phpdocumentor-code ">
  214. <span class="phpdocumentor-signature__visibility">public</span>
  215. <span class="phpdocumentor-signature__type">mixed</span>
  216. <span class="phpdocumentor-signature__name">DATAMODE</span>
  217. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::ALPHANUM</span>
  218. </code>
  219. <section class="phpdocumentor-description"></section>
  220. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  221. Tags
  222. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  223. </h5>
  224. <dl class="phpdocumentor-tag-list">
  225. <dt class="phpdocumentor-tag-list__entry">
  226. <span class="phpdocumentor-tag__name">inheritDoc</span>
  227. </dt>
  228. <dd class="phpdocumentor-tag-list__definition">
  229. </dd>
  230. </dl>
  231. </article>
  232. <article class="phpdocumentor-element -constant -private ">
  233. <h4 class="phpdocumentor-element__name" id="constant_CHAR_TO_ORD">
  234. CHAR_TO_ORD
  235. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD" class="headerlink"><i class="fas fa-link"></i></a>
  236. </h4>
  237. <aside class="phpdocumentor-element-found-in">
  238. <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>
  239. :
  240. <span class="phpdocumentor-element-found-in__line">30</span>
  241. </aside>
  242. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Table 5</p>
  243. <code class="phpdocumentor-signature phpdocumentor-code ">
  244. <span class="phpdocumentor-signature__visibility">private</span>
  245. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  246. <span class="phpdocumentor-signature__name">CHAR_TO_ORD</span>
  247. = <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>
  248. </code>
  249. </article>
  250. </section>
  251. <section class="phpdocumentor-properties">
  252. <h3 class="phpdocumentor-elements__header" id="properties">
  253. Properties
  254. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  255. </h3>
  256. <article
  257. class="
  258. phpdocumentor-element
  259. -property
  260. -protected
  261. "
  262. >
  263. <h4 class="phpdocumentor-element__name" id="property_data">
  264. $data
  265. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  266. <span class="phpdocumentor-element__modifiers">
  267. </span>
  268. </h4>
  269. <aside class="phpdocumentor-element-found-in">
  270. <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>
  271. :
  272. <span class="phpdocumentor-element-found-in__line">23</span>
  273. </aside>
  274. <p class="phpdocumentor-summary">The data to write</p>
  275. <code class="phpdocumentor-code phpdocumentor-signature ">
  276. <span class="phpdocumentor-signature__visibility">protected</span>
  277. <span class="phpdocumentor-signature__type">string</span>
  278. <span class="phpdocumentor-signature__name">$data</span>
  279. </code>
  280. <section class="phpdocumentor-description"></section>
  281. </article>
  282. </section>
  283. <section class="phpdocumentor-methods">
  284. <h3 class="phpdocumentor-elements__header" id="methods">
  285. Methods
  286. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  287. </h3>
  288. <article
  289. class="phpdocumentor-element
  290. -method
  291. -public
  292. "
  293. >
  294. <h4 class="phpdocumentor-element__name" id="method___construct">
  295. __construct()
  296. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  297. </h4>
  298. <aside class="phpdocumentor-element-found-in">
  299. <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>
  300. :
  301. <span class="phpdocumentor-element-found-in__line">30</span>
  302. </aside>
  303. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  304. <code class="phpdocumentor-code phpdocumentor-signature ">
  305. <span class="phpdocumentor-signature__visibility">public</span>
  306. <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>
  307. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  308. <dl class="phpdocumentor-argument-list">
  309. <dt class="phpdocumentor-argument-list__entry">
  310. <span class="phpdocumentor-signature__argument__name">$data</span>
  311. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  312. </dt>
  313. <dd class="phpdocumentor-argument-list__definition">
  314. <section class="phpdocumentor-description"></section>
  315. </dd>
  316. </dl>
  317. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  318. Tags
  319. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  320. </h5>
  321. <dl class="phpdocumentor-tag-list">
  322. <dt class="phpdocumentor-tag-list__entry">
  323. <span class="phpdocumentor-tag__name">throws</span>
  324. </dt>
  325. <dd class="phpdocumentor-tag-list__definition">
  326. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  327. </dd>
  328. </dl>
  329. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  330. <span class="phpdocumentor-signature__response_type">mixed</span>
  331. &mdash;
  332. </article>
  333. <article
  334. class="phpdocumentor-element
  335. -method
  336. -public
  337. -static "
  338. >
  339. <h4 class="phpdocumentor-element__name" id="method_convertEncoding">
  340. convertEncoding()
  341. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding" class="headerlink"><i class="fas fa-link"></i></a>
  342. </h4>
  343. <aside class="phpdocumentor-element-found-in">
  344. <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>
  345. :
  346. <span class="phpdocumentor-element-found-in__line">50</span>
  347. </aside>
  348. <p class="phpdocumentor-summary">encoding conversion helper</p>
  349. <code class="phpdocumentor-code phpdocumentor-signature ">
  350. <span class="phpdocumentor-signature__visibility">public</span>
  351. <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>
  352. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  353. <dl class="phpdocumentor-argument-list">
  354. <dt class="phpdocumentor-argument-list__entry">
  355. <span class="phpdocumentor-signature__argument__name">$string</span>
  356. : <span class="phpdocumentor-signature__argument__return-type">string</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. </dl>
  373. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  374. <span class="phpdocumentor-signature__response_type">string</span>
  375. &mdash;
  376. </article>
  377. <article
  378. class="phpdocumentor-element
  379. -method
  380. -public
  381. -static "
  382. >
  383. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  384. decodeSegment()
  385. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  386. </h4>
  387. <aside class="phpdocumentor-element-found-in">
  388. <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>
  389. :
  390. <span class="phpdocumentor-element-found-in__line">98</span>
  391. </aside>
  392. <code class="phpdocumentor-code phpdocumentor-signature ">
  393. <span class="phpdocumentor-signature__visibility">public</span>
  394. <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>
  395. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  396. <dl class="phpdocumentor-argument-list">
  397. <dt class="phpdocumentor-argument-list__entry">
  398. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  399. : <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>
  400. </dt>
  401. <dd class="phpdocumentor-argument-list__definition">
  402. <section class="phpdocumentor-description"></section>
  403. </dd>
  404. <dt class="phpdocumentor-argument-list__entry">
  405. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  406. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  407. </dt>
  408. <dd class="phpdocumentor-argument-list__definition">
  409. <section class="phpdocumentor-description"></section>
  410. </dd>
  411. </dl>
  412. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  413. Tags
  414. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  415. </h5>
  416. <dl class="phpdocumentor-tag-list">
  417. <dt class="phpdocumentor-tag-list__entry">
  418. <span class="phpdocumentor-tag__name">inheritDoc</span>
  419. </dt>
  420. <dd class="phpdocumentor-tag-list__definition">
  421. </dd>
  422. <dt class="phpdocumentor-tag-list__entry">
  423. <span class="phpdocumentor-tag__name">throws</span>
  424. </dt>
  425. <dd class="phpdocumentor-tag-list__definition">
  426. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  427. </dd>
  428. </dl>
  429. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  430. <span class="phpdocumentor-signature__response_type">string</span>
  431. &mdash;
  432. </article>
  433. <article
  434. class="phpdocumentor-element
  435. -method
  436. -public
  437. "
  438. >
  439. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  440. getLengthInBits()
  441. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  442. </h4>
  443. <aside class="phpdocumentor-element-found-in">
  444. <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>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">47</span>
  447. </aside>
  448. <code class="phpdocumentor-code phpdocumentor-signature ">
  449. <span class="phpdocumentor-signature__visibility">public</span>
  450. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  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">int</span>
  464. &mdash;
  465. </article>
  466. <article
  467. class="phpdocumentor-element
  468. -method
  469. -public
  470. -static "
  471. >
  472. <h4 class="phpdocumentor-element__name" id="method_validateString">
  473. validateString()
  474. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString" 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">54</span>
  480. </aside>
  481. <code class="phpdocumentor-code phpdocumentor-signature ">
  482. <span class="phpdocumentor-signature__visibility">public</span>
  483. <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>
  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">$string</span>
  488. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  489. </dt>
  490. <dd class="phpdocumentor-argument-list__definition">
  491. <section class="phpdocumentor-description"></section>
  492. </dd>
  493. </dl>
  494. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  495. Tags
  496. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  497. </h5>
  498. <dl class="phpdocumentor-tag-list">
  499. <dt class="phpdocumentor-tag-list__entry">
  500. <span class="phpdocumentor-tag__name">inheritDoc</span>
  501. </dt>
  502. <dd class="phpdocumentor-tag-list__definition">
  503. </dd>
  504. </dl>
  505. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  506. <span class="phpdocumentor-signature__response_type">bool</span>
  507. &mdash;
  508. </article>
  509. <article
  510. class="phpdocumentor-element
  511. -method
  512. -public
  513. "
  514. >
  515. <h4 class="phpdocumentor-element__name" id="method_write">
  516. write()
  517. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  518. </h4>
  519. <aside class="phpdocumentor-element-found-in">
  520. <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>
  521. :
  522. <span class="phpdocumentor-element-found-in__line">72</span>
  523. </aside>
  524. <code class="phpdocumentor-code phpdocumentor-signature ">
  525. <span class="phpdocumentor-signature__visibility">public</span>
  526. <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>
  527. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  528. <dl class="phpdocumentor-argument-list">
  529. <dt class="phpdocumentor-argument-list__entry">
  530. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  531. : <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>
  532. </dt>
  533. <dd class="phpdocumentor-argument-list__definition">
  534. <section class="phpdocumentor-description"></section>
  535. </dd>
  536. <dt class="phpdocumentor-argument-list__entry">
  537. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  538. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  539. </dt>
  540. <dd class="phpdocumentor-argument-list__definition">
  541. <section class="phpdocumentor-description"></section>
  542. </dd>
  543. </dl>
  544. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  545. Tags
  546. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  547. </h5>
  548. <dl class="phpdocumentor-tag-list">
  549. <dt class="phpdocumentor-tag-list__entry">
  550. <span class="phpdocumentor-tag__name">inheritDoc</span>
  551. </dt>
  552. <dd class="phpdocumentor-tag-list__definition">
  553. </dd>
  554. </dl>
  555. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  556. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></span>
  557. &mdash;
  558. </article>
  559. <article
  560. class="phpdocumentor-element
  561. -method
  562. -protected
  563. "
  564. >
  565. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  566. getCharCount()
  567. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  568. </h4>
  569. <aside class="phpdocumentor-element-found-in">
  570. <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>
  571. :
  572. <span class="phpdocumentor-element-found-in__line">43</span>
  573. </aside>
  574. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  575. <code class="phpdocumentor-code phpdocumentor-signature ">
  576. <span class="phpdocumentor-signature__visibility">protected</span>
  577. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  578. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  579. <span class="phpdocumentor-signature__response_type">int</span>
  580. &mdash;
  581. </article>
  582. <article
  583. class="phpdocumentor-element
  584. -method
  585. -protected
  586. -static "
  587. >
  588. <h4 class="phpdocumentor-element__name" id="method_getLengthBits">
  589. getLengthBits()
  590. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits" class="headerlink"><i class="fas fa-link"></i></a>
  591. </h4>
  592. <aside class="phpdocumentor-element-found-in">
  593. <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>
  594. :
  595. <span class="phpdocumentor-element-found-in__line">57</span>
  596. </aside>
  597. <p class="phpdocumentor-summary">shortcut</p>
  598. <code class="phpdocumentor-code phpdocumentor-signature ">
  599. <span class="phpdocumentor-signature__visibility">protected</span>
  600. <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>
  601. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  602. <dl class="phpdocumentor-argument-list">
  603. <dt class="phpdocumentor-argument-list__entry">
  604. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  605. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  606. </dt>
  607. <dd class="phpdocumentor-argument-list__definition">
  608. <section class="phpdocumentor-description"></section>
  609. </dd>
  610. </dl>
  611. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  612. <span class="phpdocumentor-signature__response_type">int</span>
  613. &mdash;
  614. </article>
  615. </section>
  616. <script type="text/javascript">
  617. function loadExternalCodeSnippets(line) {
  618. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  619. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  620. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  621. var language = 'php';
  622. var code = document.createElement('code');
  623. code.className = 'language-' + language;
  624. pre.textContent = '';
  625. pre.setAttribute('data-line', line)
  626. code.textContent = 'Loading…';
  627. pre.appendChild(code);
  628. var xhr = new XMLHttpRequest();
  629. xhr.open('GET', src, true);
  630. xhr.onreadystatechange = function () {
  631. if (xhr.readyState == 4) {
  632. if (xhr.status < 400 && xhr.responseText) {
  633. code.textContent = xhr.responseText;
  634. Prism.highlightElement(code);
  635. }
  636. else if (xhr.status >= 400) {
  637. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  638. }
  639. else {
  640. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  641. }
  642. }
  643. };
  644. xhr.send(null);
  645. });
  646. }
  647. var modals = document.querySelectorAll("[data-modal]");
  648. modals.forEach(function (trigger) {
  649. trigger.addEventListener("click", function (event) {
  650. //event.preventDefault();
  651. const modal = document.getElementById(trigger.dataset.modal);
  652. modal.classList.add("phpdocumentor-modal__open");
  653. loadExternalCodeSnippets(trigger.dataset.line)
  654. const exits = modal.querySelectorAll("[data-exit-button]");
  655. exits.forEach(function (exit) {
  656. exit.addEventListener("click", function (event) {
  657. event.preventDefault();
  658. modal.classList.remove("phpdocumentor-modal__open");
  659. });
  660. });
  661. });
  662. });
  663. </script>
  664. </article>
  665. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  666. <section class="phpdocumentor-search-results__dialog">
  667. <header class="phpdocumentor-search-results__header">
  668. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  669. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  670. </header>
  671. <section class="phpdocumentor-search-results__body">
  672. <ul class="phpdocumentor-search-results__entries"></ul>
  673. </section>
  674. </section>
  675. </section>
  676. </div>
  677. </div>
  678. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  679. </main>
  680. <script>
  681. cssVars({});
  682. </script>
  683. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  684. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  685. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  686. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  687. </body>
  688. </html>