chillerlan-QRCode-Data-ReedSolomonEncoder.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. ReedSolomonEncoder
  109. <div class="phpdocumentor-element__package">
  110. in package
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  113. </ul>
  114. </div>
  115. </h2>
  116. <div class="phpdocumentor-label-line">
  117. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  118. </div>
  119. <aside class="phpdocumentor-element-found-in">
  120. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  121. :
  122. <span class="phpdocumentor-element-found-in__line">21</span>
  123. </aside>
  124. <p class="phpdocumentor-summary">Reed-Solomon encoding - ISO/IEC 18004:2000 Section 8.5 ff</p>
  125. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  126. Tags
  127. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  128. </h5>
  129. <dl class="phpdocumentor-tag-list">
  130. <dt class="phpdocumentor-tag-list__entry">
  131. <span class="phpdocumentor-tag__name">see</span>
  132. </dt>
  133. <dd class="phpdocumentor-tag-list__definition">
  134. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/error-correction-coding">http://www.thonky.com/qr-code-tutorial/error-correction-coding</a></span>
  135. </dd>
  136. </dl>
  137. <h3 id="toc">
  138. Table of Contents
  139. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h3>
  141. <h4 id="toc-properties">
  142. Properties
  143. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  144. </h4>
  145. <dl class="phpdocumentor-table-of-contents">
  146. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  147. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel">$eccLevel</a>
  148. <span>
  149. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  150. </dt>
  151. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  152. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData">$interleavedData</a>
  153. <span>
  154. &nbsp;: array&lt;string|int, mixed&gt; </span>
  155. </dt>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  157. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex">$interleavedDataIndex</a>
  158. <span>
  159. &nbsp;: int </span>
  160. </dt>
  161. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  162. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version">$version</a>
  163. <span>
  164. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  165. </dt>
  166. </dl>
  167. <h4 id="toc-methods">
  168. Methods
  169. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  170. </h4>
  171. <dl class="phpdocumentor-table-of-contents">
  172. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  173. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct">__construct()</a>
  174. <span>
  175. &nbsp;: mixed </span>
  176. </dt>
  177. <dd>ReedSolomonDecoder constructor</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  179. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes">interleaveEcBytes()</a>
  180. <span>
  181. &nbsp;: array&lt;string|int, mixed&gt; </span>
  182. </dt>
  183. <dd>ECC interleaving</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  185. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode">encode()</a>
  186. <span>
  187. &nbsp;: array&lt;string|int, mixed&gt; </span>
  188. </dt>
  189. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  190. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave">interleave()</a>
  191. <span>
  192. &nbsp;: void </span>
  193. </dt>
  194. </dl>
  195. <section class="phpdocumentor-properties">
  196. <h3 class="phpdocumentor-elements__header" id="properties">
  197. Properties
  198. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  199. </h3>
  200. <article
  201. class="
  202. phpdocumentor-element
  203. -property
  204. -private
  205. "
  206. >
  207. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  208. $eccLevel
  209. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  210. <span class="phpdocumentor-element__modifiers">
  211. </span>
  212. </h4>
  213. <aside class="phpdocumentor-element-found-in">
  214. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  215. :
  216. <span class="phpdocumentor-element-found-in__line">24</span>
  217. </aside>
  218. <code class="phpdocumentor-code phpdocumentor-signature ">
  219. <span class="phpdocumentor-signature__visibility">private</span>
  220. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  221. <span class="phpdocumentor-signature__name">$eccLevel</span>
  222. </code>
  223. </article>
  224. <article
  225. class="
  226. phpdocumentor-element
  227. -property
  228. -private
  229. "
  230. >
  231. <h4 class="phpdocumentor-element__name" id="property_interleavedData">
  232. $interleavedData
  233. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData" class="headerlink"><i class="fas fa-link"></i></a>
  234. <span class="phpdocumentor-element__modifiers">
  235. </span>
  236. </h4>
  237. <aside class="phpdocumentor-element-found-in">
  238. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  239. :
  240. <span class="phpdocumentor-element-found-in__line">26</span>
  241. </aside>
  242. <code class="phpdocumentor-code phpdocumentor-signature ">
  243. <span class="phpdocumentor-signature__visibility">private</span>
  244. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  245. <span class="phpdocumentor-signature__name">$interleavedData</span>
  246. </code>
  247. </article>
  248. <article
  249. class="
  250. phpdocumentor-element
  251. -property
  252. -private
  253. "
  254. >
  255. <h4 class="phpdocumentor-element__name" id="property_interleavedDataIndex">
  256. $interleavedDataIndex
  257. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex" class="headerlink"><i class="fas fa-link"></i></a>
  258. <span class="phpdocumentor-element__modifiers">
  259. </span>
  260. </h4>
  261. <aside class="phpdocumentor-element-found-in">
  262. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  263. :
  264. <span class="phpdocumentor-element-found-in__line">27</span>
  265. </aside>
  266. <code class="phpdocumentor-code phpdocumentor-signature ">
  267. <span class="phpdocumentor-signature__visibility">private</span>
  268. <span class="phpdocumentor-signature__type">int</span>
  269. <span class="phpdocumentor-signature__name">$interleavedDataIndex</span>
  270. </code>
  271. </article>
  272. <article
  273. class="
  274. phpdocumentor-element
  275. -property
  276. -private
  277. "
  278. >
  279. <h4 class="phpdocumentor-element__name" id="property_version">
  280. $version
  281. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version" 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/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  287. :
  288. <span class="phpdocumentor-element-found-in__line">23</span>
  289. </aside>
  290. <code class="phpdocumentor-code phpdocumentor-signature ">
  291. <span class="phpdocumentor-signature__visibility">private</span>
  292. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  293. <span class="phpdocumentor-signature__name">$version</span>
  294. </code>
  295. </article>
  296. </section>
  297. <section class="phpdocumentor-methods">
  298. <h3 class="phpdocumentor-elements__header" id="methods">
  299. Methods
  300. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  301. </h3>
  302. <article
  303. class="phpdocumentor-element
  304. -method
  305. -public
  306. "
  307. >
  308. <h4 class="phpdocumentor-element__name" id="method___construct">
  309. __construct()
  310. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  311. </h4>
  312. <aside class="phpdocumentor-element-found-in">
  313. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  314. :
  315. <span class="phpdocumentor-element-found-in__line">32</span>
  316. </aside>
  317. <p class="phpdocumentor-summary">ReedSolomonDecoder constructor</p>
  318. <code class="phpdocumentor-code phpdocumentor-signature ">
  319. <span class="phpdocumentor-signature__visibility">public</span>
  320. <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>
  321. <div class="phpdocumentor-label-line">
  322. </div>
  323. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  324. <dl class="phpdocumentor-argument-list">
  325. <dt class="phpdocumentor-argument-list__entry">
  326. <span class="phpdocumentor-signature__argument__name">$version</span>
  327. : <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>
  328. </dt>
  329. <dd class="phpdocumentor-argument-list__definition">
  330. </dd>
  331. <dt class="phpdocumentor-argument-list__entry">
  332. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  333. : <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>
  334. </dt>
  335. <dd class="phpdocumentor-argument-list__definition">
  336. </dd>
  337. </dl>
  338. </article>
  339. <article
  340. class="phpdocumentor-element
  341. -method
  342. -public
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="method_interleaveEcBytes">
  346. interleaveEcBytes()
  347. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes" class="headerlink"><i class="fas fa-link"></i></a>
  348. </h4>
  349. <aside class="phpdocumentor-element-found-in">
  350. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  351. :
  352. <span class="phpdocumentor-element-found-in__line">42</span>
  353. </aside>
  354. <p class="phpdocumentor-summary">ECC interleaving</p>
  355. <code class="phpdocumentor-code phpdocumentor-signature ">
  356. <span class="phpdocumentor-signature__visibility">public</span>
  357. <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>
  358. <div class="phpdocumentor-label-line">
  359. </div>
  360. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  361. <dl class="phpdocumentor-argument-list">
  362. <dt class="phpdocumentor-argument-list__entry">
  363. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  364. : <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>
  365. </dt>
  366. <dd class="phpdocumentor-argument-list__definition">
  367. </dd>
  368. </dl>
  369. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  370. Tags
  371. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes#tags" class="headerlink"><i class="fas fa-link"></i></a>
  372. </h5>
  373. <dl class="phpdocumentor-tag-list">
  374. <dt class="phpdocumentor-tag-list__entry">
  375. <span class="phpdocumentor-tag__name">throws</span>
  376. </dt>
  377. <dd class="phpdocumentor-tag-list__definition">
  378. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  379. </dd>
  380. </dl>
  381. <section>
  382. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  383. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  384. </section>
  385. </article>
  386. <article
  387. class="phpdocumentor-element
  388. -method
  389. -private
  390. "
  391. >
  392. <h4 class="phpdocumentor-element__name" id="method_encode">
  393. encode()
  394. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode" class="headerlink"><i class="fas fa-link"></i></a>
  395. </h4>
  396. <aside class="phpdocumentor-element-found-in">
  397. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  398. :
  399. <span class="phpdocumentor-element-found-in__line">85</span>
  400. </aside>
  401. <code class="phpdocumentor-code phpdocumentor-signature ">
  402. <span class="phpdocumentor-signature__visibility">private</span>
  403. <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>
  404. <div class="phpdocumentor-label-line">
  405. </div>
  406. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  407. <dl class="phpdocumentor-argument-list">
  408. <dt class="phpdocumentor-argument-list__entry">
  409. <span class="phpdocumentor-signature__argument__name">$dataBytes</span>
  410. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  411. </dt>
  412. <dd class="phpdocumentor-argument-list__definition">
  413. </dd>
  414. <dt class="phpdocumentor-argument-list__entry">
  415. <span class="phpdocumentor-signature__argument__name">$ecByteCount</span>
  416. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  417. </dt>
  418. <dd class="phpdocumentor-argument-list__definition">
  419. </dd>
  420. </dl>
  421. <section>
  422. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  423. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  424. </section>
  425. </article>
  426. <article
  427. class="phpdocumentor-element
  428. -method
  429. -private
  430. "
  431. >
  432. <h4 class="phpdocumentor-element__name" id="method_interleave">
  433. interleave()
  434. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave" class="headerlink"><i class="fas fa-link"></i></a>
  435. </h4>
  436. <aside class="phpdocumentor-element-found-in">
  437. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  438. :
  439. <span class="phpdocumentor-element-found-in__line">117</span>
  440. </aside>
  441. <code class="phpdocumentor-code phpdocumentor-signature ">
  442. <span class="phpdocumentor-signature__visibility">private</span>
  443. <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>
  444. <div class="phpdocumentor-label-line">
  445. </div>
  446. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  447. <dl class="phpdocumentor-argument-list">
  448. <dt class="phpdocumentor-argument-list__entry">
  449. <span class="phpdocumentor-signature__argument__name">$byteArray</span>
  450. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  451. </dt>
  452. <dd class="phpdocumentor-argument-list__definition">
  453. </dd>
  454. <dt class="phpdocumentor-argument-list__entry">
  455. <span class="phpdocumentor-signature__argument__name">$maxBytes</span>
  456. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  457. </dt>
  458. <dd class="phpdocumentor-argument-list__definition">
  459. </dd>
  460. <dt class="phpdocumentor-argument-list__entry">
  461. <span class="phpdocumentor-signature__argument__name">$numRsBlocks</span>
  462. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  463. </dt>
  464. <dd class="phpdocumentor-argument-list__definition">
  465. </dd>
  466. </dl>
  467. </article>
  468. </section>
  469. <div class="phpdocumentor-modal" id="source-view">
  470. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  471. <div class="phpdocumentor-modal-container">
  472. <div class="phpdocumentor-modal-content">
  473. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Data/ReedSolomonEncoder.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  474. </div>
  475. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  476. </div>
  477. </div>
  478. <script type="text/javascript">
  479. (function () {
  480. function loadExternalCodeSnippet(el, url, line) {
  481. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  482. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  483. const language = 'php';
  484. const code = document.createElement('code');
  485. code.className = 'language-' + language;
  486. pre.textContent = '';
  487. pre.setAttribute('data-line', line)
  488. code.textContent = 'Loading…';
  489. pre.appendChild(code);
  490. var xhr = new XMLHttpRequest();
  491. xhr.open('GET', src, true);
  492. xhr.onreadystatechange = function () {
  493. if (xhr.readyState !== 4) {
  494. return;
  495. }
  496. if (xhr.status < 400 && xhr.responseText) {
  497. code.textContent = xhr.responseText;
  498. Prism.highlightElement(code);
  499. return;
  500. }
  501. if (xhr.status === 404) {
  502. code.textContent = '✖ Error: File could not be found';
  503. return;
  504. }
  505. if (xhr.status >= 400) {
  506. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  507. return;
  508. }
  509. code.textContent = '✖ Error: An unknown error occurred';
  510. };
  511. xhr.send(null);
  512. });
  513. }
  514. const modalButtons = document.querySelectorAll("[data-modal]");
  515. const openedAsLocalFile = window.location.protocol === 'file:';
  516. if (modalButtons.length > 0 && openedAsLocalFile) {
  517. console.warn(
  518. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  519. 'browsers block XHR requests when a page is opened this way'
  520. );
  521. }
  522. modalButtons.forEach(function (trigger) {
  523. if (openedAsLocalFile) {
  524. trigger.setAttribute("hidden", "hidden");
  525. }
  526. trigger.addEventListener("click", function (event) {
  527. event.preventDefault();
  528. const modal = document.getElementById(trigger.dataset.modal);
  529. if (!modal) {
  530. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  531. return;
  532. }
  533. modal.classList.add("phpdocumentor-modal__open");
  534. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  535. const exits = modal.querySelectorAll("[data-exit-button]");
  536. exits.forEach(function (exit) {
  537. exit.addEventListener("click", function (event) {
  538. event.preventDefault();
  539. modal.classList.remove("phpdocumentor-modal__open");
  540. });
  541. });
  542. });
  543. });
  544. })();
  545. </script>
  546. </article>
  547. </section>
  548. <section class="phpdocumentor-on-this-page__sidebar">
  549. <section class="phpdocumentor-on-this-page__content">
  550. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  551. <ul class="phpdocumentor-list -clean">
  552. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  553. <li>
  554. <ul class="phpdocumentor-list -clean">
  555. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-properties">Properties</a></li>
  556. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-methods">Methods</a></li>
  557. </ul>
  558. </li>
  559. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  560. <li>
  561. <ul class="phpdocumentor-list -clean">
  562. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel">$eccLevel<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  563. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData">$interleavedData<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  564. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex">$interleavedDataIndex<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  565. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version">$version<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  566. </ul>
  567. </li>
  568. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  569. <li>
  570. <ul class="phpdocumentor-list -clean">
  571. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct">__construct()</a></li>
  572. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes">interleaveEcBytes()</a></li>
  573. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode">encode()</a></li>
  574. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave">interleave()</a></li>
  575. </ul>
  576. </li>
  577. </ul>
  578. </section>
  579. </section>
  580. </div>
  581. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  582. <section class="phpdocumentor-search-results__dialog">
  583. <header class="phpdocumentor-search-results__header">
  584. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  585. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  586. </header>
  587. <section class="phpdocumentor-search-results__body">
  588. <ul class="phpdocumentor-search-results__entries"></ul>
  589. </section>
  590. </section>
  591. </section>
  592. </div>
  593. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  594. </main>
  595. <script>
  596. cssVars({});
  597. </script>
  598. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  599. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  600. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  601. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  602. </body>
  603. </html>