chillerlan-QRCode-Decoder-DecoderResult.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985
  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. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  112. </ul>
  113. <article class="phpdocumentor-element -class">
  114. <h2 class="phpdocumentor-content__title">
  115. DecoderResult
  116. <div class="phpdocumentor-element__package">
  117. in package
  118. <ul class="phpdocumentor-breadcrumbs">
  119. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  120. </ul>
  121. </div>
  122. </h2>
  123. <div class="phpdocumentor-label-line">
  124. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  125. </div>
  126. <aside class="phpdocumentor-element-found-in">
  127. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  128. :
  129. <span class="phpdocumentor-element-found-in__line">33</span>
  130. </aside>
  131. <p class="phpdocumentor-summary">Encapsulates the result of decoding a matrix of bits. This typically
  132. applies to 2D barcode formats. For now, it contains the raw bytes obtained
  133. as well as a String interpretation of those bytes, if applicable.</p>
  134. <h3 id="toc">
  135. Table of Contents
  136. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  137. </h3>
  138. <h4 id="toc-properties">
  139. Properties
  140. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  141. </h4>
  142. <dl class="phpdocumentor-table-of-contents">
  143. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  144. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data">$data</a>
  145. <span>
  146. &nbsp;: string </span>
  147. </dt>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  149. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel">$eccLevel</a>
  150. <span>
  151. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  152. </dt>
  153. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  154. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_finderPatterns">$finderPatterns</a>
  155. <span>
  156. &nbsp;: array&lt;string|int, <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a>&gt; </span>
  157. </dt>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  159. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.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> </span>
  162. </dt>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  164. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes">$rawBytes</a>
  165. <span>
  166. &nbsp;: <a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a> </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  169. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity">$structuredAppendParity</a>
  170. <span>
  171. &nbsp;: int </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  174. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence">$structuredAppendSequence</a>
  175. <span>
  176. &nbsp;: int </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  179. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version">$version</a>
  180. <span>
  181. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  182. </dt>
  183. </dl>
  184. <h4 id="toc-methods">
  185. Methods
  186. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  187. </h4>
  188. <dl class="phpdocumentor-table-of-contents">
  189. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  190. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct">__construct()</a>
  191. <span>
  192. &nbsp;: mixed </span>
  193. </dt>
  194. <dd>DecoderResult constructor.</dd>
  195. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  196. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___get">__get()</a>
  197. <span>
  198. &nbsp;: mixed </span>
  199. </dt>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  201. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___toString">__toString()</a>
  202. <span>
  203. &nbsp;: string </span>
  204. </dt>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  206. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_getQRMatrix">getQRMatrix()</a>
  207. <span>
  208. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  209. </dt>
  210. <dd>Returns a QRMatrix instance with the settings and data of the reader result</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  212. <a class="" href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_hasStructuredAppend">hasStructuredAppend()</a>
  213. <span>
  214. &nbsp;: bool </span>
  215. </dt>
  216. </dl>
  217. <section class="phpdocumentor-properties">
  218. <h3 class="phpdocumentor-elements__header" id="properties">
  219. Properties
  220. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  221. </h3>
  222. <article
  223. class="
  224. phpdocumentor-element
  225. -property
  226. -private
  227. "
  228. >
  229. <h4 class="phpdocumentor-element__name" id="property_data">
  230. $data
  231. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  232. <span class="phpdocumentor-element__modifiers">
  233. </span>
  234. </h4>
  235. <aside class="phpdocumentor-element-found-in">
  236. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  237. :
  238. <span class="phpdocumentor-element-found-in__line">35</span>
  239. </aside>
  240. <code class="phpdocumentor-code phpdocumentor-signature ">
  241. <span class="phpdocumentor-signature__visibility">private</span>
  242. <span class="phpdocumentor-signature__type">string</span>
  243. <span class="phpdocumentor-signature__name">$data</span>
  244. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  245. </article>
  246. <article
  247. class="
  248. phpdocumentor-element
  249. -property
  250. -private
  251. "
  252. >
  253. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  254. $eccLevel
  255. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  256. <span class="phpdocumentor-element__modifiers">
  257. </span>
  258. </h4>
  259. <aside class="phpdocumentor-element-found-in">
  260. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  261. :
  262. <span class="phpdocumentor-element-found-in__line">36</span>
  263. </aside>
  264. <code class="phpdocumentor-code phpdocumentor-signature ">
  265. <span class="phpdocumentor-signature__visibility">private</span>
  266. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  267. <span class="phpdocumentor-signature__name">$eccLevel</span>
  268. </code>
  269. </article>
  270. <article
  271. class="
  272. phpdocumentor-element
  273. -property
  274. -private
  275. "
  276. >
  277. <h4 class="phpdocumentor-element__name" id="property_finderPatterns">
  278. $finderPatterns
  279. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_finderPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  280. <span class="phpdocumentor-element__modifiers">
  281. </span>
  282. </h4>
  283. <aside class="phpdocumentor-element-found-in">
  284. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  285. :
  286. <span class="phpdocumentor-element-found-in__line">38</span>
  287. </aside>
  288. <code class="phpdocumentor-code phpdocumentor-signature ">
  289. <span class="phpdocumentor-signature__visibility">private</span>
  290. <span class="phpdocumentor-signature__type">array&lt;string|int, <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a>&gt;</span>
  291. <span class="phpdocumentor-signature__name">$finderPatterns</span>
  292. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  293. </article>
  294. <article
  295. class="
  296. phpdocumentor-element
  297. -property
  298. -private
  299. "
  300. >
  301. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  302. $maskPattern
  303. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  304. <span class="phpdocumentor-element__modifiers">
  305. </span>
  306. </h4>
  307. <aside class="phpdocumentor-element-found-in">
  308. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  309. :
  310. <span class="phpdocumentor-element-found-in__line">39</span>
  311. </aside>
  312. <code class="phpdocumentor-code phpdocumentor-signature ">
  313. <span class="phpdocumentor-signature__visibility">private</span>
  314. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  315. <span class="phpdocumentor-signature__name">$maskPattern</span>
  316. </code>
  317. </article>
  318. <article
  319. class="
  320. phpdocumentor-element
  321. -property
  322. -private
  323. "
  324. >
  325. <h4 class="phpdocumentor-element__name" id="property_rawBytes">
  326. $rawBytes
  327. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes" class="headerlink"><i class="fas fa-link"></i></a>
  328. <span class="phpdocumentor-element__modifiers">
  329. </span>
  330. </h4>
  331. <aside class="phpdocumentor-element-found-in">
  332. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  333. :
  334. <span class="phpdocumentor-element-found-in__line">40</span>
  335. </aside>
  336. <code class="phpdocumentor-code phpdocumentor-signature ">
  337. <span class="phpdocumentor-signature__visibility">private</span>
  338. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  339. <span class="phpdocumentor-signature__name">$rawBytes</span>
  340. </code>
  341. </article>
  342. <article
  343. class="
  344. phpdocumentor-element
  345. -property
  346. -private
  347. "
  348. >
  349. <h4 class="phpdocumentor-element__name" id="property_structuredAppendParity">
  350. $structuredAppendParity
  351. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity" class="headerlink"><i class="fas fa-link"></i></a>
  352. <span class="phpdocumentor-element__modifiers">
  353. </span>
  354. </h4>
  355. <aside class="phpdocumentor-element-found-in">
  356. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  357. :
  358. <span class="phpdocumentor-element-found-in__line">41</span>
  359. </aside>
  360. <code class="phpdocumentor-code phpdocumentor-signature ">
  361. <span class="phpdocumentor-signature__visibility">private</span>
  362. <span class="phpdocumentor-signature__type">int</span>
  363. <span class="phpdocumentor-signature__name">$structuredAppendParity</span>
  364. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  365. </article>
  366. <article
  367. class="
  368. phpdocumentor-element
  369. -property
  370. -private
  371. "
  372. >
  373. <h4 class="phpdocumentor-element__name" id="property_structuredAppendSequence">
  374. $structuredAppendSequence
  375. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence" class="headerlink"><i class="fas fa-link"></i></a>
  376. <span class="phpdocumentor-element__modifiers">
  377. </span>
  378. </h4>
  379. <aside class="phpdocumentor-element-found-in">
  380. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  381. :
  382. <span class="phpdocumentor-element-found-in__line">42</span>
  383. </aside>
  384. <code class="phpdocumentor-code phpdocumentor-signature ">
  385. <span class="phpdocumentor-signature__visibility">private</span>
  386. <span class="phpdocumentor-signature__type">int</span>
  387. <span class="phpdocumentor-signature__name">$structuredAppendSequence</span>
  388. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  389. </article>
  390. <article
  391. class="
  392. phpdocumentor-element
  393. -property
  394. -private
  395. "
  396. >
  397. <h4 class="phpdocumentor-element__name" id="property_version">
  398. $version
  399. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  400. <span class="phpdocumentor-element__modifiers">
  401. </span>
  402. </h4>
  403. <aside class="phpdocumentor-element-found-in">
  404. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  405. :
  406. <span class="phpdocumentor-element-found-in__line">43</span>
  407. </aside>
  408. <code class="phpdocumentor-code phpdocumentor-signature ">
  409. <span class="phpdocumentor-signature__visibility">private</span>
  410. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  411. <span class="phpdocumentor-signature__name">$version</span>
  412. </code>
  413. </article>
  414. </section>
  415. <section class="phpdocumentor-methods">
  416. <h3 class="phpdocumentor-elements__header" id="methods">
  417. Methods
  418. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  419. </h3>
  420. <article
  421. class="phpdocumentor-element
  422. -method
  423. -public
  424. "
  425. >
  426. <h4 class="phpdocumentor-element__name" id="method___construct">
  427. __construct()
  428. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  429. </h4>
  430. <aside class="phpdocumentor-element-found-in">
  431. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  432. :
  433. <span class="phpdocumentor-element-found-in__line">50</span>
  434. </aside>
  435. <p class="phpdocumentor-summary">DecoderResult constructor.</p>
  436. <code class="phpdocumentor-code phpdocumentor-signature ">
  437. <span class="phpdocumentor-signature__visibility">public</span>
  438. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">iterable&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  439. <div class="phpdocumentor-label-line">
  440. </div>
  441. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  442. <dl class="phpdocumentor-argument-list">
  443. <dt class="phpdocumentor-argument-list__entry">
  444. <span class="phpdocumentor-signature__argument__name">$properties</span>
  445. : <span class="phpdocumentor-signature__argument__return-type">iterable&lt;string|int, mixed&gt;|null</span>
  446. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  447. <dd class="phpdocumentor-argument-list__definition">
  448. </dd>
  449. </dl>
  450. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  451. Tags
  452. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  453. </h5>
  454. <dl class="phpdocumentor-tag-list">
  455. <dt class="phpdocumentor-tag-list__entry">
  456. <span class="phpdocumentor-tag__name">phpstan-param</span>
  457. </dt>
  458. <dd class="phpdocumentor-tag-list__definition">
  459. <section class="phpdocumentor-description"><p>array&lt;string, mixed&gt; $properties</p>
  460. </section>
  461. </dd>
  462. </dl>
  463. </article>
  464. <article
  465. class="phpdocumentor-element
  466. -method
  467. -public
  468. "
  469. >
  470. <h4 class="phpdocumentor-element__name" id="method___get">
  471. __get()
  472. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___get" class="headerlink"><i class="fas fa-link"></i></a>
  473. </h4>
  474. <aside class="phpdocumentor-element-found-in">
  475. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  476. :
  477. <span class="phpdocumentor-element-found-in__line">67</span>
  478. </aside>
  479. <code class="phpdocumentor-code phpdocumentor-signature ">
  480. <span class="phpdocumentor-signature__visibility">public</span>
  481. <span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$property</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  482. <div class="phpdocumentor-label-line">
  483. </div>
  484. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  485. <dl class="phpdocumentor-argument-list">
  486. <dt class="phpdocumentor-argument-list__entry">
  487. <span class="phpdocumentor-signature__argument__name">$property</span>
  488. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  489. </dt>
  490. <dd class="phpdocumentor-argument-list__definition">
  491. </dd>
  492. </dl>
  493. </article>
  494. <article
  495. class="phpdocumentor-element
  496. -method
  497. -public
  498. "
  499. >
  500. <h4 class="phpdocumentor-element__name" id="method___toString">
  501. __toString()
  502. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
  503. </h4>
  504. <aside class="phpdocumentor-element-found-in">
  505. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  506. :
  507. <span class="phpdocumentor-element-found-in__line">76</span>
  508. </aside>
  509. <code class="phpdocumentor-code phpdocumentor-signature ">
  510. <span class="phpdocumentor-signature__visibility">public</span>
  511. <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  512. <div class="phpdocumentor-label-line">
  513. </div>
  514. <section>
  515. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  516. <span class="phpdocumentor-signature__response_type">string</span>
  517. </section>
  518. </article>
  519. <article
  520. class="phpdocumentor-element
  521. -method
  522. -public
  523. "
  524. >
  525. <h4 class="phpdocumentor-element__name" id="method_getQRMatrix">
  526. getQRMatrix()
  527. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_getQRMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  528. </h4>
  529. <aside class="phpdocumentor-element-found-in">
  530. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  531. :
  532. <span class="phpdocumentor-element-found-in__line">87</span>
  533. </aside>
  534. <p class="phpdocumentor-summary">Returns a QRMatrix instance with the settings and data of the reader result</p>
  535. <code class="phpdocumentor-code phpdocumentor-signature ">
  536. <span class="phpdocumentor-signature__visibility">public</span>
  537. <span class="phpdocumentor-signature__name">getQRMatrix</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span></code>
  538. <div class="phpdocumentor-label-line">
  539. </div>
  540. <section>
  541. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  542. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  543. </section>
  544. </article>
  545. <article
  546. class="phpdocumentor-element
  547. -method
  548. -public
  549. "
  550. >
  551. <h4 class="phpdocumentor-element__name" id="method_hasStructuredAppend">
  552. hasStructuredAppend()
  553. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_hasStructuredAppend" class="headerlink"><i class="fas fa-link"></i></a>
  554. </h4>
  555. <aside class="phpdocumentor-element-found-in">
  556. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  557. :
  558. <span class="phpdocumentor-element-found-in__line">80</span>
  559. </aside>
  560. <code class="phpdocumentor-code phpdocumentor-signature ">
  561. <span class="phpdocumentor-signature__visibility">public</span>
  562. <span class="phpdocumentor-signature__name">hasStructuredAppend</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  563. <div class="phpdocumentor-label-line">
  564. </div>
  565. <section>
  566. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  567. <span class="phpdocumentor-signature__response_type">bool</span>
  568. </section>
  569. </article>
  570. </section>
  571. <div class="phpdocumentor-modal" id="source-view">
  572. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  573. <div class="phpdocumentor-modal-container">
  574. <div class="phpdocumentor-modal-content">
  575. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Decoder/DecoderResult.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  576. </div>
  577. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  578. </div>
  579. </div>
  580. <script type="text/javascript">
  581. (function () {
  582. function loadExternalCodeSnippet(el, url, line) {
  583. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  584. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  585. const language = 'php';
  586. const code = document.createElement('code');
  587. code.className = 'language-' + language;
  588. pre.textContent = '';
  589. pre.setAttribute('data-line', line)
  590. code.textContent = 'Loading…';
  591. pre.appendChild(code);
  592. var xhr = new XMLHttpRequest();
  593. xhr.open('GET', src, true);
  594. xhr.onreadystatechange = function () {
  595. if (xhr.readyState !== 4) {
  596. return;
  597. }
  598. if (xhr.status < 400 && xhr.responseText) {
  599. code.textContent = xhr.responseText;
  600. Prism.highlightElement(code);
  601. d=document.getElementsByClassName("line-numbers");
  602. d[0].scrollTop = d[0].children[1].offsetTop;
  603. return;
  604. }
  605. if (xhr.status === 404) {
  606. code.textContent = '✖ Error: File could not be found';
  607. return;
  608. }
  609. if (xhr.status >= 400) {
  610. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  611. return;
  612. }
  613. code.textContent = '✖ Error: An unknown error occurred';
  614. };
  615. xhr.send(null);
  616. });
  617. }
  618. const modalButtons = document.querySelectorAll("[data-modal]");
  619. const openedAsLocalFile = window.location.protocol === 'file:';
  620. if (modalButtons.length > 0 && openedAsLocalFile) {
  621. console.warn(
  622. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  623. 'browsers block XHR requests when a page is opened this way'
  624. );
  625. }
  626. modalButtons.forEach(function (trigger) {
  627. if (openedAsLocalFile) {
  628. trigger.setAttribute("hidden", "hidden");
  629. }
  630. trigger.addEventListener("click", function (event) {
  631. event.preventDefault();
  632. const modal = document.getElementById(trigger.dataset.modal);
  633. if (!modal) {
  634. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  635. return;
  636. }
  637. modal.classList.add("phpdocumentor-modal__open");
  638. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  639. const exits = modal.querySelectorAll("[data-exit-button]");
  640. exits.forEach(function (exit) {
  641. exit.addEventListener("click", function (event) {
  642. event.preventDefault();
  643. modal.classList.remove("phpdocumentor-modal__open");
  644. });
  645. });
  646. });
  647. });
  648. })();
  649. </script>
  650. </article>
  651. </section>
  652. <section class="phpdocumentor-on-this-page__sidebar">
  653. <section class="phpdocumentor-on-this-page__content">
  654. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  655. <ul class="phpdocumentor-list -clean">
  656. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  657. <li>
  658. <ul class="phpdocumentor-list -clean">
  659. <li><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#toc-properties">Properties</a></li>
  660. <li><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#toc-methods">Methods</a></li>
  661. </ul>
  662. </li>
  663. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  664. <li>
  665. <ul class="phpdocumentor-list -clean">
  666. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data">$data</a></li>
  667. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel">$eccLevel</a></li>
  668. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_finderPatterns">$finderPatterns</a></li>
  669. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern">$maskPattern</a></li>
  670. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes">$rawBytes</a></li>
  671. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity">$structuredAppendParity</a></li>
  672. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence">$structuredAppendSequence</a></li>
  673. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version">$version</a></li>
  674. </ul>
  675. </li>
  676. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  677. <li>
  678. <ul class="phpdocumentor-list -clean">
  679. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct">__construct()</a></li>
  680. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___get">__get()</a></li>
  681. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___toString">__toString()</a></li>
  682. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_getQRMatrix">getQRMatrix()</a></li>
  683. <li class=""><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_hasStructuredAppend">hasStructuredAppend()</a></li>
  684. </ul>
  685. </li>
  686. </ul>
  687. </section>
  688. </section>
  689. </div>
  690. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  691. <section class="phpdocumentor-search-results__dialog">
  692. <header class="phpdocumentor-search-results__header">
  693. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  694. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  695. </header>
  696. <section class="phpdocumentor-search-results__body">
  697. <ul class="phpdocumentor-search-results__entries"></ul>
  698. </section>
  699. </section>
  700. </section>
  701. </div>
  702. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  703. </main>
  704. <script>
  705. cssVars({});
  706. </script>
  707. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  708. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  709. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  710. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  711. </body>
  712. </html>