Inicio Explorar Axuda
Iniciar sesión
mrkad
/
php-qrcode
réplica de https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: e77c22b437
Ramas Etiquetas
php-qrcode
/
API-QRMatrix.html

API-QRMatrix.html 31 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475 
  1. <!DOCTYPE html>
    2. 

  2. <html class="writer-html5" lang="en" >
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
    5. 

  5. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <title>QRMatrix &mdash; PHP-QRCode main
    8. 

  8.  Manual</title>
    9. 

  9.       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    10. 

  10.       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    11. 

  11.   <!--[if lt IE 9]>
    12. 

  12.     <script src="_static/js/html5shiv.min.js"></script>
    13. 

  13.   <![endif]-->
    14. 

  14.   
    15. 

  15.         <script src="_static/jquery.js"></script>
    16. 

  16.         <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
    17. 

  17.         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
    18. 

  18.         <script src="_static/doctools.js"></script>
    19. 

  19.         <script src="_static/sphinx_highlight.js"></script>
    20. 

  20.     <script src="_static/js/theme.js"></script>
    21. 

  21.     <link rel="index" title="Index" href="genindex.html" />
    22. 

  22.     <link rel="search" title="Search" href="search.html" />
    23. 

  23.     <link rel="next" title="DecoderResult" href="API-DecoderResult.html" />
    24. 

  24.     <link rel="prev" title="QROutputInterface" href="API-QROutputInterface.html" /> 
    25. 

  25. </head>
    26. 

  26. 

  27. <body class="wy-body-for-nav"> 
    28. 

  28.   <div class="wy-grid-for-nav">
    29. 

  29.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    30. 

  30.       <div class="wy-side-scroll">
    31. 

  31.         <div class="wy-side-nav-search" >
    32. 

  32. 

  33.           
    34. 

  34.           
    35. 

  35.           <a href="index.html" class="icon icon-home">
    36. 

  36.             PHP-QRCode
    37. 

  37.           </a>
    38. 

  38. <div role="search">
    39. 

  39.   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    40. 

  40.     <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    41. 

  41.     <input type="hidden" name="check_keywords" value="yes" />
    42. 

  42.     <input type="hidden" name="area" value="default" />
    43. 

  43.   </form>
    44. 

  44. </div>
    45. 

  45.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    46. 

  46.               <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
    47. 

  47. <ul>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
    49. 

  49. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
    50. 

  50. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
    51. 

  51. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
    52. 

  52. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
    53. 

  53. </ul>
    54. 

  54. </li>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
    56. 

  56. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
    57. 

  57. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a><ul>
    58. 

  58. <li class="toctree-l4"><a class="reference internal" href="Usage-Installation.html#version-switch">Version switch</a></li>
    59. 

  59. </ul>
    60. 

  60. </li>
    61. 

  61. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
    62. 

  62. </ul>
    63. 

  63. </li>
    64. 

  64. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
    65. 

  65. <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>
    66. 

  66. </ul>
    67. 

  67. </li>
    68. 

  68. <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>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
    70. 

  70. </ul>
    71. 

  71. </li>
    72. 

  72. <li class="toctree-l1"><a class="reference internal" href="Usage-Quickstart.html">Quickstart</a><ul>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#import-the-library">Import the library</a></li>
    74. 

  74. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
    75. 

  75. <li class="toctree-l3"><a class="reference internal" href="Usage-Quickstart.html#configuration">Configuration</a></li>
    76. 

  76. </ul>
    77. 

  77. </li>
    78. 

  78. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#notes">Notes</a></li>
    80. 

  80. </ul>
    81. 

  81. </li>
    82. 

  82. <li class="toctree-l1"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
    83. 

  83. <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>
    84. 

  84. <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>
    85. 

  85. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
    86. 

  86. <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>
    87. 

  87. </ul>
    88. 

  88. </li>
    89. 

  89. <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>
    90. 

  90. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
    91. 

  91. <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>
    92. 

  92. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
    93. 

  93. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
    94. 

  94. </ul>
    95. 

  95. </li>
    96. 

  96. </ul>
    97. 

  97. </li>
    98. 

  98. </ul>
    99. 

  99. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
    100. 

  100. <ul class="current">
    101. 

  101. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code></a><ul>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
    103. 

  103. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
    104. 

  104. </ul>
    105. 

  105. </li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
    107. 

  107. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
    108. 

  108. </ul>
    109. 

  109. </li>
    110. 

  110. </ul>
    111. 

  111. </li>
    112. 

  112. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html"><code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
    115. 

  115. </ul>
    116. 

  116. </li>
    117. 

  117. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html"><code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
    120. 

  120. </ul>
    121. 

  121. </li>
    122. 

  122. <li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></a><ul>
    123. 

  123. <li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a><ul>
    124. 

  124. <li class="toctree-l3"><a class="reference internal" href="#deprecated-methods">Deprecated methods</a></li>
    125. 

  125. </ul>
    126. 

  126. </li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="#constants">Constants</a></li>
    128. 

  128. </ul>
    129. 

  129. </li>
    130. 

  130. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html"><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></a><ul>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
    133. 

  133. </ul>
    134. 

  134. </li>
    135. 

  135. </ul>
    136. 

  136. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    137. 

  137. <ul>
    138. 

  138. <li class="toctree-l1"><a class="reference internal" href="Appendix-Glossary.html">Terminology</a><ul>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#qr-code">QR Code</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#matrix">Matrix</a><ul>
    141. 

  141. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#module">Module</a></li>
    142. 

  142. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#version">Version</a></li>
    143. 

  143. </ul>
    144. 

  144. </li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#function-patterns">Function Patterns</a><ul>
    146. 

  146. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#finder-pattern">Finder Pattern</a></li>
    147. 

  147. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#alignment-pattern">Alignment Pattern</a></li>
    148. 

  148. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#timing-pattern">Timing Pattern</a></li>
    149. 

  149. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#separators">Separators</a></li>
    150. 

  150. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#quiet-zone">Quiet Zone</a></li>
    151. 

  151. </ul>
    152. 

  152. </li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#encoding-region">Encoding Region</a><ul>
    154. 

  154. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#data">Data</a></li>
    155. 

  155. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#version-information">Version Information</a></li>
    156. 

  156. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#format-information">Format Information</a></li>
    157. 

  157. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#darkmodule">Darkmodule</a></li>
    158. 

  158. </ul>
    159. 

  159. </li>
    160. 

  160. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#mode">Mode</a><ul>
    161. 

  161. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#segment">Segment</a></li>
    162. 

  162. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
    163. 

  163. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#mixed-mode">Mixed Mode</a></li>
    164. 

  164. </ul>
    165. 

  165. </li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
    167. 

  167. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#ecc-level">ECC Level</a></li>
    168. 

  168. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#maximum-data-capacity">Maximum data capacity</a></li>
    169. 

  169. </ul>
    170. 

  170. </li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#data-masking">Data masking</a><ul>
    172. 

  172. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#evaluation">Evaluation</a></li>
    173. 

  173. <li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#mask-pattern">Mask pattern</a></li>
    174. 

  174. </ul>
    175. 

  175. </li>
    176. 

  176. <li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#reflectance">Reflectance</a></li>
    177. 

  177. </ul>
    178. 

  178. </li>
    179. 

  179. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
    180. 

  180. </ul>
    181. 

  181. 

  182.         </div>
    183. 

  183.       </div>
    184. 

  184.     </nav>
    185. 

  185. 

  186.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
    187. 

  187.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    188. 

  188.           <a href="index.html">PHP-QRCode</a>
    189. 

  189.       </nav>
    190. 

  190. 

  191.       <div class="wy-nav-content">
    192. 

  192.         <div class="rst-content">
    193. 

  193.           <div role="navigation" aria-label="Page navigation">
    194. 

  194.   <ul class="wy-breadcrumbs">
    195. 

  195.       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
    196. 

  196.       <li class="breadcrumb-item active"><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></li>
    197. 

  197.       <li class="wy-breadcrumbs-aside">
    198. 

  198.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QRMatrix.md" class="fa fa-github"> Edit on GitHub</a>
    199. 

  199.       </li>
    200. 

  200.   </ul>
    201. 

  201.   <hr/>
    202. 

  202. </div>
    203. 

  203.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    204. 

  204.            <div itemprop="articleBody">
    205. 

  205.              
    206. 

  206.   <section id="qrmatrix">
    207. 

  207. <h1><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code><a class="headerlink" href="#qrmatrix" title="Permalink to this heading"></a></h1>
    208. 

  208. <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>
    209. 

  209. <section id="methods">
    210. 

  210. <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this heading"></a></h2>
    211. 

  211. <!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
    212. 

  212. <table class="docutils align-default">
    213. 

  213. <thead>
    214. 

  214. <tr class="row-odd"><th class="head"><p>method</p></th>
    215. 

  215. <th class="head"><p>return</p></th>
    216. 

  216. <th class="head"><p>description</p></th>
    217. 

  217. </tr>
    218. 

  218. </thead>
    219. 

  219. <tbody>
    220. 

  220. <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>
    221. 

  221. <td><p>-</p></td>
    222. 

  222. <td><p></p></td>
    223. 

  223. </tr>
    224. 

  224. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initFunctionalPatterns()</span></code></p></td>
    225. 

  225. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    226. 

  226. <td><p>shortcut to initialize the functional patterns</p></td>
    227. 

  227. </tr>
    228. 

  228. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getMatrix()</span></code></p></td>
    229. 

  229. <td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
    230. 

  230. <td><p>the internal matrix representation as a 2 dimensional array</p></td>
    231. 

  231. </tr>
    232. 

  232. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></p></td>
    233. 

  233. <td><p><code class="docutils literal notranslate"><span class="pre">Version|null</span></code></p></td>
    234. 

  234. <td><p>the current QR Code version instance</p></td>
    235. 

  235. </tr>
    236. 

  236. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getEccLevel()</span></code></p></td>
    237. 

  237. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel|null</span></code></p></td>
    238. 

  238. <td><p>the current ECC level instance</p></td>
    239. 

  239. </tr>
    240. 

  240. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">getMaskPattern()</span></code></p></td>
    241. 

  241. <td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern|null</span></code></p></td>
    242. 

  242. <td><p>the used mask pattern instance</p></td>
    243. 

  243. </tr>
    244. 

  244. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getSize()</span></code></p></td>
    245. 

  245. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
    246. 

  246. <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>
    247. 

  247. </tr>
    248. 

  248. <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>
    249. 

  249. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
    250. 

  250. <td><p>returns the value of the module</p></td>
    251. 

  251. </tr>
    252. 

  252. <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>
    253. 

  253. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    254. 

  254. <td><p>sets the <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> value for the module</p></td>
    255. 

  255. </tr>
    256. 

  256. <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>
    257. 

  257. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    258. 

  258. <td><p>Fills an area of $width * $height, from the given starting point $startX, $startY (top left) with $value for $M_TYPE</p></td>
    259. 

  259. </tr>
    260. 

  260. <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>
    261. 

  261. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
    262. 

  262. <td><p>Checks whether a module is of the given $M_TYPE</p></td>
    263. 

  263. </tr>
    264. 

  264. <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>
    265. 

  265. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
    266. 

  266. <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>
    267. 

  267. </tr>
    268. 

  268. <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>
    269. 

  269. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
    270. 

  270. <td><p>checks whether a module is true (dark) or false (light)</p></td>
    271. 

  271. </tr>
    272. 

  272. <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>
    273. 

  273. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
    274. 

  274. <td><p>Checks the status neighbouring modules of the given module at ($x, $y) and returns a bitmask with the results.</p></td>
    275. 

  275. </tr>
    276. 

  276. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setDarkModule()</span></code></p></td>
    277. 

  277. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    278. 

  278. <td><p></p></td>
    279. 

  279. </tr>
    280. 

  280. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setFinderPattern()</span></code></p></td>
    281. 

  281. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    282. 

  282. <td><p></p></td>
    283. 

  283. </tr>
    284. 

  284. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setSeparators()</span></code></p></td>
    285. 

  285. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    286. 

  286. <td><p></p></td>
    287. 

  287. </tr>
    288. 

  288. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setAlignmentPattern()</span></code></p></td>
    289. 

  289. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    290. 

  290. <td><p></p></td>
    291. 

  291. </tr>
    292. 

  292. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">setTimingPattern()</span></code></p></td>
    293. 

  293. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    294. 

  294. <td><p></p></td>
    295. 

  295. </tr>
    296. 

  296. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setVersionNumber()</span></code></p></td>
    297. 

  297. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    298. 

  298. <td><p></p></td>
    299. 

  299. </tr>
    300. 

  300. <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>
    301. 

  301. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    302. 

  302. <td><p></p></td>
    303. 

  303. </tr>
    304. 

  304. <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>
    305. 

  305. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    306. 

  306. <td><p>Draws the “quiet zone” of $quietZoneSize around the matrix</p></td>
    307. 

  307. </tr>
    308. 

  308. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">rotate90()</span></code></p></td>
    309. 

  309. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    310. 

  310. <td><p>Rotates the matrix by 90 degrees clock wise</p></td>
    311. 

  311. </tr>
    312. 

  312. <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>
    313. 

  313. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    314. 

  314. <td><p>Clears a space of $width * $height in order to add a logo or text.</p></td>
    315. 

  315. </tr>
    316. 

  316. <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>
    317. 

  317. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    318. 

  318. <td><p>Maps the interleaved binary data on the matrix</p></td>
    319. 

  319. </tr>
    320. 

  320. <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>
    321. 

  321. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
    322. 

  322. <td><p>Applies/reverses the mask pattern</p></td>
    323. 

  323. </tr>
    324. 

  324. </tbody>
    325. 

  325. </table>
    326. 

  326. <section id="deprecated-methods">
    327. 

  327. <h3>Deprecated methods<a class="headerlink" href="#deprecated-methods" title="Permalink to this heading"></a></h3>
    328. 

  328. <table class="docutils align-default">
    329. 

  329. <thead>
    330. 

  330. <tr class="row-odd"><th class="head"><p>method</p></th>
    331. 

  331. <th class="head"><p>since</p></th>
    332. 

  332. <th class="head"><p>replacement</p></th>
    333. 

  333. </tr>
    334. 

  334. </thead>
    335. 

  335. <tbody>
    336. 

  336. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">matrix()</span></code></p></td>
    337. 

  337. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
    338. 

  338. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getMatrix()</span></code></p></td>
    339. 

  339. </tr>
    340. 

  340. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">eccLevel()</span></code></p></td>
    341. 

  341. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
    342. 

  342. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getEccLevel()</span></code></p></td>
    343. 

  343. </tr>
    344. 

  344. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">version()</span></code></p></td>
    345. 

  345. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
    346. 

  346. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getVersion()</span></code></p></td>
    347. 

  347. </tr>
    348. 

  348. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">maskPattern()</span></code></p></td>
    349. 

  349. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
    350. 

  350. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getMaskPattern()</span></code></p></td>
    351. 

  351. </tr>
    352. 

  352. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">size()</span></code></p></td>
    353. 

  353. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
    354. 

  354. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix::getSize()</span></code></p></td>
    355. 

  355. </tr>
    356. 

  356. </tbody>
    357. 

  357. </table>
    358. 

  358. </section>
    359. 

  359. </section>
    360. 

  360. <section id="constants">
    361. 

  361. <h2>Constants<a class="headerlink" href="#constants" title="Permalink to this heading"></a></h2>
    362. 

  362. <p>The <code class="docutils literal notranslate"><span class="pre">_DARK</span></code> prefixed constans exist purely for convenience - their value is the same as <code class="docutils literal notranslate"><span class="pre">QRMatrix::M_XXX\|QRMatrix::IS_DARK</span></code>, 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>
    363. 

  363. <table class="docutils align-default">
    364. 

  364. <thead>
    365. 

  365. <tr class="row-odd"><th class="head"><p>name</p></th>
    366. 

  366. <th class="head"><p>description</p></th>
    367. 

  367. </tr>
    368. 

  368. </thead>
    369. 

  369. <tbody>
    370. 

  370. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">IS_DARK</span></code></p></td>
    371. 

  371. <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>
    372. 

  372. </tr>
    373. 

  373. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_NULL</span></code></p></td>
    374. 

  374. <td><p>module not set</p></td>
    375. 

  375. </tr>
    376. 

  376. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_DARKMODULE</span></code></p></td>
    377. 

  377. <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>
    378. 

  378. </tr>
    379. 

  379. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_DATA</span></code></p></td>
    380. 

  380. <td><p>the actual encoded data</p></td>
    381. 

  381. </tr>
    382. 

  382. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_DATA_DARK</span></code></p></td>
    383. 

  383. <td><p>convenience</p></td>
    384. 

  384. </tr>
    385. 

  385. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER</span></code></p></td>
    386. 

  386. <td><p>the 7x7 finder patterns</p></td>
    387. 

  387. </tr>
    388. 

  388. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER_DARK</span></code></p></td>
    389. 

  389. <td><p>convenience</p></td>
    390. 

  390. </tr>
    391. 

  391. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FINDER_DOT</span></code></p></td>
    392. 

  392. <td><p>the inner 3x3 block of the finder pattern</p></td>
    393. 

  393. </tr>
    394. 

  394. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_SEPARATOR</span></code></p></td>
    395. 

  395. <td><p>separator lines along the finder patterns</p></td>
    396. 

  396. </tr>
    397. 

  397. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_SEPARATOR_DARK</span></code></p></td>
    398. 

  398. <td><p>convenience</p></td>
    399. 

  399. </tr>
    400. 

  400. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_ALIGNMENT</span></code></p></td>
    401. 

  401. <td><p>the 5x5 alignment patterns</p></td>
    402. 

  402. </tr>
    403. 

  403. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_ALIGNMENT_DARK</span></code></p></td>
    404. 

  404. <td><p>convenience</p></td>
    405. 

  405. </tr>
    406. 

  406. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_TIMING</span></code></p></td>
    407. 

  407. <td><p>the timing pattern lines</p></td>
    408. 

  408. </tr>
    409. 

  409. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_TIMING_DARK</span></code></p></td>
    410. 

  410. <td><p>convenience</p></td>
    411. 

  411. </tr>
    412. 

  412. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_FORMAT</span></code></p></td>
    413. 

  413. <td><p>format information pattern</p></td>
    414. 

  414. </tr>
    415. 

  415. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_FORMAT_DARK</span></code></p></td>
    416. 

  416. <td><p>convenience</p></td>
    417. 

  417. </tr>
    418. 

  418. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_VERSION</span></code></p></td>
    419. 

  419. <td><p>version information pattern</p></td>
    420. 

  420. </tr>
    421. 

  421. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_VERSION_DARK</span></code></p></td>
    422. 

  422. <td><p>convenience</p></td>
    423. 

  423. </tr>
    424. 

  424. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_QUIETZONE</span></code></p></td>
    425. 

  425. <td><p>margin around the QR Code</p></td>
    426. 

  426. </tr>
    427. 

  427. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_QUIETZONE_DARK</span></code></p></td>
    428. 

  428. <td><p>convenience</p></td>
    429. 

  429. </tr>
    430. 

  430. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_LOGO</span></code></p></td>
    431. 

  431. <td><p>space for a logo image (not used yet)</p></td>
    432. 

  432. </tr>
    433. 

  433. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_LOGO_DARK</span></code></p></td>
    434. 

  434. <td><p>convenience</p></td>
    435. 

  435. </tr>
    436. 

  436. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">M_TEST</span></code></p></td>
    437. 

  437. <td><p>test value</p></td>
    438. 

  438. </tr>
    439. 

  439. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">M_TEST_DARK</span></code></p></td>
    440. 

  440. <td><p>convenience</p></td>
    441. 

  441. </tr>
    442. 

  442. </tbody>
    443. 

  443. </table>
    444. 

  444. </section>
    445. 

  445. </section>
    446. 

  446. 

  447. 

  448.            </div>
    449. 

  449.           </div>
    450. 

  450.           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
    451. 

  451.         <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>
    452. 

  452.         <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>
    453. 

  453.     </div>
    454. 

  454. 

  455.   <hr/>
    456. 

  456. 

  457.   <div role="contentinfo">
    458. 

  458.     <p>&#169; Copyright 2023, smiley.</p>
    459. 

  459.   </div>
    460. 

  460. 

  461.    
    462. 

  462. 

  463. </footer>
    464. 

  464.         </div>
    465. 

  465.       </div>
    466. 

  466.     </section>
    467. 

  467.   </div>
    468. 

  468.   <script>
    469. 

  469.       jQuery(function () {
    470. 

  470.           SphinxRtdTheme.Navigation.enable(true);
    471. 

  471.       });
    472. 

  472.   </script> 
    473. 

  473. 

  474. </body>
    475. 

  475. </html>
    476.