Главная Обзор Помощь
Вход
mrkad
/
php-qrcode
зеркало из https://github.com/chillerlan/php-qrcode.git
1
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 017a21f644
Ветки Метки
php-qrcode
/
index.html

index.html 56 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651 
  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>PHP-QRCode Manual &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="Overview" href="Usage/Overview.html" /> 
    24. 

  24. </head>
    25. 

  25. 

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

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

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

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

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

  31. 

  32.           
    33. 

  33.           
    34. 

  34.           <a href="#" class="icon icon-home">
    35. 

  35.             PHP-QRCode
    36. 

  36.           </a>
    37. 

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

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

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

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

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

  42.   </form>
    43. 

  43. </div>
    44. 

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

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

  46. <ul>
    47. 

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

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

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

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

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

  52. </ul>
    53. 

  53. </li>
    54. 

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

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

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

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

  58. </ul>
    59. 

  59. </li>
    60. 

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

  61. </ul>
    62. 

  62. </li>
    63. 

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

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

  65. </ul>
    66. 

  66. </li>
    67. 

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

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

  69. </ul>
    70. 

  70. </li>
    71. 

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

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

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

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

  75. </ul>
    76. 

  76. </li>
    77. 

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

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

  79. </ul>
    80. 

  80. </li>
    81. 

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

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

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

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

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

  86. </ul>
    87. 

  87. </li>
    88. 

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

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

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

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

  92. </ul>
    93. 

  93. </li>
    94. 

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

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

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

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

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

  99. </ul>
    100. 

  100. </li>
    101. 

  101. </ul>
    102. 

  102. </li>
    103. 

  103. <li class="toctree-l1"><a class="reference internal" href="Usage/Configuration-settings.html">Configuration settings</a><ul>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#version">version</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmin">versionMin</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmax">versionMax</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#ecclevel">eccLevel</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#maskpattern">maskPattern</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addquietzone">addQuietzone</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quietzonesize">quietzoneSize</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#returnresource">returnResource</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cachefile">cachefile</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputbase64">outputBase64</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#eol">eol</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#bgcolor">bgColor</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#invertmatrix">invertMatrix</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawlightmodules">drawLightModules</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawcircularmodules">drawCircularModules</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#circleradius">circleRadius</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#keepassquare">keepAsSquare</a></li>
    121. 

  121. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#connectpaths">connectPaths</a></li>
    122. 

  122. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#excludefromconnect">excludeFromConnect</a></li>
    123. 

  123. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#modulevalues">moduleValues</a></li>
    124. 

  124. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addlogospace">addLogoSpace</a></li>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacewidth">logoSpaceWidth</a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospaceheight">logoSpaceHeight</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestartx">logoSpaceStartX</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestarty">logoSpaceStartY</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#scale">scale</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagetransparent">imageTransparent</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#transparencycolor">transparencyColor</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quality">quality</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#gdimageuseupscale">gdImageUseUpscale</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagickformat">imagickFormat</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cssclass">cssClass</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgaddxmlheader">svgAddXmlHeader</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgdefs">svgDefs</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgusefillattributes">svgUseFillAttributes</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#textlinestart">textLineStart</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonflags">jsonFlags</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonasbooleans">jsonAsBooleans</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#fpdfmeasureunit">fpdfMeasureUnit</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readergrayscale">readerGrayscale</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerincreasecontrast">readerIncreaseContrast</a></li>
    147. 

  147. </ul>
    148. 

  148. </li>
    149. 

  149. </ul>
    150. 

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

  151. <ul>
    152. 

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

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

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

  155. <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>
    156. 

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

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

  158. </ul>
    159. 

  159. </li>
    160. 

  160. </ul>
    161. 

  161. </li>
    162. 

  162. <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>
    163. 

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

  164. <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>
    165. 

  165. <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>
    166. 

  166. <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>
    167. 

  167. <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>
    168. 

  168. </ul>
    169. 

  169. </li>
    170. 

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

  171. <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>
    172. 

  172. <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>
    173. 

  173. <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>
    174. 

  174. <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>
    175. 

  175. <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>
    176. 

  176. <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>
    177. 

  177. <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>
    178. 

  178. <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>
    179. 

  179. <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>
    180. 

  180. </ul>
    181. 

  181. </li>
    182. 

  182. </ul>
    183. 

  183. </li>
    184. 

  184. </ul>
    185. 

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

  186. <ul>
    187. 

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

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

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

  190. <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>
    191. 

  191. <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>
    192. 

  192. </ul>
    193. 

  193. </li>
    194. 

  194. </ul>
    195. 

  195. </li>
    196. 

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

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

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

  199. <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>
    200. 

  200. <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>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. </li>
    205. 

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

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

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

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

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

  210. </ul>
    211. 

  211. </li>
    212. 

  212. </ul>
    213. 

  213. </li>
    214. 

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

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

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

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

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

  219. </ul>
    220. 

  220. </li>
    221. 

  221. </ul>
    222. 

  222. </li>
    223. 

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

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

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

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

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

  228. </ul>
    229. 

  229. </li>
    230. 

  230. </ul>
    231. 

  231. </li>
    232. 

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

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

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

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

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

  237. </ul>
    238. 

  238. </li>
    239. 

  239. </ul>
    240. 

  240. </li>
    241. 

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

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

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

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

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

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

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. </li>
    251. 

  251. </ul>
    252. 

  252. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    253. 

  253. <ul>
    254. 

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

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

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

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

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

  259. </ul>
    260. 

  260. </li>
    261. 

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

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

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

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

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

  266. </ul>
    267. 

  267. </li>
    268. 

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

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

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

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

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

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

  274. </ul>
    275. 

  275. </li>
    276. 

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

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

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

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

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

  281. </ul>
    282. 

  282. </li>
    283. 

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

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

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

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

  287. </ul>
    288. 

  288. </li>
    289. 

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

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

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

  292. </ul>
    293. 

  293. </li>
    294. 

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

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

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

  297. </ul>
    298. 

  298. </li>
    299. 

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

  300. </ul>
    301. 

  301. </li>
    302. 

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

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

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

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

  306. <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>
    307. 

  307. <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>
    308. 

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

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

  310. <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>
    311. 

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

  312. </ul>
    313. 

  313. </li>
    314. 

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

  315. </ul>
    316. 

  316. 

  317.         </div>
    318. 

  318.       </div>
    319. 

  319.     </nav>
    320. 

  320. 

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

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

  323.           <a href="#">PHP-QRCode</a>
    324. 

  324.       </nav>
    325. 

  325. 

  326.       <div class="wy-nav-content">
    327. 

  327.         <div class="rst-content">
    328. 

  328.           <div role="navigation" aria-label="Page navigation">
    329. 

  329.   <ul class="wy-breadcrumbs">
    330. 

  330.       <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
    331. 

  331.       <li class="breadcrumb-item active">PHP-QRCode Manual</li>
    332. 

  332.       <li class="wy-breadcrumbs-aside">
    333. 

  333.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/index.rst" class="fa fa-github"> Edit on GitHub</a>
    334. 

  334.       </li>
    335. 

  335.   </ul>
    336. 

  336.   <hr/>
    337. 

  337. </div>
    338. 

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

  339.            <div itemprop="articleBody">
    340. 

  340.              
    341. 

  341.   <section id="php-qrcode-manual">
    342. 

  342. <h1>PHP-QRCode Manual<a class="headerlink" href="#php-qrcode-manual" title="Link to this heading"></a></h1>
    343. 

  343. <p>User manual for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a>  [main]. Updated on Oct 25, 2023.</p>
    344. 

  344. <p>The phpDocumentor API documentation can be found at <a class="reference external" href="https://chillerlan.github.io/php-qrcode/">chillerlan.github.io/php-qrcode</a>.</p>
    345. 

  345. <p>This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.</p>
    346. 

  346. <div class="toctree-wrapper compound">
    347. 

  347. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
    348. 

  348. <ul>
    349. 

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

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

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

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

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

  354. </ul>
    355. 

  355. </li>
    356. 

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

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

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

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

  360. </ul>
    361. 

  361. </li>
    362. 

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

  363. <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>
    364. 

  364. </ul>
    365. 

  365. </li>
    366. 

  366. <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>
    367. 

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

  368. </ul>
    369. 

  369. </li>
    370. 

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

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

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

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

  374. </ul>
    375. 

  375. </li>
    376. 

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

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

  378. </ul>
    379. 

  379. </li>
    380. 

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

  381. <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>
    382. 

  382. <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>
    383. 

  383. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#load-and-save-options-from-to-json">Load and save options from/to JSON</a></li>
    384. 

  384. <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>
    385. 

  385. </ul>
    386. 

  386. </li>
    387. 

  387. <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>
    388. 

  388. <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>
    389. 

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

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

  391. </ul>
    392. 

  392. </li>
    393. 

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

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

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

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

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

  398. </ul>
    399. 

  399. </li>
    400. 

  400. </ul>
    401. 

  401. </li>
    402. 

  402. <li class="toctree-l1"><a class="reference internal" href="Usage/Configuration-settings.html">Configuration settings</a><ul>
    403. 

  403. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#version">version</a></li>
    404. 

  404. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmin">versionMin</a></li>
    405. 

  405. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmax">versionMax</a></li>
    406. 

  406. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#ecclevel">eccLevel</a></li>
    407. 

  407. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#maskpattern">maskPattern</a></li>
    408. 

  408. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addquietzone">addQuietzone</a></li>
    409. 

  409. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quietzonesize">quietzoneSize</a></li>
    410. 

  410. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#returnresource">returnResource</a></li>
    411. 

  411. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cachefile">cachefile</a></li>
    412. 

  412. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputbase64">outputBase64</a></li>
    413. 

  413. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#eol">eol</a></li>
    414. 

  414. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#bgcolor">bgColor</a></li>
    415. 

  415. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#invertmatrix">invertMatrix</a></li>
    416. 

  416. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawlightmodules">drawLightModules</a></li>
    417. 

  417. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawcircularmodules">drawCircularModules</a></li>
    418. 

  418. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#circleradius">circleRadius</a></li>
    419. 

  419. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#keepassquare">keepAsSquare</a></li>
    420. 

  420. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#connectpaths">connectPaths</a></li>
    421. 

  421. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#excludefromconnect">excludeFromConnect</a></li>
    422. 

  422. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#modulevalues">moduleValues</a></li>
    423. 

  423. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addlogospace">addLogoSpace</a></li>
    424. 

  424. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacewidth">logoSpaceWidth</a></li>
    425. 

  425. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospaceheight">logoSpaceHeight</a></li>
    426. 

  426. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestartx">logoSpaceStartX</a></li>
    427. 

  427. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestarty">logoSpaceStartY</a></li>
    428. 

  428. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#scale">scale</a></li>
    429. 

  429. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagetransparent">imageTransparent</a></li>
    430. 

  430. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#transparencycolor">transparencyColor</a></li>
    431. 

  431. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quality">quality</a></li>
    432. 

  432. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#gdimageuseupscale">gdImageUseUpscale</a></li>
    433. 

  433. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagickformat">imagickFormat</a></li>
    434. 

  434. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cssclass">cssClass</a></li>
    435. 

  435. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgaddxmlheader">svgAddXmlHeader</a></li>
    436. 

  436. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgdefs">svgDefs</a></li>
    437. 

  437. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
    438. 

  438. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgusefillattributes">svgUseFillAttributes</a></li>
    439. 

  439. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#textlinestart">textLineStart</a></li>
    440. 

  440. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonflags">jsonFlags</a></li>
    441. 

  441. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonasbooleans">jsonAsBooleans</a></li>
    442. 

  442. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#fpdfmeasureunit">fpdfMeasureUnit</a></li>
    443. 

  443. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
    444. 

  444. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readergrayscale">readerGrayscale</a></li>
    445. 

  445. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerincreasecontrast">readerIncreaseContrast</a></li>
    446. 

  446. </ul>
    447. 

  447. </li>
    448. 

  448. </ul>
    449. 

  449. </div>
    450. 

  450. <div class="toctree-wrapper compound">
    451. 

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

  452. <ul>
    453. 

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

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

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

  456. <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>
    457. 

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

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

  459. </ul>
    460. 

  460. </li>
    461. 

  461. </ul>
    462. 

  462. </li>
    463. 

  463. <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>
    464. 

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

  465. <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>
    466. 

  466. <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>
    467. 

  467. <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>
    468. 

  468. <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>
    469. 

  469. </ul>
    470. 

  470. </li>
    471. 

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

  472. <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>
    473. 

  473. <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>
    474. 

  474. <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>
    475. 

  475. <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>
    476. 

  476. <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>
    477. 

  477. <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>
    478. 

  478. <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>
    479. 

  479. <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>
    480. 

  480. <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>
    481. 

  481. </ul>
    482. 

  482. </li>
    483. 

  483. </ul>
    484. 

  484. </li>
    485. 

  485. </ul>
    486. 

  486. </div>
    487. 

  487. <div class="toctree-wrapper compound">
    488. 

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

  489. <ul>
    490. 

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

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

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

  493. <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>
    494. 

  494. <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>
    495. 

  495. </ul>
    496. 

  496. </li>
    497. 

  497. </ul>
    498. 

  498. </li>
    499. 

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

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

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

  502. <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>
    503. 

  503. <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>
    504. 

  504. </ul>
    505. 

  505. </li>
    506. 

  506. </ul>
    507. 

  507. </li>
    508. 

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

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

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

  511. <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>
    512. 

  512. <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>
    513. 

  513. </ul>
    514. 

  514. </li>
    515. 

  515. </ul>
    516. 

  516. </li>
    517. 

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

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

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

  520. <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>
    521. 

  521. <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>
    522. 

  522. </ul>
    523. 

  523. </li>
    524. 

  524. </ul>
    525. 

  525. </li>
    526. 

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

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

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

  529. <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>
    530. 

  530. <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>
    531. 

  531. </ul>
    532. 

  532. </li>
    533. 

  533. </ul>
    534. 

  534. </li>
    535. 

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

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

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

  538. <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>
    539. 

  539. <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>
    540. 

  540. </ul>
    541. 

  541. </li>
    542. 

  542. </ul>
    543. 

  543. </li>
    544. 

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

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

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

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

  548. <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>
    549. 

  549. <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>
    550. 

  550. </ul>
    551. 

  551. </li>
    552. 

  552. </ul>
    553. 

  553. </li>
    554. 

  554. </ul>
    555. 

  555. </div>
    556. 

  556. <div class="toctree-wrapper compound">
    557. 

  557. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    558. 

  558. <ul>
    559. 

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

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

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

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

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

  564. </ul>
    565. 

  565. </li>
    566. 

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

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

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

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

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

  571. </ul>
    572. 

  572. </li>
    573. 

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

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

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

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

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

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

  579. </ul>
    580. 

  580. </li>
    581. 

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

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

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

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

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

  586. </ul>
    587. 

  587. </li>
    588. 

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

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

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

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

  592. </ul>
    593. 

  593. </li>
    594. 

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

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

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

  597. </ul>
    598. 

  598. </li>
    599. 

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

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

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

  602. </ul>
    603. 

  603. </li>
    604. 

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

  605. </ul>
    606. 

  606. </li>
    607. 

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

  608. <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>
    609. 

  609. <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>
    610. 

  610. <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>
    611. 

  611. <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>
    612. 

  612. <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>
    613. 

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

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

  615. <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>
    616. 

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

  617. </ul>
    618. 

  618. </li>
    619. 

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

  620. </ul>
    621. 

  621. </div>
    622. 

  622. </section>
    623. 

  623. 

  624. 

  625.            </div>
    626. 

  626.           </div>
    627. 

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

  628.         <a href="Usage/Overview.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    629. 

  629.     </div>
    630. 

  630. 

  631.   <hr/>
    632. 

  632. 

  633.   <div role="contentinfo">
    634. 

  634.     <p>&#169; Copyright 2023, smiley.</p>
    635. 

  635.   </div>
    636. 

  636. 

  637.    
    638. 

  638. 

  639. </footer>
    640. 

  640.         </div>
    641. 

  641.       </div>
    642. 

  642.     </section>
    643. 

  643.   </div>
    644. 

  644.   <script>
    645. 

  645.       jQuery(function () {
    646. 

  646.           SphinxRtdTheme.Navigation.enable(true);
    647. 

  647.       });
    648. 

  648.   </script> 
    649. 

  649. 

  650. </body>
    651. 

  651. </html>
    652.