chillerlan-QRCode-Decoder-Decoder.html 34 KB

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