index.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" data-content_root="./">
  3. <head>
  4. <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>chillerlan PHP-QRCode Manual &mdash; PHP-QRCode main
  7. Manual</title>
  8. <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
  9. <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
  10. <script src="_static/jquery.js?v=5d32c60e"></script>
  11. <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  12. <script src="_static/documentation_options.js?v=a8da1a53"></script>
  13. <script src="_static/doctools.js?v=9bcbadda"></script>
  14. <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  15. <script src="_static/js/theme.js"></script>
  16. <link rel="index" title="Index" href="genindex.html" />
  17. <link rel="search" title="Search" href="search.html" />
  18. <link rel="next" title="Overview" href="Usage/Overview.html" />
  19. </head>
  20. <body class="wy-body-for-nav">
  21. <div class="wy-grid-for-nav">
  22. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  23. <div class="wy-side-scroll">
  24. <div class="wy-side-nav-search" >
  25. <a href="#" class="icon icon-home">
  26. PHP-QRCode
  27. </a>
  28. <div role="search">
  29. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  30. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  31. <input type="hidden" name="check_keywords" value="yes" />
  32. <input type="hidden" name="area" value="default" />
  33. </form>
  34. </div>
  35. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  36. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  37. <ul>
  38. <li class="toctree-l1"><a class="reference internal" href="Usage/Overview.html">Overview</a><ul>
  39. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#features">Features</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#requirements">Requirements</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#framework-integration">Framework Integration</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#shameless-advertising">Shameless advertising</a></li>
  43. </ul>
  44. </li>
  45. <li class="toctree-l1"><a class="reference internal" href="Usage/Installation.html">Installation</a><ul>
  46. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#installation-with-composer">Installation with Composer</a><ul>
  47. <li class="toctree-l3"><a class="reference internal" href="Usage/Installation.html#composer-json">composer.json</a><ul>
  48. <li class="toctree-l4"><a class="reference internal" href="Usage/Installation.html#version-switch">Version switch</a></li>
  49. </ul>
  50. </li>
  51. <li class="toctree-l3"><a class="reference internal" href="Usage/Installation.html#terminal">Terminal</a></li>
  52. </ul>
  53. </li>
  54. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#manual-installation">Manual installation</a><ul>
  55. <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>
  56. </ul>
  57. </li>
  58. <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>
  59. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#imagemagick">ImageMagick</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l1"><a class="reference internal" href="Usage/Quickstart.html">Quickstart</a><ul>
  63. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#import-the-library">Import the library</a></li>
  64. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
  65. <li class="toctree-l3"><a class="reference internal" href="Usage/Quickstart.html#configuration">Configuration</a></li>
  66. </ul>
  67. </li>
  68. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
  69. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#notes">Notes</a></li>
  70. </ul>
  71. </li>
  72. <li class="toctree-l1"><a class="reference internal" href="Usage/Advanced-usage.html">Advanced usage</a><ul>
  73. <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>
  74. <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>
  75. <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>
  76. <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>
  77. </ul>
  78. </li>
  79. <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>
  80. <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>
  81. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  82. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  83. </ul>
  84. </li>
  85. <li class="toctree-l2"><a class="reference internal" href="Usage/Advanced-usage.html#common-output-options">Common output options</a><ul>
  86. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#save-to-file">Save to file</a></li>
  87. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#base64-uri-output">Base64 URI output</a></li>
  88. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#return-the-image-resource">Return the image resource</a></li>
  89. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#add-a-logo-space">Add a logo space</a></li>
  90. </ul>
  91. </li>
  92. </ul>
  93. </li>
  94. <li class="toctree-l1"><a class="reference internal" href="Usage/Configuration-settings.html">Configuration settings</a><ul>
  95. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#version">version</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmin">versionMin</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmax">versionMax</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#ecclevel">eccLevel</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#maskpattern">maskPattern</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addquietzone">addQuietzone</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quietzonesize">quietzoneSize</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputinterface">outputInterface</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#returnresource">returnResource</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cachefile">cachefile</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputbase64">outputBase64</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#eol">eol</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#bgcolor">bgColor</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#invertmatrix">invertMatrix</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawlightmodules">drawLightModules</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawcircularmodules">drawCircularModules</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#circleradius">circleRadius</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#keepassquare">keepAsSquare</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#connectpaths">connectPaths</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#excludefromconnect">excludeFromConnect</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#modulevalues">moduleValues</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addlogospace">addLogoSpace</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacewidth">logoSpaceWidth</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospaceheight">logoSpaceHeight</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestartx">logoSpaceStartX</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestarty">logoSpaceStartY</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#scale">scale</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagetransparent">imageTransparent</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#transparencycolor">transparencyColor</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quality">quality</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#gdimageuseupscale">gdImageUseUpscale</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagickformat">imagickFormat</a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cssclass">cssClass</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgaddxmlheader">svgAddXmlHeader</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgdefs">svgDefs</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgusefillattributes">svgUseFillAttributes</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#textlinestart">textLineStart</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonflags">jsonFlags</a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#fpdfmeasureunit">fpdfMeasureUnit</a></li>
  135. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#xmlstylesheet">xmlStylesheet</a></li>
  136. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
  137. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readergrayscale">readerGrayscale</a></li>
  138. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerinvertcolors">readerInvertColors</a></li>
  139. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerincreasecontrast">readerIncreaseContrast</a></li>
  140. </ul>
  141. </li>
  142. </ul>
  143. <p class="caption" role="heading"><span class="caption-text">Customizing output</span></p>
  144. <ul>
  145. <li class="toctree-l1"><a class="reference internal" href="Customizing/Module-Values.html">Module values</a><ul>
  146. <li class="toctree-l2"><a class="reference internal" href="Customizing/Module-Values.html#basics">Basics</a></li>
  147. <li class="toctree-l2"><a class="reference internal" href="Customizing/Module-Values.html#assigning-values">Assigning values</a></li>
  148. <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>
  149. <li class="toctree-l3"><a class="reference internal" href="Customizing/Module-Values.html#setting-module-values">Setting module values</a></li>
  150. <li class="toctree-l3"><a class="reference internal" href="Customizing/Module-Values.html#using-the-module-values">Using the module values</a></li>
  151. </ul>
  152. </li>
  153. </ul>
  154. </li>
  155. <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>
  156. <li class="toctree-l2"><a class="reference internal" href="Customizing/QROutputAbstract.html#properties">Properties</a><ul>
  157. <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>
  158. <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>
  159. <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>
  160. <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>
  161. </ul>
  162. </li>
  163. <li class="toctree-l2"><a class="reference internal" href="Customizing/QROutputAbstract.html#methods">Methods</a><ul>
  164. <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>
  165. <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>
  166. <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>
  167. <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>
  168. <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>
  169. <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>
  170. <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>
  171. <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>
  172. <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>
  173. </ul>
  174. </li>
  175. </ul>
  176. </li>
  177. <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>
  178. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#class-skeleton">Class skeleton</a></li>
  179. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#module-values">Module values</a></li>
  180. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#transform-the-output">Transform the output</a></li>
  181. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#run-the-custom-output">Run the custom output</a></li>
  182. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#summary">Summary</a></li>
  183. </ul>
  184. </li>
  185. </ul>
  186. <p class="caption" role="heading"><span class="caption-text">Built-In Output Classes</span></p>
  187. <ul>
  188. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QREps.html">QREps</a><ul>
  189. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#example">Example</a></li>
  190. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#additional-methods">Additional methods</a></li>
  191. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#options-that-affect-this-class">Options that affect this class</a></li>
  192. </ul>
  193. </li>
  194. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRFpdf.html">QRFpdf</a><ul>
  195. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#example">Example</a></li>
  196. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#additional-methods">Additional methods</a></li>
  197. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#options-that-affect-this-class">Options that affect this class</a></li>
  198. </ul>
  199. </li>
  200. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRGdImage.html">QRGdImage</a><ul>
  201. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#example">Example</a></li>
  202. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#additional-methods">Additional methods</a></li>
  203. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#options-that-affect-this-class">Options that affect this class</a></li>
  204. </ul>
  205. </li>
  206. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRImagick.html">QRImagick</a><ul>
  207. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#example">Example</a></li>
  208. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#additional-methods">Additional methods</a></li>
  209. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#options-that-affect-this-class">Options that affect this class</a></li>
  210. </ul>
  211. </li>
  212. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html">QRInterventionImage</a><ul>
  213. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#example">Example</a></li>
  214. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#additional-methods">Additional methods</a></li>
  215. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#options-that-affect-this-class">Options that affect this class</a></li>
  216. </ul>
  217. </li>
  218. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html">QRMarkupHTML</a><ul>
  219. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#example">Example</a></li>
  220. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  221. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#options-that-affect-this-class">Options that affect this class</a></li>
  222. </ul>
  223. </li>
  224. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html">QRMarkupSVG</a><ul>
  225. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#example">Example</a></li>
  226. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  227. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#options-that-affect-this-class">Options that affect this class</a></li>
  228. </ul>
  229. </li>
  230. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html">QRMarkupXML</a><ul>
  231. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#example">Example</a></li>
  232. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#additional-methods">Additional methods</a></li>
  233. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#options-that-affect-this-class">Options that affect this class</a></li>
  234. </ul>
  235. </li>
  236. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRStringJSON.html">QRStringJSON</a><ul>
  237. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#example">Example</a></li>
  238. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#previous-functionality">Previous functionality</a></li>
  239. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#additional-methods">Additional methods</a></li>
  240. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#options-that-affect-this-class">Options that affect this class</a></li>
  241. </ul>
  242. </li>
  243. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRStringText.html">QRStringText</a><ul>
  244. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#example">Example</a></li>
  245. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#additional-methods">Additional methods</a></li>
  246. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#options-that-affect-this-class">Options that affect this class</a></li>
  247. </ul>
  248. </li>
  249. </ul>
  250. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  251. <ul>
  252. <li class="toctree-l1"><a class="reference internal" href="Appendix/Terminology.html">Terminology</a><ul>
  253. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#qr-code">QR Code</a></li>
  254. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#matrix">Matrix</a><ul>
  255. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#module">Module</a></li>
  256. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#version">Version</a></li>
  257. </ul>
  258. </li>
  259. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#function-patterns">Function Patterns</a><ul>
  260. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#finder-pattern">Finder Pattern</a></li>
  261. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  262. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#timing-pattern">Timing Pattern</a></li>
  263. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#separators">Separators</a></li>
  264. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#quiet-zone">Quiet Zone</a></li>
  265. </ul>
  266. </li>
  267. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#encoding-region">Encoding Region</a><ul>
  268. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#data">Data</a></li>
  269. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#version-information">Version Information</a></li>
  270. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#format-information">Format Information</a></li>
  271. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#darkmodule">Darkmodule</a></li>
  272. </ul>
  273. </li>
  274. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#mode">Mode</a><ul>
  275. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#segment">Segment</a></li>
  276. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  277. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#mixed-mode">Mixed Mode</a></li>
  278. </ul>
  279. </li>
  280. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  281. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#ecc-level">ECC Level</a></li>
  282. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  283. </ul>
  284. </li>
  285. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#data-masking">Data masking</a><ul>
  286. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#evaluation">Evaluation</a></li>
  287. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#mask-pattern">Mask pattern</a></li>
  288. </ul>
  289. </li>
  290. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#reflectance">Reflectance</a></li>
  291. </ul>
  292. </li>
  293. <li class="toctree-l1"><a class="reference internal" href="Appendix/URI-Content.html">Popular content and URI schemes</a><ul>
  294. <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>
  295. <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>
  296. <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>
  297. <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>
  298. <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>
  299. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  300. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  301. <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>
  302. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#credit-transfer">Credit Transfer</a><ul>
  303. <li class="toctree-l3"><a class="reference internal" href="Appendix/URI-Content.html#sepa-european-payments-council">SEPA (European Payments Council)</a></li>
  304. <li class="toctree-l3"><a class="reference internal" href="Appendix/URI-Content.html#pix-banco-central-do-brasil">Pix (Banco Central do Brasil)</a></li>
  305. </ul>
  306. </li>
  307. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#see-also">See also</a></li>
  308. </ul>
  309. </li>
  310. <li class="toctree-l1"><a class="reference internal" href="Appendix/Performance-considerations.html">Performance considerations</a><ul>
  311. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#version">Version</a></li>
  312. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#ecc-level">Ecc level</a></li>
  313. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#data-mode">Data mode</a></li>
  314. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#mask-pattern">Mask pattern</a></li>
  315. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#output">Output</a></li>
  316. </ul>
  317. </li>
  318. <li class="toctree-l1"><a class="reference internal" href="Appendix/Contribute.html">How to contribute</a><ul>
  319. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#questions-and-issues">Questions and issues</a></li>
  320. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#bug-reports">Bug reports</a></li>
  321. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#pull-requests-and-bug-fixes">Pull requests and bug fixes</a></li>
  322. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#documentation">Documentation</a></li>
  323. </ul>
  324. </li>
  325. <li class="toctree-l1"><a class="reference internal" href="Appendix/License.html">License</a></li>
  326. </ul>
  327. </div>
  328. </div>
  329. </nav>
  330. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  331. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  332. <a href="#">PHP-QRCode</a>
  333. </nav>
  334. <div class="wy-nav-content">
  335. <div class="rst-content">
  336. <div role="navigation" aria-label="Page navigation">
  337. <ul class="wy-breadcrumbs">
  338. <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
  339. <li class="breadcrumb-item active">chillerlan PHP-QRCode Manual</li>
  340. <li class="wy-breadcrumbs-aside">
  341. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/index.rst" class="fa fa-github"> Edit on GitHub</a>
  342. </li>
  343. </ul>
  344. <hr/>
  345. </div>
  346. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  347. <div itemprop="articleBody">
  348. <section id="chillerlan-php-qrcode-manual">
  349. <h1>chillerlan PHP-QRCode Manual<a class="headerlink" href="#chillerlan-php-qrcode-manual" title="Link to this heading"></a></h1>
  350. <p>User manual for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a> [main]. Updated on Nov 01, 2025.</p>
  351. <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>
  352. <p>This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.</p>
  353. <div class="toctree-wrapper compound">
  354. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  355. <ul>
  356. <li class="toctree-l1"><a class="reference internal" href="Usage/Overview.html">Overview</a><ul>
  357. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#features">Features</a></li>
  358. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#requirements">Requirements</a></li>
  359. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#framework-integration">Framework Integration</a></li>
  360. <li class="toctree-l2"><a class="reference internal" href="Usage/Overview.html#shameless-advertising">Shameless advertising</a></li>
  361. </ul>
  362. </li>
  363. <li class="toctree-l1"><a class="reference internal" href="Usage/Installation.html">Installation</a><ul>
  364. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#installation-with-composer">Installation with Composer</a><ul>
  365. <li class="toctree-l3"><a class="reference internal" href="Usage/Installation.html#composer-json">composer.json</a></li>
  366. <li class="toctree-l3"><a class="reference internal" href="Usage/Installation.html#terminal">Terminal</a></li>
  367. </ul>
  368. </li>
  369. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#manual-installation">Manual installation</a><ul>
  370. <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>
  371. </ul>
  372. </li>
  373. <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>
  374. <li class="toctree-l2"><a class="reference internal" href="Usage/Installation.html#imagemagick">ImageMagick</a></li>
  375. </ul>
  376. </li>
  377. <li class="toctree-l1"><a class="reference internal" href="Usage/Quickstart.html">Quickstart</a><ul>
  378. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#import-the-library">Import the library</a></li>
  379. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
  380. <li class="toctree-l3"><a class="reference internal" href="Usage/Quickstart.html#configuration">Configuration</a></li>
  381. </ul>
  382. </li>
  383. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
  384. <li class="toctree-l2"><a class="reference internal" href="Usage/Quickstart.html#notes">Notes</a></li>
  385. </ul>
  386. </li>
  387. <li class="toctree-l1"><a class="reference internal" href="Usage/Advanced-usage.html">Advanced usage</a><ul>
  388. <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>
  389. <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>
  390. <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>
  391. <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>
  392. </ul>
  393. </li>
  394. <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>
  395. <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>
  396. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  397. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  398. </ul>
  399. </li>
  400. <li class="toctree-l2"><a class="reference internal" href="Usage/Advanced-usage.html#common-output-options">Common output options</a><ul>
  401. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#save-to-file">Save to file</a></li>
  402. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#base64-uri-output">Base64 URI output</a></li>
  403. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#return-the-image-resource">Return the image resource</a></li>
  404. <li class="toctree-l3"><a class="reference internal" href="Usage/Advanced-usage.html#add-a-logo-space">Add a logo space</a></li>
  405. </ul>
  406. </li>
  407. </ul>
  408. </li>
  409. <li class="toctree-l1"><a class="reference internal" href="Usage/Configuration-settings.html">Configuration settings</a><ul>
  410. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#version">version</a></li>
  411. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmin">versionMin</a></li>
  412. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#versionmax">versionMax</a></li>
  413. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#ecclevel">eccLevel</a></li>
  414. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#maskpattern">maskPattern</a></li>
  415. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addquietzone">addQuietzone</a></li>
  416. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quietzonesize">quietzoneSize</a></li>
  417. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputinterface">outputInterface</a></li>
  418. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#returnresource">returnResource</a></li>
  419. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cachefile">cachefile</a></li>
  420. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#outputbase64">outputBase64</a></li>
  421. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#eol">eol</a></li>
  422. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#bgcolor">bgColor</a></li>
  423. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#invertmatrix">invertMatrix</a></li>
  424. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawlightmodules">drawLightModules</a></li>
  425. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#drawcircularmodules">drawCircularModules</a></li>
  426. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#circleradius">circleRadius</a></li>
  427. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#keepassquare">keepAsSquare</a></li>
  428. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#connectpaths">connectPaths</a></li>
  429. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#excludefromconnect">excludeFromConnect</a></li>
  430. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#modulevalues">moduleValues</a></li>
  431. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#addlogospace">addLogoSpace</a></li>
  432. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacewidth">logoSpaceWidth</a></li>
  433. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospaceheight">logoSpaceHeight</a></li>
  434. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestartx">logoSpaceStartX</a></li>
  435. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#logospacestarty">logoSpaceStartY</a></li>
  436. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#scale">scale</a></li>
  437. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagetransparent">imageTransparent</a></li>
  438. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#transparencycolor">transparencyColor</a></li>
  439. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#quality">quality</a></li>
  440. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#gdimageuseupscale">gdImageUseUpscale</a></li>
  441. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#imagickformat">imagickFormat</a></li>
  442. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#cssclass">cssClass</a></li>
  443. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgaddxmlheader">svgAddXmlHeader</a></li>
  444. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgdefs">svgDefs</a></li>
  445. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
  446. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#svgusefillattributes">svgUseFillAttributes</a></li>
  447. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#textlinestart">textLineStart</a></li>
  448. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#jsonflags">jsonFlags</a></li>
  449. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#fpdfmeasureunit">fpdfMeasureUnit</a></li>
  450. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#xmlstylesheet">xmlStylesheet</a></li>
  451. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
  452. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readergrayscale">readerGrayscale</a></li>
  453. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerinvertcolors">readerInvertColors</a></li>
  454. <li class="toctree-l2"><a class="reference internal" href="Usage/Configuration-settings.html#readerincreasecontrast">readerIncreaseContrast</a></li>
  455. </ul>
  456. </li>
  457. </ul>
  458. </div>
  459. <div class="toctree-wrapper compound">
  460. <p class="caption" role="heading"><span class="caption-text">Customizing output</span></p>
  461. <ul>
  462. <li class="toctree-l1"><a class="reference internal" href="Customizing/Module-Values.html">Module values</a><ul>
  463. <li class="toctree-l2"><a class="reference internal" href="Customizing/Module-Values.html#basics">Basics</a></li>
  464. <li class="toctree-l2"><a class="reference internal" href="Customizing/Module-Values.html#assigning-values">Assigning values</a></li>
  465. <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>
  466. <li class="toctree-l3"><a class="reference internal" href="Customizing/Module-Values.html#setting-module-values">Setting module values</a></li>
  467. <li class="toctree-l3"><a class="reference internal" href="Customizing/Module-Values.html#using-the-module-values">Using the module values</a></li>
  468. </ul>
  469. </li>
  470. </ul>
  471. </li>
  472. <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>
  473. <li class="toctree-l2"><a class="reference internal" href="Customizing/QROutputAbstract.html#properties">Properties</a><ul>
  474. <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>
  475. <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>
  476. <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>
  477. <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>
  478. </ul>
  479. </li>
  480. <li class="toctree-l2"><a class="reference internal" href="Customizing/QROutputAbstract.html#methods">Methods</a><ul>
  481. <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>
  482. <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>
  483. <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>
  484. <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>
  485. <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>
  486. <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>
  487. <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>
  488. <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>
  489. <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>
  490. </ul>
  491. </li>
  492. </ul>
  493. </li>
  494. <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>
  495. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#class-skeleton">Class skeleton</a></li>
  496. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#module-values">Module values</a></li>
  497. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#transform-the-output">Transform the output</a></li>
  498. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#run-the-custom-output">Run the custom output</a></li>
  499. <li class="toctree-l2"><a class="reference internal" href="Customizing/Custom-output-interface.html#summary">Summary</a></li>
  500. </ul>
  501. </li>
  502. </ul>
  503. </div>
  504. <div class="toctree-wrapper compound">
  505. <p class="caption" role="heading"><span class="caption-text">Built-In Output Classes</span></p>
  506. <ul>
  507. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QREps.html">QREps</a><ul>
  508. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#example">Example</a></li>
  509. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#additional-methods">Additional methods</a></li>
  510. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QREps.html#options-that-affect-this-class">Options that affect this class</a></li>
  511. </ul>
  512. </li>
  513. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRFpdf.html">QRFpdf</a><ul>
  514. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#example">Example</a></li>
  515. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#additional-methods">Additional methods</a></li>
  516. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRFpdf.html#options-that-affect-this-class">Options that affect this class</a></li>
  517. </ul>
  518. </li>
  519. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRGdImage.html">QRGdImage</a><ul>
  520. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#example">Example</a></li>
  521. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#additional-methods">Additional methods</a></li>
  522. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRGdImage.html#options-that-affect-this-class">Options that affect this class</a></li>
  523. </ul>
  524. </li>
  525. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRImagick.html">QRImagick</a><ul>
  526. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#example">Example</a></li>
  527. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#additional-methods">Additional methods</a></li>
  528. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRImagick.html#options-that-affect-this-class">Options that affect this class</a></li>
  529. </ul>
  530. </li>
  531. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html">QRInterventionImage</a><ul>
  532. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#example">Example</a></li>
  533. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#additional-methods">Additional methods</a></li>
  534. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRInterventionImage.html#options-that-affect-this-class">Options that affect this class</a></li>
  535. </ul>
  536. </li>
  537. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html">QRMarkupHTML</a><ul>
  538. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#example">Example</a></li>
  539. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  540. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupHTML.html#options-that-affect-this-class">Options that affect this class</a></li>
  541. </ul>
  542. </li>
  543. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html">QRMarkupSVG</a><ul>
  544. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#example">Example</a></li>
  545. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  546. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupSVG.html#options-that-affect-this-class">Options that affect this class</a></li>
  547. </ul>
  548. </li>
  549. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html">QRMarkupXML</a><ul>
  550. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#example">Example</a></li>
  551. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#additional-methods">Additional methods</a></li>
  552. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRMarkupXML.html#options-that-affect-this-class">Options that affect this class</a></li>
  553. </ul>
  554. </li>
  555. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRStringJSON.html">QRStringJSON</a><ul>
  556. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#example">Example</a></li>
  557. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#previous-functionality">Previous functionality</a></li>
  558. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#additional-methods">Additional methods</a></li>
  559. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringJSON.html#options-that-affect-this-class">Options that affect this class</a></li>
  560. </ul>
  561. </li>
  562. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output/QRStringText.html">QRStringText</a><ul>
  563. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#example">Example</a></li>
  564. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#additional-methods">Additional methods</a></li>
  565. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output/QRStringText.html#options-that-affect-this-class">Options that affect this class</a></li>
  566. </ul>
  567. </li>
  568. </ul>
  569. </div>
  570. <div class="toctree-wrapper compound">
  571. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  572. <ul>
  573. <li class="toctree-l1"><a class="reference internal" href="Appendix/Terminology.html">Terminology</a><ul>
  574. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#qr-code">QR Code</a></li>
  575. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#matrix">Matrix</a><ul>
  576. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#module">Module</a></li>
  577. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#version">Version</a></li>
  578. </ul>
  579. </li>
  580. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#function-patterns">Function Patterns</a><ul>
  581. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#finder-pattern">Finder Pattern</a></li>
  582. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  583. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#timing-pattern">Timing Pattern</a></li>
  584. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#separators">Separators</a></li>
  585. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#quiet-zone">Quiet Zone</a></li>
  586. </ul>
  587. </li>
  588. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#encoding-region">Encoding Region</a><ul>
  589. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#data">Data</a></li>
  590. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#version-information">Version Information</a></li>
  591. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#format-information">Format Information</a></li>
  592. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#darkmodule">Darkmodule</a></li>
  593. </ul>
  594. </li>
  595. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#mode">Mode</a><ul>
  596. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#segment">Segment</a></li>
  597. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  598. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#mixed-mode">Mixed Mode</a></li>
  599. </ul>
  600. </li>
  601. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  602. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#ecc-level">ECC Level</a></li>
  603. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  604. </ul>
  605. </li>
  606. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#data-masking">Data masking</a><ul>
  607. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#evaluation">Evaluation</a></li>
  608. <li class="toctree-l3"><a class="reference internal" href="Appendix/Terminology.html#mask-pattern">Mask pattern</a></li>
  609. </ul>
  610. </li>
  611. <li class="toctree-l2"><a class="reference internal" href="Appendix/Terminology.html#reflectance">Reflectance</a></li>
  612. </ul>
  613. </li>
  614. <li class="toctree-l1"><a class="reference internal" href="Appendix/URI-Content.html">Popular content and URI schemes</a><ul>
  615. <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>
  616. <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>
  617. <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>
  618. <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>
  619. <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>
  620. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  621. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  622. <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>
  623. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#credit-transfer">Credit Transfer</a><ul>
  624. <li class="toctree-l3"><a class="reference internal" href="Appendix/URI-Content.html#sepa-european-payments-council">SEPA (European Payments Council)</a></li>
  625. <li class="toctree-l3"><a class="reference internal" href="Appendix/URI-Content.html#pix-banco-central-do-brasil">Pix (Banco Central do Brasil)</a></li>
  626. </ul>
  627. </li>
  628. <li class="toctree-l2"><a class="reference internal" href="Appendix/URI-Content.html#see-also">See also</a></li>
  629. </ul>
  630. </li>
  631. <li class="toctree-l1"><a class="reference internal" href="Appendix/Performance-considerations.html">Performance considerations</a><ul>
  632. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#version">Version</a></li>
  633. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#ecc-level">Ecc level</a></li>
  634. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#data-mode">Data mode</a></li>
  635. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#mask-pattern">Mask pattern</a></li>
  636. <li class="toctree-l2"><a class="reference internal" href="Appendix/Performance-considerations.html#output">Output</a></li>
  637. </ul>
  638. </li>
  639. <li class="toctree-l1"><a class="reference internal" href="Appendix/Contribute.html">How to contribute</a><ul>
  640. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#questions-and-issues">Questions and issues</a></li>
  641. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#bug-reports">Bug reports</a></li>
  642. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#pull-requests-and-bug-fixes">Pull requests and bug fixes</a></li>
  643. <li class="toctree-l2"><a class="reference internal" href="Appendix/Contribute.html#documentation">Documentation</a></li>
  644. </ul>
  645. </li>
  646. <li class="toctree-l1"><a class="reference internal" href="Appendix/License.html">License</a></li>
  647. </ul>
  648. </div>
  649. </section>
  650. </div>
  651. </div>
  652. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  653. <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>
  654. </div>
  655. <hr/>
  656. <div role="contentinfo">
  657. <p>&#169; Copyright 2023, smiley.</p>
  658. </div>
  659. </footer>
  660. </div>
  661. </div>
  662. </section>
  663. </div>
  664. <script>
  665. jQuery(function () {
  666. SphinxRtdTheme.Navigation.enable(true);
  667. });
  668. </script>
  669. </body>
  670. </html>