chillerlan-QRCode-Decoder-DecoderResult.html 45 KB

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