chillerlan-QRCode-Data-ReedSolomonEncoder.html 38 KB

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