Usage-Quickstart.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  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>Quickstart &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="Advanced usage" href="Usage-Advanced-usage.html" />
  22. <link rel="prev" title="Installation" href="Usage-Installation.html" />
  23. </head>
  24. <body class="wy-body-for-nav">
  25. <div class="wy-grid-for-nav">
  26. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  27. <div class="wy-side-scroll">
  28. <div class="wy-side-nav-search" >
  29. <a href="index.html" class="icon icon-home">
  30. PHP-QRCode
  31. </a>
  32. <div role="search">
  33. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  35. <input type="hidden" name="check_keywords" value="yes" />
  36. <input type="hidden" name="area" value="default" />
  37. </form>
  38. </div>
  39. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  40. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  41. <ul class="current">
  42. <li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
  43. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
  47. </ul>
  48. </li>
  49. <li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
  50. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
  51. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a><ul>
  52. <li class="toctree-l4"><a class="reference internal" href="Usage-Installation.html#version-switch">Version switch</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
  59. <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>
  60. </ul>
  61. </li>
  62. <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>
  63. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
  64. </ul>
  65. </li>
  66. <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
  67. <li class="toctree-l2"><a class="reference internal" href="#import-the-library">Import the library</a></li>
  68. <li class="toctree-l2"><a class="reference internal" href="#create-your-first-qr-code">Create your first QR Code</a><ul>
  69. <li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a></li>
  70. </ul>
  71. </li>
  72. <li class="toctree-l2"><a class="reference internal" href="#reading-qr-codes">Reading QR Codes</a></li>
  73. <li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
  74. </ul>
  75. </li>
  76. <li class="toctree-l1"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
  77. <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>
  78. <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>
  79. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
  80. <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>
  81. </ul>
  82. </li>
  83. <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>
  84. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
  85. <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>
  86. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  87. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  88. </ul>
  89. </li>
  90. </ul>
  91. </li>
  92. </ul>
  93. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
  94. <ul>
  95. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
  96. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#example">Example</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
  98. <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>
  99. <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>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  105. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#example">Example</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
  107. <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>
  108. <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>
  109. </ul>
  110. </li>
  111. </ul>
  112. </li>
  113. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  114. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#example">Example</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
  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. <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. </ul>
  119. </li>
  120. </ul>
  121. </li>
  122. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  123. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#example">Example</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
  125. <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>
  126. <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>
  127. </ul>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  132. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#example">Example</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  134. <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>
  135. <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>
  136. </ul>
  137. </li>
  138. </ul>
  139. </li>
  140. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  141. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#example">Example</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  143. <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>
  144. <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>
  145. </ul>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  150. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#plain-text">Plain text</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
  153. <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>
  154. <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>
  155. </ul>
  156. </li>
  157. </ul>
  158. </li>
  159. </ul>
  160. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  161. <ul>
  162. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  163. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  164. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  165. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  166. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  167. </ul>
  168. </li>
  169. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  170. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  171. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  172. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  173. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  174. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  175. </ul>
  176. </li>
  177. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  178. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  179. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  180. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  181. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  182. </ul>
  183. </li>
  184. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  185. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  186. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  187. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  188. </ul>
  189. </li>
  190. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  191. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  192. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  193. </ul>
  194. </li>
  195. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  196. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  197. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  198. </ul>
  199. </li>
  200. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  201. </ul>
  202. </li>
  203. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  204. <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>
  205. <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>
  206. <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>
  207. <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>
  208. <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>
  209. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  210. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  211. <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>
  212. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  213. </ul>
  214. </li>
  215. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  216. </ul>
  217. </div>
  218. </div>
  219. </nav>
  220. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  221. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  222. <a href="index.html">PHP-QRCode</a>
  223. </nav>
  224. <div class="wy-nav-content">
  225. <div class="rst-content">
  226. <div role="navigation" aria-label="Page navigation">
  227. <ul class="wy-breadcrumbs">
  228. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  229. <li class="breadcrumb-item active">Quickstart</li>
  230. <li class="wy-breadcrumbs-aside">
  231. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Usage-Quickstart.md" class="fa fa-github"> Edit on GitHub</a>
  232. </li>
  233. </ul>
  234. <hr/>
  235. </div>
  236. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  237. <div itemprop="articleBody">
  238. <section id="quickstart">
  239. <h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h1>
  240. <section id="import-the-library">
  241. <h2>Import the library<a class="headerlink" href="#import-the-library" title="Link to this heading"></a></h2>
  242. <p>Import the main class(es) and include the autoloader (if necessary):</p>
  243. <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>
  244. <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>
  245. </pre></div>
  246. </div>
  247. </section>
  248. <section id="create-your-first-qr-code">
  249. <h2>Create your first QR Code<a class="headerlink" href="#create-your-first-qr-code" title="Link to this heading"></a></h2>
  250. <p>We want to encode this URI for a mobile authenticator into a QRcode image:</p>
  251. <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>
  252. <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>
  253. <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>
  254. </pre></div>
  255. </div>
  256. <section id="configuration">
  257. <h3>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h3>
  258. <p>Configuration using <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>:</p>
  259. <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>
  260. <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>
  261. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">outputBase64</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>
  262. <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>
  263. <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>
  264. </pre></div>
  265. </div>
  266. <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.
  267. 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>
  268. </section>
  269. </section>
  270. <section id="reading-qr-codes">
  271. <h2>Reading QR Codes<a class="headerlink" href="#reading-qr-codes" title="Link to this heading"></a></h2>
  272. <p>Using the built-in QR Code reader is pretty straight-forward:</p>
  273. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">try</span><span class="p">{</span>
  274. <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>
  275. <span class="p">}</span>
  276. <span class="k">catch</span><span class="p">(</span><span class="nx">Throwable</span> <span class="nv">$exception</span><span class="p">){</span>
  277. <span class="c1">// handle exception...</span>
  278. <span class="c1">// throw ...</span>
  279. <span class="p">}</span>
  280. <span class="c1">// you can now use the result instance...</span>
  281. <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>
  282. <span class="c1">// ...or simply cast the result instance to string to get the content</span>
  283. <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>
  284. </pre></div>
  285. </div>
  286. <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>
  287. </section>
  288. <section id="notes">
  289. <h2>Notes<a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
  290. <p>The QR encoder, especially the subroutines for mask pattern testing, can cause high CPU load on increased matrix size.
  291. You can avoid a part of this load by choosing a fast output module, like SVG.
  292. Oh hey and don’t forget to sanitize any user input!</p>
  293. </section>
  294. </section>
  295. </div>
  296. </div>
  297. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  298. <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>
  299. <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>
  300. </div>
  301. <hr/>
  302. <div role="contentinfo">
  303. <p>&#169; Copyright 2023, smiley.</p>
  304. </div>
  305. </footer>
  306. </div>
  307. </div>
  308. </section>
  309. </div>
  310. <script>
  311. jQuery(function () {
  312. SphinxRtdTheme.Navigation.enable(true);
  313. });
  314. </script>
  315. </body>
  316. </html>