chillerlan-QRCode-Decoder-Decoder.html 39 KB

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