chillerlan-QRCode-Decoder-Decoder.html 38 KB

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