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

Advanced-usage.html 56 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614 
  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>Advanced usage &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="Configuration settings" href="Configuration-settings.html" />
    24. 

  24.     <link rel="prev" title="Quickstart" href="Quickstart.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="Overview.html">Overview</a><ul>
    49. 

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

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

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

  52. <li class="toctree-l2"><a class="reference internal" href="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="Installation.html">Installation</a><ul>
    56. 

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

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

  58. <li class="toctree-l4"><a class="reference internal" href="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="Installation.html#terminal">Terminal</a></li>
    62. 

  62. </ul>
    63. 

  63. </li>
    64. 

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

  65. <li class="toctree-l3"><a class="reference internal" href="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="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="Installation.html#imagemagick">ImageMagick</a></li>
    70. 

  70. </ul>
    71. 

  71. </li>
    72. 

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

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

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

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

  76. </ul>
    77. 

  77. </li>
    78. 

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

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

  80. </ul>
    81. 

  81. </li>
    82. 

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

  83. <li class="toctree-l2"><a class="reference internal" href="#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="#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="#load-and-save-options-from-to-json">Load and save options from/to JSON</a></li>
    86. 

  86. <li class="toctree-l3"><a class="reference internal" href="#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="#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="#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="#mixed-mode">Mixed mode</a></li>
    92. 

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

  93. </ul>
    94. 

  94. </li>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="#common-output-options">Common output options</a><ul>
    96. 

  96. <li class="toctree-l3"><a class="reference internal" href="#save-to-file">Save to file</a></li>
    97. 

  97. <li class="toctree-l3"><a class="reference internal" href="#base64-uri-output">Base64 URI output</a></li>
    98. 

  98. <li class="toctree-l3"><a class="reference internal" href="#return-the-image-resource">Return the image resource</a></li>
    99. 

  99. <li class="toctree-l3"><a class="reference internal" href="#add-a-logo-space">Add a logo space</a></li>
    100. 

  100. </ul>
    101. 

  101. </li>
    102. 

  102. </ul>
    103. 

  103. </li>
    104. 

  104. <li class="toctree-l1"><a class="reference internal" href="Configuration-settings.html">Configuration settings</a><ul>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#version">version</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#versionmin">versionMin</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#versionmax">versionMax</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#ecclevel">eccLevel</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#maskpattern">maskPattern</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#addquietzone">addQuietzone</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#quietzonesize">quietzoneSize</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#outputtype">outputType</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#outputinterface">outputInterface</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#returnresource">returnResource</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#cachefile">cachefile</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#outputbase64">outputBase64</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#eol">eol</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#bgcolor">bgColor</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#invertmatrix">invertMatrix</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#drawlightmodules">drawLightModules</a></li>
    121. 

  121. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#drawcircularmodules">drawCircularModules</a></li>
    122. 

  122. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#circleradius">circleRadius</a></li>
    123. 

  123. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#keepassquare">keepAsSquare</a></li>
    124. 

  124. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#connectpaths">connectPaths</a></li>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#excludefromconnect">excludeFromConnect</a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#modulevalues">moduleValues</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#addlogospace">addLogoSpace</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#logospacewidth">logoSpaceWidth</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#logospaceheight">logoSpaceHeight</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#logospacestartx">logoSpaceStartX</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#logospacestarty">logoSpaceStartY</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#scale">scale</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#imagetransparent">imageTransparent</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#transparencycolor">transparencyColor</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#quality">quality</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#imagickformat">imagickFormat</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#cssclass">cssClass</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#svgaddxmlheader">svgAddXmlHeader</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#svgdefs">svgDefs</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#svgpreserveaspectratio">svgPreserveAspectRatio</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#svgusefillattributes">svgUseFillAttributes</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#textlinestart">textLineStart</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#jsonasbooleans">jsonAsBooleans</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#fpdfmeasureunit">fpdfMeasureUnit</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#readeruseimagickifavailable">readerUseImagickIfAvailable</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#readergrayscale">readerGrayscale</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="Configuration-settings.html#readerincreasecontrast">readerIncreaseContrast</a></li>
    148. 

  148. </ul>
    149. 

  149. </li>
    150. 

  150. </ul>
    151. 

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

  152. <ul>
    153. 

  153. <li class="toctree-l1"><a class="reference internal" href="../Customizing/Module-Values.html">Module values</a><ul>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#basics">Basics</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#assigning-values">Assigning values</a></li>
    156. 

  156. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Module-Values.html#handling-in-your-own-qroutputinterface">Handling in your own <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
    157. 

  157. <li class="toctree-l3"><a class="reference internal" href="../Customizing/Module-Values.html#setting-module-values">Setting module values</a></li>
    158. 

  158. <li class="toctree-l3"><a class="reference internal" href="../Customizing/Module-Values.html#using-the-module-values">Using the module values</a></li>
    159. 

  159. </ul>
    160. 

  160. </li>
    161. 

  161. </ul>
    162. 

  162. </li>
    163. 

  163. <li class="toctree-l1"><a class="reference internal" href="../Customizing/QROutputAbstract.html"><code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code></a><ul>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../Customizing/QROutputAbstract.html#properties">Properties</a><ul>
    165. 

  165. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#options-and-matrix"><code class="docutils literal notranslate"><span class="pre">$options</span></code> and <code class="docutils literal notranslate"><span class="pre">$matrix</span></code></a></li>
    166. 

  166. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulecount-scale-and-length"><code class="docutils literal notranslate"><span class="pre">$moduleCount</span></code>, <code class="docutils literal notranslate"><span class="pre">$scale</span></code> and <code class="docutils literal notranslate"><span class="pre">$length</span></code></a></li>
    167. 

  167. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulevalues"><code class="docutils literal notranslate"><span class="pre">$moduleValues</span></code></a></li>
    168. 

  168. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#copies-of-qroptions-values">Copies of <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> values</a></li>
    169. 

  169. </ul>
    170. 

  170. </li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="../Customizing/QROutputAbstract.html#methods">Methods</a><ul>
    172. 

  172. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#setmodulevalues"><code class="docutils literal notranslate"><span class="pre">setModuleValues()</span></code></a></li>
    173. 

  173. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#modulevalueisvalid"><code class="docutils literal notranslate"><span class="pre">moduleValueIsValid()</span></code></a></li>
    174. 

  174. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#preparemodulevalue"><code class="docutils literal notranslate"><span class="pre">prepareModuleValue()</span></code></a></li>
    175. 

  175. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getdefaultmodulevalue"><code class="docutils literal notranslate"><span class="pre">getDefaultModuleValue()</span></code></a></li>
    176. 

  176. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getmodulevalue-and-getmodulevalueat"><code class="docutils literal notranslate"><span class="pre">getModuleValue()</span></code> and <code class="docutils literal notranslate"><span class="pre">getModuleValueAt()</span></code></a></li>
    177. 

  177. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#setmatrixdimensions"><code class="docutils literal notranslate"><span class="pre">setMatrixDimensions()</span></code></a></li>
    178. 

  178. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#getoutputdimensions"><code class="docutils literal notranslate"><span class="pre">getOutputDimensions()</span></code></a></li>
    179. 

  179. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#collectmodules"><code class="docutils literal notranslate"><span class="pre">collectModules()</span></code></a></li>
    180. 

  180. <li class="toctree-l3"><a class="reference internal" href="../Customizing/QROutputAbstract.html#savetofile-and-tobase64datauri"><code class="docutils literal notranslate"><span class="pre">saveToFile()</span></code> and <code class="docutils literal notranslate"><span class="pre">toBase64DataURI()</span></code></a></li>
    181. 

  181. </ul>
    182. 

  182. </li>
    183. 

  183. </ul>
    184. 

  184. </li>
    185. 

  185. </ul>
    186. 

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

  187. <ul>
    188. 

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

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

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

  191. <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>
    192. 

  192. <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>
    193. 

  193. </ul>
    194. 

  194. </li>
    195. 

  195. </ul>
    196. 

  196. </li>
    197. 

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

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

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

  200. <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>
    201. 

  201. <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>
    202. 

  202. </ul>
    203. 

  203. </li>
    204. 

  204. </ul>
    205. 

  205. </li>
    206. 

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

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

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

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

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

  211. </ul>
    212. 

  212. </li>
    213. 

  213. </ul>
    214. 

  214. </li>
    215. 

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

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

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

  218. <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>
    219. 

  219. <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>
    220. 

  220. </ul>
    221. 

  221. </li>
    222. 

  222. </ul>
    223. 

  223. </li>
    224. 

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

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

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

  227. <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>
    228. 

  228. <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>
    229. 

  229. </ul>
    230. 

  230. </li>
    231. 

  231. </ul>
    232. 

  232. </li>
    233. 

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

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

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

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

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

  238. </ul>
    239. 

  239. </li>
    240. 

  240. </ul>
    241. 

  241. </li>
    242. 

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

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

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

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

  246. <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>
    247. 

  247. <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>
    248. 

  248. </ul>
    249. 

  249. </li>
    250. 

  250. </ul>
    251. 

  251. </li>
    252. 

  252. </ul>
    253. 

  253. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    254. 

  254. <ul>
    255. 

  255. <li class="toctree-l1"><a class="reference internal" href="../Appendix/Contribute.html">How to contribute</a><ul>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#questions-and-issues">Questions and issues</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#bug-reports">Bug reports</a></li>
    258. 

  258. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#pull-requests-and-bug-fixes">Pull requests and bug fixes</a></li>
    259. 

  259. <li class="toctree-l2"><a class="reference internal" href="../Appendix/Contribute.html#documentation">Documentation</a></li>
    260. 

  260. </ul>
    261. 

  261. </li>
    262. 

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

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

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

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

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

  267. </ul>
    268. 

  268. </li>
    269. 

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

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

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

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

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

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

  275. </ul>
    276. 

  276. </li>
    277. 

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

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

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

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

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

  282. </ul>
    283. 

  283. </li>
    284. 

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

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

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

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

  288. </ul>
    289. 

  289. </li>
    290. 

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

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

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

  293. </ul>
    294. 

  294. </li>
    295. 

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

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

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

  298. </ul>
    299. 

  299. </li>
    300. 

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

  301. </ul>
    302. 

  302. </li>
    303. 

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

  304. <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>
    305. 

  305. <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>
    306. 

  306. <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>
    307. 

  307. <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>
    308. 

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

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

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

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

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

  313. </ul>
    314. 

  314. </li>
    315. 

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

  316. </ul>
    317. 

  317. 

  318.         </div>
    319. 

  319.       </div>
    320. 

  320.     </nav>
    321. 

  321. 

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

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

  324.           <a href="../index.html">PHP-QRCode</a>
    325. 

  325.       </nav>
    326. 

  326. 

  327.       <div class="wy-nav-content">
    328. 

  328.         <div class="rst-content">
    329. 

  329.           <div role="navigation" aria-label="Page navigation">
    330. 

  330.   <ul class="wy-breadcrumbs">
    331. 

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

  332.       <li class="breadcrumb-item active">Advanced usage</li>
    333. 

  333.       <li class="wy-breadcrumbs-aside">
    334. 

  334.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Usage/Advanced-usage.md" class="fa fa-github"> Edit on GitHub</a>
    335. 

  335.       </li>
    336. 

  336.   </ul>
    337. 

  337.   <hr/>
    338. 

  338. </div>
    339. 

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

  340.            <div itemprop="articleBody">
    341. 

  341.              
    342. 

  342.   <section id="advanced-usage">
    343. 

  343. <h1>Advanced usage<a class="headerlink" href="#advanced-usage" title="Link to this heading"></a></h1>
    344. 

  344. <section id="configuration-via-qroptions">
    345. 

  345. <h2>Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code><a class="headerlink" href="#configuration-via-qroptions" title="Link to this heading"></a></h2>
    346. 

  346. <p>The <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/QROptions.php"><code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a> class is a container based on <a class="reference external" href="https://github.com/chillerlan/php-settings-container">chillerlan/php-settings-container</a> that behaves similar to a <a class="reference external" href="https://www.php.net/manual/class.stdclass"><code class="docutils literal notranslate"><span class="pre">\stdClass</span></code></a> object, but with fixed properties.
    347. 

  347. A list with all available <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> can be found under <a class="reference internal" href="Configuration-settings.html"><span class="std std-doc">configuration settings</span></a>.</p>
    348. 

  348. <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>
    349. 

  349. 

  350. <span class="c1">// set some values</span>
    351. 

  351. <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>     <span class="c1">// property &quot;version&quot; exists</span>
    352. 

  352. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">foo</span>     <span class="o">=</span> <span class="s1">&#39;bar&#39;</span><span class="p">;</span> <span class="c1">// property &quot;foo&quot; does not exist (and will not be created)</span>
    353. 

  353. 

  354. <span class="c1">// retrieve values</span>
    355. 

  355. <span class="nb">var_dump</span><span class="p">(</span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">version</span><span class="p">);</span> <span class="c1">// -&gt; 7</span>
    356. 

  356. <span class="nb">var_dump</span><span class="p">(</span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">foo</span><span class="p">);</span>     <span class="c1">// -&gt; null (no error will be thrown)</span>
    357. 

  357. </pre></div>
    358. 

  358. </div>
    359. 

  359. <section id="supply-an-iterable-of-options">
    360. 

  360. <h3>Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options<a class="headerlink" href="#supply-an-iterable-of-options" title="Link to this heading"></a></h3>
    361. 

  361. <p>The constructor takes an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of <code class="docutils literal notranslate"><span class="pre">$key</span> <span class="pre">=&gt;</span> <span class="pre">$value</span></code> pairs. For each setting an optional setter will be called if present.</p>
    362. 

  362. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$myOptions</span> <span class="o">=</span> <span class="p">[</span>
    363. 

  363. 	<span class="s1">&#39;version&#39;</span>    <span class="o">=&gt;</span> <span class="mi">5</span><span class="p">,</span>
    364. 

  364. 	<span class="s1">&#39;outputType&#39;</span> <span class="o">=&gt;</span> <span class="nx">QROutputInterface</span><span class="o">::</span><span class="na">GDIMAGE_PNG</span><span class="p">,</span>
    365. 

  365. 	<span class="s1">&#39;eccLevel&#39;</span>   <span class="o">=&gt;</span> <span class="nx">EccLevel</span><span class="o">::</span><span class="na">M</span><span class="p">,</span>
    366. 

  366. <span class="p">];</span>
    367. 

  367. 

  368. <span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">);</span>
    369. 

  369. </pre></div>
    370. 

  370. </div>
    371. 

  371. <p>You can also set an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options on an existing QROptions instance:</p>
    372. 

  372. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">fromIterable</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">);</span>
    373. 

  373. </pre></div>
    374. 

  374. </div>
    375. 

  375. </section>
    376. 

  376. <section id="load-and-save-options-from-to-json">
    377. 

  377. <h3>Load and save options from/to JSON<a class="headerlink" href="#load-and-save-options-from-to-json" title="Link to this heading"></a></h3>
    378. 

  378. <p>The settings can be saved to and loaded from JSON, e.g. to store them in a database:</p>
    379. 

  379. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$json</span> <span class="o">=</span> <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">toJSON</span><span class="p">(</span><span class="nx">JSON_THROW_ON_ERROR</span><span class="p">);</span>
    380. 

  380. <span class="c1">// via JsonSerializable interface</span>
    381. 

  381. <span class="nv">$json</span> <span class="o">=</span> <span class="nb">json_encode</span><span class="p">(</span><span class="nv">$options</span><span class="p">,</span> <span class="nx">JSON_THROW_ON_ERROR</span><span class="p">);</span>
    382. 

  382. <span class="c1">// via __toString()</span>
    383. 

  383. <span class="nv">$json</span> <span class="o">=</span> <span class="p">(</span><span class="nx">string</span><span class="p">)</span><span class="nv">$options</span><span class="p">;</span>
    384. 

  384. 

  385. <span class="nv">$options</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QROptions</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">fromJSON</span><span class="p">(</span><span class="nv">$json</span><span class="p">);</span>
    386. 

  386. <span class="c1">// on an existing instance - properties will be overwriten</span>
    387. 

  387. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">fromJSON</span><span class="p">(</span><span class="nv">$json</span><span class="p">);</span>
    388. 

  388. </pre></div>
    389. 

  389. </div>
    390. 

  390. </section>
    391. 

  391. <section id="extending-the-qroptions-class">
    392. 

  392. <h3>Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class<a class="headerlink" href="#extending-the-qroptions-class" title="Link to this heading"></a></h3>
    393. 

  393. <p>In case you need additional settings for your output module, just extend <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>…</p>
    394. 

  394. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyCustomOptions</span> <span class="k">extends</span> <span class="nx">QROptions</span><span class="p">{</span>
    395. 

  395. 	<span class="k">protected</span> <span class="nx">string</span> <span class="nv">$myParam</span> <span class="o">=</span> <span class="s1">&#39;defaultValue&#39;</span><span class="p">;</span>
    396. 

  396. 	<span class="c1">// ...</span>
    397. 

  397. <span class="p">}</span>
    398. 

  398. </pre></div>
    399. 

  399. </div>
    400. 

  400. <p>…or use the <a class="reference external" href="https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php"><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></a>, which is the more flexible approach.</p>
    401. 

  401. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">trait</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">{</span>
    402. 

  402. 	<span class="k">protected</span> <span class="nx">string</span> <span class="nv">$myParam</span> <span class="o">=</span> <span class="s1">&#39;defaultValue&#39;</span><span class="p">;</span>
    403. 

  403. 	<span class="c1">// ...</span>
    404. 

  404. 

  405. 	<span class="c1">// an optional magic setter, named &quot;set_&quot; + property name</span>
    406. 

  406. 	<span class="k">protected</span> <span class="k">function</span> <span class="nf">set_myParam</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$myParam</span><span class="p">)</span><span class="o">:</span><span class="nx">void</span><span class="p">{</span>
    407. 

  407. 		<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">myParam</span> <span class="o">=</span> <span class="nb">trim</span><span class="p">(</span><span class="nv">$myParam</span><span class="p">);</span>
    408. 

  408. 	<span class="p">}</span>
    409. 

  409. 

  410. 	<span class="c1">// an optional magic getter, named &quot;get_&quot; + property name</span>
    411. 

  411. 	<span class="k">protected</span> <span class="k">function</span> <span class="nf">get_myParam</span><span class="p">()</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
    412. 

  412. 		<span class="k">return</span> <span class="nb">strtoupper</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">myParam</span><span class="p">);</span>
    413. 

  413. 	<span class="p">}</span>
    414. 

  414. <span class="p">}</span>
    415. 

  415. 

  416. <span class="k">class</span> <span class="nc">MyCustomOptions</span> <span class="k">extends</span> <span class="nx">SettingsContainerAbstract</span><span class="p">{</span>
    417. 

  417. 	<span class="k">use</span> <span class="nx">QROptionsTrait</span><span class="p">,</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">;</span>
    418. 

  418. <span class="p">}</span>
    419. 

  419. 

  420. <span class="c1">// set the options</span>
    421. 

  421. <span class="nv">$myCustomOptions</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">MyCustomOptions</span><span class="p">;</span>
    422. 

  422. <span class="nv">$myCustomOptions</span><span class="o">-&gt;</span><span class="na">myParam</span> <span class="o">=</span> <span class="s1">&#39;whatever value&#39;</span><span class="p">;</span>
    423. 

  423. </pre></div>
    424. 

  424. </div>
    425. 

  425. <p>Extend the <code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code> on-the-fly:</p>
    426. 

  426. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$myOptions</span> <span class="o">=</span> <span class="p">[</span>
    427. 

  427. 	<span class="s1">&#39;myParam&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;whatever value&#39;</span><span class="p">,</span>
    428. 

  428. 	<span class="c1">// ...</span>
    429. 

  429. <span class="p">];</span>
    430. 

  430. 

  431. <span class="nv">$myCustomOptions</span> <span class="o">=</span> <span class="k">new</span> <span class="k">class</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">)</span> <span class="k">extends</span> <span class="nx">SettingsContainerAbstract</span><span class="p">{</span>
    432. 

  432. 	<span class="k">use</span> <span class="nx">QROptionsTrait</span><span class="p">,</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">;</span>
    433. 

  433. <span class="p">};</span>
    434. 

  434. </pre></div>
    435. 

  435. </div>
    436. 

  436. </section>
    437. 

  437. </section>
    438. 

  438. <section id="qrcode-methods">
    439. 

  439. <h2><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods<a class="headerlink" href="#qrcode-methods" title="Link to this heading"></a></h2>
    440. 

  440. <p>Aside of invoking a <code class="docutils literal notranslate"><span class="pre">QRCode</span></code> instance with an optional <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> object as parameter, you can also set the options instance after invocation.
    441. 

  441. After invocation of the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> instance, values can be set without calling <code class="docutils literal notranslate"><span class="pre">QRCode::setOptions()</span></code> again (instance is backreferenced), however, this may create side effects.</p>
    442. 

  442. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// instance will be invoked with default settings</span>
    443. 

  443. <span class="nv">$qrcode</span>  <span class="o">=</span> <span class="k">new</span> <span class="nx">QRCode</span><span class="p">;</span>
    444. 

  444. 

  445. <span class="c1">// set options after QRCode invocation</span>
    446. 

  446. <span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">;</span>
    447. 

  447. 

  448. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">setOptions</span><span class="p">(</span><span class="nv">$options</span><span class="p">);</span>
    449. 

  449. </pre></div>
    450. 

  450. </div>
    451. 

  451. <section id="render-a-qrmatrix-instance">
    452. 

  452. <h3>Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance<a class="headerlink" href="#render-a-qrmatrix-instance" title="Link to this heading"></a></h3>
    453. 

  453. <p>You can render a <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRMatrix.php"><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></a> instance directly:</p>
    454. 

  454. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// a matrix from the current data segments</span>
    455. 

  455. <span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>
    456. 

  456. <span class="c1">// from the QR Code reader</span>
    457. 

  457. <span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$readerResult</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>
    458. 

  458. <span class="c1">// manually invoked</span>
    459. 

  459. <span class="nv">$matrix</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRMatrix</span><span class="p">(</span><span class="k">new</span> <span class="nx">Version</span><span class="p">(</span><span class="mi">7</span><span class="p">),</span> <span class="k">new</span> <span class="nx">EccLevel</span><span class="p">(</span><span class="nx">EccLevel</span><span class="o">::</span><span class="na">M</span><span class="p">)))</span><span class="o">-&gt;</span><span class="na">initFunctionalPatterns</span><span class="p">();</span>
    460. 

  460. 

  461. <span class="nv">$output</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">);</span>
    462. 

  462. <span class="c1">// save to file</span>
    463. 

  463. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">,</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
    464. 

  464. </pre></div>
    465. 

  465. </div>
    466. 

  466. </section>
    467. 

  467. <section id="mixed-mode">
    468. 

  468. <h3>Mixed mode<a class="headerlink" href="#mixed-mode" title="Link to this heading"></a></h3>
    469. 

  469. <p>Mixed mode QR Codes can be generated by adding several data segments:</p>
    470. 

  470. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// make sure to set a proper internal encoding character set</span>
    471. 

  471. <span class="c1">// ideally, this should be set in php.ini internal_encoding,</span>
    472. 

  472. <span class="c1">// default_charset or mbstring.internal_encoding</span>
    473. 

  473. <span class="nb">mb_internal_encoding</span><span class="p">(</span><span class="s1">&#39;UTF-8&#39;</span><span class="p">);</span>
    474. 

  474. 

  475. <span class="c1">// clear any existing data segments</span>
    476. 

  476. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">clearSegments</span><span class="p">();</span>
    477. 

  477. 

  478. <span class="nv">$qrcode</span>
    479. 

  479. 	<span class="o">-&gt;</span><span class="na">addNumericSegment</span><span class="p">(</span><span class="nv">$numericData</span><span class="p">)</span>
    480. 

  480. 	<span class="o">-&gt;</span><span class="na">addAlphaNumSegment</span><span class="p">(</span><span class="nv">$alphaNumData</span><span class="p">)</span>
    481. 

  481. 	<span class="o">-&gt;</span><span class="na">addKanjiSegment</span><span class="p">(</span><span class="nv">$kanjiData</span><span class="p">)</span>
    482. 

  482. 	<span class="o">-&gt;</span><span class="na">addHanziSegment</span><span class="p">(</span><span class="nv">$hanziData</span><span class="p">)</span>
    483. 

  483. 	<span class="o">-&gt;</span><span class="na">addByteSegment</span><span class="p">(</span><span class="nv">$binaryData</span><span class="p">)</span>
    484. 

  484. 	<span class="o">-&gt;</span><span class="na">addEciSegment</span><span class="p">(</span><span class="nx">ECICharset</span><span class="o">::</span><span class="na">GB18030</span><span class="p">,</span> <span class="nv">$encodedEciData</span><span class="p">)</span>
    485. 

  485. <span class="p">;</span>
    486. 

  486. 

  487. <span class="nv">$output</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">();</span>
    488. 

  488. <span class="c1">// render to file</span>
    489. 

  489. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="k">null</span><span class="p">,</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
    490. 

  490. </pre></div>
    491. 

  491. </div>
    492. 

  492. <p>The <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRDataModeInterface.php"><code class="docutils literal notranslate"><span class="pre">QRDataModeInterface</span></code></a> offers the <code class="docutils literal notranslate"><span class="pre">validateString()</span></code> method (implemended for <code class="docutils literal notranslate"><span class="pre">AlphaNum</span></code>, <code class="docutils literal notranslate"><span class="pre">Byte</span></code>, <code class="docutils literal notranslate"><span class="pre">Hanzi</span></code>, <code class="docutils literal notranslate"><span class="pre">Kanji</span></code> and <code class="docutils literal notranslate"><span class="pre">Number</span></code>).
    493. 

  493. This method is used internally when a data mode is invoked, but it can come in handy if you need to check input data beforehand.</p>
    494. 

  494. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">Hanzi</span><span class="o">::</span><span class="na">validateString</span><span class="p">(</span><span class="nv">$data</span><span class="p">)){</span>
    495. 

  495. 	<span class="k">throw</span> <span class="k">new</span> <span class="nx">Exception</span><span class="p">(</span><span class="s1">&#39;invalid GB2312 data&#39;</span><span class="p">);</span>
    496. 

  496. <span class="p">}</span>
    497. 

  497. 

  498. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">addHanziSegment</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    499. 

  499. </pre></div>
    500. 

  500. </div>
    501. 

  501. </section>
    502. 

  502. <section id="qr-code-reader">
    503. 

  503. <h3>QR Code reader<a class="headerlink" href="#qr-code-reader" title="Link to this heading"></a></h3>
    504. 

  504. <p>In some cases it might be necessary to increase the contrast of a QR Code image:</p>
    505. 

  505. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerUseImagickIfAvailable</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
    506. 

  506. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerIncreaseContrast</span>      <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
    507. 

  507. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerGrayscale</span>             <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
    508. 

  508. 

  509. <span class="nv">$qrcode</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QRCode</span><span class="p">(</span><span class="nv">$options</span><span class="p">);</span>
    510. 

  510. 

  511. <span class="nv">$result</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">readFromFile</span><span class="p">(</span><span class="s1">&#39;path/to/qrcode.png&#39;</span><span class="p">);</span>
    512. 

  512. <span class="nv">$result</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">readFromBlob</span><span class="p">(</span><span class="nv">$imagedata</span><span class="p">);</span>
    513. 

  513. </pre></div>
    514. 

  514. </div>
    515. 

  515. <p>The <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> object from the <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Decoder/DecoderResult.php"><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></a> can be reused:</p>
    516. 

  516. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$result</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>
    517. 

  517. 

  518. <span class="c1">// ...matrix modification...</span>
    519. 

  519. 

  520. <span class="nv">$output</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="nv">$options</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">);</span>
    521. 

  521. 

  522. <span class="c1">// ...output</span>
    523. 

  523. </pre></div>
    524. 

  524. </div>
    525. 

  525. </section>
    526. 

  526. </section>
    527. 

  527. <section id="common-output-options">
    528. 

  528. <h2>Common output options<a class="headerlink" href="#common-output-options" title="Link to this heading"></a></h2>
    529. 

  529. <section id="save-to-file">
    530. 

  530. <h3>Save to file<a class="headerlink" href="#save-to-file" title="Link to this heading"></a></h3>
    531. 

  531. <p>You can specify an output file path in which the QR Code content is stored:</p>
    532. 

  532. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><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>
    533. 

  533. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">cachefile</span>    <span class="o">=</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">;</span>
    534. 

  534. 

  535. <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    536. 

  536. 

  537. <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">$options</span><span class="o">-&gt;</span><span class="na">cachefile</span><span class="p">);</span>
    538. 

  538. </pre></div>
    539. 

  539. </div>
    540. 

  540. <p>The file path can also be supplied as second parameter to the render methods (this will override the <code class="docutils literal notranslate"><span class="pre">QROptions::$cachefile</span></code> setting):</p>
    541. 

  541. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">,</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
    542. 

  542. </pre></div>
    543. 

  543. </div>
    544. 

  544. </section>
    545. 

  545. <section id="base64-uri-output">
    546. 

  546. <h3>Base64 URI output<a class="headerlink" href="#base64-uri-output" title="Link to this heading"></a></h3>
    547. 

  547. <p>By default, a <a class="reference external" href="https://en.wikipedia.org/wiki/Data_URI_scheme">Base64 encoded data URI</a> will be returned (where applicable):</p>
    548. 

  548. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span> <span class="c1">// -&gt; data:image/png;base64,...</span>
    549. 

  549. </pre></div>
    550. 

  550. </div>
    551. 

  551. <p>Disable Base64 output:</p>
    552. 

  552. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><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>
    553. 

  553. 

  554. <span class="nb">header</span><span class="p">(</span><span class="s1">&#39;Content-type: image/png&#39;</span><span class="p">);</span>
    555. 

  555. 

  556. <span class="k">echo</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    557. 

  557. </pre></div>
    558. 

  558. </div>
    559. 

  559. </section>
    560. 

  560. <section id="return-the-image-resource">
    561. 

  561. <h3>Return the image resource<a class="headerlink" href="#return-the-image-resource" title="Link to this heading"></a></h3>
    562. 

  562. <p>In some cases you might want to modify the QR image after creation (without crating a custom output class), in which case you want the internal image resource rather than the final output.</p>
    563. 

  563. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">outputType</span>     <span class="o">=</span> <span class="nx">QROutputInterface</span><span class="o">::</span><span class="na">IMAGICK</span><span class="p">;</span>
    564. 

  564. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">returnResource</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
    565. 

  565. 

  566. <span class="sd">/** @var Imagick $imagick */</span>
    567. 

  567. <span class="nv">$imagick</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    568. 

  568. 

  569. <span class="k">echo</span> <span class="nv">$imagick</span><span class="o">-&gt;</span><span class="na">getImageBlob</span><span class="p">();</span>
    570. 

  570. </pre></div>
    571. 

  571. </div>
    572. 

  572. </section>
    573. 

  573. <section id="add-a-logo-space">
    574. 

  574. <h3>Add a logo space<a class="headerlink" href="#add-a-logo-space" title="Link to this heading"></a></h3>
    575. 

  575. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">addLogoSpace</span>    <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
    576. 

  576. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">logoSpaceWidth</span>  <span class="o">=</span> <span class="mi">9</span><span class="p">;</span>
    577. 

  577. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">logoSpaceHeight</span> <span class="o">=</span> <span class="mi">9</span><span class="p">;</span>
    578. 

  578. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">logoSpaceStartX</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
    579. 

  579. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">logoSpaceStartY</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span>
    580. 

  580. </pre></div>
    581. 

  581. </div>
    582. 

  582. </section>
    583. 

  583. </section>
    584. 

  584. </section>
    585. 

  585. 

  586. 

  587.            </div>
    588. 

  588.           </div>
    589. 

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

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

  591.         <a href="Configuration-settings.html" class="btn btn-neutral float-right" title="Configuration settings" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    592. 

  592.     </div>
    593. 

  593. 

  594.   <hr/>
    595. 

  595. 

  596.   <div role="contentinfo">
    597. 

  597.     <p>&#169; Copyright 2023, smiley.</p>
    598. 

  598.   </div>
    599. 

  599. 

  600.    
    601. 

  601. 

  602. </footer>
    603. 

  603.         </div>
    604. 

  604.       </div>
    605. 

  605.     </section>
    606. 

  606.   </div>
    607. 

  607.   <script>
    608. 

  608.       jQuery(function () {
    609. 

  609.           SphinxRtdTheme.Navigation.enable(true);
    610. 

  610.       });
    611. 

  611.   </script> 
    612. 

  612. 

  613. </body>
    614. 

  614. </html>
    615.