chillerlan-QRCode-Data-ReedSolomonEncoder.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  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. <h4 class="phpdocumentor-sidebar__root-namespace">
  82. <a href="namespaces/output.html" class="">Output</a>
  83. </h4>
  84. </section>
  85. <section class="phpdocumentor-sidebar__category">
  86. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  87. <h4 class="phpdocumentor-sidebar__root-namespace">
  88. <a href="packages/Application.html" class="">Application</a>
  89. </h4>
  90. </section>
  91. <section class="phpdocumentor-sidebar__category">
  92. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  93. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  94. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  96. </section>
  97. <section class="phpdocumentor-sidebar__category">
  98. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  100. </section>
  101. </aside>
  102. <div class="phpdocumentor-column -nine phpdocumentor-content">
  103. <section>
  104. <ul class="phpdocumentor-breadcrumbs">
  105. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  106. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  107. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  108. </ul>
  109. <article class="phpdocumentor-element -class">
  110. <h2 class="phpdocumentor-content__title">
  111. ReedSolomonEncoder
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  121. </div>
  122. <aside class="phpdocumentor-element-found-in">
  123. <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>
  124. :
  125. <span class="phpdocumentor-element-found-in__line">21</span>
  126. </aside>
  127. <p class="phpdocumentor-summary">Reed-Solomon encoding - ISO/IEC 18004:2000 Section 8.5 ff</p>
  128. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  129. Tags
  130. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  131. </h5>
  132. <dl class="phpdocumentor-tag-list">
  133. <dt class="phpdocumentor-tag-list__entry">
  134. <span class="phpdocumentor-tag__name">see</span>
  135. </dt>
  136. <dd class="phpdocumentor-tag-list__definition">
  137. <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>
  138. </dd>
  139. </dl>
  140. <h3 id="toc">
  141. Table of Contents
  142. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  143. </h3>
  144. <h4 id="toc-properties">
  145. Properties
  146. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  147. </h4>
  148. <dl class="phpdocumentor-table-of-contents">
  149. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  150. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel">$eccLevel</a>
  151. <span>
  152. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  153. </dt>
  154. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  155. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData">$interleavedData</a>
  156. <span>
  157. &nbsp;: array&lt;string|int, mixed&gt; </span>
  158. </dt>
  159. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  160. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex">$interleavedDataIndex</a>
  161. <span>
  162. &nbsp;: int </span>
  163. </dt>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  165. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version">$version</a>
  166. <span>
  167. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  168. </dt>
  169. </dl>
  170. <h4 id="toc-methods">
  171. Methods
  172. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  173. </h4>
  174. <dl class="phpdocumentor-table-of-contents">
  175. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  176. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct">__construct()</a>
  177. <span>
  178. &nbsp;: mixed </span>
  179. </dt>
  180. <dd>ReedSolomonDecoder constructor</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  182. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes">interleaveEcBytes()</a>
  183. <span>
  184. &nbsp;: array&lt;string|int, mixed&gt; </span>
  185. </dt>
  186. <dd>ECC encoding and interleaving</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  188. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode">encode()</a>
  189. <span>
  190. &nbsp;: array&lt;string|int, mixed&gt; </span>
  191. </dt>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  193. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave">interleave()</a>
  194. <span>
  195. &nbsp;: void </span>
  196. </dt>
  197. </dl>
  198. <section class="phpdocumentor-properties">
  199. <h3 class="phpdocumentor-elements__header" id="properties">
  200. Properties
  201. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  202. </h3>
  203. <article
  204. class="
  205. phpdocumentor-element
  206. -property
  207. -private
  208. "
  209. >
  210. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  211. $eccLevel
  212. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel" 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/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  218. :
  219. <span class="phpdocumentor-element-found-in__line">24</span>
  220. </aside>
  221. <code class="phpdocumentor-code phpdocumentor-signature ">
  222. <span class="phpdocumentor-signature__visibility">private</span>
  223. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  224. <span class="phpdocumentor-signature__name">$eccLevel</span>
  225. </code>
  226. </article>
  227. <article
  228. class="
  229. phpdocumentor-element
  230. -property
  231. -private
  232. "
  233. >
  234. <h4 class="phpdocumentor-element__name" id="property_interleavedData">
  235. $interleavedData
  236. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData" 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/Data/ReedSolomonEncoder.php"><a href="files/src-data-reedsolomonencoder.html"><abbr title="src/Data/ReedSolomonEncoder.php">ReedSolomonEncoder.php</abbr></a></abbr>
  242. :
  243. <span class="phpdocumentor-element-found-in__line">26</span>
  244. </aside>
  245. <code class="phpdocumentor-code phpdocumentor-signature ">
  246. <span class="phpdocumentor-signature__visibility">private</span>
  247. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  248. <span class="phpdocumentor-signature__name">$interleavedData</span>
  249. </code>
  250. </article>
  251. <article
  252. class="
  253. phpdocumentor-element
  254. -property
  255. -private
  256. "
  257. >
  258. <h4 class="phpdocumentor-element__name" id="property_interleavedDataIndex">
  259. $interleavedDataIndex
  260. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex" class="headerlink"><i class="fas fa-link"></i></a>
  261. <span class="phpdocumentor-element__modifiers">
  262. </span>
  263. </h4>
  264. <aside class="phpdocumentor-element-found-in">
  265. <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>
  266. :
  267. <span class="phpdocumentor-element-found-in__line">27</span>
  268. </aside>
  269. <code class="phpdocumentor-code phpdocumentor-signature ">
  270. <span class="phpdocumentor-signature__visibility">private</span>
  271. <span class="phpdocumentor-signature__type">int</span>
  272. <span class="phpdocumentor-signature__name">$interleavedDataIndex</span>
  273. </code>
  274. </article>
  275. <article
  276. class="
  277. phpdocumentor-element
  278. -property
  279. -private
  280. "
  281. >
  282. <h4 class="phpdocumentor-element__name" id="property_version">
  283. $version
  284. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  285. <span class="phpdocumentor-element__modifiers">
  286. </span>
  287. </h4>
  288. <aside class="phpdocumentor-element-found-in">
  289. <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>
  290. :
  291. <span class="phpdocumentor-element-found-in__line">23</span>
  292. </aside>
  293. <code class="phpdocumentor-code phpdocumentor-signature ">
  294. <span class="phpdocumentor-signature__visibility">private</span>
  295. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  296. <span class="phpdocumentor-signature__name">$version</span>
  297. </code>
  298. </article>
  299. </section>
  300. <section class="phpdocumentor-methods">
  301. <h3 class="phpdocumentor-elements__header" id="methods">
  302. Methods
  303. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  304. </h3>
  305. <article
  306. class="phpdocumentor-element
  307. -method
  308. -public
  309. "
  310. >
  311. <h4 class="phpdocumentor-element__name" id="method___construct">
  312. __construct()
  313. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  314. </h4>
  315. <aside class="phpdocumentor-element-found-in">
  316. <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>
  317. :
  318. <span class="phpdocumentor-element-found-in__line">32</span>
  319. </aside>
  320. <p class="phpdocumentor-summary">ReedSolomonDecoder constructor</p>
  321. <code class="phpdocumentor-code phpdocumentor-signature ">
  322. <span class="phpdocumentor-signature__visibility">public</span>
  323. <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>
  324. <div class="phpdocumentor-label-line">
  325. </div>
  326. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  327. <dl class="phpdocumentor-argument-list">
  328. <dt class="phpdocumentor-argument-list__entry">
  329. <span class="phpdocumentor-signature__argument__name">$version</span>
  330. : <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>
  331. </dt>
  332. <dd class="phpdocumentor-argument-list__definition">
  333. </dd>
  334. <dt class="phpdocumentor-argument-list__entry">
  335. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  336. : <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>
  337. </dt>
  338. <dd class="phpdocumentor-argument-list__definition">
  339. </dd>
  340. </dl>
  341. </article>
  342. <article
  343. class="phpdocumentor-element
  344. -method
  345. -public
  346. "
  347. >
  348. <h4 class="phpdocumentor-element__name" id="method_interleaveEcBytes">
  349. interleaveEcBytes()
  350. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes" class="headerlink"><i class="fas fa-link"></i></a>
  351. </h4>
  352. <aside class="phpdocumentor-element-found-in">
  353. <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>
  354. :
  355. <span class="phpdocumentor-element-found-in__line">42</span>
  356. </aside>
  357. <p class="phpdocumentor-summary">ECC encoding and interleaving</p>
  358. <code class="phpdocumentor-code phpdocumentor-signature ">
  359. <span class="phpdocumentor-signature__visibility">public</span>
  360. <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>
  361. <div class="phpdocumentor-label-line">
  362. </div>
  363. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  364. <dl class="phpdocumentor-argument-list">
  365. <dt class="phpdocumentor-argument-list__entry">
  366. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  367. : <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>
  368. </dt>
  369. <dd class="phpdocumentor-argument-list__definition">
  370. </dd>
  371. </dl>
  372. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  373. Tags
  374. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes#tags" class="headerlink"><i class="fas fa-link"></i></a>
  375. </h5>
  376. <dl class="phpdocumentor-tag-list">
  377. <dt class="phpdocumentor-tag-list__entry">
  378. <span class="phpdocumentor-tag__name">throws</span>
  379. </dt>
  380. <dd class="phpdocumentor-tag-list__definition">
  381. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  382. </dd>
  383. </dl>
  384. <section>
  385. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  386. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  387. </section>
  388. </article>
  389. <article
  390. class="phpdocumentor-element
  391. -method
  392. -private
  393. "
  394. >
  395. <h4 class="phpdocumentor-element__name" id="method_encode">
  396. encode()
  397. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode" class="headerlink"><i class="fas fa-link"></i></a>
  398. </h4>
  399. <aside class="phpdocumentor-element-found-in">
  400. <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>
  401. :
  402. <span class="phpdocumentor-element-found-in__line">85</span>
  403. </aside>
  404. <code class="phpdocumentor-code phpdocumentor-signature ">
  405. <span class="phpdocumentor-signature__visibility">private</span>
  406. <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>
  407. <div class="phpdocumentor-label-line">
  408. </div>
  409. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  410. <dl class="phpdocumentor-argument-list">
  411. <dt class="phpdocumentor-argument-list__entry">
  412. <span class="phpdocumentor-signature__argument__name">$dataBytes</span>
  413. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  414. </dt>
  415. <dd class="phpdocumentor-argument-list__definition">
  416. </dd>
  417. <dt class="phpdocumentor-argument-list__entry">
  418. <span class="phpdocumentor-signature__argument__name">$ecByteCount</span>
  419. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  420. </dt>
  421. <dd class="phpdocumentor-argument-list__definition">
  422. </dd>
  423. </dl>
  424. <section>
  425. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  426. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  427. </section>
  428. </article>
  429. <article
  430. class="phpdocumentor-element
  431. -method
  432. -private
  433. "
  434. >
  435. <h4 class="phpdocumentor-element__name" id="method_interleave">
  436. interleave()
  437. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave" class="headerlink"><i class="fas fa-link"></i></a>
  438. </h4>
  439. <aside class="phpdocumentor-element-found-in">
  440. <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>
  441. :
  442. <span class="phpdocumentor-element-found-in__line">117</span>
  443. </aside>
  444. <code class="phpdocumentor-code phpdocumentor-signature ">
  445. <span class="phpdocumentor-signature__visibility">private</span>
  446. <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>
  447. <div class="phpdocumentor-label-line">
  448. </div>
  449. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  450. <dl class="phpdocumentor-argument-list">
  451. <dt class="phpdocumentor-argument-list__entry">
  452. <span class="phpdocumentor-signature__argument__name">$byteArray</span>
  453. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  454. </dt>
  455. <dd class="phpdocumentor-argument-list__definition">
  456. </dd>
  457. <dt class="phpdocumentor-argument-list__entry">
  458. <span class="phpdocumentor-signature__argument__name">$maxBytes</span>
  459. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  460. </dt>
  461. <dd class="phpdocumentor-argument-list__definition">
  462. </dd>
  463. <dt class="phpdocumentor-argument-list__entry">
  464. <span class="phpdocumentor-signature__argument__name">$numRsBlocks</span>
  465. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  466. </dt>
  467. <dd class="phpdocumentor-argument-list__definition">
  468. </dd>
  469. </dl>
  470. </article>
  471. </section>
  472. <div class="phpdocumentor-modal" id="source-view">
  473. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  474. <div class="phpdocumentor-modal-container">
  475. <div class="phpdocumentor-modal-content">
  476. <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>
  477. </div>
  478. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  479. </div>
  480. </div>
  481. <script type="text/javascript">
  482. (function () {
  483. function loadExternalCodeSnippet(el, url, line) {
  484. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  485. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  486. const language = 'php';
  487. const code = document.createElement('code');
  488. code.className = 'language-' + language;
  489. pre.textContent = '';
  490. pre.setAttribute('data-line', line)
  491. code.textContent = 'Loading…';
  492. pre.appendChild(code);
  493. var xhr = new XMLHttpRequest();
  494. xhr.open('GET', src, true);
  495. xhr.onreadystatechange = function () {
  496. if (xhr.readyState !== 4) {
  497. return;
  498. }
  499. if (xhr.status < 400 && xhr.responseText) {
  500. code.textContent = xhr.responseText;
  501. Prism.highlightElement(code);
  502. return;
  503. }
  504. if (xhr.status === 404) {
  505. code.textContent = '✖ Error: File could not be found';
  506. return;
  507. }
  508. if (xhr.status >= 400) {
  509. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  510. return;
  511. }
  512. code.textContent = '✖ Error: An unknown error occurred';
  513. };
  514. xhr.send(null);
  515. });
  516. }
  517. const modalButtons = document.querySelectorAll("[data-modal]");
  518. const openedAsLocalFile = window.location.protocol === 'file:';
  519. if (modalButtons.length > 0 && openedAsLocalFile) {
  520. console.warn(
  521. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  522. 'browsers block XHR requests when a page is opened this way'
  523. );
  524. }
  525. modalButtons.forEach(function (trigger) {
  526. if (openedAsLocalFile) {
  527. trigger.setAttribute("hidden", "hidden");
  528. }
  529. trigger.addEventListener("click", function (event) {
  530. event.preventDefault();
  531. const modal = document.getElementById(trigger.dataset.modal);
  532. if (!modal) {
  533. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  534. return;
  535. }
  536. modal.classList.add("phpdocumentor-modal__open");
  537. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  538. const exits = modal.querySelectorAll("[data-exit-button]");
  539. exits.forEach(function (exit) {
  540. exit.addEventListener("click", function (event) {
  541. event.preventDefault();
  542. modal.classList.remove("phpdocumentor-modal__open");
  543. });
  544. });
  545. });
  546. });
  547. })();
  548. </script>
  549. </article>
  550. </section>
  551. <section class="phpdocumentor-on-this-page__sidebar">
  552. <section class="phpdocumentor-on-this-page__content">
  553. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  554. <ul class="phpdocumentor-list -clean">
  555. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  556. <li>
  557. <ul class="phpdocumentor-list -clean">
  558. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-properties">Properties</a></li>
  559. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#toc-methods">Methods</a></li>
  560. </ul>
  561. </li>
  562. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  563. <li>
  564. <ul class="phpdocumentor-list -clean">
  565. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_eccLevel">$eccLevel<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  566. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedData">$interleavedData<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  567. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_interleavedDataIndex">$interleavedDataIndex<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  568. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#property_version">$version<a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"></li>
  569. </ul>
  570. </li>
  571. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  572. <li>
  573. <ul class="phpdocumentor-list -clean">
  574. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method___construct">__construct()</a></li>
  575. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleaveEcBytes">interleaveEcBytes()</a></li>
  576. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_encode">encode()</a></li>
  577. <li><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#method_interleave">interleave()</a></li>
  578. </ul>
  579. </li>
  580. </ul>
  581. </section>
  582. </section>
  583. </div>
  584. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  585. <section class="phpdocumentor-search-results__dialog">
  586. <header class="phpdocumentor-search-results__header">
  587. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  588. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  589. </header>
  590. <section class="phpdocumentor-search-results__body">
  591. <ul class="phpdocumentor-search-results__entries"></ul>
  592. </section>
  593. </section>
  594. </section>
  595. </div>
  596. <a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  597. </main>
  598. <script>
  599. cssVars({});
  600. </script>
  601. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  602. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  603. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  604. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  605. </body>
  606. </html>