index.html 60 KB

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