mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-24 11:47:50 +00:00
codemasher
629 lines
31 KiB
HTML
629 lines
31 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>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -interface">
|
|
<h2 class="phpdocumentor-content__title">
|
|
QROutputInterface
|
|
<div class="phpdocumentor-element__package">
|
|
in
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li><a href="packages/Application.html">Application</a></li>
|
|
</ul>
|
|
</div>
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">19</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Converts the data matrix into readable output</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-constants">
|
|
Constants
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a>
|
|
<span>
|
|
: array<string|int, mixed> = [ // light \chillerlan\QRCode\Data\QRMatrix::M_... </span>
|
|
</dt>
|
|
<dd>Map of module type => default value</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a>
|
|
<span>
|
|
: array<string|int, mixed> = [ // light \chillerlan\QRCode\Data\QRMatrix::M_... </span>
|
|
</dt>
|
|
<dd>Map of module type => readable name (for CSS etc.)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE">MIME_TYPE</a>
|
|
<span>
|
|
: string = '' </span>
|
|
</dt>
|
|
<dd>Note: do not call this constant from the interface, but rather from one of the child classes</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a>
|
|
<span>
|
|
: array<string|int, mixed> = [\chillerlan\QRCode\Output\QREps::class, \chill... </span>
|
|
</dt>
|
|
<dd>Map of built-in output class FQN</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.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 -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Generates the output, optionally dumps it to a file, and returns it</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Determines whether the given value is valid</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_MODULE_VALUES">
|
|
DEFAULT_MODULE_VALUES
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Map of module type => default value</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">DEFAULT_MODULE_VALUES</span>
|
|
= <span class="phpdocumentor-signature__default-value">[
|
|
// light
|
|
\chillerlan\QRCode\Data\QRMatrix::M_NULL => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DATA => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_TIMING => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FORMAT => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_VERSION => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_LOGO => false,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => false,
|
|
// dark
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK => true,
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT => true,
|
|
]</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_LAYERNAMES">
|
|
LAYERNAMES
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">83</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Map of module type => readable name (for CSS etc.)</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">LAYERNAMES</span>
|
|
= <span class="phpdocumentor-signature__default-value">[
|
|
// light
|
|
\chillerlan\QRCode\Data\QRMatrix::M_NULL => 'null',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT => 'darkmodule-light',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DATA => 'data',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER => 'finder',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR => 'separator',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT => 'alignment',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_TIMING => 'timing',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FORMAT => 'format',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_VERSION => 'version',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE => 'quietzone',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_LOGO => 'logo',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT => 'finder-dot-light',
|
|
// dark
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE => 'darkmodule',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK => 'data-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK => 'finder-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK => 'separator-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK => 'alignment-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK => 'timing-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK => 'format-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK => 'version-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK => 'quietzone-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK => 'logo-dark',
|
|
\chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT => 'finder-dot',
|
|
]</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
|
|
MIME_TYPE
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">117</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Note: do not call this constant from the interface, but rather from one of the child classes</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">MIME_TYPE</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="constant_MIME_TYPE_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE_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 -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MODES">
|
|
MODES
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">27</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Map of built-in output class FQN</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">MODES</span>
|
|
= <span class="phpdocumentor-signature__default-value">[\chillerlan\QRCode\Output\QREps::class, \chillerlan\QRCode\Output\QRFpdf::class, \chillerlan\QRCode\Output\QRGdImageAVIF::class, \chillerlan\QRCode\Output\QRGdImageBMP::class, \chillerlan\QRCode\Output\QRGdImageGIF::class, \chillerlan\QRCode\Output\QRGdImageJPEG::class, \chillerlan\QRCode\Output\QRGdImagePNG::class, \chillerlan\QRCode\Output\QRGdImageWEBP::class, \chillerlan\QRCode\Output\QRImagick::class, \chillerlan\QRCode\Output\QRInterventionImage::class, \chillerlan\QRCode\Output\QRMarkupHTML::class, \chillerlan\QRCode\Output\QRMarkupSVG::class, \chillerlan\QRCode\Output\QRMarkupXML::class, \chillerlan\QRCode\Output\QRStringJSON::class, \chillerlan\QRCode\Output\QRStringText::class]</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="constant_MODES_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES_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/issues/223">https://github.com/chillerlan/php-qrcode/issues/223</a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_dump">
|
|
dump()
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">133</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__type">string|null </span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>please note that the value of QROptions::$cachefile is already evaluated at this point.
|
|
if the output module is invoked manually, it has no effect at all.
|
|
you need to supply the $file parameter here in that case (or handle the option value in your custom output module).</p>
|
|
</section>
|
|
|
|
<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">$file</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">string|null</span>
|
|
= <span class="phpdocumentor-argument-list__argument__default-value">null</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="method_dump_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump_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_renderMatrix"><abbr title="\chillerlan\QRCode\QRCode::renderMatrix()">QRCode::renderMatrix()</abbr></a></span>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
|
|
moduleValueIsValid()
|
|
<a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid" 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/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">122</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Determines whether the given value is valid</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">mixed</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">bool</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-Output-QROutputInterface.html#toc-constants">Constants</a></li>
|
|
<li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-methods">Methods</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-Output-QROutputInterface.html#method_dump">dump()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE">MIME_TYPE</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</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-Output-QROutputInterface.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>
|