chillerlan-QRCode-Data-Byte.html 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. Byte
  119. <span class="phpdocumentor-element__extends">
  120. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  121. </span>
  122. <div class="phpdocumentor-element__package">
  123. in package
  124. <ul class="phpdocumentor-breadcrumbs">
  125. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  126. </ul>
  127. </div>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  131. </div>
  132. <aside class="phpdocumentor-element-found-in">
  133. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  134. :
  135. <span class="phpdocumentor-element-found-in__line">22</span>
  136. </aside>
  137. <p class="phpdocumentor-summary">8-bit Byte mode, ISO-8859-1 or UTF-8</p>
  138. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.3.4
  139. ISO/IEC 18004:2000 Section 8.4.4</p>
  140. </section>
  141. <h3 id="toc">
  142. Table of Contents
  143. <a href="classes/chillerlan-QRCode-Data-Byte.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  144. </h3>
  145. <h4 id="toc-constants">
  146. Constants
  147. <a href="classes/chillerlan-QRCode-Data-Byte.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  148. </h4>
  149. <dl class="phpdocumentor-table-of-contents">
  150. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  151. <a class="" href="classes/chillerlan-QRCode-Data-Byte.html#constant_DATAMODE">DATAMODE</a>
  152. <span>
  153. &nbsp;= \chillerlan\QRCode\Common\Mode::BYTE </span>
  154. </dt>
  155. </dl>
  156. <h4 id="toc-properties">
  157. Properties
  158. <a href="classes/chillerlan-QRCode-Data-Byte.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  159. </h4>
  160. <dl class="phpdocumentor-table-of-contents">
  161. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  162. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  163. <span>
  164. &nbsp;: string </span>
  165. </dt>
  166. <dd>The data to write</dd>
  167. </dl>
  168. <h4 id="toc-methods">
  169. Methods
  170. <a href="classes/chillerlan-QRCode-Data-Byte.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  171. </h4>
  172. <dl class="phpdocumentor-table-of-contents">
  173. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  174. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  175. <span>
  176. &nbsp;: mixed </span>
  177. </dt>
  178. <dd>QRDataModeAbstract constructor.</dd>
  179. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  180. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding">convertEncoding()</a>
  181. <span>
  182. &nbsp;: string </span>
  183. </dt>
  184. <dd>encoding conversion helper</dd>
  185. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  186. <a class="" href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment">decodeSegment()</a>
  187. <span>
  188. &nbsp;: string </span>
  189. </dt>
  190. <dd>reads a segment from the BitBuffer and decodes in the current data mode</dd>
  191. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  192. <a class="" href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits">getLengthInBits()</a>
  193. <span>
  194. &nbsp;: int </span>
  195. </dt>
  196. <dd>retruns the length in bits of the data string</dd>
  197. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  198. <a class="" href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString">validateString()</a>
  199. <span>
  200. &nbsp;: bool </span>
  201. </dt>
  202. <dd>checks if the given string qualifies for the encoder module</dd>
  203. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  204. <a class="" href="classes/chillerlan-QRCode-Data-Byte.html#method_write">write()</a>
  205. <span>
  206. &nbsp;: static </span>
  207. </dt>
  208. <dd>writes the actual data string to the BitBuffer, uses the given version to determine the length bits</dd>
  209. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  210. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  211. <span>
  212. &nbsp;: int </span>
  213. </dt>
  214. <dd>returns the character count of the $data string</dd>
  215. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  216. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a>
  217. <span>
  218. &nbsp;: int </span>
  219. </dt>
  220. <dd>shortcut</dd>
  221. </dl>
  222. <section class="phpdocumentor-constants">
  223. <h3 class="phpdocumentor-elements__header" id="constants">
  224. Constants
  225. <a href="classes/chillerlan-QRCode-Data-Byte.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  226. </h3>
  227. <article class="phpdocumentor-element -constant -public ">
  228. <h4 class="phpdocumentor-element__name" id="constant_DATAMODE">
  229. DATAMODE
  230. <a href="classes/chillerlan-QRCode-Data-Byte.html#constant_DATAMODE" class="headerlink"><i class="fas fa-link"></i></a>
  231. </h4>
  232. <aside class="phpdocumentor-element-found-in">
  233. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  234. :
  235. <span class="phpdocumentor-element-found-in__line">27</span>
  236. </aside>
  237. <code class="phpdocumentor-signature phpdocumentor-code ">
  238. <span class="phpdocumentor-signature__visibility">public</span>
  239. <span class="phpdocumentor-signature__type">mixed</span>
  240. <span class="phpdocumentor-signature__name">DATAMODE</span>
  241. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::BYTE</span>
  242. </code>
  243. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  244. Tags
  245. <a href="classes/chillerlan-QRCode-Data-Byte.html#constant_DATAMODE#tags" class="headerlink"><i class="fas fa-link"></i></a>
  246. </h5>
  247. <dl class="phpdocumentor-tag-list">
  248. <dt class="phpdocumentor-tag-list__entry">
  249. <span class="phpdocumentor-tag__name">inheritDoc</span>
  250. </dt>
  251. <dd class="phpdocumentor-tag-list__definition">
  252. </dd>
  253. </dl>
  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-Byte.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. </article>
  286. </section>
  287. <section class="phpdocumentor-methods">
  288. <h3 class="phpdocumentor-elements__header" id="methods">
  289. Methods
  290. <a href="classes/chillerlan-QRCode-Data-Byte.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  291. </h3>
  292. <article
  293. class="phpdocumentor-element
  294. -method
  295. -public
  296. "
  297. >
  298. <h4 class="phpdocumentor-element__name" id="method___construct">
  299. __construct()
  300. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  301. </h4>
  302. <aside class="phpdocumentor-element-found-in">
  303. <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>
  304. :
  305. <span class="phpdocumentor-element-found-in__line">30</span>
  306. </aside>
  307. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  308. <code class="phpdocumentor-code phpdocumentor-signature ">
  309. <span class="phpdocumentor-signature__visibility">public</span>
  310. <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>
  311. <div class="phpdocumentor-label-line">
  312. </div>
  313. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  314. <dl class="phpdocumentor-argument-list">
  315. <dt class="phpdocumentor-argument-list__entry">
  316. <span class="phpdocumentor-signature__argument__name">$data</span>
  317. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  318. </dt>
  319. <dd class="phpdocumentor-argument-list__definition">
  320. </dd>
  321. </dl>
  322. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  323. Tags
  324. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct#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. </article>
  335. <article
  336. class="phpdocumentor-element
  337. -method
  338. -public
  339. -static "
  340. >
  341. <h4 class="phpdocumentor-element__name" id="method_convertEncoding">
  342. convertEncoding()
  343. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding" class="headerlink"><i class="fas fa-link"></i></a>
  344. </h4>
  345. <aside class="phpdocumentor-element-found-in">
  346. <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>
  347. :
  348. <span class="phpdocumentor-element-found-in__line">50</span>
  349. </aside>
  350. <p class="phpdocumentor-summary">encoding conversion helper</p>
  351. <code class="phpdocumentor-code phpdocumentor-signature ">
  352. <span class="phpdocumentor-signature__visibility">public</span>
  353. <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>
  354. <div class="phpdocumentor-label-line">
  355. </div>
  356. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  357. <dl class="phpdocumentor-argument-list">
  358. <dt class="phpdocumentor-argument-list__entry">
  359. <span class="phpdocumentor-signature__argument__name">$string</span>
  360. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  361. </dt>
  362. <dd class="phpdocumentor-argument-list__definition">
  363. </dd>
  364. </dl>
  365. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  366. Tags
  367. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding#tags" class="headerlink"><i class="fas fa-link"></i></a>
  368. </h5>
  369. <dl class="phpdocumentor-tag-list">
  370. <dt class="phpdocumentor-tag-list__entry">
  371. <span class="phpdocumentor-tag__name">inheritDoc</span>
  372. </dt>
  373. <dd class="phpdocumentor-tag-list__definition">
  374. </dd>
  375. </dl>
  376. <section>
  377. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  378. <span class="phpdocumentor-signature__response_type">string</span>
  379. </section>
  380. </article>
  381. <article
  382. class="phpdocumentor-element
  383. -method
  384. -public
  385. -static "
  386. >
  387. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  388. decodeSegment()
  389. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  390. </h4>
  391. <aside class="phpdocumentor-element-found-in">
  392. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  393. :
  394. <span class="phpdocumentor-element-found-in__line">69</span>
  395. </aside>
  396. <p class="phpdocumentor-summary">reads a segment from the BitBuffer and decodes in the current data mode</p>
  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. <div class="phpdocumentor-label-line">
  401. </div>
  402. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  403. <dl class="phpdocumentor-argument-list">
  404. <dt class="phpdocumentor-argument-list__entry">
  405. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  406. : <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>
  407. </dt>
  408. <dd class="phpdocumentor-argument-list__definition">
  409. </dd>
  410. <dt class="phpdocumentor-argument-list__entry">
  411. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  412. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  413. </dt>
  414. <dd class="phpdocumentor-argument-list__definition">
  415. </dd>
  416. </dl>
  417. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  418. Tags
  419. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment#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. <section>
  435. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  436. <span class="phpdocumentor-signature__response_type">string</span>
  437. </section>
  438. </article>
  439. <article
  440. class="phpdocumentor-element
  441. -method
  442. -public
  443. "
  444. >
  445. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  446. getLengthInBits()
  447. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  448. </h4>
  449. <aside class="phpdocumentor-element-found-in">
  450. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  451. :
  452. <span class="phpdocumentor-element-found-in__line">32</span>
  453. </aside>
  454. <p class="phpdocumentor-summary">retruns the length in bits of the data string</p>
  455. <code class="phpdocumentor-code phpdocumentor-signature ">
  456. <span class="phpdocumentor-signature__visibility">public</span>
  457. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  458. <div class="phpdocumentor-label-line">
  459. </div>
  460. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  461. Tags
  462. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits#tags" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h5>
  464. <dl class="phpdocumentor-tag-list">
  465. <dt class="phpdocumentor-tag-list__entry">
  466. <span class="phpdocumentor-tag__name">inheritDoc</span>
  467. </dt>
  468. <dd class="phpdocumentor-tag-list__definition">
  469. </dd>
  470. </dl>
  471. <section>
  472. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  473. <span class="phpdocumentor-signature__response_type">int</span>
  474. </section>
  475. </article>
  476. <article
  477. class="phpdocumentor-element
  478. -method
  479. -public
  480. -static "
  481. >
  482. <h4 class="phpdocumentor-element__name" id="method_validateString">
  483. validateString()
  484. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  485. </h4>
  486. <aside class="phpdocumentor-element-found-in">
  487. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  488. :
  489. <span class="phpdocumentor-element-found-in__line">39</span>
  490. </aside>
  491. <p class="phpdocumentor-summary">checks if the given string qualifies for the encoder module</p>
  492. <code class="phpdocumentor-code phpdocumentor-signature ">
  493. <span class="phpdocumentor-signature__visibility">public</span>
  494. <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>
  495. <div class="phpdocumentor-label-line">
  496. </div>
  497. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  498. <dl class="phpdocumentor-argument-list">
  499. <dt class="phpdocumentor-argument-list__entry">
  500. <span class="phpdocumentor-signature__argument__name">$string</span>
  501. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  502. </dt>
  503. <dd class="phpdocumentor-argument-list__definition">
  504. </dd>
  505. </dl>
  506. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  507. Tags
  508. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString#tags" class="headerlink"><i class="fas fa-link"></i></a>
  509. </h5>
  510. <dl class="phpdocumentor-tag-list">
  511. <dt class="phpdocumentor-tag-list__entry">
  512. <span class="phpdocumentor-tag__name">inheritDoc</span>
  513. </dt>
  514. <dd class="phpdocumentor-tag-list__definition">
  515. </dd>
  516. </dl>
  517. <section>
  518. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  519. <span class="phpdocumentor-signature__response_type">bool</span>
  520. </section>
  521. </article>
  522. <article
  523. class="phpdocumentor-element
  524. -method
  525. -public
  526. "
  527. >
  528. <h4 class="phpdocumentor-element__name" id="method_write">
  529. write()
  530. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  531. </h4>
  532. <aside class="phpdocumentor-element-found-in">
  533. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  534. :
  535. <span class="phpdocumentor-element-found-in__line">46</span>
  536. </aside>
  537. <p class="phpdocumentor-summary">writes the actual data string to the BitBuffer, uses the given version to determine the length bits</p>
  538. <code class="phpdocumentor-code phpdocumentor-signature ">
  539. <span class="phpdocumentor-signature__visibility">public</span>
  540. <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">static</span></code>
  541. <div class="phpdocumentor-label-line">
  542. </div>
  543. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  544. <dl class="phpdocumentor-argument-list">
  545. <dt class="phpdocumentor-argument-list__entry">
  546. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  547. : <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>
  548. </dt>
  549. <dd class="phpdocumentor-argument-list__definition">
  550. </dd>
  551. <dt class="phpdocumentor-argument-list__entry">
  552. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  553. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  554. </dt>
  555. <dd class="phpdocumentor-argument-list__definition">
  556. </dd>
  557. </dl>
  558. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  559. Tags
  560. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_write#tags" class="headerlink"><i class="fas fa-link"></i></a>
  561. </h5>
  562. <dl class="phpdocumentor-tag-list">
  563. <dt class="phpdocumentor-tag-list__entry">
  564. <span class="phpdocumentor-tag__name">inheritDoc</span>
  565. </dt>
  566. <dd class="phpdocumentor-tag-list__definition">
  567. </dd>
  568. </dl>
  569. <section>
  570. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  571. <span class="phpdocumentor-signature__response_type">static</span>
  572. </section>
  573. </article>
  574. <article
  575. class="phpdocumentor-element
  576. -method
  577. -protected
  578. "
  579. >
  580. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  581. getCharCount()
  582. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  583. </h4>
  584. <aside class="phpdocumentor-element-found-in">
  585. <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>
  586. :
  587. <span class="phpdocumentor-element-found-in__line">43</span>
  588. </aside>
  589. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  590. <code class="phpdocumentor-code phpdocumentor-signature ">
  591. <span class="phpdocumentor-signature__visibility">protected</span>
  592. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  593. <div class="phpdocumentor-label-line">
  594. </div>
  595. <section>
  596. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  597. <span class="phpdocumentor-signature__response_type">int</span>
  598. </section>
  599. </article>
  600. <article
  601. class="phpdocumentor-element
  602. -method
  603. -protected
  604. -static "
  605. >
  606. <h4 class="phpdocumentor-element__name" id="method_getLengthBits">
  607. getLengthBits()
  608. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits" class="headerlink"><i class="fas fa-link"></i></a>
  609. </h4>
  610. <aside class="phpdocumentor-element-found-in">
  611. <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>
  612. :
  613. <span class="phpdocumentor-element-found-in__line">57</span>
  614. </aside>
  615. <p class="phpdocumentor-summary">shortcut</p>
  616. <code class="phpdocumentor-code phpdocumentor-signature ">
  617. <span class="phpdocumentor-signature__visibility">protected</span>
  618. <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>
  619. <div class="phpdocumentor-label-line">
  620. </div>
  621. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  622. <dl class="phpdocumentor-argument-list">
  623. <dt class="phpdocumentor-argument-list__entry">
  624. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  625. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  626. </dt>
  627. <dd class="phpdocumentor-argument-list__definition">
  628. </dd>
  629. </dl>
  630. <section>
  631. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  632. <span class="phpdocumentor-signature__response_type">int</span>
  633. </section>
  634. </article>
  635. </section>
  636. <div class="phpdocumentor-modal" id="source-view">
  637. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  638. <div class="phpdocumentor-modal-container">
  639. <div class="phpdocumentor-modal-content">
  640. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Data/Byte.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  641. </div>
  642. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  643. </div>
  644. </div>
  645. <script type="text/javascript">
  646. (function () {
  647. function loadExternalCodeSnippet(el, url, line) {
  648. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  649. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  650. const language = 'php';
  651. const code = document.createElement('code');
  652. code.className = 'language-' + language;
  653. pre.textContent = '';
  654. pre.setAttribute('data-line', line)
  655. code.textContent = 'Loading…';
  656. pre.appendChild(code);
  657. var xhr = new XMLHttpRequest();
  658. xhr.open('GET', src, true);
  659. xhr.onreadystatechange = function () {
  660. if (xhr.readyState !== 4) {
  661. return;
  662. }
  663. if (xhr.status < 400 && xhr.responseText) {
  664. code.textContent = xhr.responseText;
  665. Prism.highlightElement(code);
  666. return;
  667. }
  668. if (xhr.status === 404) {
  669. code.textContent = '✖ Error: File could not be found';
  670. return;
  671. }
  672. if (xhr.status >= 400) {
  673. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  674. return;
  675. }
  676. code.textContent = '✖ Error: An unknown error occurred';
  677. };
  678. xhr.send(null);
  679. });
  680. }
  681. const modalButtons = document.querySelectorAll("[data-modal]");
  682. const openedAsLocalFile = window.location.protocol === 'file:';
  683. if (modalButtons.length > 0 && openedAsLocalFile) {
  684. console.warn(
  685. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  686. 'browsers block XHR requests when a page is opened this way'
  687. );
  688. }
  689. modalButtons.forEach(function (trigger) {
  690. if (openedAsLocalFile) {
  691. trigger.setAttribute("hidden", "hidden");
  692. }
  693. trigger.addEventListener("click", function (event) {
  694. event.preventDefault();
  695. const modal = document.getElementById(trigger.dataset.modal);
  696. if (!modal) {
  697. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  698. return;
  699. }
  700. modal.classList.add("phpdocumentor-modal__open");
  701. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  702. const exits = modal.querySelectorAll("[data-exit-button]");
  703. exits.forEach(function (exit) {
  704. exit.addEventListener("click", function (event) {
  705. event.preventDefault();
  706. modal.classList.remove("phpdocumentor-modal__open");
  707. });
  708. });
  709. });
  710. });
  711. })();
  712. </script>
  713. </article>
  714. </section>
  715. <section class="phpdocumentor-on-this-page__sidebar">
  716. <section class="phpdocumentor-on-this-page__content">
  717. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  718. <ul class="phpdocumentor-list -clean">
  719. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  720. <li>
  721. <ul class="phpdocumentor-list -clean">
  722. <li><a href="classes/chillerlan-QRCode-Data-Byte.html#toc-constants">Constants</a></li>
  723. <li><a href="classes/chillerlan-QRCode-Data-Byte.html#toc-properties">Properties</a></li>
  724. <li><a href="classes/chillerlan-QRCode-Data-Byte.html#toc-methods">Methods</a></li>
  725. </ul>
  726. </li>
  727. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  728. <li>
  729. <ul class="phpdocumentor-list -clean">
  730. <li class=""><a href="classes/chillerlan-QRCode-Data-Byte.html#constant_DATAMODE">DATAMODE</a></li>
  731. </ul>
  732. </li>
  733. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  734. <li>
  735. <ul class="phpdocumentor-list -clean">
  736. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</li>
  737. </ul>
  738. </li>
  739. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  740. <li>
  741. <ul class="phpdocumentor-list -clean">
  742. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a></li>
  743. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding">convertEncoding()</a></li>
  744. <li class=""><a href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment">decodeSegment()</a></li>
  745. <li class=""><a href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits">getLengthInBits()</a></li>
  746. <li class=""><a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString">validateString()</a></li>
  747. <li class=""><a href="classes/chillerlan-QRCode-Data-Byte.html#method_write">write()</a></li>
  748. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a></li>
  749. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a></li>
  750. </ul>
  751. </li>
  752. </ul>
  753. </section>
  754. </section>
  755. </div>
  756. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  757. <section class="phpdocumentor-search-results__dialog">
  758. <header class="phpdocumentor-search-results__header">
  759. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  760. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  761. </header>
  762. <section class="phpdocumentor-search-results__body">
  763. <ul class="phpdocumentor-search-results__entries"></ul>
  764. </section>
  765. </section>
  766. </section>
  767. </div>
  768. <a href="classes/chillerlan-QRCode-Data-Byte.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  769. </main>
  770. <script>
  771. cssVars({});
  772. </script>
  773. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  774. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  775. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  776. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  777. </body>
  778. </html>