chillerlan-QRCode-Data-Number.html 40 KB

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