API-QRCode.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>QRCode &mdash; PHP-QRCode main
  7. Manual</title>
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  10. <!--[if lt IE 9]>
  11. <script src="_static/js/html5shiv.min.js"></script>
  12. <![endif]-->
  13. <script src="_static/jquery.js?v=5d32c60e"></script>
  14. <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  15. <script src="_static/documentation_options.js?v=a8da1a53"></script>
  16. <script src="_static/doctools.js?v=888ff710"></script>
  17. <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  18. <script src="_static/js/theme.js"></script>
  19. <link rel="index" title="Index" href="genindex.html" />
  20. <link rel="search" title="Search" href="search.html" />
  21. <link rel="next" title="QROptions" href="API-QROptions.html" />
  22. <link rel="prev" title="QRString" href="Built-In-Output-QRString.html" />
  23. </head>
  24. <body class="wy-body-for-nav">
  25. <div class="wy-grid-for-nav">
  26. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  27. <div class="wy-side-scroll">
  28. <div class="wy-side-nav-search" >
  29. <a href="index.html" class="icon icon-home">
  30. PHP-QRCode
  31. </a>
  32. <div role="search">
  33. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  35. <input type="hidden" name="check_keywords" value="yes" />
  36. <input type="hidden" name="area" value="default" />
  37. </form>
  38. </div>
  39. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  40. <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
  41. <ul>
  42. <li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
  43. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
  47. </ul>
  48. </li>
  49. <li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
  50. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
  51. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a><ul>
  52. <li class="toctree-l4"><a class="reference internal" href="Usage-Installation.html#version-switch">Version switch</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
  59. <li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#can-i-use-this-library-without-using-composer">Can i use this library without using composer?</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#supported-php-versions-extension-requirements">Supported PHP versions &amp; extension requirements</a></li>
  63. <li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
  64. </ul>
  65. </li>
  66. <li class="toctree-l1"><a class="reference internal" href="Usage-Quickstart.html">Quickstart</a><ul>
  67. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#import-the-library">Import the library</a></li>
  68. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
  69. <li class="toctree-l3"><a class="reference internal" href="Usage-Quickstart.html#configuration">Configuration</a></li>
  70. </ul>
  71. </li>
  72. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
  73. <li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#notes">Notes</a></li>
  74. </ul>
  75. </li>
  76. <li class="toctree-l1"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
  77. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#configuration-via-qroptions">Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
  78. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#supply-an-iterable-of-options">Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options</a></li>
  79. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
  80. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#extending-the-qroptions-class">Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class</a></li>
  81. </ul>
  82. </li>
  83. <li class="toctree-l2"><a class="reference internal" href="Usage-Advanced-usage.html#qrcode-methods"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods</a><ul>
  84. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
  85. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
  87. <li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
  88. </ul>
  89. </li>
  90. </ul>
  91. </li>
  92. </ul>
  93. <p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
  94. <ul>
  95. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
  96. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#example">Example</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#options-that-affect-this-module">Options that affect this module</a><ul>
  99. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QREps.html#options-that-have-no-effect">Options that have no effect</a></li>
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
  105. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#example">Example</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#options-that-affect-this-module">Options that affect this module</a><ul>
  108. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRFpdf.html#options-that-have-no-effect">Options that have no effect</a></li>
  109. </ul>
  110. </li>
  111. </ul>
  112. </li>
  113. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
  114. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#example">Example</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#options-that-affect-this-module">Options that affect this module</a><ul>
  117. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRGdImage.html#options-that-have-no-effect">Options that have no effect</a></li>
  118. </ul>
  119. </li>
  120. </ul>
  121. </li>
  122. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
  123. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#example">Example</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#options-that-affect-this-module">Options that affect this module</a><ul>
  126. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRImagick.html#options-that-have-no-effect">Options that have no effect</a></li>
  127. </ul>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
  132. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#example">Example</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#options-that-affect-this-module">Options that affect this module</a><ul>
  135. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#options-that-have-no-effect">Options that have no effect</a></li>
  136. </ul>
  137. </li>
  138. </ul>
  139. </li>
  140. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
  141. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#example">Example</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
  143. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#options-that-affect-this-module">Options that affect this module</a><ul>
  144. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#options-that-have-no-effect">Options that have no effect</a></li>
  145. </ul>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
  150. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#plain-text">Plain text</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
  153. <li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#options-that-affect-this-module">Options that affect this module</a><ul>
  154. <li class="toctree-l3"><a class="reference internal" href="Built-In-Output-QRString.html#options-that-have-no-effect">Options that have no effect</a></li>
  155. </ul>
  156. </li>
  157. </ul>
  158. </li>
  159. </ul>
  160. <p class="caption" role="heading"><span class="caption-text">Public API</span></p>
  161. <ul class="current">
  162. <li class="toctree-l1 current"><a class="current reference internal" href="#">QRCode</a><ul>
  163. <li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a><ul>
  164. <li class="toctree-l3"><a class="reference internal" href="#deprecated-methods">Deprecated methods</a></li>
  165. </ul>
  166. </li>
  167. <li class="toctree-l2"><a class="reference internal" href="#constants">Constants</a><ul>
  168. <li class="toctree-l3"><a class="reference internal" href="#deprecated-constants">Deprecated constants</a></li>
  169. </ul>
  170. </li>
  171. </ul>
  172. </li>
  173. <li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</a><ul>
  174. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
  175. <li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
  176. </ul>
  177. </li>
  178. <li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html">QROutputInterface</a><ul>
  179. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
  180. <li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
  181. </ul>
  182. </li>
  183. <li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html">QRMatrix</a><ul>
  184. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
  185. <li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
  186. </ul>
  187. </li>
  188. <li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
  189. </ul>
  190. </li>
  191. <li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html">DecoderResult</a><ul>
  192. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
  193. <li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
  194. </ul>
  195. </li>
  196. </ul>
  197. <p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
  198. <ul>
  199. <li class="toctree-l1"><a class="reference internal" href="Appendix-Terminology.html">Terminology</a><ul>
  200. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
  201. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
  202. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
  203. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
  204. </ul>
  205. </li>
  206. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
  207. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
  208. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
  209. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
  210. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
  211. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
  212. </ul>
  213. </li>
  214. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
  215. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
  216. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
  217. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
  218. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
  219. </ul>
  220. </li>
  221. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
  222. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
  223. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
  224. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
  225. </ul>
  226. </li>
  227. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
  228. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
  229. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
  230. </ul>
  231. </li>
  232. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
  233. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
  234. <li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
  235. </ul>
  236. </li>
  237. <li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#reflectance">Reflectance</a></li>
  238. </ul>
  239. </li>
  240. <li class="toctree-l1"><a class="reference internal" href="Appendix-URI-Content.html">Popular content and URI schemes</a><ul>
  241. <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>
  242. <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>
  243. <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>
  244. <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>
  245. <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>
  246. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
  247. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
  248. <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>
  249. <li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</a></li>
  250. </ul>
  251. </li>
  252. <li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
  253. </ul>
  254. </div>
  255. </div>
  256. </nav>
  257. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  258. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  259. <a href="index.html">PHP-QRCode</a>
  260. </nav>
  261. <div class="wy-nav-content">
  262. <div class="rst-content">
  263. <div role="navigation" aria-label="Page navigation">
  264. <ul class="wy-breadcrumbs">
  265. <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
  266. <li class="breadcrumb-item active">QRCode</li>
  267. <li class="wy-breadcrumbs-aside">
  268. <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QRCode.md" class="fa fa-github"> Edit on GitHub</a>
  269. </li>
  270. </ul>
  271. <hr/>
  272. </div>
  273. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  274. <div itemprop="articleBody">
  275. <section id="qrcode">
  276. <h1>QRCode<a class="headerlink" href="#qrcode" title="Link to this heading"></a></h1>
  277. <p>The full phpDocumentor API documentation can be found at <a class="reference external" href="https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-QRCode.html">chillerlan.github.io/php-qrcode</a>.</p>
  278. <section id="methods">
  279. <h2>Methods<a class="headerlink" href="#methods" title="Link to this heading"></a></h2>
  280. <!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
  281. <table class="docutils align-default">
  282. <thead>
  283. <tr class="row-odd"><th class="head"><p>method</p></th>
  284. <th class="head"><p>return</p></th>
  285. <th class="head"><p>description</p></th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__construct(SettingsContainerInterface $options = null)</span></code></p></td>
  290. <td><p>-</p></td>
  291. <td><p>see <a class="reference internal" href="API-QROptions.html"><span class="std std-doc"><code class="docutils literal notranslate"><span class="pre">QROptions</span></code></span></a> and <a class="reference external" href="https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php"><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></a></p></td>
  292. </tr>
  293. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">setOptions(SettingsContainerInterface</span> <span class="pre">$options)</span></code></p></td>
  294. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  295. <td><p>Sets an options instance, internally called via the constructor</p></td>
  296. </tr>
  297. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">render(string</span> <span class="pre">$data,</span> <span class="pre">string</span> <span class="pre">$file</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  298. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  299. <td><p>renders a QR Code for the given <code class="docutils literal notranslate"><span class="pre">$data</span></code> and <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>, saves <code class="docutils literal notranslate"><span class="pre">$file</span></code> optionally, output depends on the chosen mode, see <code class="docutils literal notranslate"><span class="pre">QROutputInterface::dump()</span></code></p></td>
  300. </tr>
  301. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">renderMatrix(QRMatrix</span> <span class="pre">$matrix,</span> <span class="pre">string</span> <span class="pre">$file</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
  302. <td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
  303. <td><p>renders a QR Code for the given <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> and <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>, saves <code class="docutils literal notranslate"><span class="pre">$file</span></code> optionally, output depends on the chosen mode, see <code class="docutils literal notranslate"><span class="pre">QROutputInterface::dump()</span></code></p></td>
  304. </tr>
  305. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getQRMatrix()</span></code></p></td>
  306. <td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></p></td>
  307. <td><p>returns a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> object for the given <code class="docutils literal notranslate"><span class="pre">$data</span></code> and current <code class="docutils literal notranslate"><span class="pre">QROptions</span></code></p></td>
  308. </tr>
  309. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">addSegment(QRDataModeInterface</span> <span class="pre">$segment)</span></code></p></td>
  310. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  311. <td><p>Adds a <code class="docutils literal notranslate"><span class="pre">QRDataModeInterface</span></code> segment</p></td>
  312. </tr>
  313. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">clearSegments()</span></code></p></td>
  314. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  315. <td><p>Clears the data segments array</p></td>
  316. </tr>
  317. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">addNumericSegment(string</span> <span class="pre">$data)</span></code></p></td>
  318. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  319. <td><p>Adds a numeric data segment</p></td>
  320. </tr>
  321. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">addAlphaNumSegment(string</span> <span class="pre">$data)</span></code></p></td>
  322. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  323. <td><p>Adds an alphanumeric data segment</p></td>
  324. </tr>
  325. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">addKanjiSegment(string</span> <span class="pre">$data)</span></code></p></td>
  326. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  327. <td><p>Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)</p></td>
  328. </tr>
  329. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">addHanziSegment(string</span> <span class="pre">$data)</span></code></p></td>
  330. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  331. <td><p>Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)</p></td>
  332. </tr>
  333. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">addByteSegment(string</span> <span class="pre">$data)</span></code></p></td>
  334. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  335. <td><p>Adds an 8-bit byte data segment</p></td>
  336. </tr>
  337. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">addEciDesignator(int</span> <span class="pre">$encoding)</span></code></p></td>
  338. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  339. <td><p>Adds a standalone ECI designator</p></td>
  340. </tr>
  341. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">addEciSegment(int</span> <span class="pre">$encoding,</span> <span class="pre">string</span> <span class="pre">$data)</span></code></p></td>
  342. <td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
  343. <td><p>Adds an ECI data segment (including designator)</p></td>
  344. </tr>
  345. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">readFromFile(string</span> <span class="pre">$path)</span></code></p></td>
  346. <td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
  347. <td><p>Reads a QR Code from a given file</p></td>
  348. </tr>
  349. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">readFromBlob(string</span> <span class="pre">$blob)</span></code></p></td>
  350. <td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
  351. <td><p>Reads a QR Code from the given data blob</p></td>
  352. </tr>
  353. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">readFromSource(LuminanceSourceInterface</span> <span class="pre">$source)</span></code></p></td>
  354. <td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
  355. <td><p>Reads a QR Code from the given luminance source</p></td>
  356. </tr>
  357. </tbody>
  358. </table>
  359. <section id="deprecated-methods">
  360. <h3>Deprecated methods<a class="headerlink" href="#deprecated-methods" title="Link to this heading"></a></h3>
  361. <table class="docutils align-default">
  362. <thead>
  363. <tr class="row-odd"><th class="head"><p>method</p></th>
  364. <th class="head"><p>since</p></th>
  365. <th class="head"><p>replacement</p></th>
  366. </tr>
  367. </thead>
  368. <tbody>
  369. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getMatrix()</span></code></p></td>
  370. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  371. <td><p><code class="docutils literal notranslate"><span class="pre">QRCode::getQRMatrix()</span></code></p></td>
  372. </tr>
  373. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">isNumber(string</span> <span class="pre">$string)</span></code></p></td>
  374. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  375. <td><p><code class="docutils literal notranslate"><span class="pre">Number::validateString(string</span> <span class="pre">$string)</span></code></p></td>
  376. </tr>
  377. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">isAlphaNum(string</span> <span class="pre">$string)</span></code></p></td>
  378. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  379. <td><p><code class="docutils literal notranslate"><span class="pre">AlphaNum::validateString(string</span> <span class="pre">$string)</span></code></p></td>
  380. </tr>
  381. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">isKanji(string</span> <span class="pre">$string)</span></code></p></td>
  382. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  383. <td><p><code class="docutils literal notranslate"><span class="pre">Kanji::validateString(string</span> <span class="pre">$string)</span></code></p></td>
  384. </tr>
  385. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">isByte(string</span> <span class="pre">$string)</span></code></p></td>
  386. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  387. <td><p><code class="docutils literal notranslate"><span class="pre">Byte::validateString(string</span> <span class="pre">$string)</span></code></p></td>
  388. </tr>
  389. </tbody>
  390. </table>
  391. </section>
  392. </section>
  393. <section id="constants">
  394. <h2>Constants<a class="headerlink" href="#constants" title="Link to this heading"></a></h2>
  395. <section id="deprecated-constants">
  396. <h3>Deprecated constants<a class="headerlink" href="#deprecated-constants" title="Link to this heading"></a></h3>
  397. <table class="docutils align-default">
  398. <thead>
  399. <tr class="row-odd"><th class="head"><p>name</p></th>
  400. <th class="head"><p>since</p></th>
  401. <th class="head"><p>replacement</p></th>
  402. </tr>
  403. </thead>
  404. <tbody>
  405. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">VERSION_AUTO</span></code></p></td>
  406. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  407. <td><p><code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code></p></td>
  408. </tr>
  409. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MASK_PATTERN_AUTO</span></code></p></td>
  410. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  411. <td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
  412. </tr>
  413. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_MARKUP_SVG</span></code></p></td>
  414. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  415. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_SVG</span></code></p></td>
  416. </tr>
  417. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_MARKUP_HTML</span></code></p></td>
  418. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  419. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_HTML</span></code></p></td>
  420. </tr>
  421. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_PNG</span></code></p></td>
  422. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  423. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_PNG</span></code></p></td>
  424. </tr>
  425. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_JPG</span></code></p></td>
  426. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  427. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_JPG</span></code></p></td>
  428. </tr>
  429. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_GIF</span></code></p></td>
  430. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  431. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_GIF</span></code></p></td>
  432. </tr>
  433. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_STRING_JSON</span></code></p></td>
  434. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  435. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_JSON</span></code></p></td>
  436. </tr>
  437. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_STRING_TEXT</span></code></p></td>
  438. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  439. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_TEXT</span></code></p></td>
  440. </tr>
  441. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGICK</span></code></p></td>
  442. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  443. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::IMAGICK</span></code></p></td>
  444. </tr>
  445. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_FPDF</span></code></p></td>
  446. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  447. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::FPDF</span></code></p></td>
  448. </tr>
  449. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_CUSTOM</span></code></p></td>
  450. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  451. <td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::CUSTOM</span></code></p></td>
  452. </tr>
  453. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_L</span></code></p></td>
  454. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  455. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::L</span></code></p></td>
  456. </tr>
  457. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_M</span></code></p></td>
  458. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  459. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::M</span></code></p></td>
  460. </tr>
  461. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_Q</span></code></p></td>
  462. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  463. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::Q</span></code></p></td>
  464. </tr>
  465. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_H</span></code></p></td>
  466. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  467. <td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::H</span></code></p></td>
  468. </tr>
  469. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_NUMBER</span></code></p></td>
  470. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  471. <td><p><code class="docutils literal notranslate"><span class="pre">Mode::NUMBER</span></code></p></td>
  472. </tr>
  473. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_ALPHANUM</span></code></p></td>
  474. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  475. <td><p><code class="docutils literal notranslate"><span class="pre">Mode::ALPHANUM</span></code></p></td>
  476. </tr>
  477. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_BYTE</span></code></p></td>
  478. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  479. <td><p><code class="docutils literal notranslate"><span class="pre">Mode::BYTE</span></code></p></td>
  480. </tr>
  481. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_KANJI</span></code></p></td>
  482. <td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
  483. <td><p><code class="docutils literal notranslate"><span class="pre">Mode::KANJI</span></code></p></td>
  484. </tr>
  485. </tbody>
  486. </table>
  487. </section>
  488. </section>
  489. </section>
  490. </div>
  491. </div>
  492. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  493. <a href="Built-In-Output-QRString.html" class="btn btn-neutral float-left" title="QRString" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  494. <a href="API-QROptions.html" class="btn btn-neutral float-right" title="QROptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  495. </div>
  496. <hr/>
  497. <div role="contentinfo">
  498. <p>&#169; Copyright 2023, smiley.</p>
  499. </div>
  500. </footer>
  501. </div>
  502. </div>
  503. </section>
  504. </div>
  505. <script>
  506. jQuery(function () {
  507. SphinxRtdTheme.Navigation.enable(true);
  508. });
  509. </script>
  510. </body>
  511. </html>