Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
mrkad
/
php-qrcode
zrkadlo https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Súbory Issues 0 Wiki
Strom: 31f6a46f75
Branche Tagy
php-qrcode
/
Appendix
/
Contribute.html

Contribute.html 38 KB
História Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <html class="writer-html5" lang="en" data-content_root="../">
    5. 

  5. <head>
    6. 

  6.   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    7. 

  7. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    9. 

  9.   <title>How to contribute &mdash; PHP-QRCode main
    10. 

  10.  Manual</title>
    11. 

  11.       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    12. 

  12.       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
    13. 

  13. 

  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=9bcbadda"></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="License" href="License.html" />
    24. 

  24.     <link rel="prev" title="Performance considerations" href="Performance-considerations.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#outputinterface">outputInterface</a></li>
    113. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  143. <li class="toctree-l2"><a class="reference internal" href="../Usage/Configuration-settings.html#jsonflags">jsonFlags</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#xmlstylesheet">xmlStylesheet</a></li>
    146. 

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

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

  148. <li class="toctree-l2"><a class="reference internal" href="../Usage/Configuration-settings.html#readerinvertcolors">readerInvertColors</a></li>
    149. 

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

  150. </ul>
    151. 

  151. </li>
    152. 

  152. </ul>
    153. 

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

  154. <ul>
    155. 

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

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

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

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

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

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

  161. </ul>
    162. 

  162. </li>
    163. 

  163. </ul>
    164. 

  164. </li>
    165. 

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

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

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

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

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

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

  171. </ul>
    172. 

  172. </li>
    173. 

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

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

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

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

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

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

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

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

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

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

  183. </ul>
    184. 

  184. </li>
    185. 

  185. </ul>
    186. 

  186. </li>
    187. 

  187. <li class="toctree-l1"><a class="reference internal" href="../Customizing/Custom-output-interface.html">Custom <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#class-skeleton">Class skeleton</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#module-values">Module values</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#transform-the-output">Transform the output</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#run-the-custom-output">Run the custom output</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="../Customizing/Custom-output-interface.html#summary">Summary</a></li>
    193. 

  193. </ul>
    194. 

  194. </li>
    195. 

  195. </ul>
    196. 

  196. <p class="caption" role="heading"><span class="caption-text">Built-In Output Classes</span></p>
    197. 

  197. <ul>
    198. 

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

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

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

  201. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QREps.html#options-that-affect-this-class">Options that affect this class</a></li>
    202. 

  202. </ul>
    203. 

  203. </li>
    204. 

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

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

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

  207. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRFpdf.html#options-that-affect-this-class">Options that affect this class</a></li>
    208. 

  208. </ul>
    209. 

  209. </li>
    210. 

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

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

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

  213. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRGdImage.html#options-that-affect-this-class">Options that affect this class</a></li>
    214. 

  214. </ul>
    215. 

  215. </li>
    216. 

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

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

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

  219. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRImagick.html#options-that-affect-this-class">Options that affect this class</a></li>
    220. 

  220. </ul>
    221. 

  221. </li>
    222. 

  222. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRInterventionImage.html">QRInterventionImage</a><ul>
    223. 

  223. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRInterventionImage.html#example">Example</a></li>
    224. 

  224. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRInterventionImage.html#additional-methods">Additional methods</a></li>
    225. 

  225. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRInterventionImage.html#options-that-affect-this-class">Options that affect this class</a></li>
    226. 

  226. </ul>
    227. 

  227. </li>
    228. 

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

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

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

  231. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupHTML.html#options-that-affect-this-class">Options that affect this class</a></li>
    232. 

  232. </ul>
    233. 

  233. </li>
    234. 

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

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

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

  237. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupSVG.html#options-that-affect-this-class">Options that affect this class</a></li>
    238. 

  238. </ul>
    239. 

  239. </li>
    240. 

  240. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRMarkupXML.html">QRMarkupXML</a><ul>
    241. 

  241. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupXML.html#example">Example</a></li>
    242. 

  242. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupXML.html#additional-methods">Additional methods</a></li>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRMarkupXML.html#options-that-affect-this-class">Options that affect this class</a></li>
    244. 

  244. </ul>
    245. 

  245. </li>
    246. 

  246. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRStringJSON.html">QRStringJSON</a><ul>
    247. 

  247. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringJSON.html#example">Example</a></li>
    248. 

  248. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringJSON.html#previous-functionality">Previous functionality</a></li>
    249. 

  249. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringJSON.html#additional-methods">Additional methods</a></li>
    250. 

  250. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringJSON.html#options-that-affect-this-class">Options that affect this class</a></li>
    251. 

  251. </ul>
    252. 

  252. </li>
    253. 

  253. <li class="toctree-l1"><a class="reference internal" href="../Built-In-Output/QRStringText.html">QRStringText</a><ul>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringText.html#example">Example</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringText.html#additional-methods">Additional methods</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../Built-In-Output/QRStringText.html#options-that-affect-this-class">Options that affect this class</a></li>
    257. 

  257. </ul>
    258. 

  258. </li>
    259. 

  259. </ul>
    260. 

  260. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
    261. 

  261. <ul class="current">
    262. 

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

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

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

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

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

  267. </ul>
    268. 

  268. </li>
    269. 

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

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

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

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

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

  274. <li class="toctree-l3"><a class="reference internal" href="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="Terminology.html#encoding-region">Encoding Region</a><ul>
    278. 

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

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

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

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

  282. </ul>
    283. 

  283. </li>
    284. 

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

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

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

  287. <li class="toctree-l3"><a class="reference internal" href="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="Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
    291. 

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

  292. <li class="toctree-l3"><a class="reference internal" href="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="Terminology.html#data-masking">Data masking</a><ul>
    296. 

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

  297. <li class="toctree-l3"><a class="reference internal" href="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="Terminology.html#reflectance">Reflectance</a></li>
    301. 

  301. </ul>
    302. 

  302. </li>
    303. 

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

  304. <li class="toctree-l2"><a class="reference internal" href="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="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="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="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="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="URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
    310. 

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

  311. <li class="toctree-l2"><a class="reference internal" href="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="URI-Content.html#credit-transfer">Credit Transfer</a><ul>
    313. 

  313. <li class="toctree-l3"><a class="reference internal" href="URI-Content.html#sepa-european-payments-council">SEPA (European Payments Council)</a></li>
    314. 

  314. <li class="toctree-l3"><a class="reference internal" href="URI-Content.html#pix-banco-central-do-brasil">Pix (Banco Central do Brasil)</a></li>
    315. 

  315. </ul>
    316. 

  316. </li>
    317. 

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

  318. </ul>
    319. 

  319. </li>
    320. 

  320. <li class="toctree-l1"><a class="reference internal" href="Performance-considerations.html">Performance considerations</a><ul>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="Performance-considerations.html#version">Version</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="Performance-considerations.html#ecc-level">Ecc level</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="Performance-considerations.html#data-mode">Data mode</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="Performance-considerations.html#mask-pattern">Mask pattern</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="Performance-considerations.html#output">Output</a></li>
    326. 

  326. </ul>
    327. 

  327. </li>
    328. 

  328. <li class="toctree-l1 current"><a class="current reference internal" href="#">How to contribute</a><ul>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="#questions-and-issues">Questions and issues</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="#bug-reports">Bug reports</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="#pull-requests-and-bug-fixes">Pull requests and bug fixes</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
    333. 

  333. </ul>
    334. 

  334. </li>
    335. 

  335. <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
    336. 

  336. </ul>
    337. 

  337. 

  338.         </div>
    339. 

  339.       </div>
    340. 

  340.     </nav>
    341. 

  341. 

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

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

  344.           <a href="../index.html">PHP-QRCode</a>
    345. 

  345.       </nav>
    346. 

  346. 

  347.       <div class="wy-nav-content">
    348. 

  348.         <div class="rst-content">
    349. 

  349.           <div role="navigation" aria-label="Page navigation">
    350. 

  350.   <ul class="wy-breadcrumbs">
    351. 

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

  352.       <li class="breadcrumb-item active">How to contribute</li>
    353. 

  353.       <li class="wy-breadcrumbs-aside">
    354. 

  354.               <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Appendix/Contribute.md" class="fa fa-github"> Edit on GitHub</a>
    355. 

  355.       </li>
    356. 

  356.   </ul>
    357. 

  357.   <hr/>
    358. 

  358. </div>
    359. 

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

  360.            <div itemprop="articleBody">
    361. 

  361.              
    362. 

  362.   <section id="how-to-contribute">
    363. 

  363. <h1>How to contribute<a class="headerlink" href="#how-to-contribute" title="Link to this heading"></a></h1>
    364. 

  364. <section id="questions-and-issues">
    365. 

  365. <h2>Questions and issues<a class="headerlink" href="#questions-and-issues" title="Link to this heading"></a></h2>
    366. 

  366. <p>If you have a question about or a general issue while using this library,
    367. 

  367. head over to the <a class="reference external" href="https://github.com/chillerlan/php-qrcode/discussions">discussions section</a>,
    368. 

  368. create a new post and describe your issue as precise as possible, ideally add a code example (if applicable).
    369. 

  369. Please don’t just write “headline says all” because the reply will likely be similarly concise - help me (and others) help you!
    370. 

  370. (just to clarify: the “general” does not mean general PHP support, in which case you’re better off on
    371. 

  371. <a class="reference external" href="https://stackoverflow.com/questions/tagged/php">StackOverflow</a> or <a class="reference external" href="https://www.reddit.com/r/PHPhelp/">/r/PHPhelp</a>)</p>
    372. 

  372. </section>
    373. 

  373. <section id="bug-reports">
    374. 

  374. <h2>Bug reports<a class="headerlink" href="#bug-reports" title="Link to this heading"></a></h2>
    375. 

  375. <p>So you found a bug or the library code is somehow misbehaving? That’s great (well, not that great tho). In that case,
    376. 

  376. please <a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/new?assignees=&amp;amp;labels=bug&amp;amp;projects=&amp;amp;template=bug_report.md&amp;amp;title=%5BBUG%5D">open a bug report and FILL OUT THE ISSUE TEMPLATE</a>
    377. 

  377. (I have to write that in all caps because nobody actually does it which usually leads to several avoidable follow-up questions that cost both of us precious time).
    378. 

  378. Below an example of the bug report template (it’s not that hard):</p>
    379. 

  379. <p><strong>Describe the bug</strong></p>
    380. 

  380. <p>A clear and concise description of what the bug is.</p>
    381. 

  381. <p><strong>Steps to reproduce the behavior</strong></p>
    382. 

  382. <ul class="simple">
    383. 

  383. <li><p>When i do …</p></li>
    384. 

  384. <li><p>The code below …</p></li>
    385. 

  385. <li><p>Error message: …</p></li>
    386. 

  386. </ul>
    387. 

  387. <p><strong>Code sample</strong></p>
    388. 

  388. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// your code here</span>
    389. 

  389. </pre></div>
    390. 

  390. </div>
    391. 

  391. <p><strong>Expected behavior</strong></p>
    392. 

  392. <p>A clear and concise description of what you expected to happen.</p>
    393. 

  393. <p><strong>Screenshots</strong></p>
    394. 

  394. <p>If applicable, add screenshots to help explain your problem.</p>
    395. 

  395. <p><strong>Environment (please complete the following information):</strong></p>
    396. 

  396. <ul class="simple">
    397. 

  397. <li><p>PHP version/OS: [e.g. 7.4.12, Ubuntu 20.04]</p></li>
    398. 

  398. <li><p>Library version: [e.g. 4.3.4]</p></li>
    399. 

  399. </ul>
    400. 

  400. <p><strong>Additional context</strong></p>
    401. 

  401. <p>Add any other useful context about the problem.</p>
    402. 

  402. </section>
    403. 

  403. <section id="pull-requests-and-bug-fixes">
    404. 

  404. <h2>Pull requests and bug fixes<a class="headerlink" href="#pull-requests-and-bug-fixes" title="Link to this heading"></a></h2>
    405. 

  405. <p>You want to contribute code to fix something or add a feature? Hey that’s cool! However, there’s a few things to keep in mind:</p>
    406. 

  406. <ul class="simple">
    407. 

  407. <li><p>Please add a description of what the PR does or fixes and why it should be merged. If you’re unsure, <a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/new?assignees=&amp;amp;labels=enhancement&amp;amp;projects=&amp;amp;template=feature_request.md&amp;amp;title=%5BENHANCEMENT%5D">open an issue</a> before to gather feedback.</p></li>
    408. 

  408. <li><p>Make sure your branch is up-to-date/even with the upstream branch you’re submitting your PR to.</p></li>
    409. 

  409. <li><p>Please try to adhere to the <a class="reference external" href="https://github.com/chillerlan/php-qrcode/discussions/60"><em>loosely outlined</em> coding standards</a>, or, in case you’re using <a class="reference external" href="https://www.jetbrains.com/phpstorm/">PHPStorm</a>, make sure you’re using <a class="reference external" href="https://github.com/chillerlan/php-qrcode/tree/main/.idea">the supplied IDE profile</a>.</p></li>
    410. 

  410. </ul>
    411. 

  411. </section>
    412. 

  412. <section id="documentation">
    413. 

  413. <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h2>
    414. 

  414. <p>The documentation is a work in progress - any suggestion and contribution is very welcome!
    415. 

  415. If you have an addition or correction, feel fre to open a <a class="reference external" href="https://github.com/chillerlan/php-qrcode/issues/new?assignees=&amp;amp;labels=docs&amp;amp;projects=&amp;amp;template=documentation.md&amp;amp;title=%5BDOCS%5D">documentation issue</a>.</p>
    416. 

  416. <p>The API documentation is auto generated with <a class="reference external" href="https://www.phpdoc.org/">phpDocumentor</a> from the docblocks <a class="reference external" href="https://github.com/chillerlan/php-qrcode/tree/main/src">in the PHP sources</a>.
    417. 

  417. The markdown sources for the <a class="reference external" href="https://php-qrcode.readthedocs.io">Read the Docs online manual</a> are located in the <a class="reference external" href="https://github.com/chillerlan/php-qrcode/tree/main/docs">/docs directory</a></p>
    418. 

  418. </section>
    419. 

  419. </section>
    420. 

  420. 

  421. 

  422.            </div>
    423. 

  423.           </div>
    424. 

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

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

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

  427.     </div>
    428. 

  428. 

  429.   <hr/>
    430. 

  430. 

  431.   <div role="contentinfo">
    432. 

  432.     <p>&#169; Copyright 2023, smiley.</p>
    433. 

  433.   </div>
    434. 

  434. 

  435.    
    436. 

  436. 

  437. </footer>
    438. 

  438.         </div>
    439. 

  439.       </div>
    440. 

  440.     </section>
    441. 

  441.   </div>
    442. 

  442.   <script>
    443. 

  443.       jQuery(function () {
    444. 

  444.           SphinxRtdTheme.Navigation.enable(true);
    445. 

  445.       });
    446. 

  446.   </script> 
    447. 

  447. 

  448. </body>
    449. 

  449. </html>
    450.