mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-25 00:17:55 +00:00
codemasher
3115 lines
138 KiB
HTML
3115 lines
138 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="">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">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
QROptions
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <abbr title="\chillerlan\Settings\SettingsContainerAbstract">SettingsContainerAbstract</abbr>
|
|
</span>
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
uses
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html"><abbr title="\chillerlan\QRCode\QROptionsTrait">QROptionsTrait</abbr></a>, <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html"><abbr title="\chillerlan\QRCode\QRCodeReaderOptionsTrait">QRCodeReaderOptionsTrait</abbr></a> </span>
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptions.php"><a href="files/src-qroptions.html"><abbr title="src/QROptions.php">QROptions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">19</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The QRCode settings container</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/chillerlan-QRCode-QROptions.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-properties">
|
|
Properties
|
|
<a href="classes/chillerlan-QRCode-QROptions.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Toggles logo space creation</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Add a "quiet zone" (margin) according to the QR code spec</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets the image background color (if applicable)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
|
|
<span>
|
|
: string|null </span>
|
|
</dt>
|
|
<dd>Optional cache file path `/path/to/cache.file`</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
|
|
<span>
|
|
: float </span>
|
|
</dt>
|
|
<dd>Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>A common css class</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Specify whether to draw the modules as filled circles</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to draw the light (false) modules</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Error correct level</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Newline string</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
|
|
<span>
|
|
: array<string|int, int> </span>
|
|
</dt>
|
|
<dd>Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale">$gdImageUseUpscale</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
|
|
`QROptions::$scale` is less than 20</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Toggle transparency</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Imagick output format</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to invert the matrix (reflectance reversal)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags">$jsonFlags</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Sets the flags to use for the `json_encode()` call</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
|
|
<span>
|
|
: array<string|int, int> </span>
|
|
</dt>
|
|
<dd>Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
|
|
<span>
|
|
: int|null </span>
|
|
</dt>
|
|
<dd>Height of the logo space</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
|
|
<span>
|
|
: int|null </span>
|
|
</dt>
|
|
<dd>Optional horizontal start position of the logo space (top left corner)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
|
|
<span>
|
|
: int|null </span>
|
|
</dt>
|
|
<dd>Optional vertical start position of the logo space (top left corner)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
|
|
<span>
|
|
: int|null </span>
|
|
</dt>
|
|
<dd>Width of the logo space</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Mask Pattern to use (no value in using, mostly for unit testing purposes, will cause unreadable symbols)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
|
|
<span>
|
|
: array<int, mixed> </span>
|
|
</dt>
|
|
<dd>Module values map</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Toggle base64 data URI or raw data output (if applicable)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The FQCN of the `QROutputInterface` to use</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Compression quality</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Size of the quiet zone</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Grayscale the image before reading.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Increase the contrast before reading.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Invert the colors of the image.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Use Imagick when reading QR Codes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Return the image resource instead of a render if applicable.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Pixel size of a QR code module</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Anything in the SVG `<defs>` tag</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Sets the value for the "preserveAspectRatio" on the `<svg>` element</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes">$svgUseFillAttributes</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to use the SVG `fill` attributes</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>An optional line prefix, e.g. empty space to align the QR Code in a console</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>QR Code version number</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet">$xmlStylesheet</a>
|
|
<span>
|
|
: string|null </span>
|
|
</dt>
|
|
<dd>Sets an optional XSLT stylesheet in the XML output</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Maximum QR version</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Minimum QR version</dd>
|
|
|
|
</dl>
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCode-QROptions.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
|
|
<span>
|
|
: int|null </span>
|
|
</dt>
|
|
<dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/chillerlan-QRCode-QROptions.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_addLogoSpace">
|
|
$addLogoSpace
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">300</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Toggles logo space creation</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$addLogoSpace</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_addLogoSpace_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_addMatrixModifications"><abbr title="\chillerlan\QRCode\QRCode::addMatrixModifications()">QRCode::addMatrixModifications()</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace"><abbr title="\chillerlan\QRCode\Data\QRMatrix::setLogoSpace()">QRMatrix::setLogoSpace()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_addQuietzone">
|
|
$addQuietzone
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">127</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add a "quiet zone" (margin) according to the QR code spec</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$addQuietzone</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_addQuietzone_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_bgColor">
|
|
$bgColor
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">202</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">$bgColor</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><ul>
|
|
<li><code class="prettyprint">QRImagick</code>: defaults to <code class="prettyprint">"white"</code></li>
|
|
<li><code class="prettyprint">QRGdImage</code>: defaults to <code class="prettyprint">[255, 255, 255]</code></li>
|
|
<li><code class="prettyprint">QRFpdf</code>: defaults to blank internally (white page)</li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_cachefile">
|
|
$cachefile
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">172</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Optional cache file path `/path/to/cache.file`</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string|null</span>
|
|
<span class="phpdocumentor-signature__name">$cachefile</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Please note that the <code class="prettyprint">$file</code> parameter in <code class="prettyprint">QRCode::render()</code> and <code class="prettyprint">QRCode::renderMatrix()</code>
|
|
takes precedence over the <code class="prettyprint">QROptions::$cachefile</code> value. (default: <code class="prettyprint">null</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_cachefile_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_render"><abbr title="\chillerlan\QRCode\QRCode::render()">QRCode::render()</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix"><abbr title="\chillerlan\QRCode\QRCode::renderMatrix()">QRCode::renderMatrix()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_circleRadius">
|
|
$circleRadius
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">241</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">float</span>
|
|
<span class="phpdocumentor-signature__name">$circleRadius</span>
|
|
= <span class="phpdocumentor-signature__default-value">0.45</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: 0.45)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_connectPaths">
|
|
$connectPaths
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">270</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$connectPaths</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>This option is exclusive to output classes that use the module collector <code class="prettyprint">QROutputAbstract::collectModules()</code>,
|
|
which converts the <code class="prettyprint">$M_TYPE</code> of all modules to <code class="prettyprint">QRMatrix::M_DATA</code> and <code class="prettyprint">QRMatrix::M_DATA_DARK</code> respectively.</p>
|
|
<p>Module types that should not be added to the connected path can be excluded via <code class="prettyprint">QROptions::$excludeFromConnect</code>.</p>
|
|
<p>Currentty used in <code class="prettyprint">QREps</code> and <code class="prettyprint">QRMarkupSVG</code>.</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_connectPaths_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::collectModules()">QROutputAbstract::collectModules()</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect"><abbr title="\chillerlan\QRCode\QROptionsTrait::$excludeFromConnect">QROptionsTrait::$excludeFromConnect</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_cssClass">
|
|
$cssClass
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">431</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">A common css class</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$cssClass</span>
|
|
= <span class="phpdocumentor-signature__default-value">'qrcode'</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
|
|
$drawCircularModules
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">234</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Specify whether to draw the modules as filled circles</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$drawCircularModules</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>a note for <code class="prettyprint">GdImage</code> output:</p>
|
|
<p>if <code class="prettyprint">QROptions::$scale</code> is less than 20, the image will be upscaled internally, then the modules will be drawn
|
|
using <code class="prettyprint">imagefilledellipse()</code> and then scaled back to the expected size</p>
|
|
<p>No effect in: <code class="prettyprint">QREps</code>, <code class="prettyprint">QRFpdf</code>, <code class="prettyprint">QRMarkupHTML</code></p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_drawCircularModules_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagefilledellipse()">imagefilledellipse()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/122">https://github.com/chillerlan/php-qrcode/discussions/122</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_drawLightModules">
|
|
$drawLightModules
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">218</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to draw the light (false) modules</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$drawLightModules</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_eccLevel">
|
|
$eccLevel
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">85</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Error correct level</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$eccLevel</span>
|
|
= <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>the constant <code class="prettyprint">EccLevel::X</code> where <code class="prettyprint">X</code> is:</p>
|
|
<ul>
|
|
<li><code class="prettyprint">L</code> => 7% (default)</li>
|
|
<li><code class="prettyprint">M</code> => 15%</li>
|
|
<li><code class="prettyprint">Q</code> => 25%</li>
|
|
<li><code class="prettyprint">H</code> => 30%</li>
|
|
</ul>
|
|
<p>alternatively you can just pass the letters L/M/Q/H (case-insensitive) to the magic setter</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_eccLevel_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/160">https://github.com/chillerlan/php-qrcode/discussions/160</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
<p class="phpdocumentor-summary">sets the ECC level</p>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$eccLevel</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int|string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_eol">
|
|
$eol
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">188</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Newline string</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$eol</span>
|
|
= <span class="phpdocumentor-signature__default-value">\PHP_EOL</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: <code class="prettyprint">PHP_EOL</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
|
|
$excludeFromConnect
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">279</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, int></span>
|
|
<span class="phpdocumentor-signature__name">$excludeFromConnect</span>
|
|
= <span class="phpdocumentor-signature__default-value">[]</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_excludeFromConnect_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths"><abbr title="\chillerlan\QRCode\QROptionsTrait::$connectPaths">QROptionsTrait::$connectPaths</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
|
|
$fpdfMeasureUnit
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">501</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
|
|
= <span class="phpdocumentor-signature__default-value">'pt'</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_fpdfMeasureUnit_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\FPDF::__construct()">FPDF::__construct()</abbr></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_gdImageUseUpscale">
|
|
$gdImageUseUpscale
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">408</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
|
|
`QROptions::$scale` is less than 20</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$gdImageUseUpscale</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_gdImageUseUpscale_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage"><abbr title="\chillerlan\QRCode\Output\QRGdImage::createImage()">QRGdImage::createImage()</abbr></a></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_imageTransparent">
|
|
$imageTransparent
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">362</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Toggle transparency</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$imageTransparent</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><ul>
|
|
<li><code class="prettyprint">QRGdImage</code> and <code class="prettyprint">QRImagick</code>: the given <code class="prettyprint">QROptions::$transparencyColor</code> is set as transparent</li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_imageTransparent_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/121">https://github.com/chillerlan/php-qrcode/discussions/121</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_imagickFormat">
|
|
$imagickFormat
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">421</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Imagick output format</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$imagickFormat</span>
|
|
= <span class="phpdocumentor-signature__default-value">'png32'</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_imagickFormat_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_invertMatrix">
|
|
$invertMatrix
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">211</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to invert the matrix (reflectance reversal)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$invertMatrix</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: <code class="prettyprint">false</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_invertMatrix_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert"><abbr title="\chillerlan\QRCode\Data\QRMatrix::invert()">QRMatrix::invert()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_jsonFlags">
|
|
$jsonFlags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">489</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the flags to use for the `json_encode()` call</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$jsonFlags</span>
|
|
= <span class="phpdocumentor-signature__default-value">\JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_jsonFlags_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://www.php.net/manual/json.constants.php">https://www.php.net/manual/json.constants.php</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
|
|
$keepAsSquare
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">254</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, int></span>
|
|
<span class="phpdocumentor-signature__name">$keepAsSquare</span>
|
|
= <span class="phpdocumentor-signature__default-value">[]</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: <code class="prettyprint">[]</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
|
|
$logoSpaceHeight
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">318</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Height of the logo space</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int|null</span>
|
|
<span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>if only <code class="prettyprint">QROptions::$logoSpaceHeight</code> is given, the logo space is assumed a square of that size</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
|
|
$logoSpaceStartX
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">327</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Optional horizontal start position of the logo space (top left corner)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int|null</span>
|
|
<span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
|
|
$logoSpaceStartY
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">336</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Optional vertical start position of the logo space (top left corner)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int|null</span>
|
|
<span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
|
|
$logoSpaceWidth
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">307</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Width of the logo space</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int|null</span>
|
|
<span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>if only <code class="prettyprint">QROptions::$logoSpaceWidth</code> is given, the logo space is assumed a square of that size</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_maskPattern">
|
|
$maskPattern
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">120</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes, will cause unreadable symbols)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$maskPattern</span>
|
|
= <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p><code class="prettyprint">0 ... 7</code> or <code class="prettyprint">MaskPattern::PATTERN_AUTO</code> (default)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_maskPattern_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_moduleValues">
|
|
$moduleValues
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">292</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Module values map</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">array<int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$moduleValues</span>
|
|
= <span class="phpdocumentor-signature__default-value">[]</span></code>
|
|
|
|
<section class="phpdocumentor-description"><ul>
|
|
<li><code class="prettyprint">QRImagick</code>, <code class="prettyprint">QRMarkupHTML</code>, <code class="prettyprint">QRMarkupSVG</code>: #ABCDEF, cssname, rgb(), rgba()...</li>
|
|
<li><code class="prettyprint">QREps</code>, <code class="prettyprint">QRFpdf</code>, <code class="prettyprint">QRGdImage</code>: <code class="prettyprint">[R, G, B]</code> // 0-255</li>
|
|
<li><code class="prettyprint">QREps</code>: <code class="prettyprint">[C, M, Y, K]</code> // 0-255</li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_moduleValues_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::setModuleValues()">QROutputAbstract::setModuleValues()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_outputBase64">
|
|
$outputBase64
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">181</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Toggle base64 data URI or raw data output (if applicable)</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$outputBase64</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_outputBase64_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()">QROutputAbstract::toBase64DataURI()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_outputInterface">
|
|
$outputInterface
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">147</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The FQCN of the `QROutputInterface` to use</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$outputInterface</span>
|
|
= <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QRMarkupSVG::class</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_quality">
|
|
$quality
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">394</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Compression quality</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$quality</span>
|
|
= <span class="phpdocumentor-signature__default-value">-1</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>The given value depends on the used output type:</p>
|
|
<ul>
|
|
<li><code class="prettyprint">QRGdImageBMP</code>: <code class="prettyprint">[0...1]</code></li>
|
|
<li><code class="prettyprint">QRGdImageJPEG</code>: <code class="prettyprint">[0...100]</code></li>
|
|
<li><code class="prettyprint">QRGdImageWEBP</code>: <code class="prettyprint">[0...9]</code></li>
|
|
<li><code class="prettyprint">QRGdImagePNG</code>: <code class="prettyprint">[0...100]</code></li>
|
|
<li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">[0...100]</code></li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_quality_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagebmp()">imagebmp()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagejpeg()">imagejpeg()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagepng()">imagepng()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagewebp()">imagewebp()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageCompressionQuality()">Imagick::setImageCompressionQuality()</abbr></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
|
|
$quietzoneSize
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">134</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Size of the quiet zone</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$quietzoneSize</span>
|
|
= <span class="phpdocumentor-signature__default-value">4</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>internally clamped to <code class="prettyprint">0 ... $moduleCount / 2</code> (default: 4)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
|
|
$readerGrayscale
|
|
<a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">35</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Grayscale the image before reading.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$readerGrayscale</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
|
|
$readerIncreaseContrast
|
|
<a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">47</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Increase the contrast before reading.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Note that applying contrast works different in GD and Imagick, so mileage may vary.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_readerInvertColors">
|
|
$readerInvertColors
|
|
<a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">40</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Invert the colors of the image.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$readerInvertColors</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
|
|
$readerUseImagickIfAvailable
|
|
<a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">26</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Use Imagick when reading QR Codes.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Enables Imagick for the QR Code reader if the extension is available.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_returnResource">
|
|
$returnResource
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">161</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$returnResource</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><ul>
|
|
<li><code class="prettyprint">QRGdImage</code>: <code class="prettyprint">GdImage</code></li>
|
|
<li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">Imagick</code></li>
|
|
<li><code class="prettyprint">QRFpdf</code>: <code class="prettyprint">FPDF</code></li>
|
|
</ul>
|
|
<p>This option overrides/ignores other output settings, such as <code class="prettyprint">QROptions::$cachefile</code>
|
|
and <code class="prettyprint">QROptions::$outputBase64</code>. (default: <code class="prettyprint">false</code>)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_returnResource_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::dump()">QROutputInterface::dump()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_scale">
|
|
$scale
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">349</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Pixel size of a QR code module</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$scale</span>
|
|
= <span class="phpdocumentor-signature__default-value">5</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_svgAddXmlHeader">
|
|
$svgAddXmlHeader
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">443</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$svgAddXmlHeader</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p><code class="prettyprint"><?xml version="1.0" encoding="UTF-8"?></code></p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_svgDefs">
|
|
$svgDefs
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">450</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Anything in the SVG `<defs>` tag</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$svgDefs</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_svgDefs_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
|
|
$svgPreserveAspectRatio
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">457</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the value for the "preserveAspectRatio" on the `<svg>` element</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
|
|
= <span class="phpdocumentor-signature__default-value">'xMidYMid'</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_svgPreserveAspectRatio_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_svgUseFillAttributes">
|
|
$svgUseFillAttributes
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">467</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to use the SVG `fill` attributes</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$svgUseFillAttributes</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>If set to <code class="prettyprint">true</code> (default), the <code class="prettyprint">fill</code> attribute will be set with the module value for the <code class="prettyprint"><path></code> element's <code class="prettyprint">$M_TYPE</code>.
|
|
When set to <code class="prettyprint">false</code>, the module values map will be ignored and the QR Code may be styled via CSS.</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_svgUseFillAttributes_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_textLineStart">
|
|
$textLineStart
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">477</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">An optional line prefix, e.g. empty space to align the QR Code in a console</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$textLineStart</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_transparencyColor">
|
|
$transparencyColor
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">375</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">$transparencyColor</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Defaults to <code class="prettyprint">QROptions::$bgColor</code>.</p>
|
|
<ul>
|
|
<li><code class="prettyprint">QRGdImage</code>: <code class="prettyprint">[R, G, B]</code>, this color is set as transparent in <code class="prettyprint">imagecolortransparent()</code></li>
|
|
<li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">"color_str"</code>, this color is set in <code class="prettyprint">Imagick::transparentPaintImage()</code></li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_transparencyColor_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\imagecolortransparent()">imagecolortransparent()</abbr></span>
|
|
|
|
</dd>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_version">
|
|
$version
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">42</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">QR Code version number</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$version</span>
|
|
= <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p><code class="prettyprint">1 ... 40</code> or <code class="prettyprint">Version::AUTO</code> (default)</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_version_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_xmlStylesheet">
|
|
$xmlStylesheet
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">523</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets an optional XSLT stylesheet in the XML output</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string|null</span>
|
|
<span class="phpdocumentor-signature__name">$xmlStylesheet</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="property_xmlStylesheet_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet_tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/XSLT">https://developer.mozilla.org/en-US/docs/Web/XSLT</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_versionMax">
|
|
$versionMax
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Maximum QR version</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$versionMax</span>
|
|
= <span class="phpdocumentor-signature__default-value">40</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 40)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_versionMin">
|
|
$versionMin
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">53</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Minimum QR version</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$versionMin</span>
|
|
= <span class="phpdocumentor-signature__default-value">1</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 1)</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Hooks</h5>
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">set</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCode-QROptions.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
|
|
clampLogoSpaceValue()
|
|
<a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">528</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$value</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int|null</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int|null</span>
|
|
</section>
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
</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="classes/chillerlan-QRCode-QROptions.html#toc-properties">Properties</a></li>
|
|
<li><a href="classes/chillerlan-QRCode-QROptions.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale">$gdImageUseUpscale</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags">$jsonFlags</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes">$svgUseFillAttributes</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet">$xmlStylesheet</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</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="classes/chillerlan-QRCode-QROptions.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>
|