chillerlan-QRCode-Data-Number.html 41 KB

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