|
|
@@ -0,0 +1,2316 @@
|
|
|
+<!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=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>
|
|
|
+ </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">
|
|
|
+ <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>
|
|
|
+
|
|
|
+ <h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
+ <a href="namespaces/output.html" class="">Output</a>
|
|
|
+</h4>
|
|
|
+
|
|
|
+ </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" class="">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 -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 -class">
|
|
|
+ <h2 class="phpdocumentor-content__title">
|
|
|
+ QRMarkupXML
|
|
|
+
|
|
|
+ <span class="phpdocumentor-element__extends">
|
|
|
+ extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</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>
|
|
|
+
|
|
|
+<div class="phpdocumentor-label-line">
|
|
|
+
|
|
|
+
|
|
|
+</div>
|
|
|
+
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">23</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">XML/XSLT output</p>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<h3 id="toc">
|
|
|
+ Table of Contents
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+
|
|
|
+</h3>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<h4 id="toc-constants">
|
|
|
+ Constants
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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 href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#constant_MIME_TYPE">MIME_TYPE</a>
|
|
|
+ <span>
|
|
|
+ = 'application/xml' </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#constant_XML_SCHEMA">XML_SCHEMA</a>
|
|
|
+ <span>
|
|
|
+ = 'https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.xsd' </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+<h4 id="toc-properties">
|
|
|
+ Properties
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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 -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
|
|
|
+ <span>
|
|
|
+ : float </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
|
|
|
+ <span>
|
|
|
+ : float </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#property_dom">$dom</a>
|
|
|
+ <span>
|
|
|
+ : <abbr title="\DOMDocument">DOMDocument</abbr> </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
|
|
|
+</dt>
|
|
|
+<dd>the options instance</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>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+<h4 id="toc-methods">
|
|
|
+ Methods
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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 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-QRMarkup.html#method_dump">dump()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid">moduleValueIsValid()</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+<dd>note: we're not necessarily validating the several values, just checking the general syntax
|
|
|
+note: css4 colors are not included</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
|
|
|
+returns an array with the transformed modules</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
|
|
|
+ <span>
|
|
|
+ : void </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates copies of several QROptions values to avoid calling the magic getters
|
|
|
+in long loops for a significant performance increase.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMarkup">createMarkup()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>returns the fully parsed and rendered markup string for the given input</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMatrix">createMatrix()</a>
|
|
|
+ <span>
|
|
|
+ : <abbr title="\DOMElement">DOMElement</abbr> </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates the matrix element</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass">getCssClass()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>returns a string with all css classes for the current element</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 default value for either dark or light modules (return value depends on the output class)</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 prepared value for the given $M_TYPE</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_getOutputDimensions">getOutputDimensions()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_module">module()</a>
|
|
|
+ <span>
|
|
|
+ : <abbr title="\DOMElement">DOMElement</abbr>|null </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates a DOM element for single module</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Prepares the value for the given input (return value depends on the output class)</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_row">row()</a>
|
|
|
+ <span>
|
|
|
+ : <abbr title="\DOMElement">DOMElement</abbr>|null </span>
|
|
|
+</dt>
|
|
|
+<dd>Creates a DOM element for a matrix row</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. If $file is null, nothing happens.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
|
|
|
+ <span>
|
|
|
+ : void </span>
|
|
|
+</dt>
|
|
|
+<dd>Sets/updates the matrix dimensions</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-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Returns a base64 data URI for the given string and mime type</dd>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-constants">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="constants">
|
|
|
+ Constants
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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_MIME_TYPE">
|
|
|
+ MIME_TYPE
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">25</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <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">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">MIME_TYPE</span>
|
|
|
+ = <span class="phpdocumentor-signature__default-value">'application/xml'</span>
|
|
|
+</code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article class="phpdocumentor-element -constant -protected ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="constant_XML_SCHEMA">
|
|
|
+ XML_SCHEMA
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#constant_XML_SCHEMA" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">26</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-signature phpdocumentor-code ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">XML_SCHEMA</span>
|
|
|
+ = <span class="phpdocumentor-signature__default-value">'https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.xsd'</span>
|
|
|
+</code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-properties">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="properties">
|
|
|
+ Properties
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.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_circleDiameter">
|
|
|
+ $circleDiameter
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" 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">67</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">float</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$circleDiameter</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_circleRadius">
|
|
|
+ $circleRadius
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">66</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">float</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$circleRadius</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#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::$circleRadius">QROptions::$circleRadius</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_connectPaths">
|
|
|
+ $connectPaths
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">bool</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$connectPaths</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_dom">
|
|
|
+ $dom
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#property_dom" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">28</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type"><abbr title="\DOMDocument">DOMDocument</abbr></span>
|
|
|
+ <span class="phpdocumentor-signature__name">$dom</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
|
|
|
+ $drawCircularModules
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">62</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">bool</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$drawCircularModules</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
|
|
|
+ $drawLightModules
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">60</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">bool</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$drawLightModules</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#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::$drawLightModules">QROptions::$drawLightModules</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_eol">
|
|
|
+ $eol
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">58</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">string</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$eol</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#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::$eol">QROptions::$eol</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
|
|
|
+ $excludeFromConnect
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">56</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <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">$excludeFromConnect</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
|
|
|
+ $keepAsSquare
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.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/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">64</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <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">$keepAsSquare</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#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::$keepAsSquare">QROptions::$keepAsSquare</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">34</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>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</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">44</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>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</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">29</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>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#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_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</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">39</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>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</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">49</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">the options instance</p>
|
|
|
+
|
|
|
+ <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></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">52</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <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>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#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-QRMarkupXML.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">72</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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </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>
|
|
|
+
|
|
|
+ <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-signature__argument__name">$options</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_dump">
|
|
|
+ dump()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.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/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">74</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</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-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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.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">inheritDoc</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ -static "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
|
|
|
+ moduleValueIsValid()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.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/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">29</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">note: we're not necessarily validating the several values, just checking the general syntax
|
|
|
+note: css4 colors are not included</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__return-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-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-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid#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">todo:</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>XSS proof</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="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value">https://developer.mozilla.org/en-US/docs/Web/CSS/color_value</a></span>
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-tag-list__entry">
|
|
|
+ <span class="phpdocumentor-tag__name">inheritDoc</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-tag-list__definition">
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_collectModules">
|
|
|
+ collectModules()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" 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">221</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
|
|
|
+returns an array with the transformed modules</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr> </span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+ <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
|
|
|
+<p>$x - current column
|
|
|
+$y - current row
|
|
|
+$M_TYPE - field value
|
|
|
+$M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ <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">$transform</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></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">array<string|int, mixed></span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_copyVars">
|
|
|
+ copyVars()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" 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">91</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
|
|
|
+in long loops for a significant performance increase.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+ <section class="phpdocumentor-description"><p>These variables are usually used in the "module" methods and are called up to 31329 times (at version 40).</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_createMarkup">
|
|
|
+ createMarkup()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMarkup" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">40</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">returns the fully parsed and rendered markup string for the given input</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">createMarkup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$saveToFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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-signature__argument__name">$saveToFile</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMarkup#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>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_createMatrix">
|
|
|
+ createMatrix()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMatrix" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">75</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates the matrix element</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">createMatrix</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\DOMElement">DOMElement</abbr></span></code>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type"><abbr title="\DOMElement">DOMElement</abbr></span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getCssClass">
|
|
|
+ getCssClass()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass" 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/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">85</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getCssClass</span><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 class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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-signature__argument__name">$M_TYPE</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ = <span class="phpdocumentor-signature__argument__default-value">0</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">string</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</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">157</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</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>
|
|
|
+
|
|
|
+ <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-signature__argument__name">$isDark</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <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">164</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><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">mixed</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-signature__argument__name">$M_TYPE</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#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>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
|
|
|
+ getModuleValueAt()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" 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">176</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getModuleValueAt</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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-signature__argument__name">$x</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
|
|
|
+ getOutputDimensions()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_getOutputDimensions" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_getOutputDimensions#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>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_module">
|
|
|
+ module()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_module" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">125</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates a DOM element for single module</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">module</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"><abbr title="\DOMElement">DOMElement</abbr>|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-signature__argument__name">$x</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </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">
|
|
|
+
|
|
|
+ </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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type"><abbr title="\DOMElement">DOMElement</abbr>|null</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ -abstract "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
|
|
|
+ prepareModuleValue()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" 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">152</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</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">prepareModuleValue</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>
|
|
|
+
|
|
|
+ <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-signature__argument__name">$value</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_row">
|
|
|
+ row()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_row" 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/QRMarkupXML.php"><a href="files/src-output-qrmarkupxml.html"><abbr title="src/Output/QRMarkupXML.php">QRMarkupXML.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">100</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Creates a DOM element for a matrix row</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">row</span><span>(</span><span class="phpdocumentor-signature__argument"><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">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$row</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\DOMElement">DOMElement</abbr>|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-signature__argument__name">$y</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$row</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">array<string|int, 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"><abbr title="\DOMElement">DOMElement</abbr>|null</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</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">195</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</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>, </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">void</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-signature__argument__name">$data</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
+ Tags
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#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>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
|
|
|
+ setMatrixDimensions()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" 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">115</span>
|
|
|
+
|
|
|
+ </aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+ <section class="phpdocumentor-description"><p>Call this method if you modify the matrix from within your custom module in case the dimensions have been changed</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</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">133</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>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-label-line">
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
|
|
|
+ toBase64DataURI()
|
|
|
+ <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" 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">183</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">toBase64DataURI</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>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$mime</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</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-signature__argument__name">$data</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$mime</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">
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">string</span>
|
|
|
+ </section>
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-modal" id="source-view">
|
|
|
+ <div class="phpdocumentor-modal-bg" data-exit-button></div>
|
|
|
+ <div class="phpdocumentor-modal-container">
|
|
|
+ <div class="phpdocumentor-modal-content">
|
|
|
+ <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRMarkupXML.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
|
+ </div>
|
|
|
+ <button data-exit-button class="phpdocumentor-modal__close">×</button>
|
|
|
+ </div>
|
|
|
+</div>
|
|
|
+
|
|
|
+ <script type="text/javascript">
|
|
|
+ (function () {
|
|
|
+ function loadExternalCodeSnippet(el, url, line) {
|
|
|
+ Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
|
+ const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
|
|
|
+ const language = 'php';
|
|
|
+
|
|
|
+ const 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) {
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (xhr.status < 400 && xhr.responseText) {
|
|
|
+ code.textContent = xhr.responseText;
|
|
|
+ Prism.highlightElement(code);
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (xhr.status === 404) {
|
|
|
+ code.textContent = '✖ Error: File could not be found';
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (xhr.status >= 400) {
|
|
|
+ code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ code.textContent = '✖ Error: An unknown error occurred';
|
|
|
+ };
|
|
|
+
|
|
|
+ xhr.send(null);
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ const modalButtons = document.querySelectorAll("[data-modal]");
|
|
|
+ const openedAsLocalFile = window.location.protocol === 'file:';
|
|
|
+ if (modalButtons.length > 0 && openedAsLocalFile) {
|
|
|
+ console.warn(
|
|
|
+ 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
|
|
|
+ 'browsers block XHR requests when a page is opened this way'
|
|
|
+ );
|
|
|
+ }
|
|
|
+
|
|
|
+ modalButtons.forEach(function (trigger) {
|
|
|
+ if (openedAsLocalFile) {
|
|
|
+ trigger.setAttribute("hidden", "hidden");
|
|
|
+ }
|
|
|
+
|
|
|
+ trigger.addEventListener("click", function (event) {
|
|
|
+ event.preventDefault();
|
|
|
+ const modal = document.getElementById(trigger.dataset.modal);
|
|
|
+ if (!modal) {
|
|
|
+ console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
|
|
|
+ return;
|
|
|
+ }
|
|
|
+ modal.classList.add("phpdocumentor-modal__open");
|
|
|
+
|
|
|
+ loadExternalCodeSnippet(modal, trigger.dataset.src || null, 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>
|
|
|
+ <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-QRMarkupXML.html#toc-constants">Constants</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#toc-properties">Properties</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#toc-methods">Methods</a></li>
|
|
|
+ </ul>
|
|
|
+ </li>
|
|
|
+ <li class="phpdocumentor-on-this-page-section__title">Constants</li>
|
|
|
+ <li>
|
|
|
+ <ul class="phpdocumentor-list -clean">
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#constant_MIME_TYPE">MIME_TYPE</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#constant_XML_SCHEMA">XML_SCHEMA</a></li>
|
|
|
+ </ul>
|
|
|
+ </li>
|
|
|
+
|
|
|
+ <li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
|
+ <li>
|
|
|
+ <ul class="phpdocumentor-list -clean">
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#property_dom">$dom<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html"></li>
|
|
|
+ </ul>
|
|
|
+ </li>
|
|
|
+
|
|
|
+ <li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
|
+ <li>
|
|
|
+ <ul class="phpdocumentor-list -clean">
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMarkup">createMarkup()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_createMatrix">createMatrix()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass">getCssClass()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_getOutputDimensions">getOutputDimensions()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_module">module()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QRMarkupXML.html#method_row">row()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
|
|
|
+ <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</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-QRMarkupXML.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