chillerlan-QRCode-Common-ReedSolomonEncoder.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  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-common.html">Common</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. ReedSolomonEncoder
  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/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">20</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Section 8.5 ff</p>
  106. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  107. Tags
  108. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  109. </h5>
  110. <dl class="phpdocumentor-tag-list">
  111. <dt class="phpdocumentor-tag-list__entry">
  112. <span class="phpdocumentor-tag__name">see</span>
  113. </dt>
  114. <dd class="phpdocumentor-tag-list__definition">
  115. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/error-correction-coding"><abbr title="http://www.thonky.com/qr-code-tutorial/error-correction-coding">http://www.thonky.com/qr-code-tutorial/error-correction-coding</abbr></a></span>
  116. </dd>
  117. </dl>
  118. <h3 id="toc">
  119. Table of Contents
  120. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  121. </h3>
  122. <dl class="phpdocumentor-table-of-contents">
  123. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  124. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_eccLevel">$eccLevel</a>
  125. <span>
  126. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  127. </dt>
  128. <dd></dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  130. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_interleavedData">$interleavedData</a>
  131. <span>
  132. &nbsp;: array&lt;string|int, mixed&gt; </span>
  133. </dt>
  134. <dd></dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  136. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_interleavedDataIndex">$interleavedDataIndex</a>
  137. <span>
  138. &nbsp;: int </span>
  139. </dt>
  140. <dd></dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  142. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_version">$version</a>
  143. <span>
  144. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  145. </dt>
  146. <dd></dd>
  147. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  148. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method___construct">__construct()</a>
  149. <span>
  150. &nbsp;: mixed </span>
  151. </dt>
  152. <dd>ReedSolomonDecoder constructor</dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  154. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_interleaveEcBytes">interleaveEcBytes()</a>
  155. <span>
  156. &nbsp;: array&lt;string|int, mixed&gt; </span>
  157. </dt>
  158. <dd>ECC interleaving</dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  160. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_encode">encode()</a>
  161. <span>
  162. &nbsp;: array&lt;string|int, mixed&gt; </span>
  163. </dt>
  164. <dd></dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  166. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_interleave">interleave()</a>
  167. <span>
  168. &nbsp;: void </span>
  169. </dt>
  170. <dd></dd>
  171. </dl>
  172. <section class="phpdocumentor-properties">
  173. <h3 class="phpdocumentor-elements__header" id="properties">
  174. Properties
  175. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  176. </h3>
  177. <article
  178. class="
  179. phpdocumentor-element
  180. -property
  181. -private
  182. "
  183. >
  184. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  185. $eccLevel
  186. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  187. <span class="phpdocumentor-element__modifiers">
  188. </span>
  189. </h4>
  190. <aside class="phpdocumentor-element-found-in">
  191. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  192. :
  193. <span class="phpdocumentor-element-found-in__line">23</span>
  194. </aside>
  195. <code class="phpdocumentor-code phpdocumentor-signature ">
  196. <span class="phpdocumentor-signature__visibility">private</span>
  197. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  198. <span class="phpdocumentor-signature__name">$eccLevel</span>
  199. </code>
  200. <section class="phpdocumentor-description"></section>
  201. <section class="phpdocumentor-description"></section>
  202. </article>
  203. <article
  204. class="
  205. phpdocumentor-element
  206. -property
  207. -private
  208. "
  209. >
  210. <h4 class="phpdocumentor-element__name" id="property_interleavedData">
  211. $interleavedData
  212. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_interleavedData" class="headerlink"><i class="fas fa-link"></i></a>
  213. <span class="phpdocumentor-element__modifiers">
  214. </span>
  215. </h4>
  216. <aside class="phpdocumentor-element-found-in">
  217. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  218. :
  219. <span class="phpdocumentor-element-found-in__line">25</span>
  220. </aside>
  221. <code class="phpdocumentor-code phpdocumentor-signature ">
  222. <span class="phpdocumentor-signature__visibility">private</span>
  223. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  224. <span class="phpdocumentor-signature__name">$interleavedData</span>
  225. </code>
  226. <section class="phpdocumentor-description"></section>
  227. <section class="phpdocumentor-description"></section>
  228. </article>
  229. <article
  230. class="
  231. phpdocumentor-element
  232. -property
  233. -private
  234. "
  235. >
  236. <h4 class="phpdocumentor-element__name" id="property_interleavedDataIndex">
  237. $interleavedDataIndex
  238. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_interleavedDataIndex" class="headerlink"><i class="fas fa-link"></i></a>
  239. <span class="phpdocumentor-element__modifiers">
  240. </span>
  241. </h4>
  242. <aside class="phpdocumentor-element-found-in">
  243. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  244. :
  245. <span class="phpdocumentor-element-found-in__line">26</span>
  246. </aside>
  247. <code class="phpdocumentor-code phpdocumentor-signature ">
  248. <span class="phpdocumentor-signature__visibility">private</span>
  249. <span class="phpdocumentor-signature__type">int</span>
  250. <span class="phpdocumentor-signature__name">$interleavedDataIndex</span>
  251. </code>
  252. <section class="phpdocumentor-description"></section>
  253. <section class="phpdocumentor-description"></section>
  254. </article>
  255. <article
  256. class="
  257. phpdocumentor-element
  258. -property
  259. -private
  260. "
  261. >
  262. <h4 class="phpdocumentor-element__name" id="property_version">
  263. $version
  264. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  265. <span class="phpdocumentor-element__modifiers">
  266. </span>
  267. </h4>
  268. <aside class="phpdocumentor-element-found-in">
  269. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  270. :
  271. <span class="phpdocumentor-element-found-in__line">22</span>
  272. </aside>
  273. <code class="phpdocumentor-code phpdocumentor-signature ">
  274. <span class="phpdocumentor-signature__visibility">private</span>
  275. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  276. <span class="phpdocumentor-signature__name">$version</span>
  277. </code>
  278. <section class="phpdocumentor-description"></section>
  279. <section class="phpdocumentor-description"></section>
  280. </article>
  281. </section>
  282. <section class="phpdocumentor-methods">
  283. <h3 class="phpdocumentor-elements__header" id="methods">
  284. Methods
  285. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  286. </h3>
  287. <article
  288. class="phpdocumentor-element
  289. -method
  290. -public
  291. "
  292. >
  293. <h4 class="phpdocumentor-element__name" id="method___construct">
  294. __construct()
  295. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  296. </h4>
  297. <aside class="phpdocumentor-element-found-in">
  298. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  299. :
  300. <span class="phpdocumentor-element-found-in__line">31</span>
  301. </aside>
  302. <p class="phpdocumentor-summary">ReedSolomonDecoder constructor</p>
  303. <code class="phpdocumentor-code phpdocumentor-signature ">
  304. <span class="phpdocumentor-signature__visibility">public</span>
  305. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  306. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  307. <dl class="phpdocumentor-argument-list">
  308. <dt class="phpdocumentor-argument-list__entry">
  309. <span class="phpdocumentor-signature__argument__name">$version</span>
  310. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  311. </dt>
  312. <dd class="phpdocumentor-argument-list__definition">
  313. <section class="phpdocumentor-description"></section>
  314. </dd>
  315. <dt class="phpdocumentor-argument-list__entry">
  316. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  317. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  318. </dt>
  319. <dd class="phpdocumentor-argument-list__definition">
  320. <section class="phpdocumentor-description"></section>
  321. </dd>
  322. </dl>
  323. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  324. <span class="phpdocumentor-signature__response_type">mixed</span>
  325. &mdash;
  326. </article>
  327. <article
  328. class="phpdocumentor-element
  329. -method
  330. -public
  331. "
  332. >
  333. <h4 class="phpdocumentor-element__name" id="method_interleaveEcBytes">
  334. interleaveEcBytes()
  335. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_interleaveEcBytes" class="headerlink"><i class="fas fa-link"></i></a>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">41</span>
  341. </aside>
  342. <p class="phpdocumentor-summary">ECC interleaving</p>
  343. <code class="phpdocumentor-code phpdocumentor-signature ">
  344. <span class="phpdocumentor-signature__visibility">public</span>
  345. <span class="phpdocumentor-signature__name">interleaveEcBytes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  346. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  347. <dl class="phpdocumentor-argument-list">
  348. <dt class="phpdocumentor-argument-list__entry">
  349. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  350. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  351. </dt>
  352. <dd class="phpdocumentor-argument-list__definition">
  353. <section class="phpdocumentor-description"></section>
  354. </dd>
  355. </dl>
  356. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  357. Tags
  358. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  359. </h5>
  360. <dl class="phpdocumentor-tag-list">
  361. <dt class="phpdocumentor-tag-list__entry">
  362. <span class="phpdocumentor-tag__name">throws</span>
  363. </dt>
  364. <dd class="phpdocumentor-tag-list__definition">
  365. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  366. </dd>
  367. </dl>
  368. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  369. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  370. &mdash;
  371. </article>
  372. <article
  373. class="phpdocumentor-element
  374. -method
  375. -private
  376. "
  377. >
  378. <h4 class="phpdocumentor-element__name" id="method_encode">
  379. encode()
  380. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_encode" class="headerlink"><i class="fas fa-link"></i></a>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">86</span>
  386. </aside>
  387. <code class="phpdocumentor-code phpdocumentor-signature ">
  388. <span class="phpdocumentor-signature__visibility">private</span>
  389. <span class="phpdocumentor-signature__name">encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dataBytes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ecByteCount</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  390. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  391. <dl class="phpdocumentor-argument-list">
  392. <dt class="phpdocumentor-argument-list__entry">
  393. <span class="phpdocumentor-signature__argument__name">$dataBytes</span>
  394. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  395. </dt>
  396. <dd class="phpdocumentor-argument-list__definition">
  397. <section class="phpdocumentor-description"></section>
  398. </dd>
  399. <dt class="phpdocumentor-argument-list__entry">
  400. <span class="phpdocumentor-signature__argument__name">$ecByteCount</span>
  401. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  402. </dt>
  403. <dd class="phpdocumentor-argument-list__definition">
  404. <section class="phpdocumentor-description"></section>
  405. </dd>
  406. </dl>
  407. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  408. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  409. &mdash;
  410. </article>
  411. <article
  412. class="phpdocumentor-element
  413. -method
  414. -private
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="method_interleave">
  418. interleave()
  419. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#method_interleave" class="headerlink"><i class="fas fa-link"></i></a>
  420. </h4>
  421. <aside class="phpdocumentor-element-found-in">
  422. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/ReedSolomonEncoder.php"><a href="files/src-common-reedsolomonencoder.html"><abbr title="src/Common/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  423. :
  424. <span class="phpdocumentor-element-found-in__line">114</span>
  425. </aside>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">private</span>
  428. <span class="phpdocumentor-signature__name">interleave</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$byteArray</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maxBytes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$numRsBlocks</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  429. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  430. <dl class="phpdocumentor-argument-list">
  431. <dt class="phpdocumentor-argument-list__entry">
  432. <span class="phpdocumentor-signature__argument__name">$byteArray</span>
  433. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  434. </dt>
  435. <dd class="phpdocumentor-argument-list__definition">
  436. <section class="phpdocumentor-description"></section>
  437. </dd>
  438. <dt class="phpdocumentor-argument-list__entry">
  439. <span class="phpdocumentor-signature__argument__name">$maxBytes</span>
  440. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  441. </dt>
  442. <dd class="phpdocumentor-argument-list__definition">
  443. <section class="phpdocumentor-description"></section>
  444. </dd>
  445. <dt class="phpdocumentor-argument-list__entry">
  446. <span class="phpdocumentor-signature__argument__name">$numRsBlocks</span>
  447. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  448. </dt>
  449. <dd class="phpdocumentor-argument-list__definition">
  450. <section class="phpdocumentor-description"></section>
  451. </dd>
  452. </dl>
  453. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  454. <span class="phpdocumentor-signature__response_type">void</span>
  455. &mdash;
  456. </article>
  457. </section>
  458. <script type="text/javascript">
  459. function loadExternalCodeSnippets(line) {
  460. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  461. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  462. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  463. var language = 'php';
  464. var code = document.createElement('code');
  465. code.className = 'language-' + language;
  466. pre.textContent = '';
  467. pre.setAttribute('data-line', line)
  468. code.textContent = 'Loading…';
  469. pre.appendChild(code);
  470. var xhr = new XMLHttpRequest();
  471. xhr.open('GET', src, true);
  472. xhr.onreadystatechange = function () {
  473. if (xhr.readyState == 4) {
  474. if (xhr.status < 400 && xhr.responseText) {
  475. code.textContent = xhr.responseText;
  476. Prism.highlightElement(code);
  477. }
  478. else if (xhr.status >= 400) {
  479. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  480. }
  481. else {
  482. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  483. }
  484. }
  485. };
  486. xhr.send(null);
  487. });
  488. }
  489. var modals = document.querySelectorAll("[data-modal]");
  490. modals.forEach(function (trigger) {
  491. trigger.addEventListener("click", function (event) {
  492. //event.preventDefault();
  493. const modal = document.getElementById(trigger.dataset.modal);
  494. modal.classList.add("phpdocumentor-modal__open");
  495. loadExternalCodeSnippets(trigger.dataset.line)
  496. const exits = modal.querySelectorAll("[data-exit-button]");
  497. exits.forEach(function (exit) {
  498. exit.addEventListener("click", function (event) {
  499. event.preventDefault();
  500. modal.classList.remove("phpdocumentor-modal__open");
  501. });
  502. });
  503. });
  504. });
  505. </script>
  506. </article>
  507. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  508. <section class="phpdocumentor-search-results__dialog">
  509. <header class="phpdocumentor-search-results__header">
  510. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  511. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  512. </header>
  513. <section class="phpdocumentor-search-results__body">
  514. <ul class="phpdocumentor-search-results__entries"></ul>
  515. </section>
  516. </section>
  517. </section>
  518. </div>
  519. </div>
  520. <a href="classes/chillerlan-QRCode-Common-ReedSolomonEncoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  521. </main>
  522. <script>
  523. cssVars({});
  524. </script>
  525. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  526. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  527. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  528. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  529. </body>
  530. </html>