chillerlan-QRCode-Decoder-Decoder.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  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_eccLevel">$eccLevel</a>
  127. <span>
  128. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </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_maskPattern">$maskPattern</a>
  133. <span>
  134. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</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_version">$version</a>
  139. <span>
  140. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  141. </dt>
  142. <dd></dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  144. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode">decode()</a>
  145. <span>
  146. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  147. </dt>
  148. <dd>Decodes a QR Code represented as a BitMatrix.</dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  150. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream">decodeBitStream()</a>
  151. <span>
  152. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  153. </dt>
  154. <dd>Decode the contents of that stream of bytes</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  156. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix">decodeMatrix()</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></dd>
  161. </dl>
  162. <section class="phpdocumentor-properties">
  163. <h3 class="phpdocumentor-elements__header" id="properties">
  164. Properties
  165. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  166. </h3>
  167. <article
  168. class="
  169. phpdocumentor-element
  170. -property
  171. -private
  172. "
  173. >
  174. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  175. $eccLevel
  176. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  177. <span class="phpdocumentor-element__modifiers">
  178. </span>
  179. </h4>
  180. <aside class="phpdocumentor-element-found-in">
  181. <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>
  182. :
  183. <span class="phpdocumentor-element-found-in__line">29</span>
  184. </aside>
  185. <code class="phpdocumentor-code phpdocumentor-signature ">
  186. <span class="phpdocumentor-signature__visibility">private</span>
  187. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  188. <span class="phpdocumentor-signature__name">$eccLevel</span>
  189. = <span class="phpdocumentor-signature__default-value">null</span></code>
  190. <section class="phpdocumentor-description"></section>
  191. <section class="phpdocumentor-description"></section>
  192. </article>
  193. <article
  194. class="
  195. phpdocumentor-element
  196. -property
  197. -private
  198. "
  199. >
  200. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  201. $maskPattern
  202. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_maskPattern" 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">30</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-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  214. <span class="phpdocumentor-signature__name">$maskPattern</span>
  215. = <span class="phpdocumentor-signature__default-value">null</span></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_version">
  227. $version
  228. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#property_version" 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">28</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-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  240. <span class="phpdocumentor-signature__name">$version</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. </section>
  246. <section class="phpdocumentor-methods">
  247. <h3 class="phpdocumentor-elements__header" id="methods">
  248. Methods
  249. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  250. </h3>
  251. <article
  252. class="phpdocumentor-element
  253. -method
  254. -public
  255. "
  256. >
  257. <h4 class="phpdocumentor-element__name" id="method_decode">
  258. decode()
  259. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decode" class="headerlink"><i class="fas fa-link"></i></a>
  260. </h4>
  261. <aside class="phpdocumentor-element-found-in">
  262. <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>
  263. :
  264. <span class="phpdocumentor-element-found-in__line">38</span>
  265. </aside>
  266. <p class="phpdocumentor-summary">Decodes a QR Code represented as a BitMatrix.</p>
  267. <code class="phpdocumentor-code phpdocumentor-signature ">
  268. <span class="phpdocumentor-signature__visibility">public</span>
  269. <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>
  270. <section class="phpdocumentor-description"><p>A 1 or &quot;true&quot; is taken to mean a black module.</p>
  271. </section>
  272. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  273. <dl class="phpdocumentor-argument-list">
  274. <dt class="phpdocumentor-argument-list__entry">
  275. <span class="phpdocumentor-signature__argument__name">$source</span>
  276. : <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>
  277. </dt>
  278. <dd class="phpdocumentor-argument-list__definition">
  279. <section class="phpdocumentor-description"></section>
  280. </dd>
  281. </dl>
  282. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  283. Tags
  284. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  285. </h5>
  286. <dl class="phpdocumentor-tag-list">
  287. <dt class="phpdocumentor-tag-list__entry">
  288. <span class="phpdocumentor-tag__name">throws</span>
  289. </dt>
  290. <dd class="phpdocumentor-tag-list__definition">
  291. <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>
  292. </dd>
  293. </dl>
  294. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  295. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  296. &mdash;
  297. </article>
  298. <article
  299. class="phpdocumentor-element
  300. -method
  301. -private
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="method_decodeBitStream">
  305. decodeBitStream()
  306. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeBitStream" class="headerlink"><i class="fas fa-link"></i></a>
  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">91</span>
  312. </aside>
  313. <p class="phpdocumentor-summary">Decode the contents of that stream of bytes</p>
  314. <code class="phpdocumentor-code phpdocumentor-signature ">
  315. <span class="phpdocumentor-signature__visibility">private</span>
  316. <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>
  317. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  318. <dl class="phpdocumentor-argument-list">
  319. <dt class="phpdocumentor-argument-list__entry">
  320. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  321. : <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>
  322. </dt>
  323. <dd class="phpdocumentor-argument-list__definition">
  324. <section class="phpdocumentor-description"></section>
  325. </dd>
  326. </dl>
  327. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  328. Tags
  329. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  330. </h5>
  331. <dl class="phpdocumentor-tag-list">
  332. <dt class="phpdocumentor-tag-list__entry">
  333. <span class="phpdocumentor-tag__name">throws</span>
  334. </dt>
  335. <dd class="phpdocumentor-tag-list__definition">
  336. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  337. </dd>
  338. </dl>
  339. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  340. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  341. &mdash;
  342. </article>
  343. <article
  344. class="phpdocumentor-element
  345. -method
  346. -private
  347. "
  348. >
  349. <h4 class="phpdocumentor-element__name" id="method_decodeMatrix">
  350. decodeMatrix()
  351. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#method_decodeMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  352. </h4>
  353. <aside class="phpdocumentor-element-found-in">
  354. <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>
  355. :
  356. <span class="phpdocumentor-element-found-in__line">70</span>
  357. </aside>
  358. <code class="phpdocumentor-code phpdocumentor-signature ">
  359. <span class="phpdocumentor-signature__visibility">private</span>
  360. <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>
  361. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  362. <dl class="phpdocumentor-argument-list">
  363. <dt class="phpdocumentor-argument-list__entry">
  364. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  365. : <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>
  366. </dt>
  367. <dd class="phpdocumentor-argument-list__definition">
  368. <section class="phpdocumentor-description"></section>
  369. </dd>
  370. </dl>
  371. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  372. Tags
  373. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  374. </h5>
  375. <dl class="phpdocumentor-tag-list">
  376. <dt class="phpdocumentor-tag-list__entry">
  377. <span class="phpdocumentor-tag__name">throws</span>
  378. </dt>
  379. <dd class="phpdocumentor-tag-list__definition">
  380. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  381. </dd>
  382. </dl>
  383. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  384. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  385. &mdash;
  386. </article>
  387. </section>
  388. <script type="text/javascript">
  389. function loadExternalCodeSnippets(line) {
  390. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  391. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  392. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  393. var language = 'php';
  394. var code = document.createElement('code');
  395. code.className = 'language-' + language;
  396. pre.textContent = '';
  397. pre.setAttribute('data-line', line)
  398. code.textContent = 'Loading…';
  399. pre.appendChild(code);
  400. var xhr = new XMLHttpRequest();
  401. xhr.open('GET', src, true);
  402. xhr.onreadystatechange = function () {
  403. if (xhr.readyState == 4) {
  404. if (xhr.status < 400 && xhr.responseText) {
  405. code.textContent = xhr.responseText;
  406. Prism.highlightElement(code);
  407. }
  408. else if (xhr.status >= 400) {
  409. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  410. }
  411. else {
  412. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  413. }
  414. }
  415. };
  416. xhr.send(null);
  417. });
  418. }
  419. var modals = document.querySelectorAll("[data-modal]");
  420. modals.forEach(function (trigger) {
  421. trigger.addEventListener("click", function (event) {
  422. //event.preventDefault();
  423. const modal = document.getElementById(trigger.dataset.modal);
  424. modal.classList.add("phpdocumentor-modal__open");
  425. loadExternalCodeSnippets(trigger.dataset.line)
  426. const exits = modal.querySelectorAll("[data-exit-button]");
  427. exits.forEach(function (exit) {
  428. exit.addEventListener("click", function (event) {
  429. event.preventDefault();
  430. modal.classList.remove("phpdocumentor-modal__open");
  431. });
  432. });
  433. });
  434. });
  435. </script>
  436. </article>
  437. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  438. <section class="phpdocumentor-search-results__dialog">
  439. <header class="phpdocumentor-search-results__header">
  440. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  441. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  442. </header>
  443. <section class="phpdocumentor-search-results__body">
  444. <ul class="phpdocumentor-search-results__entries"></ul>
  445. </section>
  446. </section>
  447. </section>
  448. </div>
  449. </div>
  450. <a href="classes/chillerlan-QRCode-Decoder-Decoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  451. </main>
  452. <script>
  453. cssVars({});
  454. </script>
  455. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  456. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  457. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  458. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  459. </body>
  460. </html>