chillerlan-QRCode-Data-Number.html 45 KB

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