chillerlan-QRCode-Decoder-Decoder.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. Decoder
  93. <div class="phpdocumentor-element__package">
  94. in package
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">26</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">The main class which implements QR Code decoding -- as opposed to locating and extracting
  106. the QR Code from an image.</p>
  107. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  108. Tags
  109. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  110. </h5>
  111. <dl class="phpdocumentor-tag-list">
  112. <dt class="phpdocumentor-tag-list__entry">
  113. <span class="phpdocumentor-tag__name">author</span>
  114. </dt>
  115. <dd class="phpdocumentor-tag-list__definition">
  116. <section class="phpdocumentor-description"><p>Sean Owen</p>
  117. </section>
  118. </dd>
  119. </dl>
  120. <h3 id="toc">
  121. Table of Contents
  122. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  123. </h3>
  124. <dl class="phpdocumentor-table-of-contents">
  125. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  126. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode">decode()</a>
  127. <span>
  128. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  129. </dt>
  130. <dd>Decodes a QR Code represented as a BitMatrix.</dd>
  131. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  132. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_correctErrors">correctErrors()</a>
  133. <span>
  134. &nbsp;: array&lt;string|int, mixed&gt; </span>
  135. </dt>
  136. <dd>Given data and error-correction codewords received, possibly corrupted by errors, attempts to
  137. correct the errors in-place using Reed-Solomon error correction.</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  139. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream">decodeBitStream()</a>
  140. <span>
  141. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  145. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix">decodeMatrix()</a>
  146. <span>
  147. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  148. </dt>
  149. <dd></dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  151. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_getDataBlocks">getDataBlocks()</a>
  152. <span>
  153. &nbsp;: array&lt;string|int, mixed&gt; </span>
  154. </dt>
  155. <dd>When QR Codes use multiple data blocks, they are actually interleaved.</dd>
  156. </dl>
  157. <section class="phpdocumentor-methods">
  158. <h3 class="phpdocumentor-elements__header" id="methods">
  159. Methods
  160. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  161. </h3>
  162. <article
  163. class="phpdocumentor-element
  164. -method
  165. -public
  166. "
  167. >
  168. <h4 class="phpdocumentor-element__name" id="method_decode">
  169. decode()
  170. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode" class="headerlink"><i class="fas fa-link"></i></a>
  171. </h4>
  172. <aside class="phpdocumentor-element-found-in">
  173. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  174. :
  175. <span class="phpdocumentor-element-found-in__line">39</span>
  176. </aside>
  177. <p class="phpdocumentor-summary">Decodes a QR Code represented as a BitMatrix.</p>
  178. <code class="phpdocumentor-code phpdocumentor-signature ">
  179. <span class="phpdocumentor-signature__visibility">public</span>
  180. <span class="phpdocumentor-signature__name">decode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$source</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  181. <section class="phpdocumentor-description"><p>A 1 or &quot;true&quot; is taken to mean a black module.</p>
  182. </section>
  183. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  184. <dl class="phpdocumentor-argument-list">
  185. <dt class="phpdocumentor-argument-list__entry">
  186. <span class="phpdocumentor-signature__argument__name">$source</span>
  187. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></span>
  188. </dt>
  189. <dd class="phpdocumentor-argument-list__definition">
  190. </dd>
  191. </dl>
  192. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  193. Tags
  194. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  195. </h5>
  196. <dl class="phpdocumentor-tag-list">
  197. <dt class="phpdocumentor-tag-list__entry">
  198. <span class="phpdocumentor-tag__name">throws</span>
  199. </dt>
  200. <dd class="phpdocumentor-tag-list__definition">
  201. <span class="phpdocumentor-tag-link"><abbr title="\Throwable">Throwable</abbr>|<a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  202. <section class="phpdocumentor-description"><p>if the QR Code cannot be decoded</p>
  203. </section>
  204. </dd>
  205. </dl>
  206. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  207. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  208. &mdash;
  209. <section class="phpdocumentor-description"><p>text and bytes encoded within the QR Code</p>
  210. </section>
  211. </article>
  212. <article
  213. class="phpdocumentor-element
  214. -method
  215. -private
  216. "
  217. >
  218. <h4 class="phpdocumentor-element__name" id="method_correctErrors">
  219. correctErrors()
  220. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_correctErrors" class="headerlink"><i class="fas fa-link"></i></a>
  221. </h4>
  222. <aside class="phpdocumentor-element-found-in">
  223. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  224. :
  225. <span class="phpdocumentor-element-found-in__line">191</span>
  226. </aside>
  227. <p class="phpdocumentor-summary">Given data and error-correction codewords received, possibly corrupted by errors, attempts to
  228. correct the errors in-place using Reed-Solomon error correction.</p>
  229. <code class="phpdocumentor-code phpdocumentor-signature ">
  230. <span class="phpdocumentor-signature__visibility">private</span>
  231. <span class="phpdocumentor-signature__name">correctErrors</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$codewordBytes</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">$numDataCodewords</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  232. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  233. <dl class="phpdocumentor-argument-list">
  234. <dt class="phpdocumentor-argument-list__entry">
  235. <span class="phpdocumentor-signature__argument__name">$codewordBytes</span>
  236. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  237. </dt>
  238. <dd class="phpdocumentor-argument-list__definition">
  239. <section class="phpdocumentor-description"></section>
  240. </dd>
  241. <dt class="phpdocumentor-argument-list__entry">
  242. <span class="phpdocumentor-signature__argument__name">$numDataCodewords</span>
  243. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  244. </dt>
  245. <dd class="phpdocumentor-argument-list__definition">
  246. <section class="phpdocumentor-description"></section>
  247. </dd>
  248. </dl>
  249. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  250. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  251. &mdash;
  252. </article>
  253. <article
  254. class="phpdocumentor-element
  255. -method
  256. -private
  257. "
  258. >
  259. <h4 class="phpdocumentor-element__name" id="method_decodeBitStream">
  260. decodeBitStream()
  261. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream" class="headerlink"><i class="fas fa-link"></i></a>
  262. </h4>
  263. <aside class="phpdocumentor-element-found-in">
  264. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  265. :
  266. <span class="phpdocumentor-element-found-in__line">213</span>
  267. </aside>
  268. <code class="phpdocumentor-code phpdocumentor-signature ">
  269. <span class="phpdocumentor-signature__visibility">private</span>
  270. <span class="phpdocumentor-signature__name">decodeBitStream</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bytes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ecLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  271. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  272. <dl class="phpdocumentor-argument-list">
  273. <dt class="phpdocumentor-argument-list__entry">
  274. <span class="phpdocumentor-signature__argument__name">$bytes</span>
  275. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  276. </dt>
  277. <dd class="phpdocumentor-argument-list__definition">
  278. <section class="phpdocumentor-description"></section>
  279. </dd>
  280. <dt class="phpdocumentor-argument-list__entry">
  281. <span class="phpdocumentor-signature__argument__name">$version</span>
  282. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  283. </dt>
  284. <dd class="phpdocumentor-argument-list__definition">
  285. <section class="phpdocumentor-description"></section>
  286. </dd>
  287. <dt class="phpdocumentor-argument-list__entry">
  288. <span class="phpdocumentor-signature__argument__name">$ecLevel</span>
  289. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  290. </dt>
  291. <dd class="phpdocumentor-argument-list__definition">
  292. <section class="phpdocumentor-description"></section>
  293. </dd>
  294. </dl>
  295. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  296. Tags
  297. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  298. </h5>
  299. <dl class="phpdocumentor-tag-list">
  300. <dt class="phpdocumentor-tag-list__entry">
  301. <span class="phpdocumentor-tag__name">throws</span>
  302. </dt>
  303. <dd class="phpdocumentor-tag-list__definition">
  304. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  305. </dd>
  306. </dl>
  307. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  308. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  309. &mdash;
  310. </article>
  311. <article
  312. class="phpdocumentor-element
  313. -method
  314. -private
  315. "
  316. >
  317. <h4 class="phpdocumentor-element__name" id="method_decodeMatrix">
  318. decodeMatrix()
  319. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  320. </h4>
  321. <aside class="phpdocumentor-element-found-in">
  322. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  323. :
  324. <span class="phpdocumentor-element-found-in__line">71</span>
  325. </aside>
  326. <code class="phpdocumentor-code phpdocumentor-signature ">
  327. <span class="phpdocumentor-signature__visibility">private</span>
  328. <span class="phpdocumentor-signature__name">decodeMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html"><abbr title="\chillerlan\QRCode\Decoder\BitMatrix">BitMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitMatrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  329. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  330. <dl class="phpdocumentor-argument-list">
  331. <dt class="phpdocumentor-argument-list__entry">
  332. <span class="phpdocumentor-signature__argument__name">$bitMatrix</span>
  333. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html"><abbr title="\chillerlan\QRCode\Decoder\BitMatrix">BitMatrix</abbr></a></span>
  334. </dt>
  335. <dd class="phpdocumentor-argument-list__definition">
  336. <section class="phpdocumentor-description"></section>
  337. </dd>
  338. </dl>
  339. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  340. Tags
  341. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  342. </h5>
  343. <dl class="phpdocumentor-tag-list">
  344. <dt class="phpdocumentor-tag-list__entry">
  345. <span class="phpdocumentor-tag__name">throws</span>
  346. </dt>
  347. <dd class="phpdocumentor-tag-list__definition">
  348. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  349. </dd>
  350. </dl>
  351. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  352. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  353. &mdash;
  354. </article>
  355. <article
  356. class="phpdocumentor-element
  357. -method
  358. -private
  359. "
  360. >
  361. <h4 class="phpdocumentor-element__name" id="method_getDataBlocks">
  362. getDataBlocks()
  363. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_getDataBlocks" class="headerlink"><i class="fas fa-link"></i></a>
  364. </h4>
  365. <aside class="phpdocumentor-element-found-in">
  366. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/Decoder.php"><a href="files/src-decoder-decoder.html"><abbr title="src/Decoder/Decoder.php">Decoder.php</abbr></a></abbr>
  367. :
  368. <span class="phpdocumentor-element-found-in__line">117</span>
  369. </aside>
  370. <p class="phpdocumentor-summary">When QR Codes use multiple data blocks, they are actually interleaved.</p>
  371. <code class="phpdocumentor-code phpdocumentor-signature ">
  372. <span class="phpdocumentor-signature__visibility">private</span>
  373. <span class="phpdocumentor-signature__name">getDataBlocks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rawCodewords</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  374. <section class="phpdocumentor-description"><p>That is, the first byte of data block 1 to n is written, then the second bytes, and so on. This
  375. method will separate the data into original blocks.</p>
  376. </section>
  377. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  378. <dl class="phpdocumentor-argument-list">
  379. <dt class="phpdocumentor-argument-list__entry">
  380. <span class="phpdocumentor-signature__argument__name">$rawCodewords</span>
  381. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  382. </dt>
  383. <dd class="phpdocumentor-argument-list__definition">
  384. <section class="phpdocumentor-description"><p>bytes as read directly from the QR Code</p>
  385. </section>
  386. </dd>
  387. <dt class="phpdocumentor-argument-list__entry">
  388. <span class="phpdocumentor-signature__argument__name">$version</span>
  389. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  390. </dt>
  391. <dd class="phpdocumentor-argument-list__definition">
  392. <section class="phpdocumentor-description"><p>version of the QR Code</p>
  393. </section>
  394. </dd>
  395. <dt class="phpdocumentor-argument-list__entry">
  396. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  397. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  398. </dt>
  399. <dd class="phpdocumentor-argument-list__definition">
  400. <section class="phpdocumentor-description"><p>error-correction level of the QR Code</p>
  401. </section>
  402. </dd>
  403. </dl>
  404. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  405. Tags
  406. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  407. </h5>
  408. <dl class="phpdocumentor-tag-list">
  409. <dt class="phpdocumentor-tag-list__entry">
  410. <span class="phpdocumentor-tag__name">throws</span>
  411. </dt>
  412. <dd class="phpdocumentor-tag-list__definition">
  413. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  414. </dd>
  415. </dl>
  416. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  417. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  418. &mdash;
  419. <section class="phpdocumentor-description"><p>DataBlocks containing original bytes, &quot;de-interleaved&quot; from representation in the QR Code</p>
  420. </section>
  421. </article>
  422. </section>
  423. <script type="text/javascript">
  424. function loadExternalCodeSnippets(line) {
  425. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  426. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  427. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  428. var language = 'php';
  429. var code = document.createElement('code');
  430. code.className = 'language-' + language;
  431. pre.textContent = '';
  432. pre.setAttribute('data-line', line)
  433. code.textContent = 'Loading…';
  434. pre.appendChild(code);
  435. var xhr = new XMLHttpRequest();
  436. xhr.open('GET', src, true);
  437. xhr.onreadystatechange = function () {
  438. if (xhr.readyState == 4) {
  439. if (xhr.status < 400 && xhr.responseText) {
  440. code.textContent = xhr.responseText;
  441. Prism.highlightElement(code);
  442. }
  443. else if (xhr.status >= 400) {
  444. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  445. }
  446. else {
  447. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  448. }
  449. }
  450. };
  451. xhr.send(null);
  452. });
  453. }
  454. var modals = document.querySelectorAll("[data-modal]");
  455. modals.forEach(function (trigger) {
  456. trigger.addEventListener("click", function (event) {
  457. //event.preventDefault();
  458. const modal = document.getElementById(trigger.dataset.modal);
  459. modal.classList.add("phpdocumentor-modal__open");
  460. loadExternalCodeSnippets(trigger.dataset.line)
  461. const exits = modal.querySelectorAll("[data-exit-button]");
  462. exits.forEach(function (exit) {
  463. exit.addEventListener("click", function (event) {
  464. event.preventDefault();
  465. modal.classList.remove("phpdocumentor-modal__open");
  466. });
  467. });
  468. });
  469. });
  470. </script>
  471. </article>
  472. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  473. <section class="phpdocumentor-search-results__dialog">
  474. <header class="phpdocumentor-search-results__header">
  475. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  476. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  477. </header>
  478. <section class="phpdocumentor-search-results__body">
  479. <ul class="phpdocumentor-search-results__entries"></ul>
  480. </section>
  481. </section>
  482. </section>
  483. </div>
  484. </div>
  485. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  486. </main>
  487. <script>
  488. cssVars({});
  489. </script>
  490. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  491. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  492. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  493. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  494. </body>
  495. </html>