chillerlan-QRCode-Decoder-Decoder.html 32 KB

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