mrkad
/
php-qrcode
зеркало из https://github.com/chillerlan/php-qrcode.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Advanced usage &mdash; PHP-QRCode main
 Manual</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/sphinx_highlight.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="QRCode" href="API-QRCode.html" />
    <link rel="prev" title="Quickstart" href="Usage-Quickstart.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          <a href="index.html" class="icon icon-home">
            PHP-QRCode
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Usage-Overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#framework-integration">Framework Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Overview.html#shameless-advertising">Shameless advertising</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Usage-Installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#installation-with-composer">Installation with Composer</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#composer-json">composer.json</a><ul>
<li class="toctree-l4"><a class="reference internal" href="Usage-Installation.html#version-switch">Version switch</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="Usage-Installation.html#terminal">Terminal</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#manual-installation">Manual installation</a><ul>
<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>
</ul>
</li>
<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>
<li class="toctree-l2"><a class="reference internal" href="Usage-Installation.html#imagemagick">ImageMagick</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Usage-Quickstart.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#import-the-library">Import the library</a></li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#create-your-first-qr-code">Create your first QR Code</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Usage-Quickstart.html#configuration">Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#reading-qr-codes">Reading QR Codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="Usage-Quickstart.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Advanced usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-via-qroptions">Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#supply-an-iterable-of-options">Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options</a></li>
<li class="toctree-l3"><a class="reference internal" href="#load-and-save-json">Load and save JSON</a></li>
<li class="toctree-l3"><a class="reference internal" href="#extending-the-qroptions-class">Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#qrcode-methods"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#save-to-file">Save to file</a></li>
<li class="toctree-l3"><a class="reference internal" href="#render-a-qrmatrix-instance">Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mixed-mode">Mixed mode</a></li>
<li class="toctree-l3"><a class="reference internal" href="#qr-code-reader">QR Code reader</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Public API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="API-QRCode.html"><code class="docutils literal notranslate"><span class="pre">QRCode</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#methods">Methods</a><ul>
<li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-methods">Deprecated methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="API-QRCode.html#constants">Constants</a><ul>
<li class="toctree-l3"><a class="reference internal" href="API-QRCode.html#deprecated-constants">Deprecated constants</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API-QROptions.html"><code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#methods">Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="API-QROptions.html#properties">Properties</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API-QROutputInterface.html"><code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#methods">Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="API-QROutputInterface.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API-QRMatrix.html"><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#methods">Methods</a><ul>
<li class="toctree-l3"><a class="reference internal" href="API-QRMatrix.html#deprecated-methods">Deprecated methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="API-QRMatrix.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API-DecoderResult.html"><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#methods">Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="API-DecoderResult.html#magic-properties-read-only">Magic Properties (read-only)</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Appendix-Glossary.html">Terminology</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#qr-code">QR Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#matrix">Matrix</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#module">Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#version">Version</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#function-patterns">Function Patterns</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#finder-pattern">Finder Pattern</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#alignment-pattern">Alignment Pattern</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#timing-pattern">Timing Pattern</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#separators">Separators</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#quiet-zone">Quiet Zone</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#encoding-region">Encoding Region</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#data">Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#version-information">Version Information</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#format-information">Format Information</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#darkmodule">Darkmodule</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#mode">Mode</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#segment">Segment</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#mixed-mode">Mixed Mode</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#ecc-level">ECC Level</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#maximum-data-capacity">Maximum data capacity</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#data-masking">Data masking</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#evaluation">Evaluation</a></li>
<li class="toctree-l3"><a class="reference internal" href="Appendix-Glossary.html#mask-pattern">Mask pattern</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="Appendix-Glossary.html#reflectance">Reflectance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Appendix-License.html">License</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">PHP-QRCode</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Advanced usage</li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/Usage-Advanced-usage.md" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="advanced-usage">
<h1>Advanced usage<a class="headerlink" href="#advanced-usage" title="Permalink to this heading"></a></h1>
<section id="configuration-via-qroptions">
<h2>Configuration via <code class="docutils literal notranslate"><span class="pre">QROptions</span></code><a class="headerlink" href="#configuration-via-qroptions" title="Permalink to this heading"></a></h2>
<p>The <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/QROptions.php"><code class="docutils literal notranslate"><span class="pre">QROptions</span></code></a> class is a container based on <a class="reference external" href="https://github.com/chillerlan/php-settings-container">chillerlan/php-settings-container</a> that behaves similar to a <a class="reference external" href="https://www.php.net/manual/class.stdclass"><code class="docutils literal notranslate"><span class="pre">\stdClass</span></code></a> object, but with fixed properties.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">;</span>

