index.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536
  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-json">Load and save 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#save-to-file">Save to file</a></li>
  84. <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>
  85. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  87. </ul>
  88. </li>
  89. </ul>
  90. </li>
  91. </ul>
  92. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
  93. <ul>
  94. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
  95. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#example">Example</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
  97. <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>
  98. <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>
  99. </ul>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  104. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#example">Example</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
  106. <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>
  107. <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>
  108. </ul>
  109. </li>
  110. </ul>
  111. </li>
  112. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  113. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#example">Example</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
  115. <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>
  116. <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>
  117. </ul>
  118. </li>
  119. </ul>
  120. </li>
  121. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  122. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#example">Example</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
  124. <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>
  125. <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>
  126. </ul>
  127. </li>
  128. </ul>
  129. </li>
  130. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  131. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#example">Example</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  133. <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>
  134. <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>
  135. </ul>
  136. </li>
  137. </ul>
  138. </li>
  139. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  140. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#example">Example</a></li>
  141. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  142. <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>
  143. <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>
  144. </ul>
  145. </li>
  146. </ul>
  147. </li>
  148. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  149. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#plain-text">Plain text</a></li>
  150. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
  152. <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>
  153. <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>
  154. </ul>
  155. </li>
  156. </ul>
  157. </li>
  158. </ul>
  159. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
  160. <ul>
  161. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html">QRCode</a><ul>
  162. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
  163. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
  164. </ul>
  165. </li>
  166. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
  167. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
  168. </ul>
  169. </li>
  170. </ul>
  171. </li>
  172. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</a><ul>
  173. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
  174. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
  175. </ul>
  176. </li>
  177. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
  178. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
  179. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
  180. </ul>
  181. </li>
  182. <li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html">QRMatrix</a><ul>
  183. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
  184. <li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
  185. </ul>
  186. </li>
  187. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
  188. </ul>
  189. </li>
  190. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
  191. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
  192. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
  193. </ul>
  194. </li>
  195. </ul>
  196. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  197. <ul>
  198. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  199. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  200. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  201. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  202. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  203. </ul>
  204. </li>
  205. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  206. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  207. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  208. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  209. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  210. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  211. </ul>
  212. </li>
  213. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  214. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  215. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  216. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  217. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  218. </ul>
  219. </li>
  220. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  221. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  222. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  223. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  224. </ul>
  225. </li>
  226. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  227. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  228. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  229. </ul>
  230. </li>
  231. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  232. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  233. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  234. </ul>
  235. </li>
  236. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  237. </ul>
  238. </li>
  239. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  240. <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>
  241. <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>
  242. <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>
  243. <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>
  244. <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>
  245. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  246. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  247. <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>
  248. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  249. </ul>
  250. </li>
  251. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  252. </ul>
  253. </div>
  254. </div>
  255. </nav>
  256. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  257. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  258. <a href="#">PHP-QRCode</a>
  259. </nav>
  260. <div class="wy-nav-content">
  261. <div class="rst-content">
  262. <div role="navigation" aria-label="Page navigation">
  263. <ul class="wy-breadcrumbs">
  264. <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
  265. <li class="breadcrumb-item active">PHP-QRCode Manual</li>
  266. <li class="wy-breadcrumbs-aside">
  267. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/index.rst" class="fa fa-github"> Edit on GitHub</a>
  268. </li>
  269. </ul>
  270. <hr/>
  271. </div>
  272. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  273. <div itemprop="articleBody">
  274. <section id="php-qrcode-manual">
  275. <h1>PHP-QRCode Manual<a class="headerlink" href="#php-qrcode-manual" title="Link to this heading"></a></h1>
  276. <p>Edition for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a> [main]. Updated on Sep 18, 2023.</p>
  277. <p>This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.</p>
  278. <div class="toctree-wrapper compound">
  279. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  280. <ul>
  281. <li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
  282. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
  283. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
  284. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
  285. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
  286. </ul>
  287. </li>
  288. <li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
  289. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
  290. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a></li>
  291. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
  292. </ul>
  293. </li>
  294. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
  295. <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>
  296. </ul>
  297. </li>
  298. <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>
  299. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
  300. </ul>
  301. </li>
  302. <li class="toctree-l1"><a class="reference internal" href="Usage-Quickstart.html">Quickstart</a><ul>
  303. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#import-the-library">Import the library</a></li>
  304. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
  305. <li class="toctree-l3"><a class="reference internal" href="Usage-Quickstart.html#configuration">Configuration</a></li>
  306. </ul>
  307. </li>
  308. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
  309. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#notes">Notes</a></li>
  310. </ul>
  311. </li>
  312. <li class="toctree-l1"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
  313. <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>
  314. <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>
  315. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
  316. <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>
  317. </ul>
  318. </li>
  319. <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>
  320. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
  321. <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>
  322. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  323. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  324. </ul>
  325. </li>
  326. </ul>
  327. </li>
  328. </ul>
  329. </div>
  330. <div class="toctree-wrapper compound">
  331. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
  332. <ul>
  333. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
  334. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#example">Example</a></li>
  335. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
  336. <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>
  337. <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>
  338. </ul>
  339. </li>
  340. </ul>
  341. </li>
  342. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  343. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#example">Example</a></li>
  344. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
  345. <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>
  346. <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>
  347. </ul>
  348. </li>
  349. </ul>
  350. </li>
  351. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  352. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#example">Example</a></li>
  353. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
  354. <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>
  355. <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>
  356. </ul>
  357. </li>
  358. </ul>
  359. </li>
  360. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  361. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#example">Example</a></li>
  362. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
  363. <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>
  364. <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>
  365. </ul>
  366. </li>
  367. </ul>
  368. </li>
  369. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  370. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#example">Example</a></li>
  371. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  372. <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>
  373. <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>
  374. </ul>
  375. </li>
  376. </ul>
  377. </li>
  378. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  379. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#example">Example</a></li>
  380. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  381. <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>
  382. <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>
  383. </ul>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  388. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#plain-text">Plain text</a></li>
  389. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
  390. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
  391. <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>
  392. <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>
  393. </ul>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </div>
  399. <div class="toctree-wrapper compound">
  400. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
  401. <ul>
  402. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html">QRCode</a><ul>
  403. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
  404. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
  405. </ul>
  406. </li>
  407. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
  408. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
  409. </ul>
  410. </li>
  411. </ul>
  412. </li>
  413. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</a><ul>
  414. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
  415. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
  416. </ul>
  417. </li>
  418. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
  419. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
  420. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
  421. </ul>
  422. </li>
  423. <li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html">QRMatrix</a><ul>
  424. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
  425. <li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
  426. </ul>
  427. </li>
  428. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
  429. </ul>
  430. </li>
  431. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
  432. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
  433. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
  434. </ul>
  435. </li>
  436. </ul>
  437. </div>
  438. <div class="toctree-wrapper compound">
  439. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  440. <ul>
  441. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  442. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  443. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  444. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  445. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  446. </ul>
  447. </li>
  448. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  449. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  450. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  451. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  452. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  453. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  454. </ul>
  455. </li>
  456. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  457. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  458. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  459. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  460. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  461. </ul>
  462. </li>
  463. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  464. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  465. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  466. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  467. </ul>
  468. </li>
  469. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  470. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  471. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  472. </ul>
  473. </li>
  474. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  475. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  476. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  477. </ul>
  478. </li>
  479. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  480. </ul>
  481. </li>
  482. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  483. <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>
  484. <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>
  485. <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>
  486. <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>
  487. <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>
  488. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  489. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  490. <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>
  491. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  492. </ul>
  493. </li>
  494. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  495. </ul>
  496. </div>
  497. </section>
  498. </div>
  499. </div>
  500. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  501. <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>
  502. </div>
  503. <hr/>
  504. <div role="contentinfo">
  505. <p>&#169; Copyright 2023, smiley.</p>
  506. </div>
  507. </footer>
  508. </div>
  509. </div>
  510. </section>
  511. </div>
  512. <script>
  513. jQuery(function () {
  514. SphinxRtdTheme.Navigation.enable(true);
  515. });
  516. </script>
  517. </body>
  518. </html>