chillerlan-QRCode-Data-AlphaNum.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. AlphaNum
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">23</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :</p>
  109. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.3.3
  110. ISO/IEC 18004:2000 Section 8.4.3</p>
  111. </section>
  112. <h3 id="toc">
  113. Table of Contents
  114. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  115. </h3>
  116. <dl class="phpdocumentor-table-of-contents">
  117. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  118. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD">CHAR_TO_ORD</a>
  119. <span>
  120. &nbsp;= [&#039;0&#039; =&gt; 0, &#039;1&#039; =&gt; 1, &#039;2&#039; =&gt; 2, &#039;3&#039; =&gt; 3, &#039;4&#039; =&gt; 4, &#039;5&#039; =&gt; 5, &#039;6&#039; =&gt; 6, &#039;7&#039; =&gt; 7, &#039;8&#039; =&gt; 8, &#039;9&#039; =&gt; 9, &#039;A&#039; =&gt; 10, &#039;B&#039; =&gt; 11, &#039;C&#039; =&gt; 12, &#039;D&#039; =&gt; 13, &#039;E&#039; =&gt; 14, &#039;F&#039; =&gt; 15, &#039;G&#039; =&gt; 16, &#039;H&#039; =&gt; 17, &#039;I&#039; =&gt; 18, &#039;J&#039; =&gt; 19, &#039;K&#039; =&gt; 20, &#039;L&#039; =&gt; 21, &#039;M&#039; =&gt; 22, &#039;N&#039; =&gt; 23, &#039;O&#039; =&gt; 24, &#039;P&#039; =&gt; 25, &#039;Q&#039; =&gt; 26, &#039;R&#039; =&gt; 27, &#039;S&#039; =&gt; 28, &#039;T&#039; =&gt; 29, &#039;U&#039; =&gt; 30, &#039;V&#039; =&gt; 31, &#039;W&#039; =&gt; 32, &#039;X&#039; =&gt; 33, &#039;Y&#039; =&gt; 34, &#039;Z&#039; =&gt; 35, &#039; &#039; =&gt; 36, &#039;$&#039; =&gt; 37, &#039;%&#039; =&gt; 38, &#039;*&#039; =&gt; 39, &#039;+&#039; =&gt; 40, &#039;-&#039; =&gt; 41, &#039;.&#039; =&gt; 42, &#039;/&#039; =&gt; 43, &#039;:&#039; =&gt; 44] </span>
  121. </dt>
  122. <dd>ISO/IEC 18004:2000 Table 5</dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  124. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  125. <span>
  126. &nbsp;: string </span>
  127. </dt>
  128. <dd>The data to write</dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  130. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#property_datamode">$datamode</a>
  131. <span>
  132. &nbsp;: int </span>
  133. </dt>
  134. <dd>the current data mode: Num, Alphanum, Kanji, Hanzi, Byte</dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  136. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  137. <span>
  138. &nbsp;: mixed </span>
  139. </dt>
  140. <dd>QRDataModeAbstract constructor.</dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCode-Data-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-QRDataModeAbstract.html#method_getDataMode">getDataMode()</a>
  155. <span>
  156. &nbsp;: int </span>
  157. </dt>
  158. <dd>returns the current data mode constant</dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  160. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits">getLengthInBits()</a>
  161. <span>
  162. &nbsp;: int </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_validateString">validateString()</a>
  167. <span>
  168. &nbsp;: bool </span>
  169. </dt>
  170. <dd></dd>
  171. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  172. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write">write()</a>
  173. <span>
  174. &nbsp;: void </span>
  175. </dt>
  176. <dd></dd>
  177. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  178. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  179. <span>
  180. &nbsp;: int </span>
  181. </dt>
  182. <dd>returns the character count of the $data string</dd>
  183. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  184. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a>
  185. <span>
  186. &nbsp;: int </span>
  187. </dt>
  188. <dd>shortcut</dd>
  189. </dl>
  190. <section class="phpdocumentor-constants">
  191. <h3 class="phpdocumentor-elements__header" id="constants">
  192. Constants
  193. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  194. </h3>
  195. <article class="phpdocumentor-element -constant -private ">
  196. <h4 class="phpdocumentor-element__name" id="constant_CHAR_TO_ORD">
  197. CHAR_TO_ORD
  198. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#constant_CHAR_TO_ORD" class="headerlink"><i class="fas fa-link"></i></a>
  199. </h4>
  200. <aside class="phpdocumentor-element-found-in">
  201. <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>
  202. :
  203. <span class="phpdocumentor-element-found-in__line">30</span>
  204. </aside>
  205. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Table 5</p>
  206. <code class="phpdocumentor-signature phpdocumentor-code ">
  207. <span class="phpdocumentor-signature__visibility">private</span>
  208. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  209. <span class="phpdocumentor-signature__name">CHAR_TO_ORD</span>
  210. = <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>
  211. </code>
  212. </article>
  213. </section>
  214. <section class="phpdocumentor-properties">
  215. <h3 class="phpdocumentor-elements__header" id="properties">
  216. Properties
  217. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  218. </h3>
  219. <article
  220. class="
  221. phpdocumentor-element
  222. -property
  223. -protected
  224. "
  225. >
  226. <h4 class="phpdocumentor-element__name" id="property_data">
  227. $data
  228. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  229. <span class="phpdocumentor-element__modifiers">
  230. </span>
  231. </h4>
  232. <aside class="phpdocumentor-element-found-in">
  233. <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>
  234. :
  235. <span class="phpdocumentor-element-found-in__line">28</span>
  236. </aside>
  237. <p class="phpdocumentor-summary">The data to write</p>
  238. <code class="phpdocumentor-code phpdocumentor-signature ">
  239. <span class="phpdocumentor-signature__visibility">protected</span>
  240. <span class="phpdocumentor-signature__type">string</span>
  241. <span class="phpdocumentor-signature__name">$data</span>
  242. </code>
  243. <section class="phpdocumentor-description"></section>
  244. </article>
  245. <article
  246. class="
  247. phpdocumentor-element
  248. -property
  249. -protected
  250. -static "
  251. >
  252. <h4 class="phpdocumentor-element__name" id="property_datamode">
  253. $datamode
  254. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#property_datamode" class="headerlink"><i class="fas fa-link"></i></a>
  255. <span class="phpdocumentor-element__modifiers">
  256. </span>
  257. </h4>
  258. <aside class="phpdocumentor-element-found-in">
  259. <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>
  260. :
  261. <span class="phpdocumentor-element-found-in__line">42</span>
  262. </aside>
  263. <p class="phpdocumentor-summary">the current data mode: Num, Alphanum, Kanji, Hanzi, Byte</p>
  264. <code class="phpdocumentor-code phpdocumentor-signature ">
  265. <span class="phpdocumentor-signature__visibility">protected</span>
  266. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
  267. <span class="phpdocumentor-signature__name">$datamode</span>
  268. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::ALPHANUM</span></code>
  269. <section class="phpdocumentor-description"></section>
  270. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  271. Tags
  272. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  273. </h5>
  274. <dl class="phpdocumentor-tag-list">
  275. <dt class="phpdocumentor-tag-list__entry">
  276. <span class="phpdocumentor-tag__name">inheritDoc</span>
  277. </dt>
  278. <dd class="phpdocumentor-tag-list__definition">
  279. </dd>
  280. </dl>
  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">35</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">62</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">97</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_getDataMode">
  440. getDataMode()
  441. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode" 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/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">55</span>
  447. </aside>
  448. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  449. <code class="phpdocumentor-code phpdocumentor-signature ">
  450. <span class="phpdocumentor-signature__visibility">public</span>
  451. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  452. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  453. Tags
  454. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  455. </h5>
  456. <dl class="phpdocumentor-tag-list">
  457. <dt class="phpdocumentor-tag-list__entry">
  458. <span class="phpdocumentor-tag__name">inheritDoc</span>
  459. </dt>
  460. <dd class="phpdocumentor-tag-list__definition">
  461. </dd>
  462. </dl>
  463. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  464. <span class="phpdocumentor-signature__response_type">int</span>
  465. &mdash;
  466. </article>
  467. <article
  468. class="phpdocumentor-element
  469. -method
  470. -public
  471. "
  472. >
  473. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  474. getLengthInBits()
  475. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  476. </h4>
  477. <aside class="phpdocumentor-element-found-in">
  478. <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>
  479. :
  480. <span class="phpdocumentor-element-found-in__line">47</span>
  481. </aside>
  482. <code class="phpdocumentor-code phpdocumentor-signature ">
  483. <span class="phpdocumentor-signature__visibility">public</span>
  484. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  485. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  486. Tags
  487. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  488. </h5>
  489. <dl class="phpdocumentor-tag-list">
  490. <dt class="phpdocumentor-tag-list__entry">
  491. <span class="phpdocumentor-tag__name">inheritDoc</span>
  492. </dt>
  493. <dd class="phpdocumentor-tag-list__definition">
  494. </dd>
  495. </dl>
  496. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  497. <span class="phpdocumentor-signature__response_type">int</span>
  498. &mdash;
  499. </article>
  500. <article
  501. class="phpdocumentor-element
  502. -method
  503. -public
  504. -static "
  505. >
  506. <h4 class="phpdocumentor-element__name" id="method_validateString">
  507. validateString()
  508. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  509. </h4>
  510. <aside class="phpdocumentor-element-found-in">
  511. <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>
  512. :
  513. <span class="phpdocumentor-element-found-in__line">54</span>
  514. </aside>
  515. <code class="phpdocumentor-code phpdocumentor-signature ">
  516. <span class="phpdocumentor-signature__visibility">public</span>
  517. <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>
  518. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  519. <dl class="phpdocumentor-argument-list">
  520. <dt class="phpdocumentor-argument-list__entry">
  521. <span class="phpdocumentor-signature__argument__name">$string</span>
  522. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  523. </dt>
  524. <dd class="phpdocumentor-argument-list__definition">
  525. <section class="phpdocumentor-description"></section>
  526. </dd>
  527. </dl>
  528. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  529. Tags
  530. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  531. </h5>
  532. <dl class="phpdocumentor-tag-list">
  533. <dt class="phpdocumentor-tag-list__entry">
  534. <span class="phpdocumentor-tag__name">inheritDoc</span>
  535. </dt>
  536. <dd class="phpdocumentor-tag-list__definition">
  537. </dd>
  538. </dl>
  539. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  540. <span class="phpdocumentor-signature__response_type">bool</span>
  541. &mdash;
  542. </article>
  543. <article
  544. class="phpdocumentor-element
  545. -method
  546. -public
  547. "
  548. >
  549. <h4 class="phpdocumentor-element__name" id="method_write">
  550. write()
  551. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  552. </h4>
  553. <aside class="phpdocumentor-element-found-in">
  554. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/AlphaNum.php"><a href="files/src-data-alphanum.html"><abbr title="src/Data/AlphaNum.php">AlphaNum.php</abbr></a></abbr>
  555. :
  556. <span class="phpdocumentor-element-found-in__line">72</span>
  557. </aside>
  558. <code class="phpdocumentor-code phpdocumentor-signature ">
  559. <span class="phpdocumentor-signature__visibility">public</span>
  560. <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>
  561. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  562. <dl class="phpdocumentor-argument-list">
  563. <dt class="phpdocumentor-argument-list__entry">
  564. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  565. : <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>
  566. </dt>
  567. <dd class="phpdocumentor-argument-list__definition">
  568. <section class="phpdocumentor-description"></section>
  569. </dd>
  570. <dt class="phpdocumentor-argument-list__entry">
  571. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  572. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  573. </dt>
  574. <dd class="phpdocumentor-argument-list__definition">
  575. <section class="phpdocumentor-description"></section>
  576. </dd>
  577. </dl>
  578. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  579. Tags
  580. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  581. </h5>
  582. <dl class="phpdocumentor-tag-list">
  583. <dt class="phpdocumentor-tag-list__entry">
  584. <span class="phpdocumentor-tag__name">inheritDoc</span>
  585. </dt>
  586. <dd class="phpdocumentor-tag-list__definition">
  587. </dd>
  588. </dl>
  589. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  590. <span class="phpdocumentor-signature__response_type">void</span>
  591. &mdash;
  592. </article>
  593. <article
  594. class="phpdocumentor-element
  595. -method
  596. -protected
  597. "
  598. >
  599. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  600. getCharCount()
  601. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  602. </h4>
  603. <aside class="phpdocumentor-element-found-in">
  604. <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>
  605. :
  606. <span class="phpdocumentor-element-found-in__line">48</span>
  607. </aside>
  608. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  609. <code class="phpdocumentor-code phpdocumentor-signature ">
  610. <span class="phpdocumentor-signature__visibility">protected</span>
  611. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  612. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  613. <span class="phpdocumentor-signature__response_type">int</span>
  614. &mdash;
  615. </article>
  616. <article
  617. class="phpdocumentor-element
  618. -method
  619. -protected
  620. -static "
  621. >
  622. <h4 class="phpdocumentor-element__name" id="method_getLengthBits">
  623. getLengthBits()
  624. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h4>
  626. <aside class="phpdocumentor-element-found-in">
  627. <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>
  628. :
  629. <span class="phpdocumentor-element-found-in__line">69</span>
  630. </aside>
  631. <p class="phpdocumentor-summary">shortcut</p>
  632. <code class="phpdocumentor-code phpdocumentor-signature ">
  633. <span class="phpdocumentor-signature__visibility">protected</span>
  634. <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>
  635. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  636. <dl class="phpdocumentor-argument-list">
  637. <dt class="phpdocumentor-argument-list__entry">
  638. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  639. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  640. </dt>
  641. <dd class="phpdocumentor-argument-list__definition">
  642. <section class="phpdocumentor-description"></section>
  643. </dd>
  644. </dl>
  645. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  646. <span class="phpdocumentor-signature__response_type">int</span>
  647. &mdash;
  648. </article>
  649. </section>
  650. <script type="text/javascript">
  651. function loadExternalCodeSnippets(line) {
  652. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  653. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  654. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  655. var language = 'php';
  656. var code = document.createElement('code');
  657. code.className = 'language-' + language;
  658. pre.textContent = '';
  659. pre.setAttribute('data-line', line)
  660. code.textContent = 'Loading…';
  661. pre.appendChild(code);
  662. var xhr = new XMLHttpRequest();
  663. xhr.open('GET', src, true);
  664. xhr.onreadystatechange = function () {
  665. if (xhr.readyState == 4) {
  666. if (xhr.status < 400 && xhr.responseText) {
  667. code.textContent = xhr.responseText;
  668. Prism.highlightElement(code);
  669. }
  670. else if (xhr.status >= 400) {
  671. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  672. }
  673. else {
  674. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  675. }
  676. }
  677. };
  678. xhr.send(null);
  679. });
  680. }
  681. var modals = document.querySelectorAll("[data-modal]");
  682. modals.forEach(function (trigger) {
  683. trigger.addEventListener("click", function (event) {
  684. //event.preventDefault();
  685. const modal = document.getElementById(trigger.dataset.modal);
  686. modal.classList.add("phpdocumentor-modal__open");
  687. loadExternalCodeSnippets(trigger.dataset.line)
  688. const exits = modal.querySelectorAll("[data-exit-button]");
  689. exits.forEach(function (exit) {
  690. exit.addEventListener("click", function (event) {
  691. event.preventDefault();
  692. modal.classList.remove("phpdocumentor-modal__open");
  693. });
  694. });
  695. });
  696. });
  697. </script>
  698. </article>
  699. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  700. <section class="phpdocumentor-search-results__dialog">
  701. <header class="phpdocumentor-search-results__header">
  702. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  703. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  704. </header>
  705. <section class="phpdocumentor-search-results__body">
  706. <ul class="phpdocumentor-search-results__entries"></ul>
  707. </section>
  708. </section>
  709. </section>
  710. </div>
  711. </div>
  712. <a href="classes/chillerlan-QRCode-Data-AlphaNum.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  713. </main>
  714. <script>
  715. cssVars({});
  716. </script>
  717. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  718. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  719. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  720. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  721. </body>
  722. </html>