Accueil Explorer Aide
Connexion
mrkad
/
php-qrcode
miroir de https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: bfc4bbfa4d
Branches Tags
php-qrcode
/
Built-In-Output-QRMarkupHTML.html

Built-In-Output-QRMarkupHTML.html 30 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473 
  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>QRMarkupHTML &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="QRMarkupSVG" href="Built-In-Output-QRMarkupSVG.html" />
    24. 

  24.     <link rel="prev" title="QRImagick" href="Built-In-Output-QRImagick.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>
    48. 

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

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

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

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

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

  53. </ul>
    54. 

  54. </li>
    55. 

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

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

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

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

  59. </ul>
    60. 

  60. </li>
    61. 

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

  62. </ul>
    63. 

  63. </li>
    64. 

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

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

  66. </ul>
    67. 

  67. </li>
    68. 

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

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

  70. </ul>
    71. 

  71. </li>
    72. 

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

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

  74. <li class="toctree-l2"><a class="reference internal" href="Usage-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="Usage-Quickstart.html#configuration">Configuration</a></li>
    76. 

  76. </ul>
    77. 

  77. </li>
    78. 

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

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

  80. </ul>
    81. 

  81. </li>
    82. 

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

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

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

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

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

  87. </ul>
    88. 

  88. </li>
    89. 

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

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

  91. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
    92. 

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

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

  94. </ul>
    95. 

  95. </li>
    96. 

  96. </ul>
    97. 

  97. </li>
    98. 

  98. </ul>
    99. 

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

  100. <ul class="current">
    101. 

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

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

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

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

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

  106. </ul>
    107. 

  107. </li>
    108. 

  108. </ul>
    109. 

  109. </li>
    110. 

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

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

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

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

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

  115. </ul>
    116. 

  116. </li>
    117. 

  117. </ul>
    118. 

  118. </li>
    119. 

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

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

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

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

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

  124. </ul>
    125. 

  125. </li>
    126. 

  126. </ul>
    127. 

  127. </li>
    128. 

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

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

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

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

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

  133. </ul>
    134. 

  134. </li>
    135. 

  135. </ul>
    136. 

  136. </li>
    137. 

  137. <li class="toctree-l1 current"><a class="current reference internal" href="#">QRMarkupHTML</a><ul>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="#example">Example</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="#additional-methods">Additional methods</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="#options-that-affect-this-module">Options that affect this module</a><ul>
    141. 

  141. <li class="toctree-l3"><a class="reference internal" href="#options-that-have-no-effect">Options that have no effect</a></li>
    142. 

  142. </ul>
    143. 

  143. </li>
    144. 

  144. </ul>
    145. 

  145. </li>
    146. 

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

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

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

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

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

  151. </ul>
    152. 

  152. </li>
    153. 

  153. </ul>
    154. 

  154. </li>
    155. 

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

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

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

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

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

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

  161. </ul>
    162. 

  162. </li>
    163. 

  163. </ul>
    164. 

  164. </li>
    165. 

  165. </ul>
    166. 

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

  167. <ul>
    168. 

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

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

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

  171. </ul>
    172. 

  172. </li>
    173. 

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

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

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. </li>
    179. 

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

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

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

  182. </ul>
    183. 

  183. </li>
    184. 

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

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

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

  187. </ul>
    188. 

  188. </li>
    189. 

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

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

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

  192. </ul>
    193. 

  193. </li>
    194. 

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

  195. </ul>
    196. 

  196. </li>
    197. 

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

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

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

  200. </ul>
    201. 

  201. </li>
    202. 

  202. </ul>
    203. 

  203. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    204. 

  204. <ul>
    205. 

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

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

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

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

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

  210. </ul>
    211. 

  211. </li>
    212. 

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

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

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

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

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

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

  218. </ul>
    219. 

  219. </li>
    220. 

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

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

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

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

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

  225. </ul>
    226. 

  226. </li>
    227. 

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

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

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

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

  231. </ul>
    232. 

  232. </li>
    233. 

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

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

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

  236. </ul>
    237. 

  237. </li>
    238. 

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

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

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

  241. </ul>
    242. 

  242. </li>
    243. 

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

  244. </ul>
    245. 

  245. </li>
    246. 

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

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

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

  249. <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>
    250. 

  250. <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>
    251. 

  251. <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>
    252. 

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

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

  254. <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>
    255. 

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

  256. </ul>
    257. 

  257. </li>
    258. 

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

  259. </ul>
    260. 

  260. 

  261.         </div>
    262. 

  262.       </div>
    263. 

  263.     </nav>
    264. 

  264. 

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

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

  267.           <a href="index.html">PHP-QRCode</a>
    268. 

  268.       </nav>
    269. 

  269. 

  270.       <div class="wy-nav-content">
    271. 

  271.         <div class="rst-content">
    272. 

  272.           <div role="navigation" aria-label="Page navigation">
    273. 

  273.   <ul class="wy-breadcrumbs">
    274. 

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

  275.       <li class="breadcrumb-item active">QRMarkupHTML</li>
    276. 

  276.       <li class="wy-breadcrumbs-aside">
    277. 

  277.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Built-In-Output-QRMarkupHTML.md" class="fa fa-github"> Edit on GitHub</a>
    278. 

  278.       </li>
    279. 

  279.   </ul>
    280. 

  280.   <hr/>
    281. 

  281. </div>
    282. 

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

  283.            <div itemprop="articleBody">
    284. 

  284.              
    285. 

  285.   <section id="qrmarkuphtml">
    286. 

  286. <h1>QRMarkupHTML<a class="headerlink" href="#qrmarkuphtml" title="Link to this heading"></a></h1>
    287. 

  287. <p><a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRMarkupHTML.php">Class <code class="docutils literal notranslate"><span class="pre">QRMarkupHTML</span></code></a>: HTML output</p>
    288. 

  288. <p>This class is a cheap markup substitute for when SVG is not available or not an option (which was an issue before ca 2012).
    289. 

  289. As a general rule: if you plan to display the QR Code in a web browser, you should be using the <a class="reference internal" href="Built-In-Output-QRMarkupSVG.html"><span class="std std-doc">SVG output</span></a>.</p>
    290. 

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

  291. <h2>Example<a class="headerlink" href="#example" title="Link to this heading"></a></h2>
    292. 

  292. <p>See: <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/examples/html.php">HTML example</a></p>
    293. 

  293. <p>Set the options:</p>
    294. 

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

  295. 

  296. <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">MARKUP_HTML</span><span class="p">;</span>
    297. 

  297. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">cssClass</span>     <span class="o">=</span> <span class="s1">&#39;qrcode&#39;</span><span class="p">;</span>
    298. 

  298. <span class="c1">// default values for unassigned module types</span>
    299. 

  299. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">markupDark</span>   <span class="o">=</span> <span class="s1">&#39;#555&#39;</span><span class="p">;</span>
    300. 

  300. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">markupLight</span>  <span class="o">=</span> <span class="s1">&#39;#CCC&#39;</span><span class="p">;</span>
    301. 

  301. <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">moduleValues</span> <span class="o">=</span> <span class="p">[</span>
    302. 

  302. 	<span class="c1">// finder</span>
    303. 

  303. 	<span class="nx">QRMatrix</span><span class="o">::</span><span class="na">M_FINDER_DARK</span>    <span class="o">=&gt;</span> <span class="s1">&#39;#A71111&#39;</span><span class="p">,</span> <span class="c1">// dark (true)</span>
    304. 

  304. 	<span class="nx">QRMatrix</span><span class="o">::</span><span class="na">M_FINDER_DOT</span>     <span class="o">=&gt;</span> <span class="s1">&#39;#A71111&#39;</span><span class="p">,</span> <span class="c1">// finder dot, dark (true)</span>
    305. 

  305. 	<span class="nx">QRMatrix</span><span class="o">::</span><span class="na">M_FINDER</span>         <span class="o">=&gt;</span> <span class="s1">&#39;#FFBFBF&#39;</span><span class="p">,</span> <span class="c1">// light (false)</span>
    306. 

  306. 	<span class="c1">// alignment</span>
    307. 

  307. 	<span class="nx">QRMatrix</span><span class="o">::</span><span class="na">M_ALIGNMENT_DARK</span> <span class="o">=&gt;</span> <span class="s1">&#39;#A70364&#39;</span><span class="p">,</span>
    308. 

  308. 	<span class="nx">QRMatrix</span><span class="o">::</span><span class="na">M_ALIGNMENT</span>      <span class="o">=&gt;</span> <span class="s1">&#39;#FFC9C9&#39;</span><span class="p">,</span>
    309. 

  309. <span class="p">];</span>
    310. 

  310. </pre></div>
    311. 

  311. </div>
    312. 

  312. <p>Output in a HTML document (via PHP):</p>
    313. 

  313. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
    314. 

  314. 

  315. <span class="nv">$data</span> <span class="o">=</span> <span class="s1">&#39;https://www.youtube.com/watch?v=dQw4w9WgXcQ&#39;</span><span class="p">;</span>
    316. 

  316. <span class="nv">$out</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">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
    317. 

  317. 

  318. <span class="nb">header</span><span class="p">(</span><span class="s1">&#39;Content-type: text/html&#39;</span><span class="p">);</span>
    319. 

  319. 

  320. <span class="cp">?&gt;</span>
    321. 

  321. <span class="x">&lt;!DOCTYPE html&gt;</span>
    322. 

  322. <span class="x">&lt;html lang=&quot;none&quot;&gt;</span>
    323. 

  323. <span class="x">&lt;head&gt;</span>
    324. 

  324. <span class="x">	&lt;meta charset=&quot;UTF-8&quot;/&gt;</span>
    325. 

  325. <span class="x">	&lt;meta name=&quot;viewport&quot; content=&quot;width=device-width, initial-scale=1.0&quot;/&gt;</span>
    326. 

  326. <span class="x">	&lt;title&gt;QRCode HTML Example&lt;/title&gt;</span>
    327. 

  327. <span class="x">	&lt;style&gt;</span>
    328. 

  328. <span class="x">		div.qrcode{</span>
    329. 

  329. <span class="x">			margin: 1em;</span>
    330. 

  330. <span class="x">		}</span>
    331. 

  331. 

  332. <span class="x">		/* rows */</span>
    333. 

  333. <span class="x">		div.qrcode &gt; div {</span>
    334. 

  334. <span class="x">			height: 10px;</span>
    335. 

  335. <span class="x">		}</span>
    336. 

  336. 

  337. <span class="x">		/* modules */</span>
    338. 

  338. <span class="x">		div.qrcode &gt; div &gt; span {</span>
    339. 

  339. <span class="x">			display: inline-block;</span>
    340. 

  340. <span class="x">			width: 10px;</span>
    341. 

  341. <span class="x">			height: 10px;</span>
    342. 

  342. <span class="x">		}</span>
    343. 

  343. <span class="x">	&lt;/style&gt;</span>
    344. 

  344. <span class="x">&lt;/head&gt;</span>
    345. 

  345. <span class="x">&lt;body&gt;</span>
    346. 

  346. <span class="x">&lt;!-- php poutput --&gt;</span>
    347. 

  347. <span class="cp">&lt;?php</span> <span class="k">echo</span> <span class="nv">$out</span><span class="p">;</span> <span class="cp">?&gt;</span>
    348. 

  348. <span class="x">&lt;/body&gt;</span>
    349. 

  349. <span class="x">&lt;/html&gt;</span>
    350. 

  350. </pre></div>
    351. 

  351. </div>
    352. 

  352. </section>
    353. 

  353. <section id="additional-methods">
    354. 

  354. <h2>Additional methods<a class="headerlink" href="#additional-methods" title="Link to this heading"></a></h2>
    355. 

  355. <table class="docutils align-default">
    356. 

  356. <thead>
    357. 

  357. <tr class="row-odd"><th class="head"><p>method</p></th>
    358. 

  358. <th class="head"><p>return</p></th>
    359. 

  359. <th class="head"><p>description</p></th>
    360. 

  360. </tr>
    361. 

  361. </thead>
    362. 

  362. <tbody>
    363. 

  363. <tr class="row-even"><td><p>(protected) <code class="docutils literal notranslate"><span class="pre">createMarkup(bool $saveToFile)</span></code></p></td>
    364. 

  364. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    365. 

  365. <td><p>Returns the fully parsed and rendered markup string for the given input</p></td>
    366. 

  366. </tr>
    367. 

  367. <tr class="row-odd"><td><p>(protected) <code class="docutils literal notranslate"><span class="pre">getCssClass(int</span> <span class="pre">$M_TYPE</span> <span class="pre">=</span> <span class="pre">0)</span></code></p></td>
    368. 

  368. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    369. 

  369. <td><p>Returns a string with all css classes for the current element</p></td>
    370. 

  370. </tr>
    371. 

  371. </tbody>
    372. 

  372. </table>
    373. 

  373. </section>
    374. 

  374. <section id="options-that-affect-this-module">
    375. 

  375. <h2>Options that affect this module<a class="headerlink" href="#options-that-affect-this-module" title="Link to this heading"></a></h2>
    376. 

  376. <table class="docutils align-default">
    377. 

  377. <thead>
    378. 

  378. <tr class="row-odd"><th class="head"><p>property</p></th>
    379. 

  379. <th class="head"><p>type</p></th>
    380. 

  380. </tr>
    381. 

  381. </thead>
    382. 

  382. <tbody>
    383. 

  383. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$cssClass</span></code></p></td>
    384. 

  384. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    385. 

  385. </tr>
    386. 

  386. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$eol</span></code></p></td>
    387. 

  387. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    388. 

  388. </tr>
    389. 

  389. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$markupDark</span></code></p></td>
    390. 

  390. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    391. 

  391. </tr>
    392. 

  392. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$markupLight</span></code></p></td>
    393. 

  393. <td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
    394. 

  394. </tr>
    395. 

  395. </tbody>
    396. 

  396. </table>
    397. 

  397. <section id="options-that-have-no-effect">
    398. 

  398. <h3>Options that have no effect<a class="headerlink" href="#options-that-have-no-effect" title="Link to this heading"></a></h3>
    399. 

  399. <table class="docutils align-default">
    400. 

  400. <thead>
    401. 

  401. <tr class="row-odd"><th class="head"><p>property</p></th>
    402. 

  402. <th class="head"><p>reason</p></th>
    403. 

  403. </tr>
    404. 

  404. </thead>
    405. 

  405. <tbody>
    406. 

  406. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$bgColor</span></code></p></td>
    407. 

  407. <td><p>via CSS</p></td>
    408. 

  408. </tr>
    409. 

  409. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$circleRadius</span></code></p></td>
    410. 

  410. <td><p>N/A</p></td>
    411. 

  411. </tr>
    412. 

  412. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$connectPaths</span></code></p></td>
    413. 

  413. <td><p>N/A</p></td>
    414. 

  414. </tr>
    415. 

  415. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$drawCircularModules</span></code></p></td>
    416. 

  416. <td><p>N/A</p></td>
    417. 

  417. </tr>
    418. 

  418. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$drawLightModules</span></code></p></td>
    419. 

  419. <td><p>N/A</p></td>
    420. 

  420. </tr>
    421. 

  421. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$excludeFromConnect</span></code></p></td>
    422. 

  422. <td><p>N/A</p></td>
    423. 

  423. </tr>
    424. 

  424. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$imageTransparent</span></code></p></td>
    425. 

  425. <td><p>N/A</p></td>
    426. 

  426. </tr>
    427. 

  427. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$keepAsSquare</span></code></p></td>
    428. 

  428. <td><p>N/A</p></td>
    429. 

  429. </tr>
    430. 

  430. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$outputBase64</span></code></p></td>
    431. 

  431. <td><p>N/A</p></td>
    432. 

  432. </tr>
    433. 

  433. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$returnResource</span></code></p></td>
    434. 

  434. <td><p>N/A</p></td>
    435. 

  435. </tr>
    436. 

  436. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$scale</span></code></p></td>
    437. 

  437. <td><p>via CSS</p></td>
    438. 

  438. </tr>
    439. 

  439. </tbody>
    440. 

  440. </table>
    441. 

  441. </section>
    442. 

  442. </section>
    443. 

  443. </section>
    444. 

  444. 

  445. 

  446.            </div>
    447. 

  447.           </div>
    448. 

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

  449.         <a href="Built-In-Output-QRImagick.html" class="btn btn-neutral float-left" title="QRImagick" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    450. 

  450.         <a href="Built-In-Output-QRMarkupSVG.html" class="btn btn-neutral float-right" title="QRMarkupSVG" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    451. 

  451.     </div>
    452. 

  452. 

  453.   <hr/>
    454. 

  454. 

  455.   <div role="contentinfo">
    456. 

  456.     <p>&#169; Copyright 2023, smiley.</p>
    457. 

  457.   </div>
    458. 

  458. 

  459.    
    460. 

  460. 

  461. </footer>
    462. 

  462.         </div>
    463. 

  463.       </div>
    464. 

  464.     </section>
    465. 

  465.   </div>
    466. 

  466.   <script>
    467. 

  467.       jQuery(function () {
    468. 

  468.           SphinxRtdTheme.Navigation.enable(true);
    469. 

  469.       });
    470. 

  470.   </script> 
    471. 

  471. 

  472. </body>
    473. 

  473. </html>
    474.