| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003 |
- <!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>
- </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">
- QRGdImage
- <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>
- <div class="phpdocumentor-label-line">
- </div>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">29</span>
- </aside>
- <p class="phpdocumentor-summary">Converts the matrix into GD images, raw or base64 output (requires ext-gd)</p>
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#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://php.net/manual/book.image.php">https://php.net/manual/book.image.php</a></span>
-
-
- </dd>
- </dl>
- <h3 id="toc">
- Table of Contents
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <h4 id="toc-properties">
- Properties
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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-QRGdImage.html#property_background">$background</a>
- <span>
- : int </span>
- </dt>
- <dd>The allocated background color</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image</a>
- <span>
- : resource|<abbr title="\GdImage">GdImage</abbr> </span>
- </dt>
- <dd>The GD image resource</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
- <span>
- : int </span>
- </dt>
- <dd>the side length of the QR image (modules * scale)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
- </dt>
- <dd>the (filled) data matrix object</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
- <span>
- : int </span>
- </dt>
- <dd>the current size of the QR matrix</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>an (optional) array of color values for the several QR matrix parts</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
- <span>
- : <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
- </dt>
- <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 -property -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled">$upscaled</a>
- <span>
- : bool </span>
- </dt>
- <dd>Whether we're running in upscale mode (scale < 20)</dd>
- </dl>
- <h4 id="toc-methods">
- Methods
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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-QRGdImage.html#method___construct">__construct()</a>
- <span>
- : mixed </span>
- </dt>
- <dd>QROutputAbstract constructor.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
- <span>
- : string|resource|<abbr title="\GdImage">GdImage</abbr> </span>
- </dt>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid">moduleValueIsValid()</a>
- <span>
- : bool </span>
- </dt>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD">checkGD()</a>
- <span>
- : void </span>
- </dt>
- <dd>Checks whether GD is installed and if the given mode is supported</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-QRGdImage.html#method_createImage">createImage()</a>
- <span>
- : <abbr title="\GdImage">GdImage</abbr>|resource </span>
- </dt>
- <dd>Creates a new GdImage resource and scales it if necessary</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage">drawImage()</a>
- <span>
- : void </span>
- </dt>
- <dd>Draws the QR image</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
- <span>
- : string </span>
- </dt>
- <dd>Creates the final image by calling the desired GD output function</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Returns a default value for either dark or light modules</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
- <span>
- : mixed|null </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|null </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-QRGdImage.html#method_module">module()</a>
- <span>
- : void </span>
- </dt>
- <dd>Creates a single QR pixel with the given settings</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue">prepareModuleValue()</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Prepares the value for the given input ()</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-QRGdImage.html#method_setBgColor">setBgColor()</a>
- <span>
- : void </span>
- </dt>
- <dd>Sets the background color</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-QRGdImage.html#method_setTransparencyColor">setTransparencyColor()</a>
- <span>
- : void </span>
- </dt>
- <dd>Sets the transparency color</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-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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_background">
- $background
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">44</span>
- </aside>
- <p class="phpdocumentor-summary">The allocated background color</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">$background</span>
- </code>
-
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background#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="\imagecolorallocate()">imagecolorallocate()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_image">
- $image
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">37</span>
- </aside>
- <p class="phpdocumentor-summary">The GD image resource</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">resource|<abbr title="\GdImage">GdImage</abbr></span>
- <span class="phpdocumentor-signature__name">$image</span>
- </code>
-
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_length">
- $length
- <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">40</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">50</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">28</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">45</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">55</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>|<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">35</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>
-
-
-
- <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>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_upscaled">
- $upscaled
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">51</span>
- </aside>
- <p class="phpdocumentor-summary">Whether we're running in upscale mode (scale < 20)</p>
- <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">$upscaled</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled#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>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">59</span>
- </aside>
- <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
- <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></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>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">inheritDoc</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">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>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">noinspection</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
- </section>
- </dd>
- </dl>
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_dump">
- dump()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">188</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></span></code>
- <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-QRGdImage.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>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">phan-suppress</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn</p>
- </section>
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">throws</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\ErrorException">ErrorException</abbr></span>
-
-
- </dd>
- </dl>
- <section>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></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-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">123</span>
- </aside>
-
- <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-QRGdImage.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">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_checkGD">
- checkGD()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">78</span>
- </aside>
- <p class="phpdocumentor-summary">Checks whether GD is installed and if the given mode is supported</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">checkGD</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-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD#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>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- </dl>
-
- </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">176</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_createImage">
- createImage()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">108</span>
- </aside>
- <p class="phpdocumentor-summary">Creates a new GdImage resource and scales it if necessary</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">createImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\GdImage">GdImage</abbr>|resource</span></code>
- <div class="phpdocumentor-label-line">
- </div>
- <section class="phpdocumentor-description"><p>we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales</p>
- </section>
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
-
-
- </dd>
- </dl>
- <section>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type"><abbr title="\GdImage">GdImage</abbr>|resource</span>
- </section>
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_drawImage">
- drawImage()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">268</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the QR image</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">drawImage</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_dumpImage">
- dumpImage()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">315</span>
- </aside>
- <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
- <div class="phpdocumentor-label-line">
- </div>
-
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage#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>
- <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_getDefaultModuleValue">
- getDefaultModuleValue()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">176</span>
- </aside>
- <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</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|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">$isDark</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-QRGdImage.html#method_getDefaultModuleValue#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">mixed|null</span>
- —
- <section class="phpdocumentor-description"><p>return value depends on the output class</p>
- </section>
- </section>
- </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">100</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|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">$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>
-
-
- </dd>
- </dl>
- <section>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">mixed|null</span>
- —
- <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
- </section>
- </section>
- </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">115</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|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>
- </dl>
-
- <section>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">mixed|null</span>
- </section>
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_module">
- module()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">279</span>
- </aside>
- <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">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">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">$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>
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
- prepareModuleValue()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.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/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">151</span>
- </aside>
- <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|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">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">array<string|int, 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-QRGdImage.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">inheritDoc</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">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>
- <section>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">mixed|null</span>
- —
- <section class="phpdocumentor-description"><p>return value depends on the output class</p>
- </section>
- </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">150</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_setBgColor">
- setBgColor()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">232</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the background color</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">setBgColor</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_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">73</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">82</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_setTransparencyColor">
- setTransparencyColor()
- <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">250</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the transparency color</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">setTransparencyColor</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">138</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 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>
- <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>
- </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/QRGdImage.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-QRGdImage.html#toc-properties">Properties</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#toc-methods">Methods</a></li>
- </ul>
- </li>
-
- <li class="phpdocumentor-on-this-page-section__title">Properties</li>
- <li>
- <ul class="phpdocumentor-list -clean">
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background">$background<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRGdImage.html"></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled">$upscaled<a href="classes/chillerlan-QRCode-Output-QRGdImage.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-QRGdImage.html#method___construct">__construct()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD">checkGD()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage">createImage()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage">drawImage()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.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-QRGdImage.html#method_module">module()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue">prepareModuleValue()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
- <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor">setBgColor()</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-QRGdImage.html#method_setTransparencyColor">setTransparencyColor()</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-QRGdImage.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>
|