API-QRMatrix.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>QRMatrix &mdash; PHP-QRCode main
  7. Manual</title>
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  10. <!--[if lt IE 9]>
  11. <script src="_static/js/html5shiv.min.js"></script>
  12. <![endif]-->
  13. <script src="_static/jquery.js"></script>
  14. <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
  15. <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
  16. <script src="_static/doctools.js"></script>
  17. <script src="_static/sphinx_highlight.js"></script>
  18. <script src="_static/js/theme.js"></script>
  19. <link rel="index" title="Index" href="genindex.html" />
  20. <link rel="search" title="Search" href="search.html" />
  21. <link rel="next" title="DecoderResult" href="API-DecoderResult.html" />
  22. <link rel="prev" title="QROutputInterface" href="API-QROutputInterface.html" />
  23. </head>
  24. <body class="wy-body-for-nav">
  25. <div class="wy-grid-for-nav">
  26. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  27. <div class="wy-side-scroll">
  28. <div class="wy-side-nav-search" >
  29. <a href="index.html" class="icon icon-home">
  30. PHP-QRCode
  31. </a>
  32. <div role="search">
  33. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  35. <input type="hidden" name="check_keywords" value="yes" />
  36. <input type="hidden" name="area" value="default" />
  37. </form>
  38. </div>
  39. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  40. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  41. <ul>
  42. <li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
  43. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
  47. </ul>
  48. </li>
  49. <li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
  50. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
  51. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a><ul>
  52. <li class="toctree-l4"><a class="reference internal" href="Usage-Installation.html#version-switch">Version switch</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
  59. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#can-i-use-this-library-without-using-composer">Can i use this library without using composer?</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#supported-php-versions-extension-requirements">Supported PHP versions &amp; extension requirements</a></li>
  63. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
  64. </ul>
  65. </li>
  66. <li class="toctree-l1"><a class="reference internal" href="Usage-Quickstart.html">Quickstart</a><ul>
  67. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#import-the-library">Import the library</a></li>
  68. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
  69. <li class="toctree-l3"><a class="reference internal" href="Usage-Quickstart.html#configuration">Configuration</a></li>
  70. </ul>
  71. </li>
  72. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
  73. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#notes">Notes</a></li>
  74. </ul>
  75. </li>
  76. <li class="toctree-l1"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
  77. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#configuration-via-qroptions">Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
  78. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#supply-an-iterable-of-options">Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options</a></li>
  79. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
  80. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#extending-the-qroptions-class">Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class</a></li>
  81. </ul>
  82. </li>
  83. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#qrcode-methods"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods</a><ul>
  84. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
  85. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  87. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  88. </ul>
  89. </li>
  90. </ul>
  91. </li>
  92. </ul>
  93. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
  94. <ul>
  95. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
  96. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#options-that-affect-this-module">Options that affect this module</a><ul>
  97. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QREps.html#options-that-have-no-effect">Options that have no effect</a></li>
  98. </ul>
  99. </li>
  100. </ul>
  101. </li>
  102. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  103. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#options-that-affect-this-module">Options that affect this module</a><ul>
  104. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRFpdf.html#options-that-have-no-effect">Options that have no effect</a></li>
  105. </ul>
  106. </li>
  107. </ul>
  108. </li>
  109. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  110. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#options-that-affect-this-module">Options that affect this module</a><ul>
  111. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRGdImage.html#options-that-have-no-effect">Options that have no effect</a></li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  117. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#options-that-affect-this-module">Options that affect this module</a><ul>
  118. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRImagick.html#options-that-have-no-effect">Options that have no effect</a></li>
  119. </ul>
  120. </li>
  121. </ul>
  122. </li>
  123. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  124. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#options-that-affect-this-module">Options that affect this module</a><ul>
  125. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#options-that-have-no-effect">Options that have no effect</a></li>
  126. </ul>
  127. </li>
  128. </ul>
  129. </li>
  130. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  131. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#options-that-affect-this-module">Options that affect this module</a><ul>
  132. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#options-that-have-no-effect">Options that have no effect</a></li>
  133. </ul>
  134. </li>
  135. </ul>
  136. </li>
  137. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  138. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#options-that-affect-this-module">Options that affect this module</a><ul>
  139. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRString.html#options-that-have-no-effect">Options that have no effect</a></li>
  140. </ul>
  141. </li>
  142. </ul>
  143. </li>
  144. </ul>
  145. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
  146. <ul class="current">
  147. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html">QRCode</a><ul>
  148. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
  149. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
  150. </ul>
  151. </li>
  152. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
  153. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
  154. </ul>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</a><ul>
  159. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
  160. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
  161. </ul>
  162. </li>
  163. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
  164. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
  165. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
  166. </ul>
  167. </li>
  168. <li class="toctree-l1 current"><a class="current reference internal" href="#">QRMatrix</a><ul>
  169. <li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a><ul>
  170. <li class="toctree-l3"><a class="reference internal" href="#deprecated-methods">Deprecated methods</a></li>
  171. </ul>
  172. </li>
  173. <li class="toctree-l2"><a class="reference internal" href="#constants">Constants</a></li>
  174. </ul>
  175. </li>
  176. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
  177. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
  178. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
  179. </ul>
  180. </li>
  181. </ul>
  182. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  183. <ul>
  184. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  185. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  186. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  187. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  188. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  189. </ul>
  190. </li>
  191. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  192. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  193. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  194. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  195. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  196. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  197. </ul>
  198. </li>
  199. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  200. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  201. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  202. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  203. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  204. </ul>
  205. </li>
  206. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  207. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  208. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  209. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  210. </ul>
  211. </li>
  212. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  213. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  214. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  215. </ul>
  216. </li>
  217. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  218. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  219. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  220. </ul>
  221. </li>
  222. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  223. </ul>
  224. </li>
  225. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  226. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#url-https">URL <code class="docutils literal notranslate"><span class="pre">https</span></code></a></li>
  227. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#e-mail-mailto">E-Mail <code class="docutils literal notranslate"><span class="pre">mailto</span></code></a></li>
  228. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#phone-numbers-tel">Phone numbers <code class="docutils literal notranslate"><span class="pre">tel</span></code></a></li>
  229. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#geo-coordinates-geo">Geo Coordinates <code class="docutils literal notranslate"><span class="pre">geo</span></code></a></li>
  230. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#mobile-authenticators-otpauth">Mobile Authenticators <code class="docutils literal notranslate"><span class="pre">otpauth</span></code></a></li>
  231. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  232. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  233. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#calendar-events-vcalendar-and-icalendar">Calendar Events: vCalendar and iCalendar</a></li>
  234. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  235. </ul>
  236. </li>
  237. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  238. </ul>
  239. </div>
  240. </div>
  241. </nav>
  242. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  243. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  244. <a href="index.html">PHP-QRCode</a>
  245. </nav>
  246. <div class="wy-nav-content">
  247. <div class="rst-content">
  248. <div role="navigation" aria-label="Page navigation">
  249. <ul class="wy-breadcrumbs">
  250. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  251. <li class="breadcrumb-item active">QRMatrix</li>
  252. <li class="wy-breadcrumbs-aside">
  253. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QRMatrix.md" class="fa fa-github"> Edit on GitHub</a>
  254. </li>
  255. </ul>
  256. <hr/>
  257. </div>
  258. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  259. <div itemprop="articleBody">
  260. <section id="qrmatrix">
  261. <h1>QRMatrix<a class="headerlink" href="#qrmatrix" title="Permalink to this heading"></a></h1>
  262. <p>The full phpDocumentor API documentation can be found at <a class="reference external" href="https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-Data-QRMatrix.html">chillerlan.github.io/php-qrcode</a>.</p>
  263. <section id="methods">
  264. <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this heading"></a></h2>
  265. <!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
  266. <table class="docutils align-default">
  267. <thead>
  268. <tr class="row-odd"><th class="head"><p>method</p></th>
  269. <th class="head"><p>return</p></th>
  270. <th class="head"><p>description</p></th>
  271. </tr>
  272. </thead>
  273. <tbody>
  274. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__construct(Version</span> <span class="pre">$version,</span> <span class="pre">EccLevel</span> <span class="pre">$eccLevel)</span></code></p></td>
  275. <td><p>-</p></td>
  276. <td><p></p></td>
  277. </tr>
  278. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initFunctionalPatterns()</span></code></p></td>
  279. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  280. <td><p>shortcut to initialize the functional patterns</p></td>
  281. </tr>
  282. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getMatrix()</span></code></p></td>
  283. <td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
  284. <td><p>the internal matrix representation as a 2 dimensional array</p></td>
  285. </tr>
  286. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></p></td>
  287. <td><p><code class="docutils literal notranslate"><span class="pre">Version|null</span></code></p></td>
  288. <td><p>the current QR Code version instance</p></td>
  289. </tr>
  290. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getEccLevel()</span></code></p></td>
  291. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel|null</span></code></p></td>
  292. <td><p>the current ECC level instance</p></td>
  293. </tr>
  294. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">getMaskPattern()</span></code></p></td>
  295. <td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern|null</span></code></p></td>
  296. <td><p>the used mask pattern instance</p></td>
  297. </tr>
  298. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getSize()</span></code></p></td>
  299. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  300. <td><p>the absoulute size of the matrix, including quiet zone (if set). <code class="docutils literal notranslate"><span class="pre">$version</span> <span class="pre">*</span> <span class="pre">4</span> <span class="pre">+</span> <span class="pre">17</span> <span class="pre">+</span> <span class="pre">2</span> <span class="pre">*</span> <span class="pre">$quietzone</span></code></p></td>
  301. </tr>
  302. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">get(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y)</span></code></p></td>
  303. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  304. <td><p>returns the value of the module</p></td>
  305. </tr>
  306. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">set(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y,</span> <span class="pre">bool</span> <span class="pre">$value,</span> <span class="pre">int</span> <span class="pre">$M_TYPE)</span></code></p></td>
  307. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  308. <td><p>sets the <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> value for the module</p></td>
  309. </tr>
  310. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setArea(int $startX, int $startY, int $width, int $height, bool $value, int $M_TYPE)</span></code></p></td>
  311. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  312. <td><p>Fills an area of $width * $height, from the given starting point $startX, $startY (top left) with $value for $M_TYPE</p></td>
  313. </tr>
  314. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">checkType(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y,</span> <span class="pre">int</span> <span class="pre">$M_TYPE)</span></code></p></td>
  315. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  316. <td><p>Checks whether a module is of the given $M_TYPE</p></td>
  317. </tr>
  318. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">checkTypeIn(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y,</span> <span class="pre">array</span> <span class="pre">$M_TYPES)</span></code></p></td>
  319. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  320. <td><p>Checks whether the module at ($x, $y) is in the given array of $M_TYPES, returns true if a match is found, otherwise false</p></td>
  321. </tr>
  322. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">check(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y)</span></code></p></td>
  323. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  324. <td><p>checks whether a module is true (dark) or false (light)</p></td>
  325. </tr>
  326. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">checkNeighbours(int</span> <span class="pre">$x,</span> <span class="pre">int</span> <span class="pre">$y,</span> <span class="pre">int</span> <span class="pre">$M_TYPE</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  327. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  328. <td><p>Checks the status neighbouring modules of the given module at ($x, $y) and returns a bitmask with the results.</p></td>
  329. </tr>
  330. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setDarkModule()</span></code></p></td>
  331. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  332. <td><p></p></td>
  333. </tr>
  334. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setFinderPattern()</span></code></p></td>
  335. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  336. <td><p></p></td>
  337. </tr>
  338. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setSeparators()</span></code></p></td>
  339. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  340. <td><p></p></td>
  341. </tr>
  342. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setAlignmentPattern()</span></code></p></td>
  343. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  344. <td><p></p></td>
  345. </tr>
  346. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setTimingPattern()</span></code></p></td>
  347. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  348. <td><p></p></td>
  349. </tr>
  350. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setVersionNumber()</span></code></p></td>
  351. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  352. <td><p></p></td>
  353. </tr>
  354. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setFormatInfo(MaskPattern</span> <span class="pre">$maskPattern</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  355. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  356. <td><p></p></td>
  357. </tr>
  358. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setQuietZone(int</span> <span class="pre">$quietZoneSize)</span></code></p></td>
  359. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  360. <td><p>Draws the “quiet zone” of $quietZoneSize around the matrix</p></td>
  361. </tr>
  362. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">rotate90()</span></code></p></td>
  363. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  364. <td><p>Rotates the matrix by 90 degrees clock wise</p></td>
  365. </tr>
  366. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setLogoSpace(int</span> <span class="pre">$width,</span> <span class="pre">int</span> <span class="pre">$height</span> <span class="pre">=</span> <span class="pre">null,</span> <span class="pre">int</span> <span class="pre">$startX</span> <span class="pre">=</span> <span class="pre">null,</span> <span class="pre">int</span> <span class="pre">$startY</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  367. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  368. <td><p>Clears a space of $width * $height in order to add a logo or text.</p></td>
  369. </tr>
  370. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">writeCodewords(BitBuffer</span> <span class="pre">$bitBuffer)</span></code></p></td>
  371. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  372. <td><p>Maps the interleaved binary data on the matrix</p></td>
  373. </tr>
  374. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">mask(MaskPattern</span> <span class="pre">$maskPattern)</span></code></p></td>
  375. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  376. <td><p>Applies/reverses the mask pattern</p></td>
  377. </tr>
  378. </tbody>
  379. </table>
  380. <section id="deprecated-methods">
  381. <h3>Deprecated methods<a class="headerlink" href="#deprecated-methods" title="Permalink to this heading"></a></h3>
  382. <table class="docutils align-default">
  383. <thead>
  384. <tr class="row-odd"><th class="head"><p>method</p></th>
  385. <th class="head"><p>since</p></th>
  386. <th class="head"><p>replacement</p></th>
  387. </tr>
  388. </thead>
  389. <tbody>
  390. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">matrix()</span></code></p></td>
  391. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  392. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getMatrix()</span></code></p></td>
  393. </tr>
  394. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">eccLevel()</span></code></p></td>
  395. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  396. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getEccLevel()</span></code></p></td>
  397. </tr>
  398. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">version()</span></code></p></td>
  399. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  400. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getVersion()</span></code></p></td>
  401. </tr>
  402. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">maskPattern()</span></code></p></td>
  403. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  404. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getMaskPattern()</span></code></p></td>
  405. </tr>
  406. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">size()</span></code></p></td>
  407. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  408. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getSize()</span></code></p></td>
  409. </tr>
  410. </tbody>
  411. </table>
  412. </section>
  413. </section>
  414. <section id="constants">
  415. <h2>Constants<a class="headerlink" href="#constants" title="Permalink to this heading"></a></h2>
  416. <p>The <code class="docutils literal notranslate"><span class="pre">_DARK</span></code> and <code class="docutils literal notranslate"><span class="pre">_LIGHT</span></code> postfixed constans exist purely for convenience - their value is the same as
  417. <code class="docutils literal notranslate"><span class="pre">QRMatrix::M_XXX</span> <span class="pre">|</span> <span class="pre">QRMatrix::IS_DARK</span></code> and <code class="docutils literal notranslate"><span class="pre">QRMatrix::M_XXX</span> <span class="pre">^</span> <span class="pre">QRMatrix::IS_DARK</span></code> respectively,
  418. see <a class="reference internal" href="API-QROutputInterface.html"><span class="std std-doc"><code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></span></a>.</p>
  419. <table class="docutils align-default">
  420. <thead>
  421. <tr class="row-odd"><th class="head"><p>name</p></th>
  422. <th class="head"><p>description</p></th>
  423. </tr>
  424. </thead>
  425. <tbody>
  426. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">IS_DARK</span></code></p></td>
  427. <td><p>sets the “dark” flag for the given value: <code class="docutils literal notranslate"><span class="pre">QRMatrix::M_DATA</span> <span class="pre">|</span> <span class="pre">QRMatrix::IS_DARK</span></code></p></td>
  428. </tr>
  429. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_NULL</span></code></p></td>
  430. <td><p>module not set</p></td>
  431. </tr>
  432. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_DARKMODULE_LIGHT</span></code></p></td>
  433. <td><p>convenience (reversed reflectance)</p></td>
  434. </tr>
  435. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_DARKMODULE</span></code></p></td>
  436. <td><p>once per matrix at <code class="docutils literal notranslate"><span class="pre">$xy</span> <span class="pre">=</span> <span class="pre">[8,</span> <span class="pre">4</span> <span class="pre">*</span> <span class="pre">$version</span> <span class="pre">+</span> <span class="pre">9]</span></code></p></td>
  437. </tr>
  438. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_DATA</span></code></p></td>
  439. <td><p>the actual encoded data</p></td>
  440. </tr>
  441. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_DATA_DARK</span></code></p></td>
  442. <td><p>convenience</p></td>
  443. </tr>
  444. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER</span></code></p></td>
  445. <td><p>the 7x7 finder patterns</p></td>
  446. </tr>
  447. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER_DARK</span></code></p></td>
  448. <td><p>convenience</p></td>
  449. </tr>
  450. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER_DOT_LIGHT</span></code></p></td>
  451. <td><p>convenience (reversed reflectance)</p></td>
  452. </tr>
  453. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER_DOT</span></code></p></td>
  454. <td><p>the inner 3x3 block of the finder pattern</p></td>
  455. </tr>
  456. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_SEPARATOR</span></code></p></td>
  457. <td><p>separator lines along the finder patterns</p></td>
  458. </tr>
  459. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_SEPARATOR_DARK</span></code></p></td>
  460. <td><p>convenience</p></td>
  461. </tr>
  462. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_ALIGNMENT</span></code></p></td>
  463. <td><p>the 5x5 alignment patterns</p></td>
  464. </tr>
  465. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_ALIGNMENT_DARK</span></code></p></td>
  466. <td><p>convenience</p></td>
  467. </tr>
  468. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_TIMING</span></code></p></td>
  469. <td><p>the timing pattern lines</p></td>
  470. </tr>
  471. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_TIMING_DARK</span></code></p></td>
  472. <td><p>convenience</p></td>
  473. </tr>
  474. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_FORMAT</span></code></p></td>
  475. <td><p>format information pattern</p></td>
  476. </tr>
  477. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FORMAT_DARK</span></code></p></td>
  478. <td><p>convenience</p></td>
  479. </tr>
  480. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_VERSION</span></code></p></td>
  481. <td><p>version information pattern</p></td>
  482. </tr>
  483. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_VERSION_DARK</span></code></p></td>
  484. <td><p>convenience</p></td>
  485. </tr>
  486. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_QUIETZONE</span></code></p></td>
  487. <td><p>margin around the QR Code</p></td>
  488. </tr>
  489. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_QUIETZONE_DARK</span></code></p></td>
  490. <td><p>convenience</p></td>
  491. </tr>
  492. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_LOGO</span></code></p></td>
  493. <td><p>space for a logo image (not used yet)</p></td>
  494. </tr>
  495. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_LOGO_DARK</span></code></p></td>
  496. <td><p>convenience</p></td>
  497. </tr>
  498. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_TEST</span></code></p></td>
  499. <td><p>test value</p></td>
  500. </tr>
  501. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_TEST_DARK</span></code></p></td>
  502. <td><p>convenience</p></td>
  503. </tr>
  504. </tbody>
  505. </table>
  506. </section>
  507. </section>
  508. </div>
  509. </div>
  510. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  511. <a href="API-QROutputInterface.html" class="btn btn-neutral float-left" title="QROutputInterface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  512. <a href="API-DecoderResult.html" class="btn btn-neutral float-right" title="DecoderResult" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  513. </div>
  514. <hr/>
  515. <div role="contentinfo">
  516. <p>&#169; Copyright 2023, smiley.</p>
  517. </div>
  518. </footer>
  519. </div>
  520. </div>
  521. </section>
  522. </div>
  523. <script>
  524. jQuery(function () {
  525. SphinxRtdTheme.Navigation.enable(true);
  526. });
  527. </script>
  528. </body>
  529. </html>