mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-24 12:57:53 +00:00
247 lines
40 KiB
HTML
247 lines
40 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Documentation</title>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png"/>
|
|
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png"/>
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="apple-touch-icon" href="images/apple-touch-icon.png"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="js/template.js"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
<li class="phpdocumentor-topnav__menu-item -menu">
|
|
<a href="https://php-qrcode.readthedocs.io">
|
|
<span>
|
|
User Manual
|
|
</span>
|
|
</a>
|
|
</li>
|
|
<li class="phpdocumentor-topnav__menu-item -social">
|
|
<a href="https://github.com/chillerlan/php-qrcode">
|
|
<span>
|
|
<i class="fab fa-github"></i>
|
|
|
|
</span>
|
|
</a>
|
|
</li>
|
|
<li class="phpdocumentor-topnav__menu-item -social">
|
|
<a href="https://github.com/chillerlan/php-qrcode/discussions">
|
|
<span>
|
|
<i class="fas fa-envelope-open-text"></i>
|
|
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/chillerlan.html" class="">chillerlan</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/Application.html" class="-active">Application</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -indices">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -nine phpdocumentor-content">
|
|
<section>
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -package">
|
|
<h2 class="phpdocumentor-content__title">Application</h2>
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="packages/Application.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
<h4 id="toc-interfaces">
|
|
Interfaces
|
|
<a href="packages/Application.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Common\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></dt><dd>Interface for the luminance sources</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></dt><dd>Specifies the methods reqired for the data modules (Number, Alphanum, Byte and Kanji)</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></dt><dd>Converts the data matrix into readable output</dd> </dl>
|
|
|
|
<h4 id="toc-classes">
|
|
Classes
|
|
<a href="packages/Application.html#toc-classes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></dt><dd>Holds the raw binary data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></dt><dd>This class encapsulates the four error correction levels defined by the QR code standard.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-ECICharset.html"><abbr title="\chillerlan\QRCode\Common\ECICharset">ECICharset</abbr></a></dt><dd>ISO/IEC 18004:2000 - 8.4.1 Extended Channel Interpretation (ECI) Mode</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-GDLuminanceSource.html"><abbr title="\chillerlan\QRCode\Common\GDLuminanceSource">GDLuminanceSource</abbr></a></dt><dd>This class is used to help decode images from files which arrive as GD Resource
|
|
It does not support rotation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-GenericGFPoly.html"><abbr title="\chillerlan\QRCode\Common\GenericGFPoly">GenericGFPoly</abbr></a></dt><dd>Represents a polynomial whose coefficients are elements of a GF.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-GF256.html"><abbr title="\chillerlan\QRCode\Common\GF256">GF256</abbr></a></dt><dd>This class contains utility methods for performing mathematical operations over
|
|
the Galois Fields. Operations use a given primitive polynomial in calculations.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-IMagickLuminanceSource.html"><abbr title="\chillerlan\QRCode\Common\IMagickLuminanceSource">IMagickLuminanceSource</abbr></a></dt><dd>This class is used to help decode images from files which arrive as Imagick Resource
|
|
It does not support rotation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-LuminanceSourceAbstract.html"><abbr title="\chillerlan\QRCode\Common\LuminanceSourceAbstract">LuminanceSourceAbstract</abbr></a></dt><dd>The purpose of this class hierarchy is to abstract different bitmap implementations across
|
|
platforms into a standard interface for requesting greyscale luminance values.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></dt><dd>ISO/IEC 18004:2000 Section 8.8.1
|
|
ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-Mode.html"><abbr title="\chillerlan\QRCode\Common\Mode">Mode</abbr></a></dt><dd>Data mode information - ISO 18004:2006, 6.4.1, Tables 2 and 3</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></dt><dd>Version related tables and methods</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-AlphaNum.html"><abbr title="\chillerlan\QRCode\Data\AlphaNum">AlphaNum</abbr></a></dt><dd>Alphanumeric mode: 0 to 9, A to Z, space, $ % * + - . / :</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-Byte.html"><abbr title="\chillerlan\QRCode\Data\Byte">Byte</abbr></a></dt><dd>8-bit Byte mode, ISO-8859-1 or UTF-8</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-ECI.html"><abbr title="\chillerlan\QRCode\Data\ECI">ECI</abbr></a></dt><dd>Adds an ECI Designator</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-Hanzi.html"><abbr title="\chillerlan\QRCode\Data\Hanzi">Hanzi</abbr></a></dt><dd>Hanzi (simplified Chinese) mode, GBT18284-2000: 13-bit double-byte characters from the GB2312/GB18030 character set</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-Kanji.html"><abbr title="\chillerlan\QRCode\Data\Kanji">Kanji</abbr></a></dt><dd>Kanji mode: 13-bit double-byte characters from the Shift-JIS character set</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-Number.html"><abbr title="\chillerlan\QRCode\Data\Number">Number</abbr></a></dt><dd>Numeric mode: decimal digits 0 to 9</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></dt><dd>An exception container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-QRData.html"><abbr title="\chillerlan\QRCode\Data\QRData">QRData</abbr></a></dt><dd>Processes the binary data and maps it on a QRMatrix which is then being returned</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a></dt><dd>abstract methods for the several data modes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></dt><dd>Holds an array representation of the final QR Code that contains numerical values for later output modifications;
|
|
maps the ECC coded binary data and applies the mask pattern</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Data-ReedSolomonEncoder.html"><abbr title="\chillerlan\QRCode\Data\ReedSolomonEncoder">ReedSolomonEncoder</abbr></a></dt><dd>Reed-Solomon encoding - ISO/IEC 18004:2000 Section 8.5 ff</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-Binarizer.html"><abbr title="\chillerlan\QRCode\Decoder\Binarizer">Binarizer</abbr></a></dt><dd>This class implements a local thresholding algorithm, which while slower than the
|
|
GlobalHistogramBinarizer, is fairly efficient for what it does. It is designed for
|
|
high frequency images of barcodes with black data on white backgrounds. For this application,
|
|
it does a much better job than a global blackpoint with severe shadows and gradients.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html"><abbr title="\chillerlan\QRCode\Decoder\BitMatrix">BitMatrix</abbr></a></dt><dd>Extended QRMatrix to map read data from the Binarizer</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-Decoder.html"><abbr title="\chillerlan\QRCode\Decoder\Decoder">Decoder</abbr></a></dt><dd>The main class which implements QR Code decoding -- as opposed to locating and extracting
|
|
the QR Code from an image.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></dt><dd>Encapsulates the result of decoding a matrix of bits. This typically
|
|
applies to 2D barcode formats. For now, it contains the raw bytes obtained
|
|
as well as a String interpretation of those bytes, if applicable.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></dt><dd>An exception container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-ReedSolomonDecoder.html"><abbr title="\chillerlan\QRCode\Decoder\ReedSolomonDecoder">ReedSolomonDecoder</abbr></a></dt><dd>Implements Reed-Solomon decoding</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html"><abbr title="\chillerlan\QRCode\Detector\AlignmentPattern">AlignmentPattern</abbr></a></dt><dd>Encapsulates an alignment pattern, which are the smaller square patterns found in
|
|
all but the simplest QR Codes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-AlignmentPatternFinder.html"><abbr title="\chillerlan\QRCode\Detector\AlignmentPatternFinder">AlignmentPatternFinder</abbr></a></dt><dd>This class attempts to find alignment patterns in a QR Code. Alignment patterns look like finder
|
|
patterns but are smaller and appear at regular intervals throughout the image.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-Detector.html"><abbr title="\chillerlan\QRCode\Detector\Detector">Detector</abbr></a></dt><dd>Encapsulates logic that can detect a QR Code in an image, even if the QR Code
|
|
is rotated or skewed, or partially obscured.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a></dt><dd>Encapsulates a finder pattern, which are the three square patterns found in
|
|
the corners of QR Codes. It also encapsulates a count of similar finder patterns,
|
|
as a convenience to the finder's bookkeeping.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-FinderPatternFinder.html"><abbr title="\chillerlan\QRCode\Detector\FinderPatternFinder">FinderPatternFinder</abbr></a></dt><dd>This class attempts to find finder patterns in a QR Code. Finder patterns are the square
|
|
markers at three corners of a QR Code.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-GridSampler.html"><abbr title="\chillerlan\QRCode\Detector\GridSampler">GridSampler</abbr></a></dt><dd>Implementations of this class can, given locations of finder patterns for a QR code in an
|
|
image, sample the right points in the image to reconstruct the QR code, accounting for
|
|
perspective distortion. It is abstracted since it is relatively expensive and should be allowed
|
|
to take advantage of platform-specific optimized implementations, like Sun's Java Advanced
|
|
Imaging library, but which may not be available in other environments such as J2ME, and vice
|
|
versa.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-PerspectiveTransform.html"><abbr title="\chillerlan\QRCode\Detector\PerspectiveTransform">PerspectiveTransform</abbr></a></dt><dd>This class implements a perspective transform in two dimensions. Given four source and four
|
|
destination points, it will compute the transformation implied between them. The code is based
|
|
directly upon section 3.4.2 of George Wolberg's "Digital Image Warping"; see pages 54-56.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-QRCodeDetectorException.html"><abbr title="\chillerlan\QRCode\Detector\QRCodeDetectorException">QRCodeDetectorException</abbr></a></dt><dd>An exception container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html"><abbr title="\chillerlan\QRCode\Detector\ResultPoint">ResultPoint</abbr></a></dt><dd>Encapsulates a point of interest in an image containing a barcode. Typically, this
|
|
would be the location of a finder pattern or the corner of the barcode, for example.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></dt><dd>An exception container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QREps.html"><abbr title="\chillerlan\QRCode\Output\QREps">QREps</abbr></a></dt><dd>Encapsulated Postscript (EPS) output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRFpdf.html"><abbr title="\chillerlan\QRCode\Output\QRFpdf">QRFpdf</abbr></a></dt><dd>QRFpdf output module (requires fpdf)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a></dt><dd>Converts the matrix into GD images, raw or base64 output (requires ext-gd)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImageAVIF.html"><abbr title="\chillerlan\QRCode\Output\QRGdImageAVIF">QRGdImageAVIF</abbr></a></dt><dd>GDImage avif output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImageBMP.html"><abbr title="\chillerlan\QRCode\Output\QRGdImageBMP">QRGdImageBMP</abbr></a></dt><dd>GdImage bmp output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"><abbr title="\chillerlan\QRCode\Output\QRGdImageGIF">QRGdImageGIF</abbr></a></dt><dd>GdImage gif output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImageJPEG.html"><abbr title="\chillerlan\QRCode\Output\QRGdImageJPEG">QRGdImageJPEG</abbr></a></dt><dd>GdImage jpeg output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImagePNG.html"><abbr title="\chillerlan\QRCode\Output\QRGdImagePNG">QRGdImagePNG</abbr></a></dt><dd>GdImage png output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRGdImageWEBP.html"><abbr title="\chillerlan\QRCode\Output\QRGdImageWEBP">QRGdImageWEBP</abbr></a></dt><dd>GdImage webp output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRImagick.html"><abbr title="\chillerlan\QRCode\Output\QRImagick">QRImagick</abbr></a></dt><dd>ImageMagick output module (requires ext-imagick)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"><abbr title="\chillerlan\QRCode\Output\QRInterventionImage">QRInterventionImage</abbr></a></dt><dd>intervention/image (GD/ImageMagick) output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</abbr></a></dt><dd>Abstract for markup types: HTML, SVG, ... XML anyone?</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html"><abbr title="\chillerlan\QRCode\Output\QRMarkupHTML">QRMarkupHTML</abbr></a></dt><dd>HTML output (a cheap markup substitute when SVG is not available or not an option)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"><abbr title="\chillerlan\QRCode\Output\QRMarkupSVG">QRMarkupSVG</abbr></a></dt><dd>SVG output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"><abbr title="\chillerlan\QRCode\Output\QRMarkupXML">QRMarkupXML</abbr></a></dt><dd>XML/XSLT output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a></dt><dd>common output abstract</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html"><abbr title="\chillerlan\QRCode\Output\QRStringJSON">QRStringJSON</abbr></a></dt><dd>JSON Output</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Output-QRStringText.html"><abbr title="\chillerlan\QRCode\Output\QRStringText">QRStringText</abbr></a></dt><dd>String/plaintext output (for CLI etc.)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-QRCode.html"><abbr title="\chillerlan\QRCode\QRCode">QRCode</abbr></a></dt><dd>Turns a text string into a Model 2 QR Code</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></dt><dd>An exception container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></dt><dd>The QRCode settings container</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-BitBufferTest.html"><abbr title="\chillerlan\QRCodeTest\Common\BitBufferTest">BitBufferTest</abbr></a></dt><dd>BitBuffer coverage test</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-EccLevelTest.html"><abbr title="\chillerlan\QRCodeTest\Common\EccLevelTest">EccLevelTest</abbr></a></dt><dd>EccLevel coverage test</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-ECICharsetTest.html"><abbr title="\chillerlan\QRCodeTest\Common\ECICharsetTest">ECICharsetTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-MaskPatternTest.html"><abbr title="\chillerlan\QRCodeTest\Common\MaskPatternTest">MaskPatternTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-ModeTest.html"><abbr title="\chillerlan\QRCodeTest\Common\ModeTest">ModeTest</abbr></a></dt><dd>Mode coverage test</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Common-VersionTest.html"><abbr title="\chillerlan\QRCodeTest\Common\VersionTest">VersionTest</abbr></a></dt><dd>Version coverage test</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-AlphaNumTest.html"><abbr title="\chillerlan\QRCodeTest\Data\AlphaNumTest">AlphaNumTest</abbr></a></dt><dd>Tests the AlphaNum class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-ByteTest.html"><abbr title="\chillerlan\QRCodeTest\Data\ByteTest">ByteTest</abbr></a></dt><dd>Tests the Byte class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-DataInterfaceTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\Data\DataInterfaceTestAbstract">DataInterfaceTestAbstract</abbr></a></dt><dd>The data interface test abstract</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-ECITest.html"><abbr title="\chillerlan\QRCodeTest\Data\ECITest">ECITest</abbr></a></dt><dd>Tests the ECI class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-HanziTest.html"><abbr title="\chillerlan\QRCodeTest\Data\HanziTest">HanziTest</abbr></a></dt><dd>Tests the Hanzi/GB2312 class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-KanjiTest.html"><abbr title="\chillerlan\QRCodeTest\Data\KanjiTest">KanjiTest</abbr></a></dt><dd>Tests the Kanji class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-NumberTest.html"><abbr title="\chillerlan\QRCodeTest\Data\NumberTest">NumberTest</abbr></a></dt><dd>Tests the Number class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-QRDataTest.html"><abbr title="\chillerlan\QRCodeTest\Data\QRDataTest">QRDataTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Data-QRMatrixTest.html"><abbr title="\chillerlan\QRCodeTest\Data\QRMatrixTest">QRMatrixTest</abbr></a></dt><dd>Tests the QRMatrix class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QREpsTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QREpsTest">QREpsTest</abbr></a></dt><dd>Tests the QREps output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRFpdfTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRFpdfTest">QRFpdfTest</abbr></a></dt><dd>Tests the QRFpdf output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageAVIFTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageAVIFTest">QRGdImageAVIFTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageBMPTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageBMPTest">QRGdImageBMPTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageGIFTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageGIFTest">QRGdImageGIFTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageJPGTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageJPGTest">QRGdImageJPGTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImagePNGTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImagePNGTest">QRGdImagePNGTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageTestAbstract">QRGdImageTestAbstract</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRGdImageWEBPTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRGdImageWEBPTest">QRGdImageWEBPTest</abbr></a></dt><dd>Tests the QRGdImage output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRImagickTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRImagickTest">QRImagickTest</abbr></a></dt><dd>Tests the QRImagick output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRInterventionImageTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRInterventionImageTest">QRInterventionImageTest</abbr></a></dt><dd>Tests the QRInterventionImage output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRMarkupHTMLTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRMarkupHTMLTest">QRMarkupHTMLTest</abbr></a></dt><dd>Tests the QRMarkup output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRMarkupSVGTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRMarkupSVGTest">QRMarkupSVGTest</abbr></a></dt><dd>Tests the QRMarkup output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRMarkupTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\Output\QRMarkupTestAbstract">QRMarkupTestAbstract</abbr></a></dt><dd>Tests the QRMarkup output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRMarkupXMLTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRMarkupXMLTest">QRMarkupXMLTest</abbr></a></dt><dd>Tests the QRMarkup output classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\Output\QROutputTestAbstract">QROutputTestAbstract</abbr></a></dt><dd>Test abstract for the several (built-in) output modules,
|
|
should also be used to test custom output modules</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRStringJSONTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRStringJSONTest">QRStringJSONTest</abbr></a></dt><dd>Tests the QRStringJSON output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-Output-QRStringTextTest.html"><abbr title="\chillerlan\QRCodeTest\Output\QRStringTextTest">QRStringTextTest</abbr></a></dt><dd>Tests the QRStringText output class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-QRCodeReaderGDTest.html"><abbr title="\chillerlan\QRCodeTest\QRCodeReaderGDTest">QRCodeReaderGDTest</abbr></a></dt><dd>Tests the GD based reader</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-QRCodeReaderImagickTest.html"><abbr title="\chillerlan\QRCodeTest\QRCodeReaderImagickTest">QRCodeReaderImagickTest</abbr></a></dt><dd>Tests the Imagick based reader</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-QRCodeReaderTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\QRCodeReaderTestAbstract">QRCodeReaderTestAbstract</abbr></a></dt><dd>Tests the QR Code reader</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-QRCodeTest.html"><abbr title="\chillerlan\QRCodeTest\QRCodeTest">QRCodeTest</abbr></a></dt><dd>Tests basic functions of the QRCode class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html"><abbr title="\chillerlan\QRCodeTest\QROptionsTest">QROptionsTest</abbr></a></dt><dd>QROptions test</dd> </dl>
|
|
|
|
<h4 id="toc-traits">
|
|
Traits
|
|
<a href="packages/Application.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html"><abbr title="\chillerlan\QRCode\Output\CssColorModuleValueTrait">CssColorModuleValueTrait</abbr></a></dt><dd>Module value checks for output classes that use CSS colors</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html"><abbr title="\chillerlan\QRCode\Output\RGBArrayModuleValueTrait">RGBArrayModuleValueTrait</abbr></a></dt><dd>Module value checks for output classes that use RGB color arrays</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html"><abbr title="\chillerlan\QRCode\QRCodeReaderOptionsTrait">QRCodeReaderOptionsTrait</abbr></a></dt><dd>Trait QRCodeReaderOptionsTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCode-QROptionsTrait.html"><abbr title="\chillerlan\QRCode\QROptionsTrait">QROptionsTrait</abbr></a></dt><dd>The QRCode plug-in settings & setter functionality</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\BuildDirTrait">BuildDirTrait</abbr></a></dt><dd>Trait BuildDirTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCodeTest-Traits-CssColorModuleValueProviderTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\CssColorModuleValueProviderTrait">CssColorModuleValueProviderTrait</abbr></a></dt><dd>A data provider for use in tests that include CssColorModuleValueTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCodeTest-Traits-QRMatrixDebugTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\QRMatrixDebugTrait">QRMatrixDebugTrait</abbr></a></dt><dd>Trait QRMatrixDebugTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCodeTest-Traits-QRMaxLengthTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\QRMaxLengthTrait">QRMaxLengthTrait</abbr></a></dt><dd>Trait QRMaxLengthTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/chillerlan-QRCodeTest-Traits-RGBArrayModuleValueProviderTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\RGBArrayModuleValueProviderTrait">RGBArrayModuleValueProviderTrait</abbr></a></dt><dd>A data provider for use in tests that include RGBArrayModuleValueTrait</dd> </dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
|
<section class="phpdocumentor-on-this-page__content">
|
|
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="packages/Application.html#toc-interfaces">Interfaces</a></li>
|
|
<li><a href="packages/Application.html#toc-classes">Classes</a></li>
|
|
<li><a href="packages/Application.html#toc-traits">Traits</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<a href="packages/Application.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|