mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-24 23:37:54 +00:00
codemasher
502 lines
34 KiB
HTML
502 lines
34 KiB
HTML
<!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>QRCode — 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="QROptions" href="API-QROptions.html" />
|
||
<link rel="prev" title="QRString" href="Built-In-Output-QRString.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>
|
||
<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 & 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"><a class="reference internal" href="Usage-Advanced-usage.html">Advanced usage</a><ul>
|
||
<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>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#load-and-save-json">Load and save JSON</a></li>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#save-to-file">Save to file</a></li>
|
||
<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>
|
||
<li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#mixed-mode">Mixed mode</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Usage-Advanced-usage.html#qr-code-reader">QR Code reader</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Built-In Output Modules</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QREps.html">QREps</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRFpdf.html">QRFpdf</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRGdImage.html">QRGdImage</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRImagick.html">QRImagick</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html">QRMarkupHTML</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html">QRMarkupSVG</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="Built-In-Output-QRString.html">QRString</a><ul>
|
||
<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>
|
||
<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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Public API</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">QRCode</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#deprecated-methods">Deprecated methods</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#constants">Constants</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#deprecated-constants">Deprecated constants</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="API-QROptions.html">QROptions</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">QROutputInterface</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">QRMatrix</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">DecoderResult</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-Terminology.html">Terminology</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#qr-code">QR Code</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#matrix">Matrix</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#module">Module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version">Version</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#function-patterns">Function Patterns</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#finder-pattern">Finder Pattern</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#alignment-pattern">Alignment Pattern</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#timing-pattern">Timing Pattern</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#separators">Separators</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#quiet-zone">Quiet Zone</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#encoding-region">Encoding Region</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#data">Data</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#version-information">Version Information</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#format-information">Format Information</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#darkmodule">Darkmodule</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#mode">Mode</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#segment">Segment</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#extended-channel-interpretation-eci">Extended Channel Interpretation (ECI)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mixed-mode">Mixed Mode</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#ecc-error-correction-coding">ECC (Error Correction Coding)</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#ecc-level">ECC Level</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#maximum-data-capacity">Maximum data capacity</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.html#data-masking">Data masking</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#evaluation">Evaluation</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Appendix-Terminology.html#mask-pattern">Mask pattern</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="Appendix-Terminology.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">QRCode</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QRCode.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="qrcode">
|
||
<h1>QRCode<a class="headerlink" href="#qrcode" title="Permalink to this heading"></a></h1>
|
||
<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>
|
||
<section id="methods">
|
||
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this heading"></a></h2>
|
||
<!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>method</p></th>
|
||
<th class="head"><p>return</p></th>
|
||
<th class="head"><p>description</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__construct(SettingsContainerInterface $options = null)</span></code></p></td>
|
||
<td><p>-</p></td>
|
||
<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>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Sets an options instance, internally called via the constructor</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
||
<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>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
||
<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>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getQRMatrix()</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QRMatrix</span></code></p></td>
|
||
<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>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds a <code class="docutils literal notranslate"><span class="pre">QRDataModeInterface</span></code> segment</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">clearSegments()</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Clears the data segments array</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds a numeric data segment</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds an alphanumeric data segment</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds an 8-bit byte data segment</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds a standalone ECI designator</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">self</span></code></p></td>
|
||
<td><p>Adds an ECI data segment (including designator)</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
|
||
<td><p>Reads a QR Code from a given file</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
|
||
<td><p>Reads a QR Code from the given data blob</p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DecoderResult</span></code></p></td>
|
||
<td><p>Reads a QR Code from the given luminance source</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<section id="deprecated-methods">
|
||
<h3>Deprecated methods<a class="headerlink" href="#deprecated-methods" title="Permalink to this heading"></a></h3>
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>method</p></th>
|
||
<th class="head"><p>since</p></th>
|
||
<th class="head"><p>replacement</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">getMatrix()</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QRCode::getQRMatrix()</span></code></p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Number::validateString(string</span> <span class="pre">$string)</span></code></p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">AlphaNum::validateString(string</span> <span class="pre">$string)</span></code></p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Kanji::validateString(string</span> <span class="pre">$string)</span></code></p></td>
|
||
</tr>
|
||
<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>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Byte::validateString(string</span> <span class="pre">$string)</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</section>
|
||
<section id="constants">
|
||
<h2>Constants<a class="headerlink" href="#constants" title="Permalink to this heading"></a></h2>
|
||
<section id="deprecated-constants">
|
||
<h3>Deprecated constants<a class="headerlink" href="#deprecated-constants" title="Permalink to this heading"></a></h3>
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>name</p></th>
|
||
<th class="head"><p>since</p></th>
|
||
<th class="head"><p>replacement</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">VERSION_AUTO</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MASK_PATTERN_AUTO</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_MARKUP_SVG</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_SVG</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_MARKUP_HTML</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_HTML</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_PNG</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_PNG</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_JPG</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_JPG</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGE_GIF</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::GDIMAGE_GIF</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_STRING_JSON</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_JSON</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_STRING_TEXT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::STRING_TEXT</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_IMAGICK</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::IMAGICK</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_FPDF</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::FPDF</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OUTPUT_CUSTOM</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::CUSTOM</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_L</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::L</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_M</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::M</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_Q</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::Q</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ECC_H</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::H</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_NUMBER</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Mode::NUMBER</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_ALPHANUM</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Mode::ALPHANUM</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_BYTE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Mode::BYTE</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DATA_KANJI</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5.0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">Mode::KANJI</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<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>
|
||
<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>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, smiley.</p>
|
||
</div>
|
||
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |