Inicio Explorar Ayuda
Iniciar sesión
mrkad
/
php-qrcode
espejo de https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: 03776aa566
Ramas Etiquetas
php-qrcode
/
Usage
/
Configuration-settings.html

Configuration-settings.html 64 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817 
  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>Configuration settings &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?v=5d32c60e"></script>
    16. 

  16.         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
    17. 

  17.         <script src="../_static/documentation_options.js?v=a8da1a53"></script>
    18. 

  18.         <script src="../_static/doctools.js?v=888ff710"></script>
    19. 

  19.         <script src="../_static/sphinx_highlight.js?v=dc90522c"></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="Module values" href="../Customizing/Module-Values.html" />
    24. 

  24.     <link rel="prev" title="Advanced usage" href="Advanced-usage.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 class="current">
    48. 

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

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

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

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

  52. <li class="toctree-l2"><a class="reference internal" href="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="Installation.html">Installation</a><ul>
    56. 

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

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

  58. <li class="toctree-l4"><a class="reference internal" href="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="Installation.html#terminal">Terminal</a></li>
    62. 

  62. </ul>
    63. 

  63. </li>
    64. 

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

  65. <li class="toctree-l3"><a class="reference internal" href="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="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="Installation.html#imagemagick">ImageMagick</a></li>
    70. 

  70. </ul>
    71. 

  71. </li>
    72. 

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

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

  74. <li class="toctree-l2"><a class="reference internal" href="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="Quickstart.html#configuration">Configuration</a></li>
    76. 

  76. </ul>
    77. 

  77. </li>
    78. 

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

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

  80. </ul>
    81. 

  81. </li>
    82. 

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

  83. <li class="toctree-l2"><a class="reference internal" href="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="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="Advanced-usage.html#load-and-save-options-from-to-json">Load and save options from/to JSON</a></li>
    86. 

  86. <li class="toctree-l3"><a class="reference internal" href="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="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="Advanced-usage.html#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
    91. 

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

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

  93. </ul>
    94. 

  94. </li>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="Advanced-usage.html#common-output-options">Common output options</a><ul>
    96. 

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

  97. <li class="toctree-l3"><a class="reference internal" href="Advanced-usage.html#base64-uri-output">Base64 URI output</a></li>
    98. 

  98. <li class="toctree-l3"><a class="reference internal" href="Advanced-usage.html#return-the-image-resource">Return the image resource</a></li>
    99. 

  99. <li class="toctree-l3"><a class="reference internal" href="Advanced-usage.html#add-a-logo-space">Add a logo space</a></li>
    100. 

  100. </ul>
    101. 

  101. </li>
    102. 

  102. </ul>
    103. 

  103. </li>
    104. 

  104. <li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration settings</a><ul>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="#version">version</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="#versionmin">versionMin</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="#versionmax">versionMax</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="#ecclevel">eccLevel</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="#maskpattern">maskPattern</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="#addquietzone">addQuietzone</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="#quietzonesize">quietzoneSize</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="#outputtype">outputType</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="#outputinterface">outputInterface</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="#returnresource">returnResource</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="#cachefile">cachefile</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="#outputbase64">outputBase64</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="#eol">eol</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="#bgcolor">bgColor</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="#invertmatrix">invertMatrix</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="#drawlightmodules">drawLightModules</a></li>
    121. 

  121. <li class="toctree-l2"><a class="reference internal" href="#drawcircularmodules">drawCircularModules</a></li>
    122. 

  122. <li class="toctree-l2"><a class="reference internal" href="#circleradius">circleRadius</a></li>
    123. 

  123. <li class="toctree-l2"><a class="reference internal" href="#keepassquare">keepAsSquare</a></li>
    124. 

  124. <li class="toctree-l2"><a class="reference internal" href="#connectpaths">connectPaths</a></li>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="#excludefromconnect">excludeFromConnect</a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="#modulevalues">moduleValues</a></li>
    127. 

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

  128. <li class="toctree-l2"><a class="reference internal" href="#logospacewidth">logoSpaceWidth</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="#logospaceheight">logoSpaceHeight</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="#logospacestartx">logoSpaceStartX</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="#logospacestarty">logoSpaceStartY</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="#scale">scale</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="#imagetransparent">imageTransparent</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="#transparencycolor">transparencyColor</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="#quality">quality</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="#gdimageuseupscale">gdImageUseUpscale</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="#imagickformat">imagickFormat</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="#cssclass">cssClass</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="#svgaddxmlheader">svgAddXmlHeader</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="#svgdefs">svgDefs</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="#svgusefillattributes">svgUseFillAttributes</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="#textlinestart">textLineStart</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="#jsonflags">jsonFlags</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="#jsonasbooleans">jsonAsBooleans</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="#fpdfmeasureunit">fpdfMeasureUnit</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="#readergrayscale">readerGrayscale</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="#readerinvertcolors">readerInvertColors</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="#readerincreasecontrast">readerIncreaseContrast</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="#imagebase64">imageBase64</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="#jpegquality">jpegQuality</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="#pngcompression">pngCompression</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="#imagetransparencybg">imageTransparencyBG</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="#imagickbg">imagickBG</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <p class="caption" role="heading"><span class="caption-text">Customizing output</span></p>
    160. 

  160. <ul>
    161. 

  161. <li class="toctree-l1"><a class="reference internal" href="../Customizing/Module-Values.html">Module values</a><ul>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#basics">Basics</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#assigning-values">Assigning values</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#handling-in-your-own-qroutputinterface">Handling in your own <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
    165. 

  165. <li class="toctree-l3"><a class="reference internal" href="../Customizing/Module-Values.html#setting-module-values">Setting module values</a></li>
    166. 

  166. <li class="toctree-l3"><a class="reference internal" href="../Customizing/Module-Values.html#using-the-module-values">Using the module values</a></li>
    167. 

  167. </ul>
    168. 

  168. </li>
    169. 

  169. </ul>
    170. 

  170. </li>
    171. 

  171. <li class="toctree-l1"><a class="reference internal" href="../Customizing/QROutputAbstract.html"><code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code></a><ul>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="../Customizing/QROutputAbstract.html#properties">Properties</a><ul>
    173. 

  173. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#options-and-matrix"><code class="docutils literal notranslate"><span class="pre">$options</span></code> and <code class="docutils literal notranslate"><span class="pre">$matrix</span></code></a></li>
    174. 

  174. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulecount-scale-and-length"><code class="docutils literal notranslate"><span class="pre">$moduleCount</span></code>, <code class="docutils literal notranslate"><span class="pre">$scale</span></code> and <code class="docutils literal notranslate"><span class="pre">$length</span></code></a></li>
    175. 

  175. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulevalues"><code class="docutils literal notranslate"><span class="pre">$moduleValues</span></code></a></li>
    176. 

  176. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#copies-of-qroptions-values">Copies of <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> values</a></li>
    177. 

  177. </ul>
    178. 

  178. </li>
    179. 

  179. <li class="toctree-l2"><a class="reference internal" href="../Customizing/QROutputAbstract.html#methods">Methods</a><ul>
    180. 

  180. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#setmodulevalues"><code class="docutils literal notranslate"><span class="pre">setModuleValues()</span></code></a></li>
    181. 

  181. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulevalueisvalid"><code class="docutils literal notranslate"><span class="pre">moduleValueIsValid()</span></code></a></li>
    182. 

  182. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#preparemodulevalue"><code class="docutils literal notranslate"><span class="pre">prepareModuleValue()</span></code></a></li>
    183. 

  183. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getdefaultmodulevalue"><code class="docutils literal notranslate"><span class="pre">getDefaultModuleValue()</span></code></a></li>
    184. 

  184. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getmodulevalue-and-getmodulevalueat"><code class="docutils literal notranslate"><span class="pre">getModuleValue()</span></code> and <code class="docutils literal notranslate"><span class="pre">getModuleValueAt()</span></code></a></li>
    185. 

  185. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#setmatrixdimensions"><code class="docutils literal notranslate"><span class="pre">setMatrixDimensions()</span></code></a></li>
    186. 

  186. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getoutputdimensions"><code class="docutils literal notranslate"><span class="pre">getOutputDimensions()</span></code></a></li>
    187. 

  187. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#collectmodules"><code class="docutils literal notranslate"><span class="pre">collectModules()</span></code></a></li>
    188. 

  188. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#savetofile-and-tobase64datauri"><code class="docutils literal notranslate"><span class="pre">saveToFile()</span></code> and <code class="docutils literal notranslate"><span class="pre">toBase64DataURI()</span></code></a></li>
    189. 

  189. </ul>
    190. 

  190. </li>
    191. 

  191. </ul>
    192. 

  192. </li>
    193. 

  193. <li class="toctree-l1"><a class="reference internal" href="../Customizing/Custom-output-interface.html">Custom <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#class-skeleton">Class skeleton</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#module-values">Module values</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#transform-the-output">Transform the output</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#run-the-custom-output">Run the custom output</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#summary">Summary</a></li>
    199. 

  199. </ul>
    200. 

  200. </li>
    201. 

  201. </ul>
    202. 

  202. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
    203. 

  203. <ul>
    204. 

  204. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QREps.html">QREps</a><ul>
    205. 

  205. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QREps.html#example">Example</a></li>
    206. 

  206. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QREps.html#additional-methods">Additional methods</a></li>
    207. 

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

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

  209. </ul>
    210. 

  210. </li>
    211. 

  211. </ul>
    212. 

  212. </li>
    213. 

  213. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRFpdf.html">QRFpdf</a><ul>
    214. 

  214. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRFpdf.html#example">Example</a></li>
    215. 

  215. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRFpdf.html#additional-methods">Additional methods</a></li>
    216. 

  216. <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>
    217. 

  217. <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>
    218. 

  218. </ul>
    219. 

  219. </li>
    220. 

  220. </ul>
    221. 

  221. </li>
    222. 

  222. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRGdImage.html">QRGdImage</a><ul>
    223. 

  223. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRGdImage.html#example">Example</a></li>
    224. 

  224. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRGdImage.html#additional-methods">Additional methods</a></li>
    225. 

  225. <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>
    226. 

  226. <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>
    227. 

  227. </ul>
    228. 

  228. </li>
    229. 

  229. </ul>
    230. 

  230. </li>
    231. 

  231. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRImagick.html">QRImagick</a><ul>
    232. 

  232. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRImagick.html#example">Example</a></li>
    233. 

  233. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRImagick.html#additional-methods">Additional methods</a></li>
    234. 

  234. <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>
    235. 

  235. <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>
    236. 

  236. </ul>
    237. 

  237. </li>
    238. 

  238. </ul>
    239. 

  239. </li>
    240. 

  240. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRMarkupHTML.html">QRMarkupHTML</a><ul>
    241. 

  241. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupHTML.html#example">Example</a></li>
    242. 

  242. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupHTML.html#additional-methods">Additional methods</a></li>
    243. 

  243. <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>
    244. 

  244. <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>
    245. 

  245. </ul>
    246. 

  246. </li>
    247. 

  247. </ul>
    248. 

  248. </li>
    249. 

  249. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRMarkupSVG.html">QRMarkupSVG</a><ul>
    250. 

  250. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupSVG.html#example">Example</a></li>
    251. 

  251. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupSVG.html#additional-methods">Additional methods</a></li>
    252. 

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

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

  254. </ul>
    255. 

  255. </li>
    256. 

  256. </ul>
    257. 

  257. </li>
    258. 

  258. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRString.html">QRString</a><ul>
    259. 

  259. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRString.html#plain-text">Plain text</a></li>
    260. 

  260. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRString.html#json">JSON</a></li>
    261. 

  261. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRString.html#additional-methods">Additional methods</a></li>
    262. 

  262. <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>
    263. 

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

  264. </ul>
    265. 

  265. </li>
    266. 

  266. </ul>
    267. 

  267. </li>
    268. 

  268. </ul>
    269. 

  269. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    270. 

  270. <ul>
    271. 

  271. <li class="toctree-l1"><a class="reference internal" href="../Appendix/Terminology.html">Terminology</a><ul>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#qr-code">QR Code</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#matrix">Matrix</a><ul>
    274. 

  274. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#module">Module</a></li>
    275. 

  275. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#version">Version</a></li>
    276. 

  276. </ul>
    277. 

  277. </li>
    278. 

  278. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#function-patterns">Function Patterns</a><ul>
    279. 

  279. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#finder-pattern">Finder Pattern</a></li>
    280. 

  280. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#alignment-pattern">Alignment Pattern</a></li>
    281. 

  281. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#timing-pattern">Timing Pattern</a></li>
    282. 

  282. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#separators">Separators</a></li>
    283. 

  283. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#quiet-zone">Quiet Zone</a></li>
    284. 

  284. </ul>
    285. 

  285. </li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#encoding-region">Encoding Region</a><ul>
    287. 

  287. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#data">Data</a></li>
    288. 

  288. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#version-information">Version Information</a></li>
    289. 

  289. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#format-information">Format Information</a></li>
    290. 

  290. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#darkmodule">Darkmodule</a></li>
    291. 

  291. </ul>
    292. 

  292. </li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#mode">Mode</a><ul>
    294. 

  294. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#segment">Segment</a></li>
    295. 

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

  296. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#mixed-mode">Mixed Mode</a></li>
    297. 

  297. </ul>
    298. 

  298. </li>
    299. 

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

  300. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#ecc-level">ECC Level</a></li>
    301. 

  301. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
    302. 

  302. </ul>
    303. 

  303. </li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#data-masking">Data masking</a><ul>
    305. 

  305. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#evaluation">Evaluation</a></li>
    306. 

  306. <li class="toctree-l3"><a class="reference internal" href="../Appendix/Terminology.html#mask-pattern">Mask pattern</a></li>
    307. 

  307. </ul>
    308. 

  308. </li>
    309. 

  309. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Terminology.html#reflectance">Reflectance</a></li>
    310. 

  310. </ul>
    311. 

  311. </li>
    312. 

  312. <li class="toctree-l1"><a class="reference internal" href="../Appendix/URI-Content.html">Popular content and URI schemes</a><ul>
    313. 

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

  314. <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>
    315. 

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

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

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

  318. <li class="toctree-l2"><a class="reference internal" href="../Appendix/URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../Appendix/URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
    320. 

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

  321. <li class="toctree-l2"><a class="reference internal" href="../Appendix/URI-Content.html#see-also">See also</a></li>
    322. 

  322. </ul>
    323. 

  323. </li>
    324. 

  324. <li class="toctree-l1"><a class="reference internal" href="../Appendix/Performance-considerations.html">Performance considerations</a><ul>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Performance-considerations.html#version">Version</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Performance-considerations.html#ecc-level">Ecc level</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Performance-considerations.html#data-mode">Data mode</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Performance-considerations.html#mask-pattern">Mask pattern</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Performance-considerations.html#output">Output</a></li>
    330. 

  330. </ul>
    331. 

  331. </li>
    332. 

  332. <li class="toctree-l1"><a class="reference internal" href="../Appendix/Contribute.html">How to contribute</a><ul>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#questions-and-issues">Questions and issues</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#bug-reports">Bug reports</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#pull-requests-and-bug-fixes">Pull requests and bug fixes</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#documentation">Documentation</a></li>
    337. 

  337. </ul>
    338. 

  338. </li>
    339. 

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

  340. </ul>
    341. 

  341. 

  342.         </div>
    343. 

  343.       </div>
    344. 

  344.     </nav>
    345. 

  345. 

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

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

  348.           <a href="../index.html">PHP-QRCode</a>
    349. 

  349.       </nav>
    350. 

  350. 

  351.       <div class="wy-nav-content">
    352. 

  352.         <div class="rst-content">
    353. 

  353.           <div role="navigation" aria-label="Page navigation">
    354. 

  354.   <ul class="wy-breadcrumbs">
    355. 

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

  356.       <li class="breadcrumb-item active">Configuration settings</li>
    357. 

  357.       <li class="wy-breadcrumbs-aside">
    358. 

  358.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Usage/Configuration-settings.md" class="fa fa-github"> Edit on GitHub</a>
    359. 

  359.       </li>
    360. 

  360.   </ul>
    361. 

  361.   <hr/>
    362. 

  362. </div>
    363. 

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

  364.            <div itemprop="articleBody">
    365. 

  365.              
    366. 

  366.   <section id="configuration-settings">
    367. 

  367. <h1>Configuration settings<a class="headerlink" href="#configuration-settings" title="Link to this heading"></a></h1>
    368. 

  368. <!-- This file is auto generated from the source of QROptionsTrait.php -->
    369. 

  369. <section id="version">
    370. 

  370. <h2>version<a class="headerlink" href="#version" title="Link to this heading"></a></h2>
    371. 

  371. <p>QR Code version number</p>
    372. 

  372. <p><code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">...</span> <span class="pre">40</span></code> or <code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code> (default)</p>
    373. 

  373. <p><strong>See also:</strong></p>
    374. 

  374. <ul class="simple">
    375. 

  375. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Common\Version</span></code></p></li>
    376. 

  376. </ul>
    377. 

  377. </section>
    378. 

  378. <section id="versionmin">
    379. 

  379. <h2>versionMin<a class="headerlink" href="#versionmin" title="Link to this heading"></a></h2>
    380. 

  380. <p>Minimum QR version</p>
    381. 

  381. <p>if <code class="docutils literal notranslate"><span class="pre">QROptions::$version</span></code> is set to <code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code> (default: 1)</p>
    382. 

  382. </section>
    383. 

  383. <section id="versionmax">
    384. 

  384. <h2>versionMax<a class="headerlink" href="#versionmax" title="Link to this heading"></a></h2>
    385. 

  385. <p>Maximum QR version</p>
    386. 

  386. <p>if <code class="docutils literal notranslate"><span class="pre">QROptions::$version</span></code> is set to <code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code> (default: 40)</p>
    387. 

  387. </section>
    388. 

  388. <section id="ecclevel">
    389. 

  389. <h2>eccLevel<a class="headerlink" href="#ecclevel" title="Link to this heading"></a></h2>
    390. 

  390. <p>Error correct level</p>
    391. 

  391. <p><code class="docutils literal notranslate"><span class="pre">EccLevel::X</span></code> where <code class="docutils literal notranslate"><span class="pre">X</span></code> is:</p>
    392. 

  392. <ul class="simple">
    393. 

  393. <li><p><code class="docutils literal notranslate"><span class="pre">L</span></code> =&gt;  7% (default)</p></li>
    394. 

  394. <li><p><code class="docutils literal notranslate"><span class="pre">M</span></code> =&gt; 15%</p></li>
    395. 

  395. <li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code> =&gt; 25%</p></li>
    396. 

  396. <li><p><code class="docutils literal notranslate"><span class="pre">H</span></code> =&gt; 30%</p></li>
    397. 

  397. </ul>
    398. 

  398. <p><strong>See also:</strong></p>
    399. 

  399. <ul class="simple">
    400. 

  400. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Common\EccLevel</span></code></p></li>
    401. 

  401. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/discussions/160">github.com/chillerlan/php-qrcode/discussions/160</a></p></li>
    402. 

  402. </ul>
    403. 

  403. </section>
    404. 

  404. <section id="maskpattern">
    405. 

  405. <h2>maskPattern<a class="headerlink" href="#maskpattern" title="Link to this heading"></a></h2>
    406. 

  406. <p>Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
    407. 

  407. <p><code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre">...</span> <span class="pre">7</span></code> or <code class="docutils literal notranslate"><span class="pre">MaskPattern::PATTERN_AUTO</span></code> (default)</p>
    408. 

  408. <p><strong>See also:</strong></p>
    409. 

  409. <ul class="simple">
    410. 

  410. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Common\MaskPattern</span></code></p></li>
    411. 

  411. </ul>
    412. 

  412. </section>
    413. 

  413. <section id="addquietzone">
    414. 

  414. <h2>addQuietzone<a class="headerlink" href="#addquietzone" title="Link to this heading"></a></h2>
    415. 

  415. <p>Add a “quiet zone” (margin) according to the QR code spec</p>
    416. 

  416. <p><strong>See also:</strong></p>
    417. 

  417. <ul class="simple">
    418. 

  418. <li><p><a class="reference external" href="https://www.qrcode.com/en/howto/code.html">www.qrcode.com/en/howto/code.html</a></p></li>
    419. 

  419. </ul>
    420. 

  420. </section>
    421. 

  421. <section id="quietzonesize">
    422. 

  422. <h2>quietzoneSize<a class="headerlink" href="#quietzonesize" title="Link to this heading"></a></h2>
    423. 

  423. <p>Size of the quiet zone</p>
    424. 

  424. <p>internally clamped to <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre">...</span> <span class="pre">$moduleCount</span> <span class="pre">/</span> <span class="pre">2</span></code> (default: 4)</p>
    425. 

  425. </section>
    426. 

  426. <section id="outputtype">
    427. 

  427. <h2>outputType<a class="headerlink" href="#outputtype" title="Link to this heading"></a></h2>
    428. 

  428. <p>The built-in output type</p>
    429. 

  429. <ul class="simple">
    430. 

  430. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_SVG</span></code> (default)</p></li>
    431. 

  431. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_HTML</span></code></p></li>
    432. 

  432. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_BMP</span></code></p></li>
    433. 

  433. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_GIF</span></code></p></li>
    434. 

  434. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_JPG</span></code></p></li>
    435. 

  435. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_PNG</span></code></p></li>
    436. 

  436. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_WEBP</span></code></p></li>
    437. 

  437. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_TEXT</span></code></p></li>
    438. 

  438. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_JSON</span></code></p></li>
    439. 

  439. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::IMAGICK</span></code></p></li>
    440. 

  440. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::EPS</span></code></p></li>
    441. 

  441. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::FPDF</span></code></p></li>
    442. 

  442. <li><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::CUSTOM</span></code></p></li>
    443. 

  443. </ul>
    444. 

  444. <p><strong>Deprecated:</strong> 5.0.0 see issue #223</p>
    445. 

  445. <p><strong>See also:</strong></p>
    446. 

  446. <ul class="simple">
    447. 

  447. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QREps</span></code></p></li>
    448. 

  448. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRFpdf</span></code></p></li>
    449. 

  449. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRGdImage</span></code></p></li>
    450. 

  450. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRImagick</span></code></p></li>
    451. 

  451. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRMarkupHTML</span></code></p></li>
    452. 

  452. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRMarkupSVG</span></code></p></li>
    453. 

  453. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRString</span></code></p></li>
    454. 

  454. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/223">github.com/chillerlan/php-qrcode/issues/223</a></p></li>
    455. 

  455. </ul>
    456. 

  456. </section>
    457. 

  457. <section id="outputinterface">
    458. 

  458. <h2>outputInterface<a class="headerlink" href="#outputinterface" title="Link to this heading"></a></h2>
    459. 

  459. <p>The FQCN of the custom <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></p>
    460. 

  460. <p>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> (default: <code class="docutils literal notranslate"><span class="pre">null</span></code>)</p>
    461. 

  461. <p><strong>Deprecated:</strong> 5.0.0 the nullable type will be removed in future versions
    462. 

  462. and the default value will be set to <code class="docutils literal notranslate"><span class="pre">QRMarkupSVG::class</span></code></p>
    463. 

  463. </section>
    464. 

  464. <section id="returnresource">
    465. 

  465. <h2>returnResource<a class="headerlink" href="#returnresource" title="Link to this heading"></a></h2>
    466. 

  466. <p>Return the image resource instead of a render if applicable.</p>
    467. 

  467. <ul class="simple">
    468. 

  468. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImage</span></code>: <code class="docutils literal notranslate"><span class="pre">resource</span></code> (PHP &lt; 8), <code class="docutils literal notranslate"><span class="pre">GdImage</span></code></p></li>
    469. 

  469. <li><p><code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>: <code class="docutils literal notranslate"><span class="pre">Imagick</span></code></p></li>
    470. 

  470. <li><p><code class="docutils literal notranslate"><span class="pre">QRFpdf</span></code>:    <code class="docutils literal notranslate"><span class="pre">FPDF</span></code></p></li>
    471. 

  471. </ul>
    472. 

  472. <p>This option overrides/ignores other output settings, such as <code class="docutils literal notranslate"><span class="pre">QROptions::$cachefile</span></code>
    473. 

  473. and <code class="docutils literal notranslate"><span class="pre">QROptions::$outputBase64</span></code>. (default: <code class="docutils literal notranslate"><span class="pre">false</span></code>)</p>
    474. 

  474. <p><strong>See also:</strong></p>
    475. 

  475. <ul class="simple">
    476. 

  476. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QROutputInterface::dump()</span></code></p></li>
    477. 

  477. </ul>
    478. 

  478. </section>
    479. 

  479. <section id="cachefile">
    480. 

  480. <h2>cachefile<a class="headerlink" href="#cachefile" title="Link to this heading"></a></h2>
    481. 

  481. <p>Optional cache file path <code class="docutils literal notranslate"><span class="pre">/path/to/cache.file</span></code></p>
    482. 

  482. <p>Please note that the <code class="docutils literal notranslate"><span class="pre">$file</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">QRCode::render()</span></code> and <code class="docutils literal notranslate"><span class="pre">QRCode::renderMatrix()</span></code>
    483. 

  483. takes precedence over the <code class="docutils literal notranslate"><span class="pre">QROptions::$cachefile</span></code> value. (default: <code class="docutils literal notranslate"><span class="pre">null</span></code>)</p>
    484. 

  484. <p><strong>See also:</strong></p>
    485. 

  485. <ul class="simple">
    486. 

  486. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\QRCode::render()</span></code></p></li>
    487. 

  487. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\QRCode::renderMatrix()</span></code></p></li>
    488. 

  488. </ul>
    489. 

  489. </section>
    490. 

  490. <section id="outputbase64">
    491. 

  491. <h2>outputBase64<a class="headerlink" href="#outputbase64" title="Link to this heading"></a></h2>
    492. 

  492. <p>Toggle base64 data URI or raw data output (if applicable)</p>
    493. 

  493. <p>(default: <code class="docutils literal notranslate"><span class="pre">true</span></code>)</p>
    494. 

  494. <p><strong>See also:</strong></p>
    495. 

  495. <ul class="simple">
    496. 

  496. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()</span></code></p></li>
    497. 

  497. </ul>
    498. 

  498. </section>
    499. 

  499. <section id="eol">
    500. 

  500. <h2>eol<a class="headerlink" href="#eol" title="Link to this heading"></a></h2>
    501. 

  501. <p>Newline string</p>
    502. 

  502. <p>(default: <code class="docutils literal notranslate"><span class="pre">PHP_EOL</span></code>)</p>
    503. 

  503. </section>
    504. 

  504. <section id="bgcolor">
    505. 

  505. <h2>bgColor<a class="headerlink" href="#bgcolor" title="Link to this heading"></a></h2>
    506. 

  506. <p>Sets the image background color (if applicable)</p>
    507. 

  507. <ul class="simple">
    508. 

  508. <li><p><code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>: defaults to <code class="docutils literal notranslate"><span class="pre">&quot;white&quot;</span></code></p></li>
    509. 

  509. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImage</span></code>: defaults to <code class="docutils literal notranslate"><span class="pre">[255,</span> <span class="pre">255,</span> <span class="pre">255]</span></code></p></li>
    510. 

  510. <li><p><code class="docutils literal notranslate"><span class="pre">QRFpdf</span></code>: defaults to blank internally (white page)</p></li>
    511. 

  511. </ul>
    512. 

  512. </section>
    513. 

  513. <section id="invertmatrix">
    514. 

  514. <h2>invertMatrix<a class="headerlink" href="#invertmatrix" title="Link to this heading"></a></h2>
    515. 

  515. <p>Whether to invert the matrix (reflectance reversal)</p>
    516. 

  516. <p>(default: <code class="docutils literal notranslate"><span class="pre">false</span></code>)</p>
    517. 

  517. <p><strong>See also:</strong></p>
    518. 

  518. <ul class="simple">
    519. 

  519. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Data\QRMatrix::invert()</span></code></p></li>
    520. 

  520. </ul>
    521. 

  521. </section>
    522. 

  522. <section id="drawlightmodules">
    523. 

  523. <h2>drawLightModules<a class="headerlink" href="#drawlightmodules" title="Link to this heading"></a></h2>
    524. 

  524. <p>Whether to draw the light (false) modules</p>
    525. 

  525. <p>(default: <code class="docutils literal notranslate"><span class="pre">true</span></code>)</p>
    526. 

  526. </section>
    527. 

  527. <section id="drawcircularmodules">
    528. 

  528. <h2>drawCircularModules<a class="headerlink" href="#drawcircularmodules" title="Link to this heading"></a></h2>
    529. 

  529. <p>Specify whether to draw the modules as filled circles</p>
    530. 

  530. <p>a note for <code class="docutils literal notranslate"><span class="pre">GdImage</span></code> output:</p>
    531. 

  531. <p>if <code class="docutils literal notranslate"><span class="pre">QROptions::$scale</span></code> is less than 20, the image will be upscaled internally, then the modules will be drawn
    532. 

  532. using <code class="docutils literal notranslate"><span class="pre">imagefilledellipse()</span></code> and then scaled back to the expected size</p>
    533. 

  533. <p>No effect in: <code class="docutils literal notranslate"><span class="pre">QREps</span></code>, <code class="docutils literal notranslate"><span class="pre">QRFpdf</span></code>, <code class="docutils literal notranslate"><span class="pre">QRMarkupHTML</span></code></p>
    534. 

  534. <p><strong>See also:</strong></p>
    535. 

  535. <ul class="simple">
    536. 

  536. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagefilledellipse">php.net: <code class="docutils literal notranslate"><span class="pre">\imagefilledellipse()</span></code></a></p></li>
    537. 

  537. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/23">github.com/chillerlan/php-qrcode/issues/23</a></p></li>
    538. 

  538. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/discussions/122">github.com/chillerlan/php-qrcode/discussions/122</a></p></li>
    539. 

  539. </ul>
    540. 

  540. </section>
    541. 

  541. <section id="circleradius">
    542. 

  542. <h2>circleRadius<a class="headerlink" href="#circleradius" title="Link to this heading"></a></h2>
    543. 

  543. <p>Specifies the radius of the modules when <code class="docutils literal notranslate"><span class="pre">QROptions::$drawCircularModules</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
    544. 

  544. <p>(default: 0.45)</p>
    545. 

  545. </section>
    546. 

  546. <section id="keepassquare">
    547. 

  547. <h2>keepAsSquare<a class="headerlink" href="#keepassquare" title="Link to this heading"></a></h2>
    548. 

  548. <p>Specifies which module types to exclude when <code class="docutils literal notranslate"><span class="pre">QROptions::$drawCircularModules</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
    549. 

  549. <p>(default: <code class="docutils literal notranslate"><span class="pre">[]</span></code>)</p>
    550. 

  550. </section>
    551. 

  551. <section id="connectpaths">
    552. 

  552. <h2>connectPaths<a class="headerlink" href="#connectpaths" title="Link to this heading"></a></h2>
    553. 

  553. <p>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
    554. 

  554. <p><strong>See also:</strong></p>
    555. 

  555. <ul class="simple">
    556. 

  556. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/57">github.com/chillerlan/php-qrcode/issues/57</a></p></li>
    557. 

  557. </ul>
    558. 

  558. </section>
    559. 

  559. <section id="excludefromconnect">
    560. 

  560. <h2>excludeFromConnect<a class="headerlink" href="#excludefromconnect" title="Link to this heading"></a></h2>
    561. 

  561. <p>Specify which paths/patterns to exclude from connecting if <code class="docutils literal notranslate"><span class="pre">QROptions::$connectPaths</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
    562. 

  562. </section>
    563. 

  563. <section id="modulevalues">
    564. 

  564. <h2>moduleValues<a class="headerlink" href="#modulevalues" title="Link to this heading"></a></h2>
    565. 

  565. <p>Module values map</p>
    566. 

  566. <ul class="simple">
    567. 

  567. <li><p><code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>, <code class="docutils literal notranslate"><span class="pre">QRMarkupHTML</span></code>, <code class="docutils literal notranslate"><span class="pre">QRMarkupSVG</span></code>: #ABCDEF, cssname, rgb(), rgba()…</p></li>
    568. 

  568. <li><p><code class="docutils literal notranslate"><span class="pre">QREps</span></code>, <code class="docutils literal notranslate"><span class="pre">QRFpdf</span></code>, <code class="docutils literal notranslate"><span class="pre">QRGdImage</span></code>: <code class="docutils literal notranslate"><span class="pre">[R,</span> <span class="pre">G,</span> <span class="pre">B]</span></code> // 0-255</p></li>
    569. 

  569. <li><p><code class="docutils literal notranslate"><span class="pre">QREps</span></code>: <code class="docutils literal notranslate"><span class="pre">[C,</span> <span class="pre">M,</span> <span class="pre">Y,</span> <span class="pre">K]</span></code> // 0-255</p></li>
    570. 

  570. </ul>
    571. 

  571. <p><strong>See also:</strong></p>
    572. 

  572. <ul class="simple">
    573. 

  573. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QROutputAbstract::setModuleValues()</span></code></p></li>
    574. 

  574. </ul>
    575. 

  575. </section>
    576. 

  576. <section id="addlogospace">
    577. 

  577. <h2>addLogoSpace<a class="headerlink" href="#addlogospace" title="Link to this heading"></a></h2>
    578. 

  578. <p>Toggles logo space creation</p>
    579. 

  579. <p><strong>See also:</strong></p>
    580. 

  580. <ul class="simple">
    581. 

  581. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\QRCode::addMatrixModifications()</span></code></p></li>
    582. 

  582. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Data\QRMatrix::setLogoSpace()</span></code></p></li>
    583. 

  583. </ul>
    584. 

  584. </section>
    585. 

  585. <section id="logospacewidth">
    586. 

  586. <h2>logoSpaceWidth<a class="headerlink" href="#logospacewidth" title="Link to this heading"></a></h2>
    587. 

  587. <p>Width of the logo space</p>
    588. 

  588. <p>if only <code class="docutils literal notranslate"><span class="pre">QROptions::$logoSpaceWidth</span></code> is given, the logo space is assumed a square of that size</p>
    589. 

  589. </section>
    590. 

  590. <section id="logospaceheight">
    591. 

  591. <h2>logoSpaceHeight<a class="headerlink" href="#logospaceheight" title="Link to this heading"></a></h2>
    592. 

  592. <p>Height of the logo space</p>
    593. 

  593. <p>if only <code class="docutils literal notranslate"><span class="pre">QROptions::$logoSpaceHeight</span></code> is given, the logo space is assumed a square of that size</p>
    594. 

  594. </section>
    595. 

  595. <section id="logospacestartx">
    596. 

  596. <h2>logoSpaceStartX<a class="headerlink" href="#logospacestartx" title="Link to this heading"></a></h2>
    597. 

  597. <p>Optional horizontal start position of the logo space (top left corner)</p>
    598. 

  598. </section>
    599. 

  599. <section id="logospacestarty">
    600. 

  600. <h2>logoSpaceStartY<a class="headerlink" href="#logospacestarty" title="Link to this heading"></a></h2>
    601. 

  601. <p>Optional vertical start position of the logo space (top left corner)</p>
    602. 

  602. </section>
    603. 

  603. <section id="scale">
    604. 

  604. <h2>scale<a class="headerlink" href="#scale" title="Link to this heading"></a></h2>
    605. 

  605. <p>Pixel size of a QR code module</p>
    606. 

  606. </section>
    607. 

  607. <section id="imagetransparent">
    608. 

  608. <h2>imageTransparent<a class="headerlink" href="#imagetransparent" title="Link to this heading"></a></h2>
    609. 

  609. <p>Toggle transparency</p>
    610. 

  610. <ul class="simple">
    611. 

  611. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImage</span></code> and <code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>: the given <code class="docutils literal notranslate"><span class="pre">QROptions::$transparencyColor</span></code> is set as transparent</p></li>
    612. 

  612. </ul>
    613. 

  613. <p><strong>See also:</strong></p>
    614. 

  614. <ul class="simple">
    615. 

  615. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/discussions/121">github.com/chillerlan/php-qrcode/discussions/121</a></p></li>
    616. 

  616. </ul>
    617. 

  617. </section>
    618. 

  618. <section id="transparencycolor">
    619. 

  619. <h2>transparencyColor<a class="headerlink" href="#transparencycolor" title="Link to this heading"></a></h2>
    620. 

  620. <p>Sets a transparency color for when <code class="docutils literal notranslate"><span class="pre">QROptions::$imageTransparent</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
    621. 

  621. <p>Defaults to <code class="docutils literal notranslate"><span class="pre">QROptions::$bgColor</span></code>.</p>
    622. 

  622. <ul class="simple">
    623. 

  623. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImage</span></code>: <code class="docutils literal notranslate"><span class="pre">[R,</span> <span class="pre">G,</span> <span class="pre">B]</span></code>, this color is set as transparent in <code class="docutils literal notranslate"><span class="pre">imagecolortransparent()</span></code></p></li>
    624. 

  624. <li><p><code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>: <code class="docutils literal notranslate"><span class="pre">&quot;color_str&quot;</span></code>, this color is set in <code class="docutils literal notranslate"><span class="pre">Imagick::transparentPaintImage()</span></code></p></li>
    625. 

  625. </ul>
    626. 

  626. <p><strong>See also:</strong></p>
    627. 

  627. <ul class="simple">
    628. 

  628. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagecolortransparent">php.net: <code class="docutils literal notranslate"><span class="pre">\imagecolortransparent()</span></code></a></p></li>
    629. 

  629. <li><p><a class="reference external" href="https://www.php.net/manual/imagick.transparentpaintimage">php.net: <code class="docutils literal notranslate"><span class="pre">\Imagick::transparentPaintImage()</span></code></a></p></li>
    630. 

  630. </ul>
    631. 

  631. </section>
    632. 

  632. <section id="quality">
    633. 

  633. <h2>quality<a class="headerlink" href="#quality" title="Link to this heading"></a></h2>
    634. 

  634. <p>Compression quality</p>
    635. 

  635. <p>The given value depends on the used output type:</p>
    636. 

  636. <ul class="simple">
    637. 

  637. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImageBMP</span></code>:  <code class="docutils literal notranslate"><span class="pre">[0...1]</span></code></p></li>
    638. 

  638. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImageJPEG</span></code>: <code class="docutils literal notranslate"><span class="pre">[0...100]</span></code></p></li>
    639. 

  639. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImageWEBP</span></code>: <code class="docutils literal notranslate"><span class="pre">[0...9]</span></code></p></li>
    640. 

  640. <li><p><code class="docutils literal notranslate"><span class="pre">QRGdImagePNG</span></code>:  <code class="docutils literal notranslate"><span class="pre">[0...100]</span></code></p></li>
    641. 

  641. <li><p><code class="docutils literal notranslate"><span class="pre">QRImagick</span></code>:     <code class="docutils literal notranslate"><span class="pre">[0...100]</span></code></p></li>
    642. 

  642. </ul>
    643. 

  643. <p><strong>See also:</strong></p>
    644. 

  644. <ul class="simple">
    645. 

  645. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagebmp">php.net: <code class="docutils literal notranslate"><span class="pre">\imagebmp()</span></code></a></p></li>
    646. 

  646. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagejpeg">php.net: <code class="docutils literal notranslate"><span class="pre">\imagejpeg()</span></code></a></p></li>
    647. 

  647. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagepng">php.net: <code class="docutils literal notranslate"><span class="pre">\imagepng()</span></code></a></p></li>
    648. 

  648. <li><p><a class="reference external" href="https://www.php.net/manual/function.imagewebp">php.net: <code class="docutils literal notranslate"><span class="pre">\imagewebp()</span></code></a></p></li>
    649. 

  649. <li><p><a class="reference external" href="https://www.php.net/manual/imagick.setimagecompressionquality">php.net: <code class="docutils literal notranslate"><span class="pre">\Imagick::setImageCompressionQuality()</span></code></a></p></li>
    650. 

  650. </ul>
    651. 

  651. </section>
    652. 

  652. <section id="gdimageuseupscale">
    653. 

  653. <h2>gdImageUseUpscale<a class="headerlink" href="#gdimageuseupscale" title="Link to this heading"></a></h2>
    654. 

  654. <p>Toggles the usage of internal upscaling when <code class="docutils literal notranslate"><span class="pre">QROptions::$drawCircularModules</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code> and
    655. 

  655. <code class="docutils literal notranslate"><span class="pre">QROptions::$scale</span></code> is less than 20</p>
    656. 

  656. <p><strong>See also:</strong></p>
    657. 

  657. <ul class="simple">
    658. 

  658. <li><p><code class="docutils literal notranslate"><span class="pre">\chillerlan\QRCode\Output\QRGdImage::createImage()</span></code></p></li>
    659. 

  659. <li><p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/23">github.com/chillerlan/php-qrcode/issues/23</a></p></li>
    660. 

  660. </ul>
    661. 

  661. </section>
    662. 

  662. <section id="imagickformat">
    663. 

  663. <h2>imagickFormat<a class="headerlink" href="#imagickformat" title="Link to this heading"></a></h2>
    664. 

  664. <p>Imagick output format</p>
    665. 

  665. <p><strong>See also:</strong></p>
    666. 

  666. <ul class="simple">
    667. 

  667. <li><p><a class="reference external" href="https://www.php.net/manual/imagick.setimageformat">php.net: <code class="docutils literal notranslate"><span class="pre">\Imagick::setImageFormat()</span></code></a></p></li>
    668. 

  668. <li><p><a class="reference external" href="https://www.imagemagick.org/script/formats.php">www.imagemagick.org/script/formats.php</a></p></li>
    669. 

  669. </ul>
    670. 

  670. </section>
    671. 

  671. <section id="cssclass">
    672. 

  672. <h2>cssClass<a class="headerlink" href="#cssclass" title="Link to this heading"></a></h2>
    673. 

  673. <p>A common css class</p>
    674. 

  674. </section>
    675. 

  675. <section id="svgaddxmlheader">
    676. 

  676. <h2>svgAddXmlHeader<a class="headerlink" href="#svgaddxmlheader" title="Link to this heading"></a></h2>
    677. 

  677. <p>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p>
    678. 

  678. <p><code class="docutils literal notranslate"><span class="pre">&lt;?xml</span> <span class="pre">version=&quot;1.0&quot;</span> <span class="pre">encoding=&quot;UTF-8&quot;?&gt;</span></code></p>
    679. 

  679. </section>
    680. 

  680. <section id="svgdefs">
    681. 

  681. <h2>svgDefs<a class="headerlink" href="#svgdefs" title="Link to this heading"></a></h2>
    682. 

  682. <p>Anything in the SVG <code class="docutils literal notranslate"><span class="pre">&lt;defs&gt;</span></code> tag</p>
    683. 

  683. <p><strong>See also:</strong></p>
    684. 

  684. <ul class="simple">
    685. 

  685. <li><p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</a></p></li>
    686. 

  686. </ul>
    687. 

  687. </section>
    688. 

  688. <section id="svgpreserveaspectratio">
    689. 

  689. <h2>svgPreserveAspectRatio<a class="headerlink" href="#svgpreserveaspectratio" title="Link to this heading"></a></h2>
    690. 

  690. <p>Sets the value for the “preserveAspectRatio” on the <code class="docutils literal notranslate"><span class="pre">&lt;svg&gt;</span></code> element</p>
    691. 

  691. <p><strong>See also:</strong></p>
    692. 

  692. <ul class="simple">
    693. 

  693. <li><p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</a></p></li>
    694. 

  694. </ul>
    695. 

  695. </section>
    696. 

  696. <section id="svgusefillattributes">
    697. 

  697. <h2>svgUseFillAttributes<a class="headerlink" href="#svgusefillattributes" title="Link to this heading"></a></h2>
    698. 

  698. <p>Whether to use the SVG <code class="docutils literal notranslate"><span class="pre">fill</span></code> attributes</p>
    699. 

  699. <p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code> (default), the <code class="docutils literal notranslate"><span class="pre">fill</span></code> attribute will be set with the module value for the <code class="docutils literal notranslate"><span class="pre">&lt;path&gt;</span></code> element’s <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code>.
    700. 

  700. When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the module values map will be ignored and the QR Code may be styled via CSS.</p>
    701. 

  701. <p><strong>See also:</strong></p>
    702. 

  702. <ul class="simple">
    703. 

  703. <li><p><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</a></p></li>
    704. 

  704. </ul>
    705. 

  705. </section>
    706. 

  706. <section id="textlinestart">
    707. 

  707. <h2>textLineStart<a class="headerlink" href="#textlinestart" title="Link to this heading"></a></h2>
    708. 

  708. <p>An optional line prefix, e.g. empty space to align the QR Code in a console</p>
    709. 

  709. </section>
    710. 

  710. <section id="jsonflags">
    711. 

  711. <h2>jsonFlags<a class="headerlink" href="#jsonflags" title="Link to this heading"></a></h2>
    712. 

  712. <p>Sets the flags to use for the <code class="docutils literal notranslate"><span class="pre">json_encode()</span></code> call</p>
    713. 

  713. <p><strong>See also:</strong></p>
    714. 

  714. <ul class="simple">
    715. 

  715. <li><p><a class="reference external" href="https://www.php.net/manual/json.constants.php">www.php.net/manual/json.constants.php</a></p></li>
    716. 

  716. </ul>
    717. 

  717. </section>
    718. 

  718. <section id="jsonasbooleans">
    719. 

  719. <h2>jsonAsBooleans<a class="headerlink" href="#jsonasbooleans" title="Link to this heading"></a></h2>
    720. 

  720. <p>Whether to return matrix values in JSON as booleans or <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> integers</p>
    721. 

  721. </section>
    722. 

  722. <section id="fpdfmeasureunit">
    723. 

  723. <h2>fpdfMeasureUnit<a class="headerlink" href="#fpdfmeasureunit" title="Link to this heading"></a></h2>
    724. 

  724. <p>Measurement unit for <code class="docutils literal notranslate"><span class="pre">FPDF</span></code> output: <code class="docutils literal notranslate"><span class="pre">pt</span></code>, <code class="docutils literal notranslate"><span class="pre">mm</span></code>, <code class="docutils literal notranslate"><span class="pre">cm</span></code>, <code class="docutils literal notranslate"><span class="pre">in</span></code> (default: <code class="docutils literal notranslate"><span class="pre">pt</span></code>)</p>
    725. 

  725. <p><strong>See also:</strong></p>
    726. 

  726. <ul class="simple">
    727. 

  727. <li><p><code class="docutils literal notranslate"><span class="pre">FPDF::__construct()</span></code></p></li>
    728. 

  728. </ul>
    729. 

  729. </section>
    730. 

  730. <section id="readeruseimagickifavailable">
    731. 

  731. <h2>readerUseImagickIfAvailable<a class="headerlink" href="#readeruseimagickifavailable" title="Link to this heading"></a></h2>
    732. 

  732. <p>Use Imagick (if available) when reading QR Codes</p>
    733. 

  733. </section>
    734. 

  734. <section id="readergrayscale">
    735. 

  735. <h2>readerGrayscale<a class="headerlink" href="#readergrayscale" title="Link to this heading"></a></h2>
    736. 

  736. <p>Grayscale the image before reading</p>
    737. 

  737. </section>
    738. 

  738. <section id="readerinvertcolors">
    739. 

  739. <h2>readerInvertColors<a class="headerlink" href="#readerinvertcolors" title="Link to this heading"></a></h2>
    740. 

  740. <p>Invert the colors of the image</p>
    741. 

  741. </section>
    742. 

  742. <section id="readerincreasecontrast">
    743. 

  743. <h2>readerIncreaseContrast<a class="headerlink" href="#readerincreasecontrast" title="Link to this heading"></a></h2>
    744. 

  744. <p>Increase the contrast before reading</p>
    745. 

  745. <p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
    746. 

  746. </section>
    747. 

  747. <section id="imagebase64">
    748. 

  748. <h2>imageBase64<a class="headerlink" href="#imagebase64" title="Link to this heading"></a></h2>
    749. 

  749. <p><strong>Deprecated:</strong> 5.0.0 use QROptions::$outputBase64 instead</p>
    750. 

  750. <p><strong>See also:</strong></p>
    751. 

  751. <ul class="simple">
    752. 

  752. <li><p><code class="docutils literal notranslate">&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\chillerlan\QRCode\QROptions::$outputBase64</span></code></p></li>
    753. 

  753. </ul>
    754. 

  754. </section>
    755. 

  755. <section id="jpegquality">
    756. 

  756. <h2>jpegQuality<a class="headerlink" href="#jpegquality" title="Link to this heading"></a></h2>
    757. 

  757. <p><strong>Deprecated:</strong> 5.0.0 use QROptions::$quality instead</p>
    758. 

  758. <p><strong>See also:</strong></p>
    759. 

  759. <ul class="simple">
    760. 

  760. <li><p><code class="docutils literal notranslate">&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\chillerlan\QRCode\QROptions::$quality</span></code></p></li>
    761. 

  761. </ul>
    762. 

  762. </section>
    763. 

  763. <section id="pngcompression">
    764. 

  764. <h2>pngCompression<a class="headerlink" href="#pngcompression" title="Link to this heading"></a></h2>
    765. 

  765. <p><strong>Deprecated:</strong> 5.0.0 use QROptions::$quality instead</p>
    766. 

  766. <p><strong>See also:</strong></p>
    767. 

  767. <ul class="simple">
    768. 

  768. <li><p><code class="docutils literal notranslate">&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\chillerlan\QRCode\QROptions::$quality</span></code></p></li>
    769. 

  769. </ul>
    770. 

  770. </section>
    771. 

  771. <section id="imagetransparencybg">
    772. 

  772. <h2>imageTransparencyBG<a class="headerlink" href="#imagetransparencybg" title="Link to this heading"></a></h2>
    773. 

  773. <p><strong>Deprecated:</strong> 5.0.0 use QROptions::$transparencyColor instead</p>
    774. 

  774. <p><strong>See also:</strong></p>
    775. 

  775. <ul class="simple">
    776. 

  776. <li><p><code class="docutils literal notranslate">&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\chillerlan\QRCode\QROptions::$transparencyColor</span></code></p></li>
    777. 

  777. </ul>
    778. 

  778. </section>
    779. 

  779. <section id="imagickbg">
    780. 

  780. <h2>imagickBG<a class="headerlink" href="#imagickbg" title="Link to this heading"></a></h2>
    781. 

  781. <p><strong>Deprecated:</strong> 5.0.0 use QROptions::$bgColor instead</p>
    782. 

  782. <p><strong>See also:</strong></p>
    783. 

  783. <ul class="simple">
    784. 

  784. <li><p><code class="docutils literal notranslate">&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\chillerlan\QRCode\QROptions::$bgColor</span></code></p></li>
    785. 

  785. </ul>
    786. 

  786. </section>
    787. 

  787. </section>
    788. 

  788. 

  789. 

  790.            </div>
    791. 

  791.           </div>
    792. 

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

  793.         <a href="Advanced-usage.html" class="btn btn-neutral float-left" title="Advanced usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    794. 

  794.         <a href="../Customizing/Module-Values.html" class="btn btn-neutral float-right" title="Module values" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    795. 

  795.     </div>
    796. 

  796. 

  797.   <hr/>
    798. 

  798. 

  799.   <div role="contentinfo">
    800. 

  800.     <p>&#169; Copyright 2023, smiley.</p>
    801. 

  801.   </div>
    802. 

  802. 

  803.    
    804. 

  804. 

  805. </footer>
    806. 

  806.         </div>
    807. 

  807.       </div>
    808. 

  808.     </section>
    809. 

  809.   </div>
    810. 

  810.   <script>
    811. 

  811.       jQuery(function () {
    812. 

  812.           SphinxRtdTheme.Navigation.enable(true);
    813. 

  813.       });
    814. 

  814.   </script> 
    815. 

  815. 

  816. </body>
    817. 

  817. </html>
    818.