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

Usage-Quickstart.html 24 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362 
  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>Quickstart &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="Advanced usage" href="Usage-Advanced-usage.html" />
    24. 

  24.     <link rel="prev" title="Installation" href="Usage-Installation.html" /> 
    25. 

  25. </head>
    26. 

  26. 

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

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

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

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

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

  32. 

  33.           
    34. 

  34.           
    35. 

  35.           <a href="index.html" class="icon icon-home">
    36. 

  36.             PHP-QRCode
    37. 

  37.           </a>
    38. 

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

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

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

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

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

  43.   </form>
    44. 

  44. </div>
    45. 

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

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

  47. <ul class="current">
    48. 

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

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

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

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

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

  53. </ul>
    54. 

  54. </li>
    55. 

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

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

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

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

  59. </ul>
    60. 

  60. </li>
    61. 

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

  62. </ul>
    63. 

  63. </li>
    64. 

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

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

  66. </ul>
    67. 

  67. </li>
    68. 

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

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

  70. </ul>
    71. 

  71. </li>
    72. 

  72. <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
    73. 

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

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

  75. <li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a></li>
    76. 

  76. </ul>
    77. 

  77. </li>
    78. 

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

  79. <li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
    80. 

  80. </ul>
    81. 

  81. </li>
    82. 

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

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

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

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

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

  87. </ul>
    88. 

  88. </li>
    89. 

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

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

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

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

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

  94. </ul>
    95. 

  95. </li>
    96. 

  96. </ul>
    97. 

  97. </li>
    98. 

  98. </ul>
    99. 

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

  100. <ul>
    101. 

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

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

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

  104. </ul>
    105. 

  105. </li>
    106. 

  106. </ul>
    107. 

  107. </li>
    108. 

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

  109. <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>
    110. 

  110. <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>
    111. 

  111. </ul>
    112. 

  112. </li>
    113. 

  113. </ul>
    114. 

  114. </li>
    115. 

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

  116. <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>
    117. 

  117. <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>
    118. 

  118. </ul>
    119. 

  119. </li>
    120. 

  120. </ul>
    121. 

  121. </li>
    122. 

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

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

  124. <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>
    125. 

  125. </ul>
    126. 

  126. </li>
    127. 

  127. </ul>
    128. 

  128. </li>
    129. 

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

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

  131. <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>
    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-QRMarkupSVG.html">QRMarkupSVG</a><ul>
    137. 

  137. <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>
    138. 

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

  139. </ul>
    140. 

  140. </li>
    141. 

  141. </ul>
    142. 

  142. </li>
    143. 

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

  144. <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>
    145. 

  145. <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>
    146. 

  146. </ul>
    147. 

  147. </li>
    148. 

  148. </ul>
    149. 

  149. </li>
    150. 

  150. </ul>
    151. 

  151. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
    152. 

  152. <ul>
    153. 

  153. <li class="toctree-l1"><a class="reference internal" href="API-QRCode.html">QRCode</a><ul>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
    155. 

  155. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. <li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
    159. 

  159. <li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
    160. 

  160. </ul>
    161. 

  161. </li>
    162. 

  162. </ul>
    163. 

  163. </li>
    164. 

  164. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</a><ul>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
    167. 

  167. </ul>
    168. 

  168. </li>
    169. 

  169. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
    170. 

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

  171. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
    172. 

  172. </ul>
    173. 

  173. </li>
    174. 

  174. <li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html">QRMatrix</a><ul>
    175. 

  175. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
    176. 

  176. <li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
    177. 

  177. </ul>
    178. 

  178. </li>
    179. 

  179. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
    180. 

  180. </ul>
    181. 

  181. </li>
    182. 

  182. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
    185. 

  185. </ul>
    186. 

  186. </li>
    187. 

  187. </ul>
    188. 

  188. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    189. 

  189. <ul>
    190. 

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

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

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

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

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

  195. </ul>
    196. 

  196. </li>
    197. 

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

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

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

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

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

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

  203. </ul>
    204. 

  204. </li>
    205. 

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

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

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

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

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

  210. </ul>
    211. 

  211. </li>
    212. 

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

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

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

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

  216. </ul>
    217. 

  217. </li>
    218. 

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

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

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

  221. </ul>
    222. 

  222. </li>
    223. 

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

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

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

  226. </ul>
    227. 

  227. </li>
    228. 

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

  229. </ul>
    230. 

  230. </li>
    231. 

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

  232. <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>
    233. 

  233. <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>
    234. 

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

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

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

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

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

  239. <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>
    240. 

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

  241. </ul>
    242. 

  242. </li>
    243. 

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

  244. </ul>
    245. 

  245. 

  246.         </div>
    247. 

  247.       </div>
    248. 

  248.     </nav>
    249. 

  249. 

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

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

  252.           <a href="index.html">PHP-QRCode</a>
    253. 

  253.       </nav>
    254. 

  254. 

  255.       <div class="wy-nav-content">
    256. 

  256.         <div class="rst-content">
    257. 

  257.           <div role="navigation" aria-label="Page navigation">
    258. 

  258.   <ul class="wy-breadcrumbs">
    259. 

  259.       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
    260. 

  260.       <li class="breadcrumb-item active">Quickstart</li>
    261. 

  261.       <li class="wy-breadcrumbs-aside">
    262. 

  262.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Usage-Quickstart.md" class="fa fa-github"> Edit on GitHub</a>
    263. 

  263.       </li>
    264. 

  264.   </ul>
    265. 

  265.   <hr/>
    266. 

  266. </div>
    267. 

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

  268.            <div itemprop="articleBody">
    269. 

  269.              
    270. 

  270.   <section id="quickstart">
    271. 

  271. <h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h1>
    272. 

  272. <section id="import-the-library">
    273. 

  273. <h2>Import the library<a class="headerlink" href="#import-the-library" title="Link to this heading"></a></h2>
    274. 

  274. <p>Import the main class(es) and include the autoloader (if necessary):</p>
    275. 

  275. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">use</span> <span class="nx">chillerlan\QRCode\</span><span class="p">{</span><span class="nx">QRCode</span><span class="p">,</span> <span class="nx">QROptions</span><span class="p">};</span>
    276. 

  276. 

  277. <span class="k">require_once</span> <span class="no">__DIR__</span><span class="o">.</span><span class="s1">&#39;/../vendor/autoload.php&#39;</span><span class="p">;</span>
    278. 

  278. </pre></div>
    279. 

  279. </div>
    280. 

  280. </section>
    281. 

  281. <section id="create-your-first-qr-code">
    282. 

  282. <h2>Create your first QR Code<a class="headerlink" href="#create-your-first-qr-code" title="Link to this heading"></a></h2>
    283. 

  283. <p>We want to encode this URI for a mobile authenticator into a QRcode image:</p>
    284. 

  284. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span>   <span class="o">=</span> <span class="s1">&#39;otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&amp;issuer=chillerlan.net&#39;</span><span class="p">;</span>
    285. 

  285. <span class="nv">$qrcode</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRCode</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    286. 

  286. 

  287. <span class="nb">printf</span><span class="p">(</span><span class="s1">&#39;&lt;img src=&quot;%s&quot; alt=&quot;QR Code&quot; /&gt;&#39;</span><span class="p">,</span> <span class="nv">$qrcode</span><span class="p">);</span>
    288. 

  288. </pre></div>
    289. 

  289. </div>
    290. 

  290. <section id="configuration">
    291. 

  291. <h3>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h3>
    292. 

  292. <p>Configuration using <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>:</p>
    293. 

  293. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">;</span>
    294. 

  294. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">version</span>     <span class="o">=</span> <span class="mi">7</span><span class="p">;</span>
    295. 

  295. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">imageBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span> <span class="c1">// output raw image instead of base64 data URI</span>
    296. 

  296. 

  297. <span class="nb">header</span><span class="p">(</span><span class="s1">&#39;Content-type: image/svg+xml&#39;</span><span class="p">);</span> <span class="c1">// the image type is SVG by default</span>
    298. 

  298. 

  299. <span class="k">echo</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRCode</span><span class="p">(</span><span class="nv">$options</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    300. 

  300. </pre></div>
    301. 

  301. </div>
    302. 

  302. <p>See <a class="reference internal" href="Usage-Advanced-usage.html"><span class="std std-doc">Advanced usage</span></a> for a more in-depth usage guide.
    303. 

  303. Also, have a look <a class="reference external" href="https://github.com/chillerlan/php-qrcode/tree/main/examples">in the examples folder</a> for some more usage examples.</p>
    304. 

  304. </section>
    305. 

  305. </section>
    306. 

  306. <section id="reading-qr-codes">
    307. 

  307. <h2>Reading QR Codes<a class="headerlink" href="#reading-qr-codes" title="Link to this heading"></a></h2>
    308. 

  308. <p>Using the built-in QR Code reader is pretty straight-forward:</p>
    309. 

  309. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">try</span><span class="p">{</span>
    310. 

  310. 	<span class="nv">$result</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRCode</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">readFromFile</span><span class="p">(</span><span class="s1">&#39;path/to/file.png&#39;</span><span class="p">);</span> <span class="c1">// -&gt; DecoderResult</span>
    311. 

  311. <span class="p">}</span>
    312. 

  312. <span class="k">catch</span><span class="p">(</span><span class="nx">Throwable</span> <span class="nv">$exception</span><span class="p">){</span>
    313. 

  313. 	<span class="c1">// handle exception...</span>
    314. 

  314. 	<span class="c1">// throw ...</span>
    315. 

  315. <span class="p">}</span>
    316. 

  316. 

  317. <span class="c1">// you can now use the result instance...</span>
    318. 

  318. <span class="nv">$content</span> <span class="o">=</span> <span class="nv">$result</span><span class="o">-&gt;</span><span class="na">data</span><span class="p">;</span>
    319. 

  319. 

  320. <span class="c1">// ...or simply cast the result instance to string to get the content</span>
    321. 

  321. <span class="nv">$content</span> <span class="o">=</span> <span class="p">(</span><span class="nx">string</span><span class="p">)</span><span class="nv">$result</span><span class="p">;</span>
    322. 

  322. </pre></div>
    323. 

  323. </div>
    324. 

  324. <p>It’s generally a good idea to wrap the reading in a try/catch block to handle any errors that may occur in the process.</p>
    325. 

  325. </section>
    326. 

  326. <section id="notes">
    327. 

  327. <h2>Notes<a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
    328. 

  328. <p>The QR encoder, especially the subroutines for mask pattern testing, can cause high CPU load on increased matrix size.
    329. 

  329. You can avoid a part of this load by choosing a fast output module, like SVG.
    330. 

  330. Oh hey and don’t forget to sanitize any user input!</p>
    331. 

  331. </section>
    332. 

  332. </section>
    333. 

  333. 

  334. 

  335.            </div>
    336. 

  336.           </div>
    337. 

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

  338.         <a href="Usage-Installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    339. 

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

  340.     </div>
    341. 

  341. 

  342.   <hr/>
    343. 

  343. 

  344.   <div role="contentinfo">
    345. 

  345.     <p>&#169; Copyright 2023, smiley.</p>
    346. 

  346.   </div>
    347. 

  347. 

  348.    
    349. 

  349. 

  350. </footer>
    351. 

  351.         </div>
    352. 

  352.       </div>
    353. 

  353.     </section>
    354. 

  354.   </div>
    355. 

  355.   <script>
    356. 

  356.       jQuery(function () {
    357. 

  357.           SphinxRtdTheme.Navigation.enable(true);
    358. 

  358.       });
    359. 

  359.   </script> 
    360. 

  360. 

  361. </body>
    362. 

  362. </html>
    363.