Startseite Erkunden Hilfe
Anmelden
mrkad
/
php-qrcode
Mirror von https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 017a21f644
Branches Tags
php-qrcode
/
Customizing
/
QROutputAbstract.html

QROutputAbstract.html 58 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600 
  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>QROutputAbstract &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="QREps" href="../Built-In-Output/QREps.html" />
    24. 

  24.     <link rel="prev" title="Module values" href="Module-Values.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-options-from-to-json">Load and save options from/to 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#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
    91. 

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

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

  93. </ul>
    94. 

  94. </li>
    95. 

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

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

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

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

  99. <li class="toctree-l3"><a class="reference internal" href="../Usage/Advanced-usage.html#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="../Usage/Configuration-settings.html">Configuration settings</a><ul>
    105. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  147. <li class="toctree-l2"><a class="reference internal" href="../Usage/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 class="current">
    153. 

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

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

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

  156. <li class="toctree-l2"><a class="reference internal" href="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="Module-Values.html#setting-module-values">Setting module values</a></li>
    158. 

  158. <li class="toctree-l3"><a class="reference internal" href="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 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code></a><ul>
    164. 

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

  165. <li class="toctree-l3"><a class="reference internal" href="#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="#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="#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="#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="#methods">Methods</a><ul>
    172. 

  172. <li class="toctree-l3"><a class="reference internal" href="#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="#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="#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="#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="#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="#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="#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="#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="#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"><code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code></li>
    333. 

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

  334.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Customizing/QROutputAbstract.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="qroutputabstract">
    343. 

  343. <h1><code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code><a class="headerlink" href="#qroutputabstract" title="Link to this heading"></a></h1>
    344. 

  344. <p>The abstract class <code class="docutils literal notranslate"><span class="pre">QROutputAbstract</span></code> contains several commonly used methods and properties and can be used as a basis for a custom output class.</p>
    345. 

  345. <section id="properties">
    346. 

  346. <h2>Properties<a class="headerlink" href="#properties" title="Link to this heading"></a></h2>
    347. 

  347. <section id="options-and-matrix">
    348. 

  348. <h3><code class="docutils literal notranslate"><span class="pre">$options</span></code> and <code class="docutils literal notranslate"><span class="pre">$matrix</span></code><a class="headerlink" href="#options-and-matrix" title="Link to this heading"></a></h3>
    349. 

  349. <p>The <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> and <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instances that were passed to the constructor of the output class.
    350. 

  350. Both objects can be modified during runtime, for example to override settings or add matrix modifications.</p>
    351. 

  351. </section>
    352. 

  352. <section id="modulecount-scale-and-length">
    353. 

  353. <h3><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 class="headerlink" href="#modulecount-scale-and-length" title="Link to this heading"></a></h3>
    354. 

  354. <p>These are convenience variables mostly to avoid multiple method calls to <code class="docutils literal notranslate"><span class="pre">QRMatrix::getSize()</span></code> and <code class="docutils literal notranslate"><span class="pre">QROptions::__get('scale')</span></code> inside loops,
    355. 

  355. the <code class="docutils literal notranslate"><span class="pre">$length</span></code> is calculated from the aforementioned values (<code class="docutils literal notranslate"><span class="pre">$moduleCount</span> <span class="pre">*</span> <span class="pre">$scale</span></code>).
    356. 

  356. The method <code class="docutils literal notranslate"><span class="pre">setMatrixDimensions()</span></code> can be called to update these 3 values after the matrix has been modified, e.g. by adding a quiet zone during output.</p>
    357. 

  357. </section>
    358. 

  358. <section id="modulevalues">
    359. 

  359. <h3><code class="docutils literal notranslate"><span class="pre">$moduleValues</span></code><a class="headerlink" href="#modulevalues" title="Link to this heading"></a></h3>
    360. 

  360. <p>The finalized map of <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> to value for the current output. This map is generated during invocation of the output class via <code class="docutils literal notranslate"><span class="pre">setModuleValues()</span></code>.</p>
    361. 

  361. </section>
    362. 

  362. <section id="copies-of-qroptions-values">
    363. 

  363. <h3>Copies of <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> values<a class="headerlink" href="#copies-of-qroptions-values" title="Link to this heading"></a></h3>
    364. 

  364. <p>Some values from the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> instance are copied to properties to avoid calling the magic getters in long loops for a significant performance increase, e.g. in the module collector.
    365. 

  365. Currently, the following values are copied via <code class="docutils literal notranslate"><span class="pre">copyVars()</span></code> during invocation:
    366. 

  366. <code class="docutils literal notranslate"><span class="pre">$connectPaths</span></code>, <code class="docutils literal notranslate"><span class="pre">$excludeFromConnect</span></code>, <code class="docutils literal notranslate"><span class="pre">$eol</span></code>, <code class="docutils literal notranslate"><span class="pre">$drawLightModules</span></code>, <code class="docutils literal notranslate"><span class="pre">$drawCircularModules</span></code>, <code class="docutils literal notranslate"><span class="pre">$keepAsSquare</span></code>, <code class="docutils literal notranslate"><span class="pre">$circleRadius</span></code>.</p>
    367. 

  367. </section>
    368. 

  368. </section>
    369. 

  369. <section id="methods">
    370. 

  370. <h2>Methods<a class="headerlink" href="#methods" title="Link to this heading"></a></h2>
    371. 

  371. <section id="setmodulevalues">
    372. 

  372. <h3><code class="docutils literal notranslate"><span class="pre">setModuleValues()</span></code><a class="headerlink" href="#setmodulevalues" title="Link to this heading"></a></h3>
    373. 

  373. <p>This method calls the abstract/interface methods <code class="docutils literal notranslate"><span class="pre">moduleValueIsValid()</span></code>,  <code class="docutils literal notranslate"><span class="pre">prepareModuleValue()</span></code> and <code class="docutils literal notranslate"><span class="pre">getDefaultModuleValue()</span></code> to prepare the module values map.</p>
    374. 

  374. </section>
    375. 

  375. <section id="modulevalueisvalid">
    376. 

  376. <h3><code class="docutils literal notranslate"><span class="pre">moduleValueIsValid()</span></code><a class="headerlink" href="#modulevalueisvalid" title="Link to this heading"></a></h3>
    377. 

  377. <p>This method is declared in the <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code> and needs to be implemented by the output class; it is <code class="docutils literal notranslate"><span class="pre">static</span></code> so that it can be called before invocation.
    378. 

  378. The purpose is to determine whether the given <code class="docutils literal notranslate"><span class="pre">mixed</span></code> input is a valid module value for the current output class and returns <code class="docutils literal notranslate"><span class="pre">bool</span></code>.
    379. 

  379. It’s also useful to check values from <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> such as <code class="docutils literal notranslate"><span class="pre">$bgColor</span></code> or <code class="docutils literal notranslate"><span class="pre">$transparencyColor</span></code>.</p>
    380. 

  380. <p>Below is a pseudo implementation, check the code of the several output classes for actual implementations
    381. 

  381. (e.g. <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/4bd4b59fdec72397f5b1f70da9cadcb76764191b/src/Output/QRImagick.php#L68-L96"><code class="docutils literal notranslate"><span class="pre">QRImagick::moduleValueIsValid()</span></code></a>)</p>
    382. 

  382. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    383. 

  383. 

  384. 	<span class="k">public</span> <span class="k">static</span> <span class="k">function</span> <span class="nf">moduleValueIsValid</span><span class="p">(</span><span class="nx">mixed</span> <span class="nv">$value</span><span class="p">)</span><span class="o">:</span><span class="nx">bool</span><span class="p">{</span>
    385. 

  385. 

  386. 		<span class="c1">// check the type of the input value first</span>
    387. 

  387. 		<span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">is_expected_type</span><span class="p">(</span><span class="nv">$value</span><span class="p">)){</span>
    388. 

  388. 			<span class="k">return</span> <span class="k">false</span><span class="p">;</span>
    389. 

  389. 		<span class="p">}</span>
    390. 

  390. 

  391. 		<span class="c1">// do some more checks to determine the value</span>
    392. 

  392. 		<span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">is_somehow_valid</span><span class="p">(</span><span class="nv">$value</span><span class="p">)){</span>
    393. 

  393. 			<span class="k">return</span> <span class="k">false</span><span class="p">;</span>
    394. 

  394. 		<span class="p">}</span>
    395. 

  395. 

  396. 		<span class="c1">// looks like we got a match</span>
    397. 

  397. 		<span class="k">return</span> <span class="k">true</span><span class="p">;</span>
    398. 

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

  399. 

  400. <span class="p">}</span>
    401. 

  401. </pre></div>
    402. 

  402. </div>
    403. 

  403. </section>
    404. 

  404. <section id="preparemodulevalue">
    405. 

  405. <h3><code class="docutils literal notranslate"><span class="pre">prepareModuleValue()</span></code><a class="headerlink" href="#preparemodulevalue" title="Link to this heading"></a></h3>
    406. 

  406. <p>This method prepares the final replacement value from the given input.
    407. 

  407. It might still be necessary to validate the given value despite it being checked earlier by <code class="docutils literal notranslate"><span class="pre">moduleValueIsValid()</span></code> -
    408. 

  408. if nothing helps, this is a good place to throw an exception.
    409. 

  409. Below a pseudo implementation example (see <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/4bd4b59fdec72397f5b1f70da9cadcb76764191b/src/Output/QRGdImage.php#L138-L158"><code class="docutils literal notranslate"><span class="pre">QRGdImage::prepareModuleValue()</span></code></a>):</p>
    410. 

  410. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    411. 

  411. 

  412. 	<span class="k">protected</span> <span class="k">function</span> <span class="nf">prepareModuleValue</span><span class="p">(</span><span class="nx">mixed</span> <span class="nv">$value</span><span class="p">)</span><span class="o">:</span><span class="nx">mixed</span><span class="p">{</span>
    413. 

  413. 

  414. 		<span class="c1">// extended validation to make sure the values are valid for output</span>
    415. 

  415. 		<span class="c1">// e.g. examine array values, clamp etc.</span>
    416. 

  416. 		<span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">is_valid</span><span class="p">(</span><span class="nv">$value</span><span class="p">)){</span>
    417. 

  417. 			<span class="k">throw</span> <span class="k">new</span> <span class="nx">QRCodeOutputException</span><span class="p">(</span><span class="s1">&#39;invalid module value&#39;</span><span class="p">);</span>
    418. 

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

  419. 

  420. 		<span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">modifyValue</span><span class="p">(</span><span class="nv">$value</span><span class="p">);</span>
    421. 

  421. 	<span class="p">}</span>
    422. 

  422. 

  423. <span class="p">}</span>
    424. 

  424. </pre></div>
    425. 

  425. </div>
    426. 

  426. </section>
    427. 

  427. <section id="getdefaultmodulevalue">
    428. 

  428. <h3><code class="docutils literal notranslate"><span class="pre">getDefaultModuleValue()</span></code><a class="headerlink" href="#getdefaultmodulevalue" title="Link to this heading"></a></h3>
    429. 

  429. <p>Finally, setting a default value is required, in case a value for an <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> is not set or it’s invalid.</p>
    430. 

  430. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    431. 

  431. 

  432. 	<span class="k">protected</span> <span class="k">function</span> <span class="nf">getDefaultModuleValue</span><span class="p">(</span><span class="nx">bool</span> <span class="nv">$isDark</span><span class="p">)</span><span class="o">:</span><span class="nx">mixed</span><span class="p">{</span>
    433. 

  433. 		<span class="nv">$defaultValue</span> <span class="o">=</span> <span class="p">(</span><span class="nv">$isDark</span> <span class="o">===</span> <span class="k">true</span><span class="p">)</span>
    434. 

  434. 			<span class="o">?</span> <span class="s1">&#39;default value for dark&#39;</span>
    435. 

  435. 			<span class="o">:</span> <span class="s1">&#39;default value for light&#39;</span><span class="p">;</span>
    436. 

  436. 

  437. 		<span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">prepareModuleValue</span><span class="p">(</span><span class="nv">$defaultValue</span><span class="p">);</span>
    438. 

  438. 	<span class="p">}</span>
    439. 

  439. 

  440. <span class="p">}</span>
    441. 

  441. </pre></div>
    442. 

  442. </div>
    443. 

  443. </section>
    444. 

  444. <section id="getmodulevalue-and-getmodulevalueat">
    445. 

  445. <h3><code class="docutils literal notranslate"><span class="pre">getModuleValue()</span></code> and <code class="docutils literal notranslate"><span class="pre">getModuleValueAt()</span></code><a class="headerlink" href="#getmodulevalue-and-getmodulevalueat" title="Link to this heading"></a></h3>
    446. 

  446. <p>Both methods return a module value, the main difference is that <code class="docutils literal notranslate"><span class="pre">getModuleValueAt()</span></code> is a convenience method
    447. 

  447. that makes an extra call to retrieve the <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> from the given matrix coordinate to return the value via <code class="docutils literal notranslate"><span class="pre">getModuleValue()</span></code>.</p>
    448. 

  448. <p>A <code class="docutils literal notranslate"><span class="pre">foreach</span></code> loop over the matrix gives you the key (coordinate) <em>and</em> value of an array element:</p>
    449. 

  449. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    450. 

  450. 

  451. 	<span class="k">public</span> <span class="k">function</span> <span class="nf">dump</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$file</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
    452. 

  452. 		<span class="nv">$lines</span> <span class="o">=</span> <span class="p">[];</span>
    453. 

  453. 

  454. 		<span class="k">foreach</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">matrix</span><span class="o">-&gt;</span><span class="na">getMatrix</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$y</span> <span class="o">=&gt;</span> <span class="nv">$row</span><span class="p">){</span>
    455. 

  455. 			<span class="nv">$lines</span><span class="p">[</span><span class="nv">$y</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
    456. 

  456. 

  457. 			<span class="k">foreach</span><span class="p">(</span><span class="nv">$row</span> <span class="k">as</span> <span class="nv">$x</span> <span class="o">=&gt;</span> <span class="nv">$M_TYPE</span><span class="p">){</span>
    458. 

  458. 				<span class="nv">$lines</span><span class="p">[</span><span class="nv">$y</span><span class="p">]</span> <span class="o">.=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getModuleValue</span><span class="p">(</span><span class="nv">$M_TYPE</span><span class="p">);</span>
    459. 

  459. 			<span class="p">}</span>
    460. 

  460. 		<span class="p">}</span>
    461. 

  461. 

  462. 		<span class="k">return</span> <span class="nb">implode</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">options</span><span class="o">-&gt;</span><span class="na">eol</span><span class="p">,</span> <span class="nv">$lines</span><span class="p">);</span>
    463. 

  463. 	<span class="p">}</span>
    464. 

  464. 

  465. <span class="p">}</span>
    466. 

  466. </pre></div>
    467. 

  467. </div>
    468. 

  468. <p>However, sometimes you might happen to use a <code class="docutils literal notranslate"><span class="pre">for</span></code> loop instead. The <code class="docutils literal notranslate"><span class="pre">for</span></code> loop leaves you only with the matrix coordinates, so you need to call <code class="docutils literal notranslate"><span class="pre">getModuleValueAt()</span></code>:</p>
    469. 

  469. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    470. 

  470. 

  471. 	<span class="k">public</span> <span class="k">function</span> <span class="nf">dump</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$file</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
    472. 

  472. 		<span class="nv">$lines</span> <span class="o">=</span> <span class="p">[];</span>
    473. 

  473. 

  474. 		<span class="k">for</span><span class="p">(</span><span class="nv">$y</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$y</span> <span class="o">&lt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">moduleCount</span><span class="p">;</span> <span class="nv">$y</span><span class="o">++</span><span class="p">){</span>
    475. 

  475. 			<span class="nv">$lines</span><span class="p">[</span><span class="nv">$y</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
    476. 

  476. 

  477. 			<span class="k">for</span><span class="p">(</span><span class="nv">$x</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$x</span> <span class="o">&lt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">moduleCount</span><span class="p">;</span> <span class="nv">$x</span><span class="o">++</span><span class="p">){</span>
    478. 

  478. 				<span class="nv">$lines</span><span class="p">[</span><span class="nv">$y</span><span class="p">]</span> <span class="o">.=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getModuleValueAt</span><span class="p">(</span><span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">);</span>
    479. 

  479. 			<span class="p">}</span>
    480. 

  480. 

  481. 		<span class="p">}</span>
    482. 

  482. 

  483. 		<span class="k">return</span> <span class="nb">implode</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">options</span><span class="o">-&gt;</span><span class="na">eol</span><span class="p">,</span> <span class="nv">$lines</span><span class="p">);</span>
    484. 

  484. 	<span class="p">}</span>
    485. 

  485. 

  486. <span class="p">}</span>
    487. 

  487. </pre></div>
    488. 

  488. </div>
    489. 

  489. </section>
    490. 

  490. <section id="setmatrixdimensions">
    491. 

  491. <h3><code class="docutils literal notranslate"><span class="pre">setMatrixDimensions()</span></code><a class="headerlink" href="#setmatrixdimensions" title="Link to this heading"></a></h3>
    492. 

  492. <p>As mentioned before, this method is supposed to set the values for the properties <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>.
    493. 

  493. It is called in the constructor during invocation, but it might be necessary to call it again if the size of the matrix was changed in the output class
    494. 

  494. (see <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/99b1f9cf454ab1316cb643950a71caed3a6c0f5a/examples/svgRoundQuietzone.php#L38-L44">the round quiet zone example</a> for a use case).</p>
    495. 

  495. </section>
    496. 

  496. <section id="getoutputdimensions">
    497. 

  497. <h3><code class="docutils literal notranslate"><span class="pre">getOutputDimensions()</span></code><a class="headerlink" href="#getoutputdimensions" title="Link to this heading"></a></h3>
    498. 

  498. <p>This method provides a simple way for consistent width/height values for the output (if applicable) which then can be changed by simply overriding this method.
    499. 

  499. It returns a 2-element array that contains the values in a format that can be used by the output class, which is <code class="docutils literal notranslate"><span class="pre">QROutputAbstract::$length</span></code> (<code class="docutils literal notranslate"><span class="pre">$moduleCount</span> <span class="pre">*</span> <span class="pre">$scale</span></code>):</p>
    500. 

  500. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="nv">$width</span><span class="p">,</span> <span class="nv">$height</span><span class="p">]</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getOutputDimensions</span><span class="p">();</span>
    501. 

  501. </pre></div>
    502. 

  502. </div>
    503. 

  503. <p>The output width and height can be changed in all places by simply overriding the method:</p>
    504. 

  504. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    505. 

  505. 

  506. 	<span class="k">protected</span> <span class="k">function</span> <span class="nf">getOutputDimensions</span><span class="p">()</span><span class="o">:</span><span class="k">array</span><span class="p">{</span>
    507. 

  507. 		<span class="c1">// adjust the height in order to add something under the QR Code</span>
    508. 

  508. 		<span class="k">return</span> <span class="p">[</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">length</span><span class="p">,</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">length</span> <span class="o">+</span> <span class="mi">69</span><span class="p">)];</span>
    509. 

  509. 	<span class="p">}</span>
    510. 

  510. 

  511. <span class="p">}</span>
    512. 

  512. </pre></div>
    513. 

  513. </div>
    514. 

  514. </section>
    515. 

  515. <section id="collectmodules">
    516. 

  516. <h3><code class="docutils literal notranslate"><span class="pre">collectModules()</span></code><a class="headerlink" href="#collectmodules" title="Link to this heading"></a></h3>
    517. 

  517. <p>The module collector is particularly useful for plain text based file formats, for example the various markup languages like SVG and HTML or other structured file formats such as EPS.
    518. 

  518. This method takes a <code class="docutils literal notranslate"><span class="pre">Closure</span></code> as a parameter, which is called with 4 parameters: the module coordinates <code class="docutils literal notranslate"><span class="pre">$x</span></code> and <code class="docutils literal notranslate"><span class="pre">$y</span></code>, the <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> and <code class="docutils literal notranslate"><span class="pre">$M_TYPE_LAYER</span></code>.
    519. 

  519. The <code class="docutils literal notranslate"><span class="pre">$M_TYPE_LAYER</span></code> is a copy of the <code class="docutils literal notranslate"><span class="pre">$M_TYPE</span></code> that represents the array key of the returned array and that may have been reassigned in the collector to another path layer, e.g. through <code class="docutils literal notranslate"><span class="pre">QROptions::$connectPaths</span></code>.</p>
    520. 

  520. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    521. 

  521. 

  522. 	<span class="k">public</span> <span class="k">function</span> <span class="nf">dump</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$file</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
    523. 

  523. 

  524. 		<span class="c1">// collect the modules for the path elements</span>
    525. 

  525. 		<span class="nv">$paths</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">collectModules</span><span class="p">(</span><span class="nx">fn</span><span class="p">(</span><span class="nx">int</span> <span class="nv">$x</span><span class="p">,</span> <span class="nx">int</span> <span class="nv">$y</span><span class="p">,</span> <span class="nx">int</span> <span class="nv">$M_TYPE</span><span class="p">)</span><span class="o">:</span><span class="nx">string</span> <span class="o">=&gt;</span> <span class="nb">sprintf</span><span class="p">(</span><span class="s1">&#39;%d %d %012b&#39;</span><span class="p">,</span> <span class="nv">$x</span><span class="p">,</span> <span class="nv">$y</span><span class="p">,</span> <span class="nv">$M_TYPE</span><span class="p">));</span>
    526. 

  526. 

  527. 		<span class="c1">// loop over the paths</span>
    528. 

  528. 		<span class="k">foreach</span><span class="p">(</span><span class="nv">$paths</span> <span class="k">as</span> <span class="nv">$M_TYPE_LAYER</span> <span class="o">=&gt;</span> <span class="o">&amp;</span><span class="nv">$path</span><span class="p">){</span>
    529. 

  529. 

  530. 			<span class="k">if</span><span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$path</span><span class="p">)){</span>
    531. 

  531. 				<span class="k">continue</span><span class="p">;</span>
    532. 

  532. 			<span class="p">}</span>
    533. 

  533. 

  534. 			<span class="nv">$path</span> <span class="o">=</span> <span class="nb">implode</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">options</span><span class="o">-&gt;</span><span class="na">eol</span><span class="p">,</span> <span class="nv">$path</span><span class="p">);</span>
    535. 

  535. 		<span class="p">}</span>
    536. 

  536. 

  537. 		<span class="k">return</span> <span class="nb">implode</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">options</span><span class="o">-&gt;</span><span class="na">eol</span><span class="p">,</span> <span class="nv">$paths</span><span class="p">);</span>
    538. 

  538. 	<span class="p">}</span>
    539. 

  539. 

  540. <span class="p">}</span>
    541. 

  541. </pre></div>
    542. 

  542. </div>
    543. 

  543. <p>Sometimes it can be necessary to override <code class="docutils literal notranslate"><span class="pre">collectModules()</span></code> in order to apply special effects such as random colors - you can find some implementations in <a class="reference external" href="https://github.com/chillerlan/php-qrcode/tree/main/examples">the SVG examples</a>.</p>
    544. 

  544. </section>
    545. 

  545. <section id="savetofile-and-tobase64datauri">
    546. 

  546. <h3><code class="docutils literal notranslate"><span class="pre">saveToFile()</span></code> and <code class="docutils literal notranslate"><span class="pre">toBase64DataURI()</span></code><a class="headerlink" href="#savetofile-and-tobase64datauri" title="Link to this heading"></a></h3>
    547. 

  547. <p>The void method <code class="docutils literal notranslate"><span class="pre">saveToFile()</span></code> takes a data blob and the <code class="docutils literal notranslate"><span class="pre">$file</span></code> given in <code class="docutils literal notranslate"><span class="pre">QROutputInterface::dump()</span></code> and save to the path if it is not <code class="docutils literal notranslate"><span class="pre">null</span></code> - the file path itself is not checked except for writability.</p>
    548. 

  548. <p>The final output can be transformed to a <a class="reference external" href="https://en.wikipedia.org/wiki/Data_URI_scheme">base64 data URI</a> with <code class="docutils literal notranslate"><span class="pre">toBase64DataURI()</span></code>, where the data blob and a valid mime type as parameters - the mime type is not checked.</p>
    549. 

  549. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyOutput</span> <span class="k">extends</span> <span class="nx">QROutputAbstract</span><span class="p">{</span>
    550. 

  550. 

  551. 	<span class="k">public</span> <span class="k">function</span> <span class="nf">dump</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$file</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
    552. 

  552. 		<span class="nv">$output</span> <span class="o">=</span> <span class="s1">&#39;qrcode data string&#39;</span><span class="p">;</span>
    553. 

  553. 

  554. 		<span class="c1">// save the plain data to file</span>
    555. 

  555. 		<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">saveToFile</span><span class="p">(</span><span class="nv">$output</span><span class="p">,</span> <span class="nv">$file</span><span class="p">);</span>
    556. 

  556. 

  557. 		<span class="c1">// base64 encoding may be called optionally</span>
    558. 

  558. 		<span class="k">if</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">options</span><span class="o">-&gt;</span><span class="na">outputBase64</span><span class="p">){</span>
    559. 

  559. 			<span class="nv">$output</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">toBase64DataURI</span><span class="p">(</span><span class="nv">$output</span><span class="p">,</span> <span class="s1">&#39;text/plain&#39;</span><span class="p">);</span>
    560. 

  560. 		<span class="p">}</span>
    561. 

  561. 

  562. 		<span class="k">return</span> <span class="nv">$output</span><span class="p">;</span>
    563. 

  563. 	<span class="p">}</span>
    564. 

  564. 

  565. <span class="p">}</span>
    566. 

  566. </pre></div>
    567. 

  567. </div>
    568. 

  568. </section>
    569. 

  569. </section>
    570. 

  570. </section>
    571. 

  571. 

  572. 

  573.            </div>
    574. 

  574.           </div>
    575. 

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

  576.         <a href="Module-Values.html" class="btn btn-neutral float-left" title="Module values" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    577. 

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

  578.     </div>
    579. 

  579. 

  580.   <hr/>
    581. 

  581. 

  582.   <div role="contentinfo">
    583. 

  583.     <p>&#169; Copyright 2023, smiley.</p>
    584. 

  584.   </div>
    585. 

  585. 

  586.    
    587. 

  587. 

  588. </footer>
    589. 

  589.         </div>
    590. 

  590.       </div>
    591. 

  591.     </section>
    592. 

  592.   </div>
    593. 

  593.   <script>
    594. 

  594.       jQuery(function () {
    595. 

  595.           SphinxRtdTheme.Navigation.enable(true);
    596. 

  596.       });
    597. 

  597.   </script> 
    598. 

  598. 

  599. </body>
    600. 

  600. </html>
    601.