chillerlan-QRCode-Decoder-DecoderResult.html 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036
  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. DecoderResult
  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/DecoderResult.php"><a href="files/src-decoder-decoderresult.html"><abbr title="src/Decoder/DecoderResult.php">DecoderResult.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">31</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Encapsulates the result of decoding a matrix of bits. This typically
  106. applies to 2D barcode formats. For now, it contains the raw bytes obtained
  107. as well as a String interpretation of those bytes, if applicable.</p>
  108. <h3 id="toc">
  109. Table of Contents
  110. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  111. </h3>
  112. <dl class="phpdocumentor-table-of-contents">
  113. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  114. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data">$data</a>
  115. <span>
  116. &nbsp;: string </span>
  117. </dt>
  118. <dd></dd>
  119. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  120. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel">$eccLevel</a>
  121. <span>
  122. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  123. </dt>
  124. <dd></dd>
  125. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  126. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern">$maskPattern</a>
  127. <span>
  128. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span>
  129. </dt>
  130. <dd></dd>
  131. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  132. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes">$rawBytes</a>
  133. <span>
  134. &nbsp;: <a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a> </span>
  135. </dt>
  136. <dd></dd>
  137. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  138. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity">$structuredAppendParity</a>
  139. <span>
  140. &nbsp;: int </span>
  141. </dt>
  142. <dd></dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  144. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence">$structuredAppendSequence</a>
  145. <span>
  146. &nbsp;: int </span>
  147. </dt>
  148. <dd></dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  150. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version">$version</a>
  151. <span>
  152. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  153. </dt>
  154. <dd></dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  156. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data">$data</a>
  157. <span>
  158. &nbsp;: string </span>
  159. </dt>
  160. <dd></dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  162. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel">$eccLevel</a>
  163. <span>
  164. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  165. </dt>
  166. <dd></dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  168. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern">$maskPattern</a>
  169. <span>
  170. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span>
  171. </dt>
  172. <dd></dd>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  174. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes">$rawBytes</a>
  175. <span>
  176. &nbsp;: <a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a> </span>
  177. </dt>
  178. <dd></dd>
  179. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  180. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity">$structuredAppendParity</a>
  181. <span>
  182. &nbsp;: int </span>
  183. </dt>
  184. <dd></dd>
  185. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  186. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence">$structuredAppendSequence</a>
  187. <span>
  188. &nbsp;: int </span>
  189. </dt>
  190. <dd></dd>
  191. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  192. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version">$version</a>
  193. <span>
  194. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  195. </dt>
  196. <dd></dd>
  197. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  198. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct">__construct()</a>
  199. <span>
  200. &nbsp;: mixed </span>
  201. </dt>
  202. <dd>DecoderResult constructor.</dd>
  203. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  204. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___get">__get()</a>
  205. <span>
  206. &nbsp;: mixed|null </span>
  207. </dt>
  208. <dd></dd>
  209. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  210. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___toString">__toString()</a>
  211. <span>
  212. &nbsp;: string </span>
  213. </dt>
  214. <dd></dd>
  215. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  216. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_getMatrix">getMatrix()</a>
  217. <span>
  218. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  219. </dt>
  220. <dd>Returns a QRMatrix instance with thesettings and data of the reader result</dd>
  221. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  222. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_hasStructuredAppend">hasStructuredAppend()</a>
  223. <span>
  224. &nbsp;: bool </span>
  225. </dt>
  226. <dd></dd>
  227. </dl>
  228. <section class="phpdocumentor-properties">
  229. <h3 class="phpdocumentor-elements__header" id="properties">
  230. Properties
  231. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  232. </h3>
  233. <article
  234. class="
  235. phpdocumentor-element
  236. -property
  237. -public
  238. "
  239. >
  240. <h4 class="phpdocumentor-element__name" id="property_data">
  241. $data
  242. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  243. <span class="phpdocumentor-element__modifiers">
  244. </span>
  245. </h4>
  246. <aside class="phpdocumentor-element-found-in">
  247. <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>
  248. :
  249. <span class="phpdocumentor-element-found-in__line">0</span>
  250. </aside>
  251. <code class="phpdocumentor-code phpdocumentor-signature ">
  252. <span class="phpdocumentor-signature__visibility">public</span>
  253. <span class="phpdocumentor-signature__type">string</span>
  254. <span class="phpdocumentor-signature__name">$data</span>
  255. </code>
  256. <section class="phpdocumentor-description"></section>
  257. </article>
  258. <article
  259. class="
  260. phpdocumentor-element
  261. -property
  262. -public
  263. "
  264. >
  265. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  266. $eccLevel
  267. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  268. <span class="phpdocumentor-element__modifiers">
  269. </span>
  270. </h4>
  271. <aside class="phpdocumentor-element-found-in">
  272. <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>
  273. :
  274. <span class="phpdocumentor-element-found-in__line">0</span>
  275. </aside>
  276. <code class="phpdocumentor-code phpdocumentor-signature ">
  277. <span class="phpdocumentor-signature__visibility">public</span>
  278. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  279. <span class="phpdocumentor-signature__name">$eccLevel</span>
  280. </code>
  281. <section class="phpdocumentor-description"></section>
  282. </article>
  283. <article
  284. class="
  285. phpdocumentor-element
  286. -property
  287. -public
  288. "
  289. >
  290. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  291. $maskPattern
  292. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  293. <span class="phpdocumentor-element__modifiers">
  294. </span>
  295. </h4>
  296. <aside class="phpdocumentor-element-found-in">
  297. <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>
  298. :
  299. <span class="phpdocumentor-element-found-in__line">0</span>
  300. </aside>
  301. <code class="phpdocumentor-code phpdocumentor-signature ">
  302. <span class="phpdocumentor-signature__visibility">public</span>
  303. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  304. <span class="phpdocumentor-signature__name">$maskPattern</span>
  305. </code>
  306. <section class="phpdocumentor-description"></section>
  307. </article>
  308. <article
  309. class="
  310. phpdocumentor-element
  311. -property
  312. -public
  313. "
  314. >
  315. <h4 class="phpdocumentor-element__name" id="property_rawBytes">
  316. $rawBytes
  317. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes" class="headerlink"><i class="fas fa-link"></i></a>
  318. <span class="phpdocumentor-element__modifiers">
  319. </span>
  320. </h4>
  321. <aside class="phpdocumentor-element-found-in">
  322. <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>
  323. :
  324. <span class="phpdocumentor-element-found-in__line">0</span>
  325. </aside>
  326. <code class="phpdocumentor-code phpdocumentor-signature ">
  327. <span class="phpdocumentor-signature__visibility">public</span>
  328. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  329. <span class="phpdocumentor-signature__name">$rawBytes</span>
  330. </code>
  331. <section class="phpdocumentor-description"></section>
  332. </article>
  333. <article
  334. class="
  335. phpdocumentor-element
  336. -property
  337. -public
  338. "
  339. >
  340. <h4 class="phpdocumentor-element__name" id="property_structuredAppendParity">
  341. $structuredAppendParity
  342. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity" class="headerlink"><i class="fas fa-link"></i></a>
  343. <span class="phpdocumentor-element__modifiers">
  344. </span>
  345. </h4>
  346. <aside class="phpdocumentor-element-found-in">
  347. <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>
  348. :
  349. <span class="phpdocumentor-element-found-in__line">0</span>
  350. </aside>
  351. <code class="phpdocumentor-code phpdocumentor-signature ">
  352. <span class="phpdocumentor-signature__visibility">public</span>
  353. <span class="phpdocumentor-signature__type">int</span>
  354. <span class="phpdocumentor-signature__name">$structuredAppendParity</span>
  355. </code>
  356. <section class="phpdocumentor-description"></section>
  357. </article>
  358. <article
  359. class="
  360. phpdocumentor-element
  361. -property
  362. -public
  363. "
  364. >
  365. <h4 class="phpdocumentor-element__name" id="property_structuredAppendSequence">
  366. $structuredAppendSequence
  367. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence" class="headerlink"><i class="fas fa-link"></i></a>
  368. <span class="phpdocumentor-element__modifiers">
  369. </span>
  370. </h4>
  371. <aside class="phpdocumentor-element-found-in">
  372. <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>
  373. :
  374. <span class="phpdocumentor-element-found-in__line">0</span>
  375. </aside>
  376. <code class="phpdocumentor-code phpdocumentor-signature ">
  377. <span class="phpdocumentor-signature__visibility">public</span>
  378. <span class="phpdocumentor-signature__type">int</span>
  379. <span class="phpdocumentor-signature__name">$structuredAppendSequence</span>
  380. </code>
  381. <section class="phpdocumentor-description"></section>
  382. </article>
  383. <article
  384. class="
  385. phpdocumentor-element
  386. -property
  387. -public
  388. "
  389. >
  390. <h4 class="phpdocumentor-element__name" id="property_version">
  391. $version
  392. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  393. <span class="phpdocumentor-element__modifiers">
  394. </span>
  395. </h4>
  396. <aside class="phpdocumentor-element-found-in">
  397. <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>
  398. :
  399. <span class="phpdocumentor-element-found-in__line">0</span>
  400. </aside>
  401. <code class="phpdocumentor-code phpdocumentor-signature ">
  402. <span class="phpdocumentor-signature__visibility">public</span>
  403. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  404. <span class="phpdocumentor-signature__name">$version</span>
  405. </code>
  406. <section class="phpdocumentor-description"></section>
  407. </article>
  408. <article
  409. class="
  410. phpdocumentor-element
  411. -property
  412. -private
  413. "
  414. >
  415. <h4 class="phpdocumentor-element__name" id="property_data">
  416. $data
  417. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  418. <span class="phpdocumentor-element__modifiers">
  419. </span>
  420. </h4>
  421. <aside class="phpdocumentor-element-found-in">
  422. <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>
  423. :
  424. <span class="phpdocumentor-element-found-in__line">37</span>
  425. </aside>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">private</span>
  428. <span class="phpdocumentor-signature__type">string</span>
  429. <span class="phpdocumentor-signature__name">$data</span>
  430. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  431. <section class="phpdocumentor-description"></section>
  432. <section class="phpdocumentor-description"></section>
  433. </article>
  434. <article
  435. class="
  436. phpdocumentor-element
  437. -property
  438. -private
  439. "
  440. >
  441. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  442. $eccLevel
  443. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  444. <span class="phpdocumentor-element__modifiers">
  445. </span>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <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>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">35</span>
  451. </aside>
  452. <code class="phpdocumentor-code phpdocumentor-signature ">
  453. <span class="phpdocumentor-signature__visibility">private</span>
  454. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  455. <span class="phpdocumentor-signature__name">$eccLevel</span>
  456. </code>
  457. <section class="phpdocumentor-description"></section>
  458. <section class="phpdocumentor-description"></section>
  459. </article>
  460. <article
  461. class="
  462. phpdocumentor-element
  463. -property
  464. -private
  465. "
  466. >
  467. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  468. $maskPattern
  469. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  470. <span class="phpdocumentor-element__modifiers">
  471. </span>
  472. </h4>
  473. <aside class="phpdocumentor-element-found-in">
  474. <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>
  475. :
  476. <span class="phpdocumentor-element-found-in__line">36</span>
  477. </aside>
  478. <code class="phpdocumentor-code phpdocumentor-signature ">
  479. <span class="phpdocumentor-signature__visibility">private</span>
  480. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  481. <span class="phpdocumentor-signature__name">$maskPattern</span>
  482. </code>
  483. <section class="phpdocumentor-description"></section>
  484. <section class="phpdocumentor-description"></section>
  485. </article>
  486. <article
  487. class="
  488. phpdocumentor-element
  489. -property
  490. -private
  491. "
  492. >
  493. <h4 class="phpdocumentor-element__name" id="property_rawBytes">
  494. $rawBytes
  495. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_rawBytes" class="headerlink"><i class="fas fa-link"></i></a>
  496. <span class="phpdocumentor-element__modifiers">
  497. </span>
  498. </h4>
  499. <aside class="phpdocumentor-element-found-in">
  500. <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>
  501. :
  502. <span class="phpdocumentor-element-found-in__line">33</span>
  503. </aside>
  504. <code class="phpdocumentor-code phpdocumentor-signature ">
  505. <span class="phpdocumentor-signature__visibility">private</span>
  506. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  507. <span class="phpdocumentor-signature__name">$rawBytes</span>
  508. </code>
  509. <section class="phpdocumentor-description"></section>
  510. <section class="phpdocumentor-description"></section>
  511. </article>
  512. <article
  513. class="
  514. phpdocumentor-element
  515. -property
  516. -private
  517. "
  518. >
  519. <h4 class="phpdocumentor-element__name" id="property_structuredAppendParity">
  520. $structuredAppendParity
  521. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendParity" class="headerlink"><i class="fas fa-link"></i></a>
  522. <span class="phpdocumentor-element__modifiers">
  523. </span>
  524. </h4>
  525. <aside class="phpdocumentor-element-found-in">
  526. <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>
  527. :
  528. <span class="phpdocumentor-element-found-in__line">38</span>
  529. </aside>
  530. <code class="phpdocumentor-code phpdocumentor-signature ">
  531. <span class="phpdocumentor-signature__visibility">private</span>
  532. <span class="phpdocumentor-signature__type">int</span>
  533. <span class="phpdocumentor-signature__name">$structuredAppendParity</span>
  534. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  535. <section class="phpdocumentor-description"></section>
  536. <section class="phpdocumentor-description"></section>
  537. </article>
  538. <article
  539. class="
  540. phpdocumentor-element
  541. -property
  542. -private
  543. "
  544. >
  545. <h4 class="phpdocumentor-element__name" id="property_structuredAppendSequence">
  546. $structuredAppendSequence
  547. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_structuredAppendSequence" class="headerlink"><i class="fas fa-link"></i></a>
  548. <span class="phpdocumentor-element__modifiers">
  549. </span>
  550. </h4>
  551. <aside class="phpdocumentor-element-found-in">
  552. <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>
  553. :
  554. <span class="phpdocumentor-element-found-in__line">39</span>
  555. </aside>
  556. <code class="phpdocumentor-code phpdocumentor-signature ">
  557. <span class="phpdocumentor-signature__visibility">private</span>
  558. <span class="phpdocumentor-signature__type">int</span>
  559. <span class="phpdocumentor-signature__name">$structuredAppendSequence</span>
  560. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  561. <section class="phpdocumentor-description"></section>
  562. <section class="phpdocumentor-description"></section>
  563. </article>
  564. <article
  565. class="
  566. phpdocumentor-element
  567. -property
  568. -private
  569. "
  570. >
  571. <h4 class="phpdocumentor-element__name" id="property_version">
  572. $version
  573. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  574. <span class="phpdocumentor-element__modifiers">
  575. </span>
  576. </h4>
  577. <aside class="phpdocumentor-element-found-in">
  578. <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>
  579. :
  580. <span class="phpdocumentor-element-found-in__line">34</span>
  581. </aside>
  582. <code class="phpdocumentor-code phpdocumentor-signature ">
  583. <span class="phpdocumentor-signature__visibility">private</span>
  584. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  585. <span class="phpdocumentor-signature__name">$version</span>
  586. </code>
  587. <section class="phpdocumentor-description"></section>
  588. <section class="phpdocumentor-description"></section>
  589. </article>
  590. </section>
  591. <section class="phpdocumentor-methods">
  592. <h3 class="phpdocumentor-elements__header" id="methods">
  593. Methods
  594. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  595. </h3>
  596. <article
  597. class="phpdocumentor-element
  598. -method
  599. -public
  600. "
  601. >
  602. <h4 class="phpdocumentor-element__name" id="method___construct">
  603. __construct()
  604. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  605. </h4>
  606. <aside class="phpdocumentor-element-found-in">
  607. <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>
  608. :
  609. <span class="phpdocumentor-element-found-in__line">44</span>
  610. </aside>
  611. <p class="phpdocumentor-summary">DecoderResult constructor.</p>
  612. <code class="phpdocumentor-code phpdocumentor-signature ">
  613. <span class="phpdocumentor-signature__visibility">public</span>
  614. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">iteratable&lt;string|int, mixed&gt;&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>
  615. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  616. <dl class="phpdocumentor-argument-list">
  617. <dt class="phpdocumentor-argument-list__entry">
  618. <span class="phpdocumentor-signature__argument__name">$properties</span>
  619. : <span class="phpdocumentor-signature__argument__return-type">iteratable&lt;string|int, mixed&gt;</span>
  620. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  621. <dd class="phpdocumentor-argument-list__definition">
  622. <section class="phpdocumentor-description"></section>
  623. </dd>
  624. </dl>
  625. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  626. <span class="phpdocumentor-signature__response_type">mixed</span>
  627. &mdash;
  628. </article>
  629. <article
  630. class="phpdocumentor-element
  631. -method
  632. -public
  633. "
  634. >
  635. <h4 class="phpdocumentor-element__name" id="method___get">
  636. __get()
  637. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___get" class="headerlink"><i class="fas fa-link"></i></a>
  638. </h4>
  639. <aside class="phpdocumentor-element-found-in">
  640. <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>
  641. :
  642. <span class="phpdocumentor-element-found-in__line">64</span>
  643. </aside>
  644. <code class="phpdocumentor-code phpdocumentor-signature ">
  645. <span class="phpdocumentor-signature__visibility">public</span>
  646. <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|null</span></code>
  647. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  648. <dl class="phpdocumentor-argument-list">
  649. <dt class="phpdocumentor-argument-list__entry">
  650. <span class="phpdocumentor-signature__argument__name">$property</span>
  651. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  652. </dt>
  653. <dd class="phpdocumentor-argument-list__definition">
  654. <section class="phpdocumentor-description"></section>
  655. </dd>
  656. </dl>
  657. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  658. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  659. &mdash;
  660. </article>
  661. <article
  662. class="phpdocumentor-element
  663. -method
  664. -public
  665. "
  666. >
  667. <h4 class="phpdocumentor-element__name" id="method___toString">
  668. __toString()
  669. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h4>
  671. <aside class="phpdocumentor-element-found-in">
  672. <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>
  673. :
  674. <span class="phpdocumentor-element-found-in__line">76</span>
  675. </aside>
  676. <code class="phpdocumentor-code phpdocumentor-signature ">
  677. <span class="phpdocumentor-signature__visibility">public</span>
  678. <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  679. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  680. <span class="phpdocumentor-signature__response_type">string</span>
  681. &mdash;
  682. </article>
  683. <article
  684. class="phpdocumentor-element
  685. -method
  686. -public
  687. "
  688. >
  689. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  690. getMatrix()
  691. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  692. </h4>
  693. <aside class="phpdocumentor-element-found-in">
  694. <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>
  695. :
  696. <span class="phpdocumentor-element-found-in__line">90</span>
  697. </aside>
  698. <p class="phpdocumentor-summary">Returns a QRMatrix instance with thesettings and data of the reader result</p>
  699. <code class="phpdocumentor-code phpdocumentor-signature ">
  700. <span class="phpdocumentor-signature__visibility">public</span>
  701. <span class="phpdocumentor-signature__name">getMatrix</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>
  702. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  703. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  704. &mdash;
  705. </article>
  706. <article
  707. class="phpdocumentor-element
  708. -method
  709. -public
  710. "
  711. >
  712. <h4 class="phpdocumentor-element__name" id="method_hasStructuredAppend">
  713. hasStructuredAppend()
  714. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#method_hasStructuredAppend" class="headerlink"><i class="fas fa-link"></i></a>
  715. </h4>
  716. <aside class="phpdocumentor-element-found-in">
  717. <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>
  718. :
  719. <span class="phpdocumentor-element-found-in__line">83</span>
  720. </aside>
  721. <code class="phpdocumentor-code phpdocumentor-signature ">
  722. <span class="phpdocumentor-signature__visibility">public</span>
  723. <span class="phpdocumentor-signature__name">hasStructuredAppend</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  724. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  725. <span class="phpdocumentor-signature__response_type">bool</span>
  726. &mdash;
  727. </article>
  728. </section>
  729. <script type="text/javascript">
  730. function loadExternalCodeSnippets(line) {
  731. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  732. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  733. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  734. var language = 'php';
  735. var code = document.createElement('code');
  736. code.className = 'language-' + language;
  737. pre.textContent = '';
  738. pre.setAttribute('data-line', line)
  739. code.textContent = 'Loading…';
  740. pre.appendChild(code);
  741. var xhr = new XMLHttpRequest();
  742. xhr.open('GET', src, true);
  743. xhr.onreadystatechange = function () {
  744. if (xhr.readyState == 4) {
  745. if (xhr.status < 400 && xhr.responseText) {
  746. code.textContent = xhr.responseText;
  747. Prism.highlightElement(code);
  748. }
  749. else if (xhr.status >= 400) {
  750. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  751. }
  752. else {
  753. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  754. }
  755. }
  756. };
  757. xhr.send(null);
  758. });
  759. }
  760. var modals = document.querySelectorAll("[data-modal]");
  761. modals.forEach(function (trigger) {
  762. trigger.addEventListener("click", function (event) {
  763. //event.preventDefault();
  764. const modal = document.getElementById(trigger.dataset.modal);
  765. modal.classList.add("phpdocumentor-modal__open");
  766. loadExternalCodeSnippets(trigger.dataset.line)
  767. const exits = modal.querySelectorAll("[data-exit-button]");
  768. exits.forEach(function (exit) {
  769. exit.addEventListener("click", function (event) {
  770. event.preventDefault();
  771. modal.classList.remove("phpdocumentor-modal__open");
  772. });
  773. });
  774. });
  775. });
  776. </script>
  777. </article>
  778. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  779. <section class="phpdocumentor-search-results__dialog">
  780. <header class="phpdocumentor-search-results__header">
  781. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  782. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  783. </header>
  784. <section class="phpdocumentor-search-results__body">
  785. <ul class="phpdocumentor-search-results__entries"></ul>
  786. </section>
  787. </section>
  788. </section>
  789. </div>
  790. </div>
  791. <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  792. </main>
  793. <script>
  794. cssVars({});
  795. </script>
  796. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  797. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  798. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  799. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  800. </body>
  801. </html>