|
|
@@ -1,691 +0,0 @@
|
|
|
-<!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>QROptions — 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?v=5d32c60e"></script>
|
|
|
- <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
|
- <script src="_static/documentation_options.js?v=a8da1a53"></script>
|
|
|
- <script src="_static/doctools.js?v=888ff710"></script>
|
|
|
- <script src="_static/sphinx_highlight.js?v=dc90522c"></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="QROutputInterface" href="API-QROutputInterface.html" />
|
|
|
- <link rel="prev" title="QRCode" href="API-QRCode.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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QREps.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRFpdf.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRGdImage.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRImagick.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupHTML.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#example">Example</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRMarkupSVG.html#additional-methods">Additional methods</a></li>
|
|
|
-<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#plain-text">Plain text</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#json">JSON</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Built-In-Output-QRString.html#additional-methods">Additional methods</a></li>
|
|
|
-<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"><a class="reference internal" href="API-QRCode.html">QRCode</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 current"><a class="current reference internal" href="#">QROptions</a><ul>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="#methods">Methods</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="#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-URI-Content.html">Popular content and URI schemes</a><ul>
|
|
|
-<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>
|
|
|
-<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>
|
|
|
-<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>
|
|
|
-<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>
|
|
|
-<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>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#wireless-network-configuration">Wireless Network configuration</a></li>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#contact-information-vcard">Contact information: vCard</a></li>
|
|
|
-<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>
|
|
|
-<li class="toctree-l2"><a class="reference internal" href="Appendix-URI-Content.html#see-also">See also</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">QROptions</li>
|
|
|
- <li class="wy-breadcrumbs-aside">
|
|
|
- <a href="https://github.com/chillerlan/php-qrcode/blob/main/docs/API-QROptions.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="qroptions">
|
|
|
-<h1>QROptions<a class="headerlink" href="#qroptions" title="Link to this heading"></a></h1>
|
|
|
-<p>(via <code class="docutils literal notranslate"><span class="pre">QROptionsTrait</span></code>)</p>
|
|
|
-<p>The full phpDocumentor API documentation can be found at <a class="reference external" href="https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-QROptions.html">chillerlan.github.io/php-qrcode</a>.</p>
|
|
|
-<section id="methods">
|
|
|
-<h2>Methods<a class="headerlink" href="#methods" title="Link to this heading"></a></h2>
|
|
|
-<p>Inherited from <a class="reference external" href="https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerAbstract.php"><code class="docutils literal notranslate"><span class="pre">SettingsContainerAbstract</span></code></a></p>
|
|
|
-<!-- 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>info</p></th>
|
|
|
-</tr>
|
|
|
-</thead>
|
|
|
-<tbody>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__construct(iterable $properties = null)</span></code></p></td>
|
|
|
-<td><p>-</p></td>
|
|
|
-<td><p>calls <code class="docutils literal notranslate"><span class="pre">construct()</span></code> internally after the properties have been set</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p>(protected) <code class="docutils literal notranslate"><span class="pre">construct()</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
|
|
|
-<td><p>calls a method with trait name as replacement constructor for each used trait (similar to PHP4 constructors)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__get(string</span> <span class="pre">$property)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
|
|
-<td><p>calls <code class="docutils literal notranslate"><span class="pre">$this->{'get_'.$property}()</span></code> if such a method exists</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">__set(string</span> <span class="pre">$property,</span> <span class="pre">$value)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
|
|
|
-<td><p>calls <code class="docutils literal notranslate"><span class="pre">$this->{'set_'.$property}($value)</span></code> if such a method exists</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__isset(string</span> <span class="pre">$property)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">__unset(string</span> <span class="pre">$property)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
|
|
|
-<td><p></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">__toString()</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p>a JSON string</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">toArray()</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
|
|
|
-<td><p></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fromIterable(iterable</span> <span class="pre">$properties)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></p></td>
|
|
|
-<td><p></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">toJSON(int</span> <span class="pre">$jsonOptions</span> <span class="pre">=</span> <span class="pre">null)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p>accepts <a class="reference external" href="http://php.net/manual/json.constants.php">JSON options constants</a></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fromJSON(string</span> <span class="pre">$json)</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">SettingsContainerInterface</span></code></p></td>
|
|
|
-<td><p></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">jsonSerialize()</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
|
|
-<td><p>implements the <a class="reference external" href="https://www.php.net/manual/en/jsonserializable.jsonserialize.php"><code class="docutils literal notranslate"><span class="pre">JsonSerializable</span></code></a> interface</p></td>
|
|
|
-</tr>
|
|
|
-</tbody>
|
|
|
-</table>
|
|
|
-</section>
|
|
|
-<section id="properties">
|
|
|
-<h2>Properties<a class="headerlink" href="#properties" title="Link to this heading"></a></h2>
|
|
|
-<table class="docutils align-default">
|
|
|
-<thead>
|
|
|
-<tr class="row-odd"><th class="head"><p>property</p></th>
|
|
|
-<th class="head"><p>type</p></th>
|
|
|
-<th class="head"><p>default</p></th>
|
|
|
-<th class="head"><p>allowed</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">$version</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<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">1...40</span></code>, <code class="docutils literal notranslate"><span class="pre">Version::AUTO</span></code></p></td>
|
|
|
-<td><p><a class="reference external" href="http://www.qrcode.com/en/about/version.html">QR Code version number</a></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$versionMin</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">1...40</span></code></p></td>
|
|
|
-<td><p>Minimum QR version (if <code class="docutils literal notranslate"><span class="pre">$version</span> <span class="pre">=</span> <span class="pre">QRCode::VERSION_AUTO</span></code>)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$versionMax</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">40</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">1...40</span></code></p></td>
|
|
|
-<td><p>Maximum QR version (if <code class="docutils literal notranslate"><span class="pre">$version</span> <span class="pre">=</span> <span class="pre">QRCode::VERSION_AUTO</span></code>)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$eccLevel</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::L</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">EccLevel::X</span></code></p></td>
|
|
|
-<td><p>Error correct level, where X = L (7%), M (15%), Q (25%), H (30%)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$maskPattern</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">0...7</span></code>, <code class="docutils literal notranslate"><span class="pre">MaskPattern::AUTO</span></code></p></td>
|
|
|
-<td><p>Mask Pattern to use</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$addQuietzone</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Add a “quiet zone” (margin) according to the QR code spec</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$quietzoneSize</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
|
|
-<td><p>clamped to <code class="docutils literal notranslate"><span class="pre">0...($matrixSize</span> <span class="pre">/</span> <span class="pre">2)</span></code></p></td>
|
|
|
-<td><p>Size of the quiet zone</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$outputType</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::MARKUP_SVG</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">QROutputInterface::XXX</span></code></p></td>
|
|
|
-<td><p>The built-in output type, XXX can be one of: <code class="docutils literal notranslate"><span class="pre">MARKUP_HTML</span></code>, <code class="docutils literal notranslate"><span class="pre">MARKUP_SVG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_PNG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_JPG</span></code>, <code class="docutils literal notranslate"><span class="pre">GDIMAGE_GIF</span></code>, <code class="docutils literal notranslate"><span class="pre">STRING_TEXT</span></code>, <code class="docutils literal notranslate"><span class="pre">STRING_JSON</span></code>, <code class="docutils literal notranslate"><span class="pre">IMAGICK</span></code>, <code class="docutils literal notranslate"><span class="pre">EPS</span></code>, <code class="docutils literal notranslate"><span class="pre">FPDF</span></code>, <code class="docutils literal notranslate"><span class="pre">CUSTOM</span></code></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$outputInterface</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>The FQCN of the custom <code class="docutils literal notranslate"><span class="pre">QROutputInterface</span></code> if <code class="docutils literal notranslate"><span class="pre">QROptions::$outputType</span></code> is set to <code class="docutils literal notranslate"><span class="pre">QROutputInterface::CUSTOM</span></code></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$returnResource</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Return the image resource instead of a render if applicable.</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$cachefile</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Optional cache file path</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$outputBase64</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Toggle base64 data URI or raw data output (if applicable)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$eol</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">PHP_EOL</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Newline string (HTML, SVG, TEXT)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$bgColor</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>a valid FPDF, GD or Imagick color value</p></td>
|
|
|
-<td><p>Sets the image background color (if applicable). QRImagick: defaults to “white”, QRGdImage: defaults to [255, 255, 255], QRFpdf: defaults to blank internally (white page)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$drawLightModules</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Whether to draw the light (false) modules</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$drawCircularModules</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Specify whether to draw the modules as filled circles</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$circleRadius</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">0.45</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">0.1...0.75</span></code></p></td>
|
|
|
-<td><p>Specifies the radius of the modules when $svgDrawCircularModules is set to true</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$keepAsSquare</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">[]</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int[]</span></code></p></td>
|
|
|
-<td><p>Specifies which module types to exclude when $svgDrawCircularModules is set to true</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$connectPaths</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$excludeFromConnect</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">array</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">[]</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int[]</span></code></p></td>
|
|
|
-<td><p>Specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$moduleValues</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">array|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Module values map, see [[Custom module values]]</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$addLogoSpace</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Toggles logo space creation</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceWidth</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Width of the logo space</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceHeight</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Height of the logo space</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceStartX</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Optional horizontal start position of the logo space (top left corner)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$logoSpaceStartY</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Optional vertical start position of the logo space (top left corner)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$scale</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">5</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Pixel size of a QR code module</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$imageTransparent</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Toggle transparency (no jpeg support), QRGdImage and QRImagick only. The given <code class="docutils literal notranslate"><span class="pre">QROptions::$transparencyColor</span></code> is set as transparent</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$transparencyColor</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">mixed</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>a valid GD or Imagick color value</p></td>
|
|
|
-<td><p>Sets a transparency color for when <code class="docutils literal notranslate"><span class="pre">QROptions::$imageTransparent</span></code> is set to true. Defaults to <code class="docutils literal notranslate"><span class="pre">QROptions::$bgColor</span></code>.</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$quality</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">-1</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>compression quality setting for <code class="docutils literal notranslate"><span class="pre">imagejpeg()</span></code>, <code class="docutils literal notranslate"><span class="pre">imagepng()</span></code>, <code class="docutils literal notranslate"><span class="pre">imagewebp()</span></code>, <code class="docutils literal notranslate"><span class="pre">Imagick::setImageCompressionQuality()</span></code></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$imagickFormat</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'png'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>ImageMagick output type, see <code class="docutils literal notranslate"><span class="pre">Imagick::setType()</span></code></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$cssClass</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'qrcode'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>A common css class</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$markupDark</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'#000'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Markup substitute for dark (CSS value)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$markupLight</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'#fff'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Markup substitute for light (CSS value)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgAddXmlHeader</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgOpacity</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">1.0</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">0...1</span></code></p></td>
|
|
|
-<td><p>SVG opacity</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgDefs</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Anything in the <a class="reference external" href="https://developer.mozilla.org/docs/Web/SVG/Element/defs"><code class="docutils literal notranslate"><span class="pre"><defs></span></code></a> tag</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgViewBoxSize</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">int|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>SVG viewBox size. A single integer number which defines width/height of the <a class="reference external" href="https://css-tricks.com/scale-svg/#article-header-id-3">viewBox attribute</a> <code class="docutils literal notranslate"><span class="pre">viewBox="0</span> <span class="pre">0</span> <span class="pre">x</span> <span class="pre">x"</span></code>.</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgPreserveAspectRatio</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'xMidYMid'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>See <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">preserveAspectRatio on MDN</a></p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$svgWidth</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Optional “width” attribute with the specified value (note that the value is not checked!)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$svgHeight</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string|null</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Optional “height” attribute with the specified value (note that the value is not checked!)</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$textDark</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'██'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>String substitute for dark</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$textLight</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'░░'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>String substitute for light</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$textLineStart</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>An optional line prefix, e.g. empty space to align the QR Code in a console</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$jsonAsBooleans</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Whether to return matrix values in JSON as booleans or $M_TYPE integers</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$fpdfMeasureUnit</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">'pt'</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Measurement unit for FPDF output: pt, mm, cm, in</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$readerUseImagickIfAvailable</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Use Imagick (if available) when reading QR Codes</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$readerGrayscale</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Grayscale the image before reading</p></td>
|
|
|
-</tr>
|
|
|
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$readerIncreaseContrast</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
|
|
-<td><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
|
|
|
-<td><p>*</p></td>
|
|
|
-<td><p>Increase the contrast before reading</p></td>
|
|
|
-</tr>
|
|
|
-</tbody>
|
|
|
-</table>
|
|
|
-</section>
|
|
|
-</section>
|
|
|
-
|
|
|
-
|
|
|
- </div>
|
|
|
- </div>
|
|
|
- <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
|
- <a href="API-QRCode.html" class="btn btn-neutral float-left" title="QRCode" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
|
- <a href="API-QROutputInterface.html" class="btn btn-neutral float-right" title="QROutputInterface" 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>
|
codemasher