chillerlan-QRCode-Decoder-DecoderResult.html 42 KB

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