API-QROptions.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  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>QROptions &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?v=5d32c60e"></script>
  14. <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  15. <script src="_static/documentation_options.js?v=a8da1a53"></script>
  16. <script src="_static/doctools.js?v=888ff710"></script>
  17. <script src="_static/sphinx_highlight.js?v=dc90522c"></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="QROutputInterface" href="API-QROutputInterface.html" />
  22. <link rel="prev" title="QRCode" href="API-QRCode.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#example">Example</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
  98. <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>
  99. <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>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  105. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#example">Example</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
  107. <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>
  108. <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>
  109. </ul>
  110. </li>
  111. </ul>
  112. </li>
  113. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  114. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#example">Example</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
  116. <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>
  117. <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>
  118. </ul>
  119. </li>
  120. </ul>
  121. </li>
  122. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  123. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#example">Example</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
  125. <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>
  126. <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>
  127. </ul>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  132. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#example">Example</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  134. <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>
  135. <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>
  136. </ul>
  137. </li>
  138. </ul>
  139. </li>
  140. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  141. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#example">Example</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  143. <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>
  144. <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>
  145. </ul>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  150. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#plain-text">Plain text</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
  153. <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>
  154. <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>
  155. </ul>
  156. </li>
  157. </ul>
  158. </li>
  159. </ul>
  160. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
  161. <ul class="current">
  162. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html">QRCode</a><ul>
  163. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
  164. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
  165. </ul>
  166. </li>
  167. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
  168. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
  169. </ul>
  170. </li>
  171. </ul>
  172. </li>
  173. <li class="toctree-l1 current"><a class="current reference internal" href="#">QROptions</a><ul>
  174. <li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a></li>
  175. <li class="toctree-l2"><a class="reference internal" href="#properties">Properties</a></li>
  176. </ul>
  177. </li>
  178. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
  179. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
  180. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
  181. </ul>
  182. </li>
  183. <li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html">QRMatrix</a><ul>
  184. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
  185. <li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
  186. </ul>
  187. </li>
  188. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
  189. </ul>
  190. </li>
  191. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
  192. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
  193. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
  194. </ul>
  195. </li>
  196. </ul>
  197. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  198. <ul>
  199. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  200. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  201. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  202. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  203. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  204. </ul>
  205. </li>
  206. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  207. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  208. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  209. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  210. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  211. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  212. </ul>
  213. </li>
  214. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  215. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  216. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  217. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  218. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  219. </ul>
  220. </li>
  221. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  222. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  223. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  224. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  225. </ul>
  226. </li>
  227. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  228. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  229. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  230. </ul>
  231. </li>
  232. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  233. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  234. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  235. </ul>
  236. </li>
  237. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  238. </ul>
  239. </li>
  240. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  241. <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>
  242. <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>
  243. <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>
  244. <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>
  245. <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>
  246. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  247. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  248. <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>
  249. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  250. </ul>
  251. </li>
  252. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  253. </ul>
  254. </div>
  255. </div>
  256. </nav>
  257. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  258. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  259. <a href="index.html">PHP-QRCode</a>
  260. </nav>
  261. <div class="wy-nav-content">
  262. <div class="rst-content">
  263. <div role="navigation" aria-label="Page navigation">
  264. <ul class="wy-breadcrumbs">
  265. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  266. <li class="breadcrumb-item active">QROptions</li>
  267. <li class="wy-breadcrumbs-aside">
  268. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QROptions.md" class="fa fa-github"> Edit on GitHub</a>
  269. </li>
  270. </ul>
  271. <hr/>
  272. </div>
  273. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  274. <div itemprop="articleBody">
  275. <section id="qroptions">
  276. <h1>QROptions<a class="headerlink" href="#qroptions" title="Link to this heading"></a></h1>
  277. <p>(via <code class="docutils literal notranslate"><span class="pre">QROptionsTrait</span></code>)</p>
  278. <p>The full phpDocumentor API documentation can be found at <a class="reference external" href="https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-QROptions.html">chillerlan.github.io/php-qrcode</a>.</p>
  279. <section id="methods">
  280. <h2>Methods<a class="headerlink" href="#methods" title="Link to this heading"></a></h2>
  281. <p>Inherited from <a class="reference external" href="https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerAbstract.php"><code class="docutils literal notranslate"><span class="pre">SettingsContainerAbstract</span></code></a></p>
  282. <!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
  283. <table class="docutils align-default">
  284. <thead>
  285. <tr class="row-odd"><th class="head"><p>method</p></th>
  286. <th class="head"><p>return</p></th>
  287. <th class="head"><p>info</p></th>
  288. </tr>
  289. </thead>
  290. <tbody>
  291. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__construct(iterable $properties = null)</span></code></p></td>
  292. <td><p>-</p></td>
  293. <td><p>calls <code class="docutils literal notranslate"><span class="pre">construct()</span></code> internally after the properties have been set</p></td>
  294. </tr>
  295. <tr class="row-odd"><td><p>(protected) <code class="docutils literal notranslate"><span class="pre">construct()</span></code></p></td>
  296. <td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
  297. <td><p>calls a method with trait name as replacement constructor for each used trait (similar to PHP4 constructors)</p></td>
  298. </tr>
  299. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__get(string</span> <span class="pre">$property)</span></code></p></td>
  300. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  301. <td><p>calls <code class="docutils literal notranslate"><span class="pre">$this-&gt;{'get_'.$property}()</span></code> if such a method exists</p></td>
  302. </tr>
  303. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">__set(string</span> <span class="pre">$property,</span> <span class="pre">$value)</span></code></p></td>
  304. <td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
  305. <td><p>calls <code class="docutils literal notranslate"><span class="pre">$this-&gt;{'set_'.$property}($value)</span></code> if such a method exists</p></td>
  306. </tr>
  307. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__isset(string</span> <span class="pre">$property)</span></code></p></td>
  308. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  309. <td><p></p></td>
  310. </tr>
  311. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">__unset(string</span> <span class="pre">$property)</span></code></p></td>
  312. <td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
  313. <td><p></p></td>
  314. </tr>
  315. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__toString()</span></code></p></td>
  316. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  317. <td><p>a JSON string</p></td>
  318. </tr>
  319. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">toArray()</span></code></p></td>
  320. <td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
  321. <td><p></p></td>
  322. </tr>
  323. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fromIterable(iterable</span> <span class="pre">$properties)</span></code></p></td>
  324. <td><p><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></p></td>
  325. <td><p></p></td>
  326. </tr>
  327. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">toJSON(int</span> <span class="pre">$jsonOptions</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  328. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  329. <td><p>accepts <a class="reference external" href="http://php.net/manual/json.constants.php">JSON options constants</a></p></td>
  330. </tr>
  331. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fromJSON(string</span> <span class="pre">$json)</span></code></p></td>
  332. <td><p><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></p></td>
  333. <td><p></p></td>
  334. </tr>
  335. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">jsonSerialize()</span></code></p></td>
  336. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  337. <td><p>implements the <a class="reference external" href="https://www.php.net/manual/en/jsonserializable.jsonserialize.php"><code class="docutils literal notranslate"><span class="pre">JsonSerializable</span></code></a> interface</p></td>
  338. </tr>
  339. </tbody>
  340. </table>
  341. </section>
  342. <section id="properties">
  343. <h2>Properties<a class="headerlink" href="#properties" title="Link to this heading"></a></h2>
  344. <table class="docutils align-default">
  345. <thead>
  346. <tr class="row-odd"><th class="head"><p>property</p></th>
  347. <th class="head"><p>type</p></th>
  348. <th class="head"><p>default</p></th>
  349. <th class="head"><p>allowed</p></th>
  350. <th class="head"><p>description</p></th>
  351. </tr>
  352. </thead>
  353. <tbody>
  354. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$version</span></code></p></td>
  355. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  356. <td><p><code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code></p></td>
  357. <td><p><code class="docutils literal notranslate"><span class="pre">1...40</span></code>, <code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code></p></td>
  358. <td><p><a class="reference external" href="http://www.qrcode.com/en/about/version.html">QR Code version number</a></p></td>
  359. </tr>
  360. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$versionMin</span></code></p></td>
  361. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  362. <td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
  363. <td><p><code class="docutils literal notranslate"><span class="pre">1...40</span></code></p></td>
  364. <td><p>Minimum QR version (if <code class="docutils literal notranslate"><span class="pre">$version</span> <span class="pre">=</span> <span class="pre">QRCode::VERSION_AUTO</span></code>)</p></td>
  365. </tr>
  366. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$versionMax</span></code></p></td>
  367. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  368. <td><p><code class="docutils literal notranslate"><span class="pre">40</span></code></p></td>
  369. <td><p><code class="docutils literal notranslate"><span class="pre">1...40</span></code></p></td>
  370. <td><p>Maximum QR version (if <code class="docutils literal notranslate"><span class="pre">$version</span> <span class="pre">=</span> <span class="pre">QRCode::VERSION_AUTO</span></code>)</p></td>
  371. </tr>
  372. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$eccLevel</span></code></p></td>
  373. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  374. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::L</span></code></p></td>
  375. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::X</span></code></p></td>
  376. <td><p>Error correct level, where X = L (7%), M (15%), Q (25%), H (30%)</p></td>
  377. </tr>
  378. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$maskPattern</span></code></p></td>
  379. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  380. <td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
  381. <td><p><code class="docutils literal notranslate"><span class="pre">0...7</span></code>, <code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
  382. <td><p>Mask Pattern to use</p></td>
  383. </tr>
  384. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$addQuietzone</span></code></p></td>
  385. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  386. <td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
  387. <td><p>*</p></td>
  388. <td><p>Add a “quiet zone” (margin) according to the QR code spec</p></td>
  389. </tr>
  390. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$quietzoneSize</span></code></p></td>
  391. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  392. <td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
  393. <td><p>clamped to <code class="docutils literal notranslate"><span class="pre">0...($matrixSize</span> <span class="pre">/</span> <span class="pre">2)</span></code></p></td>
  394. <td><p>Size of the quiet zone</p></td>
  395. </tr>
  396. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$outputType</span></code></p></td>
  397. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  398. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_SVG</span></code></p></td>
  399. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::XXX</span></code></p></td>
  400. <td><p>The built-in output type, XXX can be one of: <code class="docutils literal notranslate"><span class="pre">MARKUP_HTML</span></code>, <code class="docutils literal notranslate"><span class="pre">MARKUP_SVG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_PNG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_JPG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_GIF</span></code>, <code class="docutils literal notranslate"><span class="pre">STRING_TEXT</span></code>, <code class="docutils literal notranslate"><span class="pre">STRING_JSON</span></code>, <code class="docutils literal notranslate"><span class="pre">IMAGICK</span></code>, <code class="docutils literal notranslate"><span class="pre">EPS</span></code>, <code class="docutils literal notranslate"><span class="pre">FPDF</span></code>, <code class="docutils literal notranslate"><span class="pre">CUSTOM</span></code></p></td>
  401. </tr>
  402. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$outputInterface</span></code></p></td>
  403. <td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
  404. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  405. <td><p>*</p></td>
  406. <td><p>The FQCN of the custom <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code> if <code class="docutils literal notranslate"><span class="pre">QROptions::$outputType</span></code> is set to <code class="docutils literal notranslate"><span class="pre">QROutputInterface::CUSTOM</span></code></p></td>
  407. </tr>
  408. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$returnResource</span></code></p></td>
  409. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  410. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  411. <td><p>*</p></td>
  412. <td><p>Return the image resource instead of a render if applicable.</p></td>
  413. </tr>
  414. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$cachefile</span></code></p></td>
  415. <td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
  416. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  417. <td><p>*</p></td>
  418. <td><p>Optional cache file path</p></td>
  419. </tr>
  420. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$outputBase64</span></code></p></td>
  421. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  422. <td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
  423. <td><p>*</p></td>
  424. <td><p>Toggle base64 data URI or raw data output (if applicable)</p></td>
  425. </tr>
  426. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$eol</span></code></p></td>
  427. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  428. <td><p><code class="docutils literal notranslate"><span class="pre">PHP_EOL</span></code></p></td>
  429. <td><p>*</p></td>
  430. <td><p>Newline string (HTML, SVG, TEXT)</p></td>
  431. </tr>
  432. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$bgColor</span></code></p></td>
  433. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  434. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  435. <td><p>a valid FPDF, GD or Imagick color value</p></td>
  436. <td><p>Sets the image background color (if applicable). QRImagick: defaults to “white”, QRGdImage: defaults to [255, 255, 255], QRFpdf: defaults to blank internally (white page)</p></td>
  437. </tr>
  438. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$drawLightModules</span></code></p></td>
  439. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  440. <td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
  441. <td><p>*</p></td>
  442. <td><p>Whether to draw the light (false) modules</p></td>
  443. </tr>
  444. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$drawCircularModules</span></code></p></td>
  445. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  446. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  447. <td><p>*</p></td>
  448. <td><p>Specify whether to draw the modules as filled circles</p></td>
  449. </tr>
  450. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$circleRadius</span></code></p></td>
  451. <td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
  452. <td><p><code class="docutils literal notranslate"><span class="pre">0.45</span></code></p></td>
  453. <td><p><code class="docutils literal notranslate"><span class="pre">0.1...0.75</span></code></p></td>
  454. <td><p>Specifies the radius of the modules when $svgDrawCircularModules is set to true</p></td>
  455. </tr>
  456. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$keepAsSquare</span></code></p></td>
  457. <td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
  458. <td><p><code class="docutils literal notranslate"><span class="pre">[]</span></code></p></td>
  459. <td><p><code class="docutils literal notranslate"><span class="pre">int[]</span></code></p></td>
  460. <td><p>Specifies which module types to exclude when $svgDrawCircularModules is set to true</p></td>
  461. </tr>
  462. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$connectPaths</span></code></p></td>
  463. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  464. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  465. <td><p>*</p></td>
  466. <td><p>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p></td>
  467. </tr>
  468. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$excludeFromConnect</span></code></p></td>
  469. <td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
  470. <td><p><code class="docutils literal notranslate"><span class="pre">[]</span></code></p></td>
  471. <td><p><code class="docutils literal notranslate"><span class="pre">int[]</span></code></p></td>
  472. <td><p>Specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</p></td>
  473. </tr>
  474. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$moduleValues</span></code></p></td>
  475. <td><p><code class="docutils literal notranslate"><span class="pre">array|null</span></code></p></td>
  476. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  477. <td><p>*</p></td>
  478. <td><p>Module values map, see [[Custom module values]]</p></td>
  479. </tr>
  480. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$addLogoSpace</span></code></p></td>
  481. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  482. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  483. <td><p>*</p></td>
  484. <td><p>Toggles logo space creation</p></td>
  485. </tr>
  486. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceWidth</span></code></p></td>
  487. <td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
  488. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  489. <td><p>*</p></td>
  490. <td><p>Width of the logo space</p></td>
  491. </tr>
  492. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceHeight</span></code></p></td>
  493. <td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
  494. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  495. <td><p>*</p></td>
  496. <td><p>Height of the logo space</p></td>
  497. </tr>
  498. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceStartX</span></code></p></td>
  499. <td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
  500. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  501. <td><p>*</p></td>
  502. <td><p>Optional horizontal start position of the logo space (top left corner)</p></td>
  503. </tr>
  504. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceStartY</span></code></p></td>
  505. <td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
  506. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  507. <td><p>*</p></td>
  508. <td><p>Optional vertical start position of the logo space (top left corner)</p></td>
  509. </tr>
  510. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$scale</span></code></p></td>
  511. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  512. <td><p><code class="docutils literal notranslate"><span class="pre">5</span></code></p></td>
  513. <td><p>*</p></td>
  514. <td><p>Pixel size of a QR code module</p></td>
  515. </tr>
  516. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$imageTransparent</span></code></p></td>
  517. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  518. <td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
  519. <td><p>*</p></td>
  520. <td><p>Toggle transparency (no jpeg support), QRGdImage and QRImagick only. The given <code class="docutils literal notranslate"><span class="pre">QROptions::$transparencyColor</span></code> is set as transparent</p></td>
  521. </tr>
  522. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$transparencyColor</span></code></p></td>
  523. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  524. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  525. <td><p>a valid GD or Imagick color value</p></td>
  526. <td><p>Sets a transparency color for when <code class="docutils literal notranslate"><span class="pre">QROptions::$imageTransparent</span></code> is set to true. Defaults to <code class="docutils literal notranslate"><span class="pre">QROptions::$bgColor</span></code>.</p></td>
  527. </tr>
  528. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$quality</span></code></p></td>
  529. <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
  530. <td><p><code class="docutils literal notranslate"><span class="pre">-1</span></code></p></td>
  531. <td><p>*</p></td>
  532. <td><p>compression quality setting for <code class="docutils literal notranslate"><span class="pre">imagejpeg()</span></code>, <code class="docutils literal notranslate"><span class="pre">imagepng()</span></code>, <code class="docutils literal notranslate"><span class="pre">imagewebp()</span></code>, <code class="docutils literal notranslate"><span class="pre">Imagick::setImageCompressionQuality()</span></code></p></td>
  533. </tr>
  534. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$imagickFormat</span></code></p></td>
  535. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  536. <td><p><code class="docutils literal notranslate"><span class="pre">'png'</span></code></p></td>
  537. <td><p>*</p></td>
  538. <td><p>ImageMagick output type, see <code class="docutils literal notranslate"><span class="pre">Imagick::setType()</span></code></p></td>
  539. </tr>
  540. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$cssClass</span></code></p></td>
  541. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  542. <td><p><code class="docutils literal notranslate"><span class="pre">'qrcode'</span></code></p></td>
  543. <td><p>*</p></td>
  544. <td><p>A common css class</p></td>
  545. </tr>
  546. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$markupDark</span></code></p></td>
  547. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  548. <td><p><code class="docutils literal notranslate"><span class="pre">'#000'</span></code></p></td>
  549. <td><p>*</p></td>
  550. <td><p>Markup substitute for dark (CSS value)</p></td>
  551. </tr>
  552. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$markupLight</span></code></p></td>
  553. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  554. <td><p><code class="docutils literal notranslate"><span class="pre">'#fff'</span></code></p></td>
  555. <td><p>*</p></td>
  556. <td><p>Markup substitute for light (CSS value)</p></td>
  557. </tr>
  558. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgAddXmlHeader</span></code></p></td>
  559. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  560. <td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
  561. <td><p>*</p></td>
  562. <td><p>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p></td>
  563. </tr>
  564. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgOpacity</span></code></p></td>
  565. <td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
  566. <td><p><code class="docutils literal notranslate"><span class="pre">1.0</span></code></p></td>
  567. <td><p><code class="docutils literal notranslate"><span class="pre">0...1</span></code></p></td>
  568. <td><p>SVG opacity</p></td>
  569. </tr>
  570. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgDefs</span></code></p></td>
  571. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  572. <td><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
  573. <td><p>*</p></td>
  574. <td><p>Anything in the <a class="reference external" href="https://developer.mozilla.org/docs/Web/SVG/Element/defs"><code class="docutils literal notranslate"><span class="pre">&lt;defs&gt;</span></code></a> tag</p></td>
  575. </tr>
  576. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgViewBoxSize</span></code></p></td>
  577. <td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
  578. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  579. <td><p>*</p></td>
  580. <td><p>SVG viewBox size. A single integer number which defines width/height of the <a class="reference external" href="https://css-tricks.com/scale-svg/#article-header-id-3">viewBox attribute</a> <code class="docutils literal notranslate"><span class="pre">viewBox=&quot;0</span> <span class="pre">0</span> <span class="pre">x</span> <span class="pre">x&quot;</span></code>.</p></td>
  581. </tr>
  582. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgPreserveAspectRatio</span></code></p></td>
  583. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  584. <td><p><code class="docutils literal notranslate"><span class="pre">'xMidYMid'</span></code></p></td>
  585. <td><p>*</p></td>
  586. <td><p>See <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">preserveAspectRatio on MDN</a></p></td>
  587. </tr>
  588. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgWidth</span></code></p></td>
  589. <td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
  590. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  591. <td><p>*</p></td>
  592. <td><p>Optional “width” attribute with the specified value (note that the value is not checked!)</p></td>
  593. </tr>
  594. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgHeight</span></code></p></td>
  595. <td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
  596. <td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
  597. <td><p>*</p></td>
  598. <td><p>Optional “height” attribute with the specified value (note that the value is not checked!)</p></td>
  599. </tr>
  600. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$textDark</span></code></p></td>
  601. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  602. <td><p><code class="docutils literal notranslate"><span class="pre">'██'</span></code></p></td>
  603. <td><p>*</p></td>
  604. <td><p>String substitute for dark</p></td>
  605. </tr>
  606. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$textLight</span></code></p></td>
  607. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  608. <td><p><code class="docutils literal notranslate"><span class="pre">'░░'</span></code></p></td>
  609. <td><p>*</p></td>
  610. <td><p>String substitute for light</p></td>
  611. </tr>
  612. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$textLineStart</span></code></p></td>
  613. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  614. <td><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
  615. <td><p>*</p></td>
  616. <td><p>An optional line prefix, e.g. empty space to align the QR Code in a console</p></td>
  617. </tr>
  618. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$jsonAsBooleans</span></code></p></td>
  619. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  620. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  621. <td><p>*</p></td>
  622. <td><p>Whether to return matrix values in JSON as booleans or $M_TYPE integers</p></td>
  623. </tr>
  624. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$fpdfMeasureUnit</span></code></p></td>
  625. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
  626. <td><p><code class="docutils literal notranslate"><span class="pre">'pt'</span></code></p></td>
  627. <td><p>*</p></td>
  628. <td><p>Measurement unit for FPDF output: pt, mm, cm, in</p></td>
  629. </tr>
  630. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$readerUseImagickIfAvailable</span></code></p></td>
  631. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  632. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  633. <td><p>*</p></td>
  634. <td><p>Use Imagick (if available) when reading QR Codes</p></td>
  635. </tr>
  636. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$readerGrayscale</span></code></p></td>
  637. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  638. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  639. <td><p>*</p></td>
  640. <td><p>Grayscale the image before reading</p></td>
  641. </tr>
  642. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$readerIncreaseContrast</span></code></p></td>
  643. <td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
  644. <td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
  645. <td><p>*</p></td>
  646. <td><p>Increase the contrast before reading</p></td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. </section>
  651. </section>
  652. </div>
  653. </div>
  654. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  655. <a href="API-QRCode.html" class="btn btn-neutral float-left" title="QRCode" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  656. <a href="API-QROutputInterface.html" class="btn btn-neutral float-right" title="QROutputInterface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  657. </div>
  658. <hr/>
  659. <div role="contentinfo">
  660. <p>&#169; Copyright 2023, smiley.</p>
  661. </div>
  662. </footer>
  663. </div>
  664. </div>
  665. </section>
  666. </div>
  667. <script>
  668. jQuery(function () {
  669. SphinxRtdTheme.Navigation.enable(true);
  670. });
  671. </script>
  672. </body>
  673. </html>