|
|
@@ -0,0 +1,1194 @@
|
|
|
+<!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" href="images/favicon.ico"/>
|
|
|
+ <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=Source+Sans+Pro:wght@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/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">
|
|
|
+ </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 -four phpdocumentor-sidebar">
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
|
+ <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
|
|
|
+ <ul class="phpdocumentor-list">
|
|
|
+ <li>
|
|
|
+ <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
|
|
|
+
|
|
|
+ </li>
|
|
|
+ <li>
|
|
|
+ <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
|
|
|
+
|
|
|
+ </li>
|
|
|
+ </ul>
|
|
|
+
|
|
|
+ </section>
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
|
+ <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
|
|
|
+
|
|
|
+ </section>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <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">
|
|
|
+ <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 -eight phpdocumentor-content">
|
|
|
+ <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 -class">
|
|
|
+ <h2 class="phpdocumentor-content__title">
|
|
|
+ QRImage
|
|
|
+
|
|
|
+ <span class="phpdocumentor-element__extends">
|
|
|
+ extends <a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a>
|
|
|
+ </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>
|
|
|
+
|
|
|
+
|
|
|
+ </h2>
|
|
|
+
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImage.php"><a href="files/src-output-qrimage.html"><abbr title="src/Output/QRImage.php">QRImage.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">17</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Converts the matrix into GD images, raw or base64 output (requires ext-gd)</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">deprecated</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>backward compatibility, use QRGdImage instead</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <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"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<h3 id="toc">
|
|
|
+ Table of Contents
|
|
|
+ <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+</h3>
|
|
|
+
|
|
|
+<dl class="phpdocumentor-table-of-contents">
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image</a>
|
|
|
+ <span>
|
|
|
+ : resource|<abbr title="\GdImage">GdImage</abbr> </span>
|
|
|
+</dt>
|
|
|
+<dd>The GD image resource</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
|
|
|
+ <span>
|
|
|
+ : int </span>
|
|
|
+</dt>
|
|
|
+<dd>the side length of the QR image (modules * scale)</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
|
|
|
+ <span>
|
|
|
+ : <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
|
|
|
+</dt>
|
|
|
+<dd>the (filled) data matrix object</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
|
|
|
+ <span>
|
|
|
+ : int </span>
|
|
|
+</dt>
|
|
|
+<dd>the current size of the QR matrix</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>an (optional) array of color values for the several QR matrix parts</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
|
|
|
+ <span>
|
|
|
+ : <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
|
|
|
+ <span>
|
|
|
+ : int </span>
|
|
|
+</dt>
|
|
|
+<dd>the current scaling for a QR pixel</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>QROutputAbstract constructor.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
|
|
|
+ <span>
|
|
|
+ : string|resource|<abbr title="\GdImage">GdImage</abbr> </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Returns a base64 data URI for the given string and mime type</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates the final image by calling the desired GD output function</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Returns the final value for the given input (return value depends on the output module)</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_moduleValueIsValid">moduleValueIsValid()</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+<dd>Determines whether the given value is valid</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
|
|
|
+ <span>
|
|
|
+ : void </span>
|
|
|
+</dt>
|
|
|
+<dd>saves the qr data to a file</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
|
|
|
+ <span>
|
|
|
+ : void </span>
|
|
|
+</dt>
|
|
|
+<dd>Sets the initial module values</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel">setPixel()</a>
|
|
|
+ <span>
|
|
|
+ : void </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates a single QR pixel with the given settings</dd>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-properties">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="properties">
|
|
|
+ Properties
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRImage.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h3>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_image">
|
|
|
+ $image
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" 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/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">37</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">The GD image resource</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">resource|<abbr title="\GdImage">GdImage</abbr></span>
|
|
|
+ <span class="phpdocumentor-signature__name">$image</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <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">see</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+ <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_length">
|
|
|
+ $length
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">39</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</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">$length</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_matrix">
|
|
|
+ $matrix
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">49</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">the (filled) data matrix object</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
|
|
|
+ <span class="phpdocumentor-signature__name">$matrix</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_moduleCount">
|
|
|
+ $moduleCount
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">27</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">the current size of the QR matrix</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">$moduleCount</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+ <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">see</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+ <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_moduleValues">
|
|
|
+ $moduleValues
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">44</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
|
+ <span class="phpdocumentor-signature__name">$moduleValues</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_options">
|
|
|
+ $options
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">54</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
|
|
|
+ <span class="phpdocumentor-signature__name">$options</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_scale">
|
|
|
+ $scale
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">34</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">the current scaling for a QR pixel</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">$scale</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+ <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">see</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+ <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-methods">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="methods">
|
|
|
+ Methods
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRImage.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___construct">
|
|
|
+ __construct()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">59</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$options</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$matrix</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">mixed</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_dump">
|
|
|
+ dump()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">82</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <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__return-type">string </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">string|resource|<abbr title="\GdImage">GdImage</abbr></span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$file</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <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">inheritDoc</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-tag-list__entry">
|
|
|
+ <span class="phpdocumentor-tag__name">phan-suppress</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <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"><abbr title="\ErrorException">ErrorException</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_base64encode">
|
|
|
+ base64encode()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">110</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">base64encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$data</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$mime</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_dumpImage">
|
|
|
+ dumpImage()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" 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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">174</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <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-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ -abstract "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
|
|
|
+ getDefaultModuleValue()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">105</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$isDark</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">mixed</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ -abstract "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
|
|
|
+ getModuleValue()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">98</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$value</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">mixed</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ -abstract "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
|
|
|
+ moduleValueIsValid()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">89</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">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$value</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">mixed|null</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_saveToFile">
|
|
|
+ saveToFile()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">122</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">saves the qr data to a file</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$data</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$file</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <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">see</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+ <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <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\QROptions::cachefile">QROptions::cachefile</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <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-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">void</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
|
|
|
+ setModuleValues()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">72</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Sets the initial module values</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">void</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_setPixel">
|
|
|
+ setPixel()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel" 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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">146</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">setPixel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$x</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$y</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">void</span>
|
|
|
+ —
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+
|
|
|
+ <script type="text/javascript">
|
|
|
+ function loadExternalCodeSnippets(line) {
|
|
|
+ Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
|
+ var src = pre.getAttribute('data-src').replace( /\\/g, '/');
|
|
|
+ var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
|
+ var language = 'php';
|
|
|
+
|
|
|
+ var code = document.createElement('code');
|
|
|
+ code.className = 'language-' + language;
|
|
|
+
|
|
|
+ pre.textContent = '';
|
|
|
+
|
|
|
+ pre.setAttribute('data-line', line)
|
|
|
+ code.textContent = 'Loading…';
|
|
|
+
|
|
|
+ pre.appendChild(code);
|
|
|
+
|
|
|
+ var xhr = new XMLHttpRequest();
|
|
|
+
|
|
|
+ xhr.open('GET', src, true);
|
|
|
+
|
|
|
+ xhr.onreadystatechange = function () {
|
|
|
+ if (xhr.readyState == 4) {
|
|
|
+
|
|
|
+ if (xhr.status < 400 && xhr.responseText) {
|
|
|
+ code.textContent = xhr.responseText;
|
|
|
+
|
|
|
+ Prism.highlightElement(code);
|
|
|
+ }
|
|
|
+ else if (xhr.status >= 400) {
|
|
|
+ code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
+ }
|
|
|
+ else {
|
|
|
+ code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
|
|
|
+ }
|
|
|
+ }
|
|
|
+ };
|
|
|
+
|
|
|
+ xhr.send(null);
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ var modals = document.querySelectorAll("[data-modal]");
|
|
|
+
|
|
|
+ modals.forEach(function (trigger) {
|
|
|
+ trigger.addEventListener("click", function (event) {
|
|
|
+ //event.preventDefault();
|
|
|
+ const modal = document.getElementById(trigger.dataset.modal);
|
|
|
+ modal.classList.add("phpdocumentor-modal__open");
|
|
|
+ loadExternalCodeSnippets(trigger.dataset.line)
|
|
|
+ const exits = modal.querySelectorAll("[data-exit-button]");
|
|
|
+ exits.forEach(function (exit) {
|
|
|
+ exit.addEventListener("click", function (event) {
|
|
|
+ event.preventDefault();
|
|
|
+ modal.classList.remove("phpdocumentor-modal__open");
|
|
|
+ });
|
|
|
+ });
|
|
|
+ });
|
|
|
+ });
|
|
|
+ </script>
|
|
|
+
|
|
|
+ </article>
|
|
|
+ <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>
|
|
|
+ </div>
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRImage.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>
|
codemasher