| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Documentation</title>
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <base href="../">
- <link rel="icon" href="images/favicon.ico"/>
- <link rel="stylesheet" href="css/normalize.css">
- <link rel="stylesheet" href="css/base.css">
- <link rel="preconnect" href="https://fonts.gstatic.com">
- <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
- <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
- <link rel="stylesheet" href="css/template.css">
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
- <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
- <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
- <script src="js/search.js"></script>
- <script defer src="js/searchIndex.js"></script>
- </head>
- <body id="top">
- <header class="phpdocumentor-header phpdocumentor-section">
- <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
- <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
- <label class="phpdocumentor-header__menu-icon" for="menu-button">
- <i class="fas fa-bars"></i>
- </label>
- <section data-search-form class="phpdocumentor-search">
- <label>
- <span class="visually-hidden">Search for</span>
- <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
- <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
- <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
- </svg>
- <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
- </label>
- </section>
- <nav class="phpdocumentor-topnav">
- <ul class="phpdocumentor-topnav__menu">
- </ul>
- </nav>
- </header>
- <main class="phpdocumentor">
- <div class="phpdocumentor-section">
- <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
- <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
- Menu
- </label>
- <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
- <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
- <ul class="phpdocumentor-list">
- <li>
- <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
-
- </li>
- <li>
- <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
-
- </li>
- </ul>
- </section>
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
- <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
- </section>
-
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
- </section>
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
- </section>
- </aside>
- <div class="phpdocumentor-column -eight phpdocumentor-content">
- <ul class="phpdocumentor-breadcrumbs">
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
- </ul>
- <article class="phpdocumentor-element -class">
- <h2 class="phpdocumentor-content__title">
- QRFpdf
- <span class="phpdocumentor-element__extends">
- extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
- </span>
-
- <div class="phpdocumentor-element__package">
- in package
- <ul class="phpdocumentor-breadcrumbs">
- <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
- </ul>
- </div>
-
-
- </h2>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">26</span>
- </aside>
- <p class="phpdocumentor-summary">QRFpdf output module (requires fpdf)</p>
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/Setasign/FPDF"><abbr title="https://github.com/Setasign/FPDF">https://github.com/Setasign/FPDF</abbr></a></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"><a href="http://www.fpdf.org/"><abbr title="http://www.fpdf.org/">http://www.fpdf.org/</abbr></a></span>
-
-
- </dd>
- </dl>
- <h3 id="toc">
- Table of Contents
- <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <dl class="phpdocumentor-table-of-contents">
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode">$defaultMode</a>
- <span>
- : string </span>
- </dt>
- <dd>the default output mode of the current output module</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
- <span>
- : int </span>
- </dt>
- <dd>the side length of the QR image (modules * scale)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
- </dt>
- <dd>the (filled) data matrix object</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
- <span>
- : int </span>
- </dt>
- <dd>the current size of the QR matrix</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>an (optional) array of color values for the several QR matrix parts</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
- <span>
- : <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode">$outputMode</a>
- <span>
- : string </span>
- </dt>
- <dd>the current output mode</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
- <span>
- : int </span>
- </dt>
- <dd>the current scaling for a QR pixel</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a>
- <span>
- : mixed </span>
- </dt>
- <dd>QRFpdf constructor.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a>
- <span>
- : string|<abbr title="\FPDF">FPDF</abbr> </span>
- </dt>
- <dd>generates the output, optionally dumps it to a file, and returns it</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
- <span>
- : string </span>
- </dt>
- <dd>Returns a base64 data URI for the given string and mime type</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
- <span>
- : bool </span>
- </dt>
- <dd>saves the qr data to a file</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_setModuleValues">setModuleValues()</a>
- <span>
- : void </span>
- </dt>
- <dd>Sets the initial module values (clean-up & defaults)</dd>
- </dl>
-
-
- <section class="phpdocumentor-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.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_defaultMode">
- $defaultMode
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">39</span>
- </aside>
- <p class="phpdocumentor-summary">the default output mode of the current output module</p>
- <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">$defaultMode</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </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">51</span>
- </aside>
- <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$length</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_matrix">
- $matrix
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">61</span>
- </aside>
- <p class="phpdocumentor-summary">the (filled) data matrix object</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
- <span class="phpdocumentor-signature__name">$matrix</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_moduleCount">
- $moduleCount
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">27</span>
- </aside>
- <p class="phpdocumentor-summary">the current size of the QR matrix</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$moduleCount</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_moduleValues">
- $moduleValues
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">56</span>
- </aside>
- <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
- <span class="phpdocumentor-signature__name">$moduleValues</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_options">
- $options
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">66</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
- <span class="phpdocumentor-signature__name">$options</span>
- </code>
-
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_outputMode">
- $outputMode
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">34</span>
- </aside>
- <p class="phpdocumentor-summary">the current output mode</p>
- <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">$outputMode</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputType">QROptions::$outputType</abbr></span>
-
-
- </dd>
- </dl>
- </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">46</span>
- </aside>
- <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$scale</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.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-QRFpdf.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/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">33</span>
- </aside>
- <p class="phpdocumentor-summary">QRFpdf constructor.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$options</span>
- : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$matrix</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">throws</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">mixed</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_dump">
- dump()
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.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/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">73</span>
- </aside>
- <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__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|<abbr title="\FPDF">FPDF</abbr></span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$file</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">inheritDoc</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_base64encode">
- base64encode()
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">95</span>
- </aside>
- <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">base64encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$data</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$mime</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_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">107</span>
- </aside>
- <p class="phpdocumentor-summary">saves the qr data to a file</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$data</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$file</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">throws</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">bool</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
- setModuleValues()
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.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/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">50</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the initial module values (clean-up & defaults)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">inheritDoc</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- </section>
-
- <script type="text/javascript">
- function loadExternalCodeSnippets(line) {
- Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
- var src = pre.getAttribute('data-src').replace( /\\/g, '/');
- var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
- var language = 'php';
- var code = document.createElement('code');
- code.className = 'language-' + language;
- pre.textContent = '';
- pre.setAttribute('data-line', line)
- code.textContent = 'Loading…';
- pre.appendChild(code);
- var xhr = new XMLHttpRequest();
- xhr.open('GET', src, true);
- xhr.onreadystatechange = function () {
- if (xhr.readyState == 4) {
- if (xhr.status < 400 && xhr.responseText) {
- code.textContent = xhr.responseText;
- Prism.highlightElement(code);
- }
- else if (xhr.status >= 400) {
- code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
- }
- else {
- code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
- }
- }
- };
- xhr.send(null);
- });
- }
- var modals = document.querySelectorAll("[data-modal]");
- modals.forEach(function (trigger) {
- trigger.addEventListener("click", function (event) {
- //event.preventDefault();
- const modal = document.getElementById(trigger.dataset.modal);
- modal.classList.add("phpdocumentor-modal__open");
- loadExternalCodeSnippets(trigger.dataset.line)
- const exits = modal.querySelectorAll("[data-exit-button]");
- exits.forEach(function (exit) {
- exit.addEventListener("click", function (event) {
- event.preventDefault();
- modal.classList.remove("phpdocumentor-modal__open");
- });
- });
- });
- });
- </script>
- </article>
- <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
- <section class="phpdocumentor-search-results__dialog">
- <header class="phpdocumentor-search-results__header">
- <h2 class="phpdocumentor-search-results__title">Search results</h2>
- <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
- </header>
- <section class="phpdocumentor-search-results__body">
- <ul class="phpdocumentor-search-results__entries"></ul>
- </section>
- </section>
- </section>
- </div>
- </div>
- <a href="classes/chillerlan-QRCode-Output-QRFpdf.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>
|