Home Explore Help
Sign In
mrkad
/
php-qrcode
mirror of https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 3b4ca2fa8a
Branches Tags
php-qrcode
/
index.html

index.html 33 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462 
  1. <!DOCTYPE html>
    2. 

  2. <html class="writer-html5" lang="en" >
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
    5. 

  5. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <title>PHP-QRCode Manual &mdash; PHP-QRCode main
    8. 

  8.  Manual</title>
    9. 

  9.       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    10. 

  10.       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    11. 

  11.   <!--[if lt IE 9]>
    12. 

  12.     <script src="_static/js/html5shiv.min.js"></script>
    13. 

  13.   <![endif]-->
    14. 

  14.   
    15. 

  15.         <script src="_static/jquery.js?v=5d32c60e"></script>
    16. 

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

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

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

  19.         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    20. 

  20.     <script src="_static/js/theme.js"></script>
    21. 

  21.     <link rel="index" title="Index" href="genindex.html" />
    22. 

  22.     <link rel="search" title="Search" href="search.html" />
    23. 

  23.     <link rel="next" title="Overview" href="Usage-Overview.html" /> 
    24. 

  24. </head>
    25. 

  25. 

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

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

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

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

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

  31. 

  32.           
    33. 

  33.           
    34. 

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

  35.             PHP-QRCode
    36. 

  36.           </a>
    37. 

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

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

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

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

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

  42.   </form>
    43. 

  43. </div>
    44. 

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

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

  46. <ul>
    47. 

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

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

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

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

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

  52. </ul>
    53. 

  53. </li>
    54. 

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

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

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

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

  58. </ul>
    59. 

  59. </li>
    60. 

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

  61. </ul>
    62. 

  62. </li>
    63. 

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

  64. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#can-i-use-this-library-without-using-composer">Can i use this library without using composer?</a></li>
    65. 

  65. </ul>
    66. 

  66. </li>
    67. 

  67. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#supported-php-versions-extension-requirements">Supported PHP versions &amp; extension requirements</a></li>
    68. 

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

  69. </ul>
    70. 

  70. </li>
    71. 

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

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

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

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

  75. </ul>
    76. 

  76. </li>
    77. 

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

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

  79. </ul>
    80. 

  80. </li>
    81. 

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

  82. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#configuration-via-qroptions">Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
    83. 

  83. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#supply-an-iterable-of-options">Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options</a></li>
    84. 

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

  85. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#extending-the-qroptions-class">Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class</a></li>
    86. 

  86. </ul>
    87. 

  87. </li>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#qrcode-methods"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods</a><ul>
    89. 

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

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

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

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

  93. </ul>
    94. 

  94. </li>
    95. 

  95. </ul>
    96. 

  96. </li>
    97. 

  97. </ul>
    98. 

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

  99. <ul>
    100. 

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

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

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

  103. <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>
    104. 

  104. <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>
    105. 

  105. </ul>
    106. 

  106. </li>
    107. 

  107. </ul>
    108. 

  108. </li>
    109. 

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

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

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

  112. <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>
    113. 

  113. <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>
    114. 

  114. </ul>
    115. 

  115. </li>
    116. 

  116. </ul>
    117. 

  117. </li>
    118. 

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

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

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

  121. <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>
    122. 

  122. <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>
    123. 

  123. </ul>
    124. 

  124. </li>
    125. 

  125. </ul>
    126. 

  126. </li>
    127. 

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

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

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

  130. <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>
    131. 

  131. <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>
    132. 

  132. </ul>
    133. 

  133. </li>
    134. 

  134. </ul>
    135. 

  135. </li>
    136. 

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

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

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

  139. <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>
    140. 

  140. <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>
    141. 

  141. </ul>
    142. 

  142. </li>
    143. 

  143. </ul>
    144. 

  144. </li>
    145. 

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

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

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

  148. <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>
    149. 

  149. <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>
    150. 

  150. </ul>
    151. 

  151. </li>
    152. 

  152. </ul>
    153. 

  153. </li>
    154. 

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

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

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

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

  158. <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>
    159. 

  159. <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>
    160. 

  160. </ul>
    161. 

  161. </li>
    162. 

  162. </ul>
    163. 

  163. </li>
    164. 

  164. </ul>
    165. 

  165. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    166. 

  166. <ul>
    167. 

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

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

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

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

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

  172. </ul>
    173. 

  173. </li>
    174. 

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

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

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

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

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

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

  180. </ul>
    181. 

  181. </li>
    182. 

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

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

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

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

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

  187. </ul>
    188. 

  188. </li>
    189. 

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

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

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

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

  193. </ul>
    194. 

  194. </li>
    195. 

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

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

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

  198. </ul>
    199. 

  199. </li>
    200. 

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

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

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

  203. </ul>
    204. 

  204. </li>
    205. 

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

  206. </ul>
    207. 

  207. </li>
    208. 

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

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

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

  211. <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>
    212. 

  212. <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>
    213. 

  213. <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>
    214. 

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

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

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

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

  218. </ul>
    219. 

  219. </li>
    220. 

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

  221. </ul>
    222. 

  222. 

  223.         </div>
    224. 

  224.       </div>
    225. 

  225.     </nav>
    226. 

  226. 

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

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

  229.           <a href="#">PHP-QRCode</a>
    230. 

  230.       </nav>
    231. 

  231. 

  232.       <div class="wy-nav-content">
    233. 

  233.         <div class="rst-content">
    234. 

  234.           <div role="navigation" aria-label="Page navigation">
    235. 

  235.   <ul class="wy-breadcrumbs">
    236. 

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

  237.       <li class="breadcrumb-item active">PHP-QRCode Manual</li>
    238. 

  238.       <li class="wy-breadcrumbs-aside">
    239. 

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

  240.       </li>
    241. 

  241.   </ul>
    242. 

  242.   <hr/>
    243. 

  243. </div>
    244. 

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

  245.            <div itemprop="articleBody">
    246. 

  246.              
    247. 

  247.   <section id="php-qrcode-manual">
    248. 

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

  249. <p>Edition for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a>  [main]. Updated on Oct 03, 2023.</p>
    250. 

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

  251. <div class="toctree-wrapper compound">
    252. 

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

  253. <ul>
    254. 

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

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

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

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

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

  259. </ul>
    260. 

  260. </li>
    261. 

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

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

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

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

  265. </ul>
    266. 

  266. </li>
    267. 

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

  268. <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>
    269. 

  269. </ul>
    270. 

  270. </li>
    271. 

  271. <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>
    272. 

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

  273. </ul>
    274. 

  274. </li>
    275. 

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

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

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

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

  279. </ul>
    280. 

  280. </li>
    281. 

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

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

  283. </ul>
    284. 

  284. </li>
    285. 

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

  286. <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>
    287. 

  287. <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>
    288. 

  288. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
    289. 

  289. <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>
    290. 

  290. </ul>
    291. 

  291. </li>
    292. 

  292. <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>
    293. 

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

  294. <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>
    295. 

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

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

  297. </ul>
    298. 

  298. </li>
    299. 

  299. </ul>
    300. 

  300. </li>
    301. 

  301. </ul>
    302. 

  302. </div>
    303. 

  303. <div class="toctree-wrapper compound">
    304. 

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

  305. <ul>
    306. 

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

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

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

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

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

  311. </ul>
    312. 

  312. </li>
    313. 

  313. </ul>
    314. 

  314. </li>
    315. 

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

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

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

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

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

  320. </ul>
    321. 

  321. </li>
    322. 

  322. </ul>
    323. 

  323. </li>
    324. 

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

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

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

  327. <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>
    328. 

  328. <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>
    329. 

  329. </ul>
    330. 

  330. </li>
    331. 

  331. </ul>
    332. 

  332. </li>
    333. 

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

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

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

  336. <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>
    337. 

  337. <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>
    338. 

  338. </ul>
    339. 

  339. </li>
    340. 

  340. </ul>
    341. 

  341. </li>
    342. 

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

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

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

  345. <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>
    346. 

  346. <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>
    347. 

  347. </ul>
    348. 

  348. </li>
    349. 

  349. </ul>
    350. 

  350. </li>
    351. 

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

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

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

  354. <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>
    355. 

  355. <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>
    356. 

  356. </ul>
    357. 

  357. </li>
    358. 

  358. </ul>
    359. 

  359. </li>
    360. 

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

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

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

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

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

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

  366. </ul>
    367. 

  367. </li>
    368. 

  368. </ul>
    369. 

  369. </li>
    370. 

  370. </ul>
    371. 

  371. </div>
    372. 

  372. <div class="toctree-wrapper compound">
    373. 

  373. </div>
    374. 

  374. <div class="toctree-wrapper compound">
    375. 

  375. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    376. 

  376. <ul>
    377. 

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

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

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

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

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

  382. </ul>
    383. 

  383. </li>
    384. 

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

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

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

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

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

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

  390. </ul>
    391. 

  391. </li>
    392. 

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

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

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

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

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

  397. </ul>
    398. 

  398. </li>
    399. 

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

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

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

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

  403. </ul>
    404. 

  404. </li>
    405. 

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

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

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

  408. </ul>
    409. 

  409. </li>
    410. 

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

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

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

  413. </ul>
    414. 

  414. </li>
    415. 

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

  416. </ul>
    417. 

  417. </li>
    418. 

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

  419. <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>
    420. 

  420. <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>
    421. 

  421. <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>
    422. 

  422. <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>
    423. 

  423. <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>
    424. 

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

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

  426. <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>
    427. 

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

  428. </ul>
    429. 

  429. </li>
    430. 

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

  431. </ul>
    432. 

  432. </div>
    433. 

  433. </section>
    434. 

  434. 

  435. 

  436.            </div>
    437. 

  437.           </div>
    438. 

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

  439.         <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>
    440. 

  440.     </div>
    441. 

  441. 

  442.   <hr/>
    443. 

  443. 

  444.   <div role="contentinfo">
    445. 

  445.     <p>&#169; Copyright 2023, smiley.</p>
    446. 

  446.   </div>
    447. 

  447. 

  448.    
    449. 

  449. 

  450. </footer>
    451. 

  451.         </div>
    452. 

  452.       </div>
    453. 

  453.     </section>
    454. 

  454.   </div>
    455. 

  455.   <script>
    456. 

  456.       jQuery(function () {
    457. 

  457.           SphinxRtdTheme.Navigation.enable(true);
    458. 

  458.       });
    459. 

  459.   </script> 
    460. 

  460. 

  461. </body>
    462. 

  462. </html>
    463.