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