<span class="c1">// set some values</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">version</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span>     <span class="c1">// property &quot;version&quot; exists</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">foo</span>     <span class="o">=</span> <span class="s1">&#39;bar&#39;</span><span class="p">;</span> <span class="c1">// property &quot;foo&quot; does not exist (and will not be created)</span>

<span class="c1">// retrieve values</span>
<span class="nb">var_dump</span><span class="p">(</span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">version</span><span class="p">);</span> <span class="c1">// -&gt; 7</span>
<span class="nb">var_dump</span><span class="p">(</span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">foo</span><span class="p">);</span>     <span class="c1">// -&gt; null (no error will be thrown)</span>
</pre></div>
</div>
<section id="supply-an-iterable-of-options">
<h3>Supply an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options<a class="headerlink" href="#supply-an-iterable-of-options" title="Permalink to this heading"></a></h3>
<p>The constructor takes an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of <code class="docutils literal notranslate"><span class="pre">$key</span> <span class="pre">=&gt;</span> <span class="pre">$value</span></code> pairs. For each setting an optional setter will be called if present.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$myOptions</span> <span class="o">=</span> <span class="p">[</span>
	<span class="s1">&#39;version&#39;</span>    <span class="o">=&gt;</span> <span class="mi">5</span><span class="p">,</span>
	<span class="s1">&#39;outputType&#39;</span> <span class="o">=&gt;</span> <span class="nx">QROutputInterface</span><span class="o">::</span><span class="na">GDIMAGE_PNG</span><span class="p">,</span>
	<span class="s1">&#39;eccLevel&#39;</span>   <span class="o">=&gt;</span> <span class="nx">EccLevel</span><span class="o">::</span><span class="na">M</span><span class="p">,</span>
<span class="p">];</span>

<span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">);</span>
</pre></div>
</div>
<p>You can also set an <code class="docutils literal notranslate"><span class="pre">iterable</span></code> of options on an existing QROptions instance:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">fromIterable</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="load-and-save-json">
<h3>Load and save JSON<a class="headerlink" href="#load-and-save-json" title="Permalink to this heading"></a></h3>
<p>The settings can be saved to and loaded from JSON, e.g. to store them in a database:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$json</span> <span class="o">=</span> <span class="nv">$options</span><span class="o">-&gt;</span><span class="na">toJSON</span><span class="p">(</span><span class="nx">JSON_THROW_ON_ERROR</span><span class="p">);</span>
<span class="c1">// via JsonSerializable interface</span>
<span class="nv">$json</span> <span class="o">=</span> <span class="nb">json_encode</span><span class="p">(</span><span class="nv">$options</span><span class="p">,</span> <span class="nx">JSON_THROW_ON_ERROR</span><span class="p">);</span>
<span class="c1">// via __toString()</span>
<span class="nv">$json</span> <span class="o">=</span> <span class="p">(</span><span class="nx">string</span><span class="p">)</span><span class="nv">$options</span><span class="p">;</span>

<span class="nv">$options</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QROptions</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">fromJSON</span><span class="p">(</span><span class="nv">$json</span><span class="p">);</span>
<span class="c1">// on an existing instance - properties will be overwriten</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">fromJSON</span><span class="p">(</span><span class="nv">$json</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="extending-the-qroptions-class">
<h3>Extending the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> class<a class="headerlink" href="#extending-the-qroptions-class" title="Permalink to this heading"></a></h3>
<p>In case you need additional settings for your output module, just extend <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>…</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyCustomOptions</span> <span class="k">extends</span> <span class="nx">QROptions</span><span class="p">{</span>
	<span class="k">protected</span> <span class="nx">string</span> <span class="nv">$myParam</span> <span class="o">=</span> <span class="s1">&#39;defaultValue&#39;</span><span class="p">;</span>
	<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>…or use the <a class="reference external" href="https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php"><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></a>, which is the more flexible approach.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">trait</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">{</span>
	<span class="k">protected</span> <span class="nx">string</span> <span class="nv">$myParam</span> <span class="o">=</span> <span class="s1">&#39;defaultValue&#39;</span><span class="p">;</span>
	<span class="c1">// ...</span>

	<span class="c1">// an optional magic setter, named &quot;set_&quot; + property name</span>
	<span class="k">protected</span> <span class="k">function</span> <span class="nf">set_myParam</span><span class="p">(</span><span class="nx">string</span> <span class="nv">$myParam</span><span class="p">)</span><span class="o">:</span><span class="nx">void</span><span class="p">{</span>
		<span class="nv">$this</span><span class="o">-&gt;</span><span class="na">myParam</span> <span class="o">=</span> <span class="nb">trim</span><span class="p">(</span><span class="nv">$myParam</span><span class="p">);</span>
	<span class="p">}</span>

	<span class="c1">// an optional magic getter, named &quot;get_&quot; + property name</span>
	<span class="k">protected</span> <span class="k">function</span> <span class="nf">get_myParam</span><span class="p">()</span><span class="o">:</span><span class="nx">string</span><span class="p">{</span>
		<span class="k">return</span> <span class="nb">strtoupper</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">myParam</span><span class="p">);</span>
	<span class="p">}</span>
<span class="p">}</span>

<span class="k">class</span> <span class="nc">MyCustomOptions</span> <span class="k">extends</span> <span class="nx">SettingsContainerAbstract</span><span class="p">{</span>
	<span class="k">use</span> <span class="nx">QROptionsTrait</span><span class="p">,</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">;</span>
<span class="p">}</span>

<span class="c1">// set the options</span>
<span class="nv">$myCustomOptions</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">MyCustomOptions</span><span class="p">;</span>
<span class="nv">$myCustomOptions</span><span class="o">-&gt;</span><span class="na">myParam</span> <span class="o">=</span> <span class="s1">&#39;whatever value&#39;</span><span class="p">;</span>
</pre></div>
</div>
<p>Extend the <code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code> on-the-fly:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$myOptions</span> <span class="o">=</span> <span class="p">[</span>
	<span class="s1">&#39;myParam&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;whatever value&#39;</span><span class="p">,</span>
	<span class="c1">// ...</span>
<span class="p">];</span>

<span class="nv">$myCustomOptions</span> <span class="o">=</span> <span class="k">new</span> <span class="k">class</span><span class="p">(</span><span class="nv">$myOptions</span><span class="p">)</span> <span class="k">extends</span> <span class="nx">SettingsContainerAbstract</span><span class="p">{</span>
	<span class="k">use</span> <span class="nx">QROptionsTrait</span><span class="p">,</span> <span class="nx">MyCustomOptionsTrait</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</div>
</section>
</section>
<section id="qrcode-methods">
<h2><code class="docutils literal notranslate"><span class="pre">QRCode</span></code> methods<a class="headerlink" href="#qrcode-methods" title="Permalink to this heading"></a></h2>
<p>Aside of invoking a <code class="docutils literal notranslate"><span class="pre">QRCode</span></code> instance with an optional <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> object as parameter, you can also set the options instance after invocation.
After invocation of the <code class="docutils literal notranslate"><span class="pre">QROptions</span></code> instance, values can be set without calling <code class="docutils literal notranslate"><span class="pre">QRCode::setOptions()</span></code> again (instance is backreferenced), however, this may create side effects.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// instance will be invoked with default settings</span>
<span class="nv">$qrcode</span>  <span class="o">=</span> <span class="k">new</span> <span class="nx">QRCode</span><span class="p">;</span>

<span class="c1">// set options after QRCode invocation</span>
<span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">;</span>

<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">setOptions</span><span class="p">(</span><span class="nv">$options</span><span class="p">);</span>
</pre></div>
</div>
<section id="save-to-file">
<h3>Save to file<a class="headerlink" href="#save-to-file" title="Permalink to this heading"></a></h3>
<p>Save the QR Code output to <code class="docutils literal notranslate"><span class="pre">/path/to/qrcode.svg</span></code>:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">imageBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">cachefile</span>   <span class="o">=</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">;</span>

<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
</pre></div>
</div>
<p>Alternatively, you can specify an output path, which will override the <code class="docutils literal notranslate"><span class="pre">QROptions::$cachefile</span></code> setting:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">,</span> <span class="s1">&#39;/other/path/to/qrcode.svg&#39;</span><span class="p">);</span>

<span class="nb">printf</span><span class="p">(</span><span class="s1">&#39;&lt;img src=&quot;%s&quot; alt=&quot;QR Code&quot; /&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;/other/path/to/qrcode.svg&#39;</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="render-a-qrmatrix-instance">
<h3>Render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance<a class="headerlink" href="#render-a-qrmatrix-instance" title="Permalink to this heading"></a></h3>
<p>You can render a <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRMatrix.php"><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></a> instance directly:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// a matrix from the current data segments</span>
<span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>
<span class="c1">// from the QR Code reader</span>
<span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$readerResult</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>
<span class="c1">// manually invoked</span>
<span class="nv">$matrix</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRMatrix</span><span class="p">(</span><span class="k">new</span> <span class="nx">Version</span><span class="p">(</span><span class="mi">7</span><span class="p">),</span> <span class="k">new</span> <span class="nx">EccLevel</span><span class="p">(</span><span class="nx">EccLevel</span><span class="o">::</span><span class="na">M</span><span class="p">)))</span><span class="o">-&gt;</span><span class="na">initFunctionalPatterns</span><span class="p">();</span>

<span class="nv">$output</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">);</span>
<span class="c1">// save to file</span>
<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">,</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
</pre></div>
</div>
<p>Manual invocation of a <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code> to render a <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> instance:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyCustomOutput</span> <span class="k">extends</span> <span class="nx">QRMarkupSVG</span><span class="p">{</span>
	<span class="c1">// ...</span>
<span class="p">}</span>

<span class="nv">$qrOutputInterface</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">MyCustomOutput</span><span class="p">(</span><span class="nv">$options</span><span class="p">,</span> <span class="nv">$matrix</span><span class="p">);</span>

<span class="nv">$output</span> <span class="o">=</span> <span class="nv">$qrOutputInterface</span><span class="o">-&gt;</span><span class="na">dump</span><span class="p">()</span>
<span class="c1">// render to file</span>
<span class="nv">$qrOutputInterface</span><span class="o">-&gt;</span><span class="na">dump</span><span class="p">(</span><span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="mixed-mode">
<h3>Mixed mode<a class="headerlink" href="#mixed-mode" title="Permalink to this heading"></a></h3>
<p>Mixed mode QR Codes can be generated by adding several data segments:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// make sure to set a proper internal encoding character set</span>
<span class="c1">// ideally, this should be set in php.ini internal_encoding,</span>
<span class="c1">// default_charset or mbstring.internal_encoding</span>
<span class="nb">mb_internal_encoding</span><span class="p">(</span><span class="s1">&#39;UTF-8&#39;</span><span class="p">);</span>

<span class="c1">// clear any existing data segments</span>
<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">clearSegments</span><span class="p">();</span>

<span class="nv">$qrcode</span>
	<span class="o">-&gt;</span><span class="na">addNumericSegment</span><span class="p">(</span><span class="nv">$numericData</span><span class="p">)</span>
	<span class="o">-&gt;</span><span class="na">addAlphaNumSegment</span><span class="p">(</span><span class="nv">$alphaNumData</span><span class="p">)</span>
	<span class="o">-&gt;</span><span class="na">addKanjiSegment</span><span class="p">(</span><span class="nv">$kanjiData</span><span class="p">)</span>
	<span class="o">-&gt;</span><span class="na">addHanziSegment</span><span class="p">(</span><span class="nv">$hanziData</span><span class="p">)</span>
	<span class="o">-&gt;</span><span class="na">addByteSegment</span><span class="p">(</span><span class="nv">$binaryData</span><span class="p">)</span>
	<span class="o">-&gt;</span><span class="na">addEciSegment</span><span class="p">(</span><span class="nx">ECICharset</span><span class="o">::</span><span class="na">GB18030</span><span class="p">,</span> <span class="nv">$encodedEciData</span><span class="p">)</span>
<span class="p">;</span>

<span class="nv">$output</span> <span class="o">=</span> <span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">();</span>
<span class="c1">// render to file</span>
<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">render</span><span class="p">(</span><span class="k">null</span><span class="p">,</span> <span class="s1">&#39;/path/to/qrcode.svg&#39;</span><span class="p">);</span>
</pre></div>
</div>
<p>The <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRDataModeInterface.php"><code class="docutils literal notranslate"><span class="pre">QRDataModeInterface</span></code></a> offers the <code class="docutils literal notranslate"><span class="pre">validateString()</span></code> method (implemended for <code class="docutils literal notranslate"><span class="pre">AlphaNum</span></code>, <code class="docutils literal notranslate"><span class="pre">Byte</span></code>, <code class="docutils literal notranslate"><span class="pre">Hanzi</span></code>, <code class="docutils literal notranslate"><span class="pre">Kanji</span></code> and <code class="docutils literal notranslate"><span class="pre">Number</span></code>).
This method is used internally when a data mode is invoked, but it can come in handy if you need to check input data beforehand.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">Hanzi</span><span class="o">::</span><span class="na">validateString</span><span class="p">(</span><span class="nv">$data</span><span class="p">)){</span>
	<span class="k">throw</span> <span class="k">new</span> <span class="nx">Exception</span><span class="p">(</span><span class="s1">&#39;invalid GB2312 data&#39;</span><span class="p">);</span>
<span class="p">}</span>

<span class="nv">$qrcode</span><span class="o">-&gt;</span><span class="na">addHanziSegment</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="qr-code-reader">
<h3>QR Code reader<a class="headerlink" href="#qr-code-reader" title="Permalink to this heading"></a></h3>
<p>In some cases it might be necessary to increase the contrast of a QR Code image:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerUseImagickIfAvailable</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerIncreaseContrast</span>      <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
<span class="nv">$options</span><span class="o">-&gt;</span><span class="na">readerGrayscale</span>             <span class="o">=</span> <span class="k">true</span><span class="p">;</span>

<span class="nv">$result</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRCode</span><span class="p">(</span><span class="nv">$options</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">readFromFile</span><span class="p">(</span><span class="s1">&#39;path/to/qrcode.png&#39;</span><span class="p">);</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code> object from the <a class="reference external" href="https://github.com/chillerlan/php-qrcode/blob/main/src/Decoder/DecoderResult.php"><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></a> can be reused:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$matrix</span> <span class="o">=</span> <span class="nv">$result</span><span class="o">-&gt;</span><span class="na">getQRMatrix</span><span class="p">();</span>

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

<span class="nv">$output</span> <span class="o">=</span> <span class="p">(</span><span class="k">new</span> <span class="nx">QRCode</span><span class="p">(</span><span class="nv">$options</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">renderMatrix</span><span class="p">(</span><span class="nv">$matrix</span><span class="p">);</span>

<span class="c1">// ...output</span>
</pre></div>
</div>
</section>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="Usage-Quickstart.html" class="btn btn-neutral float-left" title="Quickstart" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="API-QRCode.html" class="btn btn-neutral float-right" title="QRCode" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2023, smiley.</p>
  </div>

   
</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>