chillerlan-QRCode-Data-Number.html 44 KB

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