| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230 |
- <!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">
- <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 -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" 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 -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>
- </ul>
- <article class="phpdocumentor-element -class">
- <h2 class="phpdocumentor-content__title">
- QROptions
- <span class="phpdocumentor-element__extends">
- extends <abbr title="\chillerlan\Settings\SettingsContainerAbstract">SettingsContainerAbstract</abbr>
- </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>
-
-
- <span class="phpdocumentor-element__extends">
- Uses
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html"><abbr title="\chillerlan\QRCode\QROptionsTrait">QROptionsTrait</abbr></a> </span>
- </h2>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptions.php"><a href="files/src-qroptions.html"><abbr title="src/QROptions.php">QROptions.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">18</span>
- </aside>
- <p class="phpdocumentor-summary">The QRCode settings container</p>
- <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-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
- <span>
- : bool </span>
- </dt>
- <dd>Toggles logo space creation</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
- <span>
- : bool </span>
- </dt>
- <dd>Add a "quiet zone" (margin) according to the QR code spec</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Sets the image background color (if applicable)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
- <span>
- : string|null </span>
- </dt>
- <dd>/path/to/cache.file</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
- <span>
- : float </span>
- </dt>
- <dd>specifies the radius of the modules when $drawCircularModules is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
- <span>
- : bool </span>
- </dt>
- <dd>whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
- <span>
- : string </span>
- </dt>
- <dd>a common css class</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
- <span>
- : bool </span>
- </dt>
- <dd>specify whether to draw the modules as filled circles</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
- <span>
- : bool </span>
- </dt>
- <dd>whether to draw the light (false) modules</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
- <span>
- : int </span>
- </dt>
- <dd>Error correct level</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
- <span>
- : string </span>
- </dt>
- <dd>newline string</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>specify which paths/patterns to exclude from connecting if $connectPaths is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
- <span>
- : string </span>
- </dt>
- <dd>Measurement unit for FPDF output: pt, mm, cm, in (defaults to "pt")</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a>
- <span>
- : bool </span>
- </dt>
- <dd>toggle base64 or raw image data (if applicable)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
- <span>
- : bool </span>
- </dt>
- <dd>toggle transparency</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
- <span>
- : string </span>
- </dt>
- <dd>Imagick output format</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality">$jpegQuality</a>
- <span>
- : int </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>specifies which module types to exclude when $drawCircularModules is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
- <span>
- : int|null </span>
- </dt>
- <dd>height of the logo space</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
- <span>
- : int|null </span>
- </dt>
- <dd>optional horizontal start position of the logo space (top left corner)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
- <span>
- : int|null </span>
- </dt>
- <dd>optional vertical start position of the logo space (top left corner)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
- <span>
- : int|null </span>
- </dt>
- <dd>width of the logo space</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a>
- <span>
- : string </span>
- </dt>
- <dd>markup substitute for dark (CSS value)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a>
- <span>
- : string </span>
- </dt>
- <dd>markup substitute for light (CSS value)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
- <span>
- : int </span>
- </dt>
- <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
- <span>
- : array<string|int, mixed>|null </span>
- </dt>
- <dd>Module values map</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
- <span>
- : string|null </span>
- </dt>
- <dd>the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a>
- <span>
- : string </span>
- </dt>
- <dd>The output type</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression">$pngCompression</a>
- <span>
- : int </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
- <span>
- : int </span>
- </dt>
- <dd>Size of the quiet zone</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
- <span>
- : bool </span>
- </dt>
- <dd>grayscale the image before reading</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
- <span>
- : bool </span>
- </dt>
- <dd>increase the contrast before reading</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
- <span>
- : bool </span>
- </dt>
- <dd>use Imagick (if available) when reading QR Codes</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
- <span>
- : bool </span>
- </dt>
- <dd>Return the image resource instead of a render if applicable.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
- <span>
- : int </span>
- </dt>
- <dd>pixel size of a QR code module</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a>
- <span>
- : bool </span>
- </dt>
- <dd>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
- <span>
- : string </span>
- </dt>
- <dd>anything between <defs></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a>
- <span>
- : string|null </span>
- </dt>
- <dd>optional "height" attribute with the specified value (note that the value is not checked!)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
- <span>
- : float </span>
- </dt>
- <dd>SVG opacity</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
- <span>
- : string </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
- <span>
- : int|null </span>
- </dt>
- <dd>SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a>
- <span>
- : string|null </span>
- </dt>
- <dd>optional "width" attribute with the specified value (note that the value is not checked!)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
- <span>
- : string </span>
- </dt>
- <dd>string substitute for dark</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
- <span>
- : string </span>
- </dt>
- <dd>string substitute for light</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
- <span>
- : int </span>
- </dt>
- <dd>QR Code version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
- <span>
- : int </span>
- </dt>
- <dd>Maximum QR version</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
- <span>
- : int </span>
- </dt>
- <dd>Minimum QR version</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
- <span>
- : int|null </span>
- </dt>
- <dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set SVG circle radius</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the FPDF measurement unit</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set logo space height</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set horizontal logo space start</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set vertical logo space start</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set logo space width</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets/clamps the quiet zone size</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
- <span>
- : void </span>
- </dt>
- <dd>enables Imagick for the QR Code reader if the extension is available</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets/clamps the version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the maximum version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the minimum version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp min/max version number</dd>
- </dl>
-
-
- <section class="phpdocumentor-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/chillerlan-QRCode-QROptions.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_addLogoSpace">
- $addLogoSpace
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">209</span>
- </aside>
- <p class="phpdocumentor-summary">Toggles logo space creation</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">$addLogoSpace</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
- $addQuietzone
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">74</span>
- </aside>
- <p class="phpdocumentor-summary">Add a "quiet zone" (margin) according to the QR code spec</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">$addQuietzone</span>
- = <span class="phpdocumentor-signature__default-value">true</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="https://www.qrcode.com/en/howto/code.html"><abbr title="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_bgColor">
- $bgColor
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">152</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">mixed|null</span>
- <span class="phpdocumentor-signature__name">$bgColor</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRGdImage: defaults to "white"</li>
- <li>QRImagick: defaults to [255, 255, 255]</li>
- <li>QRFpdf: defaults to blank internally (white page)</li>
- </ul>
- </section>
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_cachefile">
- $cachefile
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">127</span>
- </aside>
- <p class="phpdocumentor-summary">/path/to/cache.file</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$cachefile</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>please note that the $file parameter in QRCode::render*() takes precedence over the $cachefile value</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_circleRadius">
- $circleRadius
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">179</span>
- </aside>
- <p class="phpdocumentor-summary">specifies the radius of the modules when $drawCircularModules is set to true</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">float</span>
- <span class="phpdocumentor-signature__name">$circleRadius</span>
- = <span class="phpdocumentor-signature__default-value">0.45</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_connectPaths">
- $connectPaths
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">191</span>
- </aside>
- <p class="phpdocumentor-summary">whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</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">$connectPaths</span>
- = <span class="phpdocumentor-signature__default-value">false</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="https://github.com/chillerlan/php-qrcode/issues/57"><abbr title="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_cssClass">
- $cssClass
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">301</span>
- </aside>
- <p class="phpdocumentor-summary">a common css class</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">$cssClass</span>
- = <span class="phpdocumentor-signature__default-value">'qrcode'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
- $drawCircularModules
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">174</span>
- </aside>
- <p class="phpdocumentor-summary">specify whether to draw the modules as filled circles</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">$drawCircularModules</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>a note for GDImage output:</p>
- <p>if QROptions::$scale is less than 20, the image will be upscaled internally, then the modules will be drawn
- using imagefilledellipse() and then scaled back to the expected size</p>
- <p>No effect in: QREps, QRFpdf, QRMarkupHTML</p>
- </section>
- <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="https://github.com/chillerlan/php-qrcode/issues/23"><abbr title="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</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="https://github.com/chillerlan/php-qrcode/discussions/122"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/122">https://github.com/chillerlan/php-qrcode/discussions/122</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
- $drawLightModules
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">159</span>
- </aside>
- <p class="phpdocumentor-summary">whether to draw the light (false) modules</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">$drawLightModules</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
-
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_eccLevel">
- $eccLevel
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">60</span>
- </aside>
- <p class="phpdocumentor-summary">Error correct level</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">$eccLevel</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
- <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
- <ul>
- <li>L => 7%</li>
- <li>M => 15%</li>
- <li>Q => 25%</li>
- <li>H => 30%</li>
- </ul>
- </section>
- <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">todo:</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>accept string values (PHP8+)</p>
- </section>
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/160"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/160">https://github.com/chillerlan/php-qrcode/discussions/160</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_eol">
- $eol
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">137</span>
- </aside>
- <p class="phpdocumentor-summary">newline string</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">$eol</span>
- = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
- $excludeFromConnect
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">196</span>
- </aside>
- <p class="phpdocumentor-summary">specify which paths/patterns to exclude from connecting if $connectPaths is set to true</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">$excludeFromConnect</span>
- = <span class="phpdocumentor-signature__default-value">[]</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
- $fpdfMeasureUnit
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">391</span>
- </aside>
- <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to "pt")</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">$fpdfMeasureUnit</span>
- = <span class="phpdocumentor-signature__default-value">'pt'</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="\FPDF::__construct()">FPDF::__construct()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imageBase64">
- $imageBase64
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">132</span>
- </aside>
- <p class="phpdocumentor-summary">toggle base64 or raw image data (if applicable)</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">$imageBase64</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
- $imageTransparent
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">252</span>
- </aside>
- <p class="phpdocumentor-summary">toggle transparency</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">$imageTransparent</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRGdImage and QRImagick: the given <abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr> is set as transparent</li>
- </ul>
- </section>
- <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="https://github.com/chillerlan/php-qrcode/discussions/121"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/121">https://github.com/chillerlan/php-qrcode/discussions/121</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
- $imagickFormat
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">291</span>
- </aside>
- <p class="phpdocumentor-summary">Imagick output format</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">$imagickFormat</span>
- = <span class="phpdocumentor-signature__default-value">'png32'</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="\Imagick::setImageFormat()">Imagick::setImageFormat()</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"><a href="https://www.imagemagick.org/script/formats.php"><abbr title="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_jpegQuality">
- $jpegQuality
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">278</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$jpegQuality</span>
- = <span class="phpdocumentor-signature__default-value">85</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\imagejpeg()">imagejpeg()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
- $keepAsSquare
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">184</span>
- </aside>
- <p class="phpdocumentor-summary">specifies which module types to exclude when $drawCircularModules is set to true</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">$keepAsSquare</span>
- = <span class="phpdocumentor-signature__default-value">[]</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
- $logoSpaceHeight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">223</span>
- </aside>
- <p class="phpdocumentor-summary">height of the logo space</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
- $logoSpaceStartX
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">228</span>
- </aside>
- <p class="phpdocumentor-summary">optional horizontal start position of the logo space (top left corner)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
- $logoSpaceStartY
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">233</span>
- </aside>
- <p class="phpdocumentor-summary">optional vertical start position of the logo space (top left corner)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
- $logoSpaceWidth
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">216</span>
- </aside>
- <p class="phpdocumentor-summary">width of the logo space</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_markupDark">
- $markupDark
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">306</span>
- </aside>
- <p class="phpdocumentor-summary">markup substitute for dark (CSS value)</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">$markupDark</span>
- = <span class="phpdocumentor-signature__default-value">'#000'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_markupLight">
- $markupLight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">311</span>
- </aside>
- <p class="phpdocumentor-summary">markup substitute for light (CSS value)</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">$markupLight</span>
- = <span class="phpdocumentor-signature__default-value">'#fff'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_maskPattern">
- $maskPattern
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">67</span>
- </aside>
- <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</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">$maskPattern</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
- <section class="phpdocumentor-description"><p>[0...7] or MaskPattern::PATTERN_AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_moduleValues">
- $moduleValues
- <a href="classes/chillerlan-QRCode-QROptionsTrait.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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">204</span>
- </aside>
- <p class="phpdocumentor-summary">Module values map</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed>|null</span>
- <span class="phpdocumentor-signature__name">$moduleValues</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRImagick, QRMarkupHTML, QRMarkupSVG: #ABCDEF, cssname, rgb(), rgba()...</li>
- <li>QREps, QRFpdf, QRGdImage: [63, 127, 255] // R, G, B</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_outputInterface">
- $outputInterface
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">104</span>
- </aside>
- <p class="phpdocumentor-summary">the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$outputInterface</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_outputType">
- $outputType
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">99</span>
- </aside>
- <p class="phpdocumentor-summary">The output type</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">$outputType</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QROutputInterface::MARKUP_XXXX where XXXX = HTML, SVG</li>
- <li>QROutputInterface::GDIMAGE_XXX where XXX = PNG, GIF, JPG</li>
- <li>QROutputInterface::STRING_XXXX where XXXX = TEXT, JSON</li>
- <li>QROutputInterface::IMAGICK</li>
- <li>QROutputInterface::EPS</li>
- <li>QROutputInterface::FPDF</li>
- <li>QROutputInterface::CUSTOM</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_pngCompression">
- $pngCompression
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">273</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$pngCompression</span>
- = <span class="phpdocumentor-signature__default-value">-1</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\imagepng()">imagepng()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
- $quietzoneSize
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">81</span>
- </aside>
- <p class="phpdocumentor-summary">Size of the quiet zone</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">$quietzoneSize</span>
- = <span class="phpdocumentor-signature__default-value">4</span></code>
- <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
- $readerGrayscale
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">406</span>
- </aside>
- <p class="phpdocumentor-summary">grayscale the image before reading</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">$readerGrayscale</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
- $readerIncreaseContrast
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">413</span>
- </aside>
- <p class="phpdocumentor-summary">increase the contrast before reading</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">$readerIncreaseContrast</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
- $readerUseImagickIfAvailable
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">401</span>
- </aside>
- <p class="phpdocumentor-summary">use Imagick (if available) when reading QR Codes</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">$readerUseImagickIfAvailable</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_returnResource">
- $returnResource
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">120</span>
- </aside>
- <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</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">$returnResource</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>This option overrides other output options, such as $cachefile and $imageBase64.</p>
- <p>Supported by the following modules:</p>
- <ul>
- <li>QRGdImage: resource (PHP < 8), GdImage</li>
- <li>QRImagick: Imagick</li>
- <li>QRFpdf: FPDF</li>
- </ul>
- </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-Output-QROutputInterface.html#method_dump"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::dump()">QROutputInterface::dump()</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_scale">
- $scale
- <a href="classes/chillerlan-QRCode-QROptionsTrait.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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">243</span>
- </aside>
- <p class="phpdocumentor-summary">pixel size of a QR code module</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>
- = <span class="phpdocumentor-signature__default-value">5</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgAddXmlHeader">
- $svgAddXmlHeader
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">323</span>
- </aside>
- <p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</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">$svgAddXmlHeader</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
- <section class="phpdocumentor-description"><p><code class="prettyprint"><?xml version="1.0" encoding="UTF-8"?></code></p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgDefs">
- $svgDefs
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">335</span>
- </aside>
- <p class="phpdocumentor-summary">anything between <defs></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">$svgDefs</span>
- = <span class="phpdocumentor-signature__default-value">''</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="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgHeight">
- $svgHeight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">364</span>
- </aside>
- <p class="phpdocumentor-summary">optional "height" attribute with the specified value (note that the value is not checked!)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$svgHeight</span>
- = <span class="phpdocumentor-signature__default-value">null</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="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
- $svgOpacity
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">328</span>
- </aside>
- <p class="phpdocumentor-summary">SVG opacity</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">float</span>
- <span class="phpdocumentor-signature__name">$svgOpacity</span>
- = <span class="phpdocumentor-signature__default-value">1.0</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
- $svgPreserveAspectRatio
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">350</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
- = <span class="phpdocumentor-signature__default-value">'xMidYMid'</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="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
- $svgViewBoxSize
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">345</span>
- </aside>
- <p class="phpdocumentor-summary">SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>viewBox="0 0 x x"</p>
- </section>
- <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="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</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="https://css-tricks.com/scale-svg/#article-header-id-3"><abbr title="https://css-tricks.com/scale-svg/#article-header-id-3">https://css-tricks.com/scale-svg/#article-header-id-3</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgWidth">
- $svgWidth
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">357</span>
- </aside>
- <p class="phpdocumentor-summary">optional "width" attribute with the specified value (note that the value is not checked!)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$svgWidth</span>
- = <span class="phpdocumentor-signature__default-value">null</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="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_textDark">
- $textDark
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">374</span>
- </aside>
- <p class="phpdocumentor-summary">string substitute for dark</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">$textDark</span>
- = <span class="phpdocumentor-signature__default-value">'🔴'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_textLight">
- $textLight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">379</span>
- </aside>
- <p class="phpdocumentor-summary">string substitute for light</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">$textLight</span>
- = <span class="phpdocumentor-signature__default-value">'⭕'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
- $transparencyColor
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">263</span>
- </aside>
- <p class="phpdocumentor-summary">Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">mixed|null</span>
- <span class="phpdocumentor-signature__name">$transparencyColor</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>Defaults to <abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr>.</p>
- <ul>
- <li>QRGdImage: [R, G, B], this color is set as transparent in <abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr>
- </li>
- <li>QRImagick: "color_str", this color is set in <abbr title="\chillerlan\QRCode\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr>
- </li>
- </ul>
- </section>
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_version">
- $version
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">33</span>
- </aside>
- <p class="phpdocumentor-summary">QR Code version number</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">$version</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
- <section class="phpdocumentor-description"><p>[1 ... 40] or Version::AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_versionMax">
- $versionMax
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">45</span>
- </aside>
- <p class="phpdocumentor-summary">Maximum QR version</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">$versionMax</span>
- = <span class="phpdocumentor-signature__default-value">40</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_versionMin">
- $versionMin
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">40</span>
- </aside>
- <p class="phpdocumentor-summary">Minimum QR version</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">$versionMin</span>
- = <span class="phpdocumentor-signature__default-value">1</span></code>
- <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/chillerlan-QRCode-QROptions.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
- clampLogoSpaceValue()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">480</span>
- </aside>
- <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</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">int|null</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
- set_circleRadius()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">520</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_circleRadius</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$circleRadius</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
- : <span class="phpdocumentor-signature__argument__return-type">float</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
- set_fpdfMeasureUnit()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">460</span>
- </aside>
- <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_fpdfMeasureUnit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$unit</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$unit</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">codeCoverageIgnore</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>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
- set_logoSpaceHeight()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">499</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set logo space height</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceHeight</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
- set_logoSpaceStartX()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">506</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceStartX</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
- set_logoSpaceStartY()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">513</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceStartY</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
- set_logoSpaceWidth()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">492</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set logo space width</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceWidth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
- set_quietzoneSize()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">451</span>
- </aside>
- <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_quietzoneSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$quietzoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
- set_readerUseImagickIfAvailable()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">473</span>
- </aside>
- <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_readerUseImagickIfAvailable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
- : <span class="phpdocumentor-signature__argument__return-type">bool</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_version">
- set_version()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">444</span>
- </aside>
- <p class="phpdocumentor-summary">sets/clamps the version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_version</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
- set_versionMax()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">437</span>
- </aside>
- <p class="phpdocumentor-summary">sets the maximum version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_versionMax</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
- set_versionMin()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">430</span>
- </aside>
- <p class="phpdocumentor-summary">sets the minimum version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_versionMin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
- setMinMaxVersion()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" 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/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">419</span>
- </aside>
- <p class="phpdocumentor-summary">clamp min/max version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">setMinMaxVersion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$versionMin</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$versionMax</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$versionMin</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$versionMax</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- </section>
-
- <script type="text/javascript">
- function loadExternalCodeSnippets(line) {
- Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
- var src = pre.getAttribute('data-src').replace( /\\/g, '/');
- var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
- var language = 'php';
- var code = document.createElement('code');
- code.className = 'language-' + language;
- pre.textContent = '';
- pre.setAttribute('data-line', line)
- code.textContent = 'Loading…';
- pre.appendChild(code);
- var xhr = new XMLHttpRequest();
- xhr.open('GET', src, true);
- xhr.onreadystatechange = function () {
- if (xhr.readyState == 4) {
- if (xhr.status < 400 && xhr.responseText) {
- code.textContent = xhr.responseText;
- Prism.highlightElement(code);
- }
- else if (xhr.status >= 400) {
- code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
- }
- else {
- code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
- }
- }
- };
- xhr.send(null);
- });
- }
- var modals = document.querySelectorAll("[data-modal]");
- modals.forEach(function (trigger) {
- trigger.addEventListener("click", function (event) {
- //event.preventDefault();
- const modal = document.getElementById(trigger.dataset.modal);
- modal.classList.add("phpdocumentor-modal__open");
- loadExternalCodeSnippets(trigger.dataset.line)
- const exits = modal.querySelectorAll("[data-exit-button]");
- exits.forEach(function (exit) {
- exit.addEventListener("click", function (event) {
- event.preventDefault();
- modal.classList.remove("phpdocumentor-modal__open");
- });
- });
- });
- });
- </script>
- </article>
- <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
- <section class="phpdocumentor-search-results__dialog">
- <header class="phpdocumentor-search-results__header">
- <h2 class="phpdocumentor-search-results__title">Search results</h2>
- <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
- </header>
- <section class="phpdocumentor-search-results__body">
- <ul class="phpdocumentor-search-results__entries"></ul>
- </section>
- </section>
- </section>
- </div>
- </div>
- <a href="classes/chillerlan-QRCode-QROptions.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>
|