chillerlan-QRCode-Decoder-Decoder.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  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 -property -private">
  126. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_bitBuffer">$bitBuffer</a>
  127. <span>
  128. &nbsp;: <a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a> </span>
  129. </dt>
  130. <dd></dd>
  131. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  132. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_eccLevel">$eccLevel</a>
  133. <span>
  134. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  135. </dt>
  136. <dd></dd>
  137. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  138. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_maskPattern">$maskPattern</a>
  139. <span>
  140. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  141. </dt>
  142. <dd></dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  144. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_version">$version</a>
  145. <span>
  146. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  147. </dt>
  148. <dd></dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  150. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode">decode()</a>
  151. <span>
  152. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  153. </dt>
  154. <dd>Decodes a QR Code represented as a BitMatrix.</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  156. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeAlphanumSegment">decodeAlphanumSegment()</a>
  157. <span>
  158. &nbsp;: string </span>
  159. </dt>
  160. <dd></dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  162. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream">decodeBitStream()</a>
  163. <span>
  164. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  165. </dt>
  166. <dd>Decode the contents of that stream of bytes</dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  168. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix">decodeMatrix()</a>
  169. <span>
  170. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  171. </dt>
  172. <dd></dd>
  173. </dl>
  174. <section class="phpdocumentor-properties">
  175. <h3 class="phpdocumentor-elements__header" id="properties">
  176. Properties
  177. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  178. </h3>
  179. <article
  180. class="
  181. phpdocumentor-element
  182. -property
  183. -private
  184. "
  185. >
  186. <h4 class="phpdocumentor-element__name" id="property_bitBuffer">
  187. $bitBuffer
  188. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_bitBuffer" class="headerlink"><i class="fas fa-link"></i></a>
  189. <span class="phpdocumentor-element__modifiers">
  190. </span>
  191. </h4>
  192. <aside class="phpdocumentor-element-found-in">
  193. <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>
  194. :
  195. <span class="phpdocumentor-element-found-in__line">31</span>
  196. </aside>
  197. <code class="phpdocumentor-code phpdocumentor-signature ">
  198. <span class="phpdocumentor-signature__visibility">private</span>
  199. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  200. <span class="phpdocumentor-signature__name">$bitBuffer</span>
  201. </code>
  202. <section class="phpdocumentor-description"></section>
  203. <section class="phpdocumentor-description"></section>
  204. </article>
  205. <article
  206. class="
  207. phpdocumentor-element
  208. -property
  209. -private
  210. "
  211. >
  212. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  213. $eccLevel
  214. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  215. <span class="phpdocumentor-element__modifiers">
  216. </span>
  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">29</span>
  222. </aside>
  223. <code class="phpdocumentor-code phpdocumentor-signature ">
  224. <span class="phpdocumentor-signature__visibility">private</span>
  225. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  226. <span class="phpdocumentor-signature__name">$eccLevel</span>
  227. = <span class="phpdocumentor-signature__default-value">null</span></code>
  228. <section class="phpdocumentor-description"></section>
  229. <section class="phpdocumentor-description"></section>
  230. </article>
  231. <article
  232. class="
  233. phpdocumentor-element
  234. -property
  235. -private
  236. "
  237. >
  238. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  239. $maskPattern
  240. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  241. <span class="phpdocumentor-element__modifiers">
  242. </span>
  243. </h4>
  244. <aside class="phpdocumentor-element-found-in">
  245. <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>
  246. :
  247. <span class="phpdocumentor-element-found-in__line">30</span>
  248. </aside>
  249. <code class="phpdocumentor-code phpdocumentor-signature ">
  250. <span class="phpdocumentor-signature__visibility">private</span>
  251. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  252. <span class="phpdocumentor-signature__name">$maskPattern</span>
  253. = <span class="phpdocumentor-signature__default-value">null</span></code>
  254. <section class="phpdocumentor-description"></section>
  255. <section class="phpdocumentor-description"></section>
  256. </article>
  257. <article
  258. class="
  259. phpdocumentor-element
  260. -property
  261. -private
  262. "
  263. >
  264. <h4 class="phpdocumentor-element__name" id="property_version">
  265. $version
  266. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  267. <span class="phpdocumentor-element__modifiers">
  268. </span>
  269. </h4>
  270. <aside class="phpdocumentor-element-found-in">
  271. <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>
  272. :
  273. <span class="phpdocumentor-element-found-in__line">28</span>
  274. </aside>
  275. <code class="phpdocumentor-code phpdocumentor-signature ">
  276. <span class="phpdocumentor-signature__visibility">private</span>
  277. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  278. <span class="phpdocumentor-signature__name">$version</span>
  279. = <span class="phpdocumentor-signature__default-value">null</span></code>
  280. <section class="phpdocumentor-description"></section>
  281. <section class="phpdocumentor-description"></section>
  282. </article>
  283. </section>
  284. <section class="phpdocumentor-methods">
  285. <h3 class="phpdocumentor-elements__header" id="methods">
  286. Methods
  287. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  288. </h3>
  289. <article
  290. class="phpdocumentor-element
  291. -method
  292. -public
  293. "
  294. >
  295. <h4 class="phpdocumentor-element__name" id="method_decode">
  296. decode()
  297. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode" class="headerlink"><i class="fas fa-link"></i></a>
  298. </h4>
  299. <aside class="phpdocumentor-element-found-in">
  300. <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>
  301. :
  302. <span class="phpdocumentor-element-found-in__line">39</span>
  303. </aside>
  304. <p class="phpdocumentor-summary">Decodes a QR Code represented as a BitMatrix.</p>
  305. <code class="phpdocumentor-code phpdocumentor-signature ">
  306. <span class="phpdocumentor-signature__visibility">public</span>
  307. <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>
  308. <section class="phpdocumentor-description"><p>A 1 or &quot;true&quot; is taken to mean a black module.</p>
  309. </section>
  310. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  311. <dl class="phpdocumentor-argument-list">
  312. <dt class="phpdocumentor-argument-list__entry">
  313. <span class="phpdocumentor-signature__argument__name">$source</span>
  314. : <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>
  315. </dt>
  316. <dd class="phpdocumentor-argument-list__definition">
  317. <section class="phpdocumentor-description"></section>
  318. </dd>
  319. </dl>
  320. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  321. Tags
  322. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  323. </h5>
  324. <dl class="phpdocumentor-tag-list">
  325. <dt class="phpdocumentor-tag-list__entry">
  326. <span class="phpdocumentor-tag__name">throws</span>
  327. </dt>
  328. <dd class="phpdocumentor-tag-list__definition">
  329. <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>
  330. </dd>
  331. </dl>
  332. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  333. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  334. &mdash;
  335. </article>
  336. <article
  337. class="phpdocumentor-element
  338. -method
  339. -private
  340. "
  341. >
  342. <h4 class="phpdocumentor-element__name" id="method_decodeAlphanumSegment">
  343. decodeAlphanumSegment()
  344. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeAlphanumSegment" class="headerlink"><i class="fas fa-link"></i></a>
  345. </h4>
  346. <aside class="phpdocumentor-element-found-in">
  347. <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>
  348. :
  349. <span class="phpdocumentor-element-found-in__line">160</span>
  350. </aside>
  351. <code class="phpdocumentor-code phpdocumentor-signature ">
  352. <span class="phpdocumentor-signature__visibility">private</span>
  353. <span class="phpdocumentor-signature__name">decodeAlphanumSegment</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 class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fc1InEffect</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  354. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  355. <dl class="phpdocumentor-argument-list">
  356. <dt class="phpdocumentor-argument-list__entry">
  357. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  358. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  359. </dt>
  360. <dd class="phpdocumentor-argument-list__definition">
  361. <section class="phpdocumentor-description"></section>
  362. </dd>
  363. <dt class="phpdocumentor-argument-list__entry">
  364. <span class="phpdocumentor-signature__argument__name">$fc1InEffect</span>
  365. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  366. </dt>
  367. <dd class="phpdocumentor-argument-list__definition">
  368. <section class="phpdocumentor-description"></section>
  369. </dd>
  370. </dl>
  371. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  372. <span class="phpdocumentor-signature__response_type">string</span>
  373. &mdash;
  374. </article>
  375. <article
  376. class="phpdocumentor-element
  377. -method
  378. -private
  379. "
  380. >
  381. <h4 class="phpdocumentor-element__name" id="method_decodeBitStream">
  382. decodeBitStream()
  383. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream" class="headerlink"><i class="fas fa-link"></i></a>
  384. </h4>
  385. <aside class="phpdocumentor-element-found-in">
  386. <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>
  387. :
  388. <span class="phpdocumentor-element-found-in__line">92</span>
  389. </aside>
  390. <p class="phpdocumentor-summary">Decode the contents of that stream of bytes</p>
  391. <code class="phpdocumentor-code phpdocumentor-signature ">
  392. <span class="phpdocumentor-signature__visibility">private</span>
  393. <span class="phpdocumentor-signature__name">decodeBitStream</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>)</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>
  394. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  395. <dl class="phpdocumentor-argument-list">
  396. <dt class="phpdocumentor-argument-list__entry">
  397. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  398. : <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>
  399. </dt>
  400. <dd class="phpdocumentor-argument-list__definition">
  401. <section class="phpdocumentor-description"></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"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  418. &mdash;
  419. </article>
  420. <article
  421. class="phpdocumentor-element
  422. -method
  423. -private
  424. "
  425. >
  426. <h4 class="phpdocumentor-element__name" id="method_decodeMatrix">
  427. decodeMatrix()
  428. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  429. </h4>
  430. <aside class="phpdocumentor-element-found-in">
  431. <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>
  432. :
  433. <span class="phpdocumentor-element-found-in__line">71</span>
  434. </aside>
  435. <code class="phpdocumentor-code phpdocumentor-signature ">
  436. <span class="phpdocumentor-signature__visibility">private</span>
  437. <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">$matrix</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>
  438. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  439. <dl class="phpdocumentor-argument-list">
  440. <dt class="phpdocumentor-argument-list__entry">
  441. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  442. : <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>
  443. </dt>
  444. <dd class="phpdocumentor-argument-list__definition">
  445. <section class="phpdocumentor-description"></section>
  446. </dd>
  447. </dl>
  448. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  449. Tags
  450. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  451. </h5>
  452. <dl class="phpdocumentor-tag-list">
  453. <dt class="phpdocumentor-tag-list__entry">
  454. <span class="phpdocumentor-tag__name">throws</span>
  455. </dt>
  456. <dd class="phpdocumentor-tag-list__definition">
  457. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  458. </dd>
  459. </dl>
  460. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  461. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  462. &mdash;
  463. </article>
  464. </section>
  465. <script type="text/javascript">
  466. function loadExternalCodeSnippets(line) {
  467. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  468. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  469. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  470. var language = 'php';
  471. var code = document.createElement('code');
  472. code.className = 'language-' + language;
  473. pre.textContent = '';
  474. pre.setAttribute('data-line', line)
  475. code.textContent = 'Loading…';
  476. pre.appendChild(code);
  477. var xhr = new XMLHttpRequest();
  478. xhr.open('GET', src, true);
  479. xhr.onreadystatechange = function () {
  480. if (xhr.readyState == 4) {
  481. if (xhr.status < 400 && xhr.responseText) {
  482. code.textContent = xhr.responseText;
  483. Prism.highlightElement(code);
  484. }
  485. else if (xhr.status >= 400) {
  486. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  487. }
  488. else {
  489. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  490. }
  491. }
  492. };
  493. xhr.send(null);
  494. });
  495. }
  496. var modals = document.querySelectorAll("[data-modal]");
  497. modals.forEach(function (trigger) {
  498. trigger.addEventListener("click", function (event) {
  499. //event.preventDefault();
  500. const modal = document.getElementById(trigger.dataset.modal);
  501. modal.classList.add("phpdocumentor-modal__open");
  502. loadExternalCodeSnippets(trigger.dataset.line)
  503. const exits = modal.querySelectorAll("[data-exit-button]");
  504. exits.forEach(function (exit) {
  505. exit.addEventListener("click", function (event) {
  506. event.preventDefault();
  507. modal.classList.remove("phpdocumentor-modal__open");
  508. });
  509. });
  510. });
  511. });
  512. </script>
  513. </article>
  514. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  515. <section class="phpdocumentor-search-results__dialog">
  516. <header class="phpdocumentor-search-results__header">
  517. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  518. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  519. </header>
  520. <section class="phpdocumentor-search-results__body">
  521. <ul class="phpdocumentor-search-results__entries"></ul>
  522. </section>
  523. </section>
  524. </section>
  525. </div>
  526. </div>
  527. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  528. </main>
  529. <script>
  530. cssVars({});
  531. </script>
  532. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  533. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  534. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  535. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  536. </body>
  537. </html>