chillerlan-QRCode-QROptionsTrait.html 196 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <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" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. </ul>
  105. <article class="phpdocumentor-element -trait">
  106. <h2 class="phpdocumentor-content__title">
  107. QROptionsTrait
  108. </h2>
  109. <aside class="phpdocumentor-element-found-in">
  110. <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>
  111. :
  112. <span class="phpdocumentor-element-found-in__line">22</span>
  113. </aside>
  114. <p class="phpdocumentor-summary">The QRCode plug-in settings &amp; setter functionality</p>
  115. <h3 id="toc">
  116. Table of Contents
  117. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  118. </h3>
  119. <h4 id="toc-properties">
  120. Properties
  121. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  122. </h4>
  123. <dl class="phpdocumentor-table-of-contents">
  124. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  125. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
  126. <span>
  127. &nbsp;: bool </span>
  128. </dt>
  129. <dd>Toggles logo space creation</dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  131. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
  132. <span>
  133. &nbsp;: bool </span>
  134. </dt>
  135. <dd>Add a &quot;quiet zone&quot; (margin) according to the QR code spec</dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  137. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
  138. <span>
  139. &nbsp;: mixed|null </span>
  140. </dt>
  141. <dd>Sets the image background color (if applicable)</dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  143. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
  144. <span>
  145. &nbsp;: string|null </span>
  146. </dt>
  147. <dd>Optional cache file path `/path/to/cache.file`</dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  149. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
  150. <span>
  151. &nbsp;: float </span>
  152. </dt>
  153. <dd>Specifies the radius of the modules when $drawCircularModules is set to true</dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
  156. <span>
  157. &nbsp;: bool </span>
  158. </dt>
  159. <dd>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  161. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
  162. <span>
  163. &nbsp;: string </span>
  164. </dt>
  165. <dd>A common css class</dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
  168. <span>
  169. &nbsp;: bool </span>
  170. </dt>
  171. <dd>Specify whether to draw the modules as filled circles</dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  173. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
  174. <span>
  175. &nbsp;: bool </span>
  176. </dt>
  177. <dd>Whether to draw the light (false) modules</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
  180. <span>
  181. &nbsp;: int </span>
  182. </dt>
  183. <dd>Error correct level</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  185. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
  186. <span>
  187. &nbsp;: string </span>
  188. </dt>
  189. <dd>Newline string</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
  192. <span>
  193. &nbsp;: array&lt;string|int, mixed&gt; </span>
  194. </dt>
  195. <dd>Specify which paths/patterns to exclude from connecting if $connectPaths is set to true</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  197. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
  198. <span>
  199. &nbsp;: string </span>
  200. </dt>
  201. <dd>Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  203. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a>
  204. <span>
  205. &nbsp;: bool </span>
  206. </dt>
  207. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  208. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
  209. <span>
  210. &nbsp;: bool </span>
  211. </dt>
  212. <dd>Toggle transparency</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  214. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
  215. <span>
  216. &nbsp;: string </span>
  217. </dt>
  218. <dd>Imagick output format</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  220. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a>
  221. <span>
  222. &nbsp;: bool </span>
  223. </dt>
  224. <dd>Whether to invert the matrix (reflectance reversal)</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  226. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans">$jsonAsBooleans</a>
  227. <span>
  228. &nbsp;: bool </span>
  229. </dt>
  230. <dd>Whether to return matrix values in JSON as booleans or $M_TYPE integers</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  232. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
  233. <span>
  234. &nbsp;: array&lt;string|int, mixed&gt; </span>
  235. </dt>
  236. <dd>Specifies which module types to exclude when $drawCircularModules is set to true</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  238. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
  239. <span>
  240. &nbsp;: int|null </span>
  241. </dt>
  242. <dd>Height of the logo space</dd>
  243. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  244. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
  245. <span>
  246. &nbsp;: int|null </span>
  247. </dt>
  248. <dd>Optional horizontal start position of the logo space (top left corner)</dd>
  249. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  250. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
  251. <span>
  252. &nbsp;: int|null </span>
  253. </dt>
  254. <dd>Optional vertical start position of the logo space (top left corner)</dd>
  255. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  256. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
  257. <span>
  258. &nbsp;: int|null </span>
  259. </dt>
  260. <dd>Width of the logo space</dd>
  261. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  262. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a>
  263. <span>
  264. &nbsp;: string </span>
  265. </dt>
  266. <dd>Markup substitute for dark (CSS value)</dd>
  267. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  268. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a>
  269. <span>
  270. &nbsp;: string </span>
  271. </dt>
  272. <dd>Markup substitute for light (CSS value)</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  274. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
  275. <span>
  276. &nbsp;: int </span>
  277. </dt>
  278. <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
  279. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  280. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
  281. <span>
  282. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  283. </dt>
  284. <dd>Module values map</dd>
  285. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  286. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a>
  287. <span>
  288. &nbsp;: bool </span>
  289. </dt>
  290. <dd>Toggle base64 data URI or raw data output (if applicable)</dd>
  291. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  292. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
  293. <span>
  294. &nbsp;: string|null </span>
  295. </dt>
  296. <dd>The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</dd>
  297. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  298. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a>
  299. <span>
  300. &nbsp;: string </span>
  301. </dt>
  302. <dd>The built-in output type</dd>
  303. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  304. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a>
  305. <span>
  306. &nbsp;: int </span>
  307. </dt>
  308. <dd>Compression quality</dd>
  309. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  310. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
  311. <span>
  312. &nbsp;: int </span>
  313. </dt>
  314. <dd>Size of the quiet zone</dd>
  315. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  316. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
  317. <span>
  318. &nbsp;: bool </span>
  319. </dt>
  320. <dd>Grayscale the image before reading</dd>
  321. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  322. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  323. <span>
  324. &nbsp;: bool </span>
  325. </dt>
  326. <dd>Increase the contrast before reading</dd>
  327. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  328. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  329. <span>
  330. &nbsp;: bool </span>
  331. </dt>
  332. <dd>Use Imagick (if available) when reading QR Codes</dd>
  333. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  334. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
  335. <span>
  336. &nbsp;: bool </span>
  337. </dt>
  338. <dd>Return the image resource instead of a render if applicable.</dd>
  339. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  340. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
  341. <span>
  342. &nbsp;: int </span>
  343. </dt>
  344. <dd>Pixel size of a QR code module</dd>
  345. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  346. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a>
  347. <span>
  348. &nbsp;: bool </span>
  349. </dt>
  350. <dd>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</dd>
  351. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  352. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
  353. <span>
  354. &nbsp;: string </span>
  355. </dt>
  356. <dd>Anything in the &lt;defs&gt; tag</dd>
  357. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  358. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a>
  359. <span>
  360. &nbsp;: string|null </span>
  361. </dt>
  362. <dd>Optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</dd>
  363. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  364. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
  365. <span>
  366. &nbsp;: float </span>
  367. </dt>
  368. <dd>SVG opacity</dd>
  369. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  370. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
  371. <span>
  372. &nbsp;: string </span>
  373. </dt>
  374. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  375. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
  376. <span>
  377. &nbsp;: int|null </span>
  378. </dt>
  379. <dd>SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.</dd>
  380. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  381. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a>
  382. <span>
  383. &nbsp;: string|null </span>
  384. </dt>
  385. <dd>Optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</dd>
  386. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  387. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
  388. <span>
  389. &nbsp;: string </span>
  390. </dt>
  391. <dd>String substitute for dark</dd>
  392. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  393. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
  394. <span>
  395. &nbsp;: string </span>
  396. </dt>
  397. <dd>String substitute for light</dd>
  398. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  399. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a>
  400. <span>
  401. &nbsp;: string </span>
  402. </dt>
  403. <dd>An optional line prefix, e.g. empty space to align the QR Code in a console</dd>
  404. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  405. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
  406. <span>
  407. &nbsp;: mixed|null </span>
  408. </dt>
  409. <dd>Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</dd>
  410. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  411. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
  412. <span>
  413. &nbsp;: int </span>
  414. </dt>
  415. <dd>QR Code version number</dd>
  416. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  417. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
  418. <span>
  419. &nbsp;: int </span>
  420. </dt>
  421. <dd>Maximum QR version</dd>
  422. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  423. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
  424. <span>
  425. &nbsp;: int </span>
  426. </dt>
  427. <dd>Minimum QR version</dd>
  428. </dl>
  429. <h4 id="toc-methods">
  430. Methods
  431. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  432. </h4>
  433. <dl class="phpdocumentor-table-of-contents">
  434. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  435. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
  436. <span>
  437. &nbsp;: int|null </span>
  438. </dt>
  439. <dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
  440. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  441. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64">get_imageBase64()</a>
  442. <span>
  443. &nbsp;: bool </span>
  444. </dt>
  445. <dd>redirect call to the new variable</dd>
  446. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  447. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG">get_imageTransparencyBG()</a>
  448. <span>
  449. &nbsp;: mixed </span>
  450. </dt>
  451. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  452. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG">get_imagickBG()</a>
  453. <span>
  454. &nbsp;: mixed </span>
  455. </dt>
  456. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  457. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality">get_jpegQuality()</a>
  458. <span>
  459. &nbsp;: int </span>
  460. </dt>
  461. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  462. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression">get_pngCompression()</a>
  463. <span>
  464. &nbsp;: int </span>
  465. </dt>
  466. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  467. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a>
  468. <span>
  469. &nbsp;: void </span>
  470. </dt>
  471. <dd>clamp/set SVG circle radius</dd>
  472. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  473. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
  474. <span>
  475. &nbsp;: void </span>
  476. </dt>
  477. <dd>sets the FPDF measurement unit</dd>
  478. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  479. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64">set_imageBase64()</a>
  480. <span>
  481. &nbsp;: void </span>
  482. </dt>
  483. <dd>redirect call to the new variable</dd>
  484. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  485. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a>
  486. <span>
  487. &nbsp;: void </span>
  488. </dt>
  489. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  490. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG">set_imagickBG()</a>
  491. <span>
  492. &nbsp;: void </span>
  493. </dt>
  494. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  495. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality">set_jpegQuality()</a>
  496. <span>
  497. &nbsp;: void </span>
  498. </dt>
  499. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  500. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a>
  501. <span>
  502. &nbsp;: void </span>
  503. </dt>
  504. <dd>clamp/set logo space height</dd>
  505. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  506. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a>
  507. <span>
  508. &nbsp;: void </span>
  509. </dt>
  510. <dd>clamp/set horizontal logo space start</dd>
  511. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  512. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a>
  513. <span>
  514. &nbsp;: void </span>
  515. </dt>
  516. <dd>clamp/set vertical logo space start</dd>
  517. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  518. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a>
  519. <span>
  520. &nbsp;: void </span>
  521. </dt>
  522. <dd>clamp/set logo space width</dd>
  523. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  524. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression">set_pngCompression()</a>
  525. <span>
  526. &nbsp;: void </span>
  527. </dt>
  528. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  529. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a>
  530. <span>
  531. &nbsp;: void </span>
  532. </dt>
  533. <dd>sets/clamps the quiet zone size</dd>
  534. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  535. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
  536. <span>
  537. &nbsp;: void </span>
  538. </dt>
  539. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  540. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  541. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
  542. <span>
  543. &nbsp;: void </span>
  544. </dt>
  545. <dd>sets/clamps the version number</dd>
  546. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  547. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
  548. <span>
  549. &nbsp;: void </span>
  550. </dt>
  551. <dd>sets the maximum version number</dd>
  552. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  553. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
  554. <span>
  555. &nbsp;: void </span>
  556. </dt>
  557. <dd>sets the minimum version number</dd>
  558. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  559. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
  560. <span>
  561. &nbsp;: void </span>
  562. </dt>
  563. <dd>clamp min/max version number</dd>
  564. </dl>
  565. <section class="phpdocumentor-properties">
  566. <h3 class="phpdocumentor-elements__header" id="properties">
  567. Properties
  568. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  569. </h3>
  570. <article
  571. class="
  572. phpdocumentor-element
  573. -property
  574. -protected
  575. "
  576. >
  577. <h4 class="phpdocumentor-element__name" id="property_addLogoSpace">
  578. $addLogoSpace
  579. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  580. <span class="phpdocumentor-element__modifiers">
  581. </span>
  582. </h4>
  583. <aside class="phpdocumentor-element-found-in">
  584. <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>
  585. :
  586. <span class="phpdocumentor-element-found-in__line">219</span>
  587. </aside>
  588. <p class="phpdocumentor-summary">Toggles logo space creation</p>
  589. <code class="phpdocumentor-code phpdocumentor-signature ">
  590. <span class="phpdocumentor-signature__visibility">protected</span>
  591. <span class="phpdocumentor-signature__type">bool</span>
  592. <span class="phpdocumentor-signature__name">$addLogoSpace</span>
  593. = <span class="phpdocumentor-signature__default-value">false</span></code>
  594. </article>
  595. <article
  596. class="
  597. phpdocumentor-element
  598. -property
  599. -protected
  600. "
  601. >
  602. <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
  603. $addQuietzone
  604. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
  605. <span class="phpdocumentor-element__modifiers">
  606. </span>
  607. </h4>
  608. <aside class="phpdocumentor-element-found-in">
  609. <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>
  610. :
  611. <span class="phpdocumentor-element-found-in__line">74</span>
  612. </aside>
  613. <p class="phpdocumentor-summary">Add a &quot;quiet zone&quot; (margin) according to the QR code spec</p>
  614. <code class="phpdocumentor-code phpdocumentor-signature ">
  615. <span class="phpdocumentor-signature__visibility">protected</span>
  616. <span class="phpdocumentor-signature__type">bool</span>
  617. <span class="phpdocumentor-signature__name">$addQuietzone</span>
  618. = <span class="phpdocumentor-signature__default-value">true</span></code>
  619. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  620. Tags
  621. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone#tags" class="headerlink"><i class="fas fa-link"></i></a>
  622. </h5>
  623. <dl class="phpdocumentor-tag-list">
  624. <dt class="phpdocumentor-tag-list__entry">
  625. <span class="phpdocumentor-tag__name">see</span>
  626. </dt>
  627. <dd class="phpdocumentor-tag-list__definition">
  628. <span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</a></span>
  629. </dd>
  630. </dl>
  631. </article>
  632. <article
  633. class="
  634. phpdocumentor-element
  635. -property
  636. -protected
  637. "
  638. >
  639. <h4 class="phpdocumentor-element__name" id="property_bgColor">
  640. $bgColor
  641. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" class="headerlink"><i class="fas fa-link"></i></a>
  642. <span class="phpdocumentor-element__modifiers">
  643. </span>
  644. </h4>
  645. <aside class="phpdocumentor-element-found-in">
  646. <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>
  647. :
  648. <span class="phpdocumentor-element-found-in__line">158</span>
  649. </aside>
  650. <p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
  651. <code class="phpdocumentor-code phpdocumentor-signature ">
  652. <span class="phpdocumentor-signature__visibility">protected</span>
  653. <span class="phpdocumentor-signature__type">mixed|null</span>
  654. <span class="phpdocumentor-signature__name">$bgColor</span>
  655. = <span class="phpdocumentor-signature__default-value">null</span></code>
  656. <section class="phpdocumentor-description"><ul>
  657. <li>QRImagick: defaults to &quot;white&quot;</li>
  658. <li>QRGdImage: defaults to [255, 255, 255]</li>
  659. <li>QRFpdf: defaults to blank internally (white page)</li>
  660. </ul>
  661. </section>
  662. </article>
  663. <article
  664. class="
  665. phpdocumentor-element
  666. -property
  667. -protected
  668. "
  669. >
  670. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  671. $cachefile
  672. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  673. <span class="phpdocumentor-element__modifiers">
  674. </span>
  675. </h4>
  676. <aside class="phpdocumentor-element-found-in">
  677. <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>
  678. :
  679. <span class="phpdocumentor-element-found-in__line">127</span>
  680. </aside>
  681. <p class="phpdocumentor-summary">Optional cache file path `/path/to/cache.file`</p>
  682. <code class="phpdocumentor-code phpdocumentor-signature ">
  683. <span class="phpdocumentor-signature__visibility">protected</span>
  684. <span class="phpdocumentor-signature__type">string|null</span>
  685. <span class="phpdocumentor-signature__name">$cachefile</span>
  686. = <span class="phpdocumentor-signature__default-value">null</span></code>
  687. <section class="phpdocumentor-description"><p>please note that the $file parameter in QRCode::render*() takes precedence over the $cachefile value</p>
  688. </section>
  689. </article>
  690. <article
  691. class="
  692. phpdocumentor-element
  693. -property
  694. -protected
  695. "
  696. >
  697. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  698. $circleRadius
  699. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  700. <span class="phpdocumentor-element__modifiers">
  701. </span>
  702. </h4>
  703. <aside class="phpdocumentor-element-found-in">
  704. <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>
  705. :
  706. <span class="phpdocumentor-element-found-in__line">188</span>
  707. </aside>
  708. <p class="phpdocumentor-summary">Specifies the radius of the modules when $drawCircularModules is set to true</p>
  709. <code class="phpdocumentor-code phpdocumentor-signature ">
  710. <span class="phpdocumentor-signature__visibility">protected</span>
  711. <span class="phpdocumentor-signature__type">float</span>
  712. <span class="phpdocumentor-signature__name">$circleRadius</span>
  713. = <span class="phpdocumentor-signature__default-value">0.45</span></code>
  714. </article>
  715. <article
  716. class="
  717. phpdocumentor-element
  718. -property
  719. -protected
  720. "
  721. >
  722. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  723. $connectPaths
  724. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  725. <span class="phpdocumentor-element__modifiers">
  726. </span>
  727. </h4>
  728. <aside class="phpdocumentor-element-found-in">
  729. <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>
  730. :
  731. <span class="phpdocumentor-element-found-in__line">200</span>
  732. </aside>
  733. <p class="phpdocumentor-summary">Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
  734. <code class="phpdocumentor-code phpdocumentor-signature ">
  735. <span class="phpdocumentor-signature__visibility">protected</span>
  736. <span class="phpdocumentor-signature__type">bool</span>
  737. <span class="phpdocumentor-signature__name">$connectPaths</span>
  738. = <span class="phpdocumentor-signature__default-value">false</span></code>
  739. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  740. Tags
  741. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  742. </h5>
  743. <dl class="phpdocumentor-tag-list">
  744. <dt class="phpdocumentor-tag-list__entry">
  745. <span class="phpdocumentor-tag__name">see</span>
  746. </dt>
  747. <dd class="phpdocumentor-tag-list__definition">
  748. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</a></span>
  749. </dd>
  750. </dl>
  751. </article>
  752. <article
  753. class="
  754. phpdocumentor-element
  755. -property
  756. -protected
  757. "
  758. >
  759. <h4 class="phpdocumentor-element__name" id="property_cssClass">
  760. $cssClass
  761. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
  762. <span class="phpdocumentor-element__modifiers">
  763. </span>
  764. </h4>
  765. <aside class="phpdocumentor-element-found-in">
  766. <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>
  767. :
  768. <span class="phpdocumentor-element-found-in__line">309</span>
  769. </aside>
  770. <p class="phpdocumentor-summary">A common css class</p>
  771. <code class="phpdocumentor-code phpdocumentor-signature ">
  772. <span class="phpdocumentor-signature__visibility">protected</span>
  773. <span class="phpdocumentor-signature__type">string</span>
  774. <span class="phpdocumentor-signature__name">$cssClass</span>
  775. = <span class="phpdocumentor-signature__default-value">&#039;qrcode&#039;</span></code>
  776. </article>
  777. <article
  778. class="
  779. phpdocumentor-element
  780. -property
  781. -protected
  782. "
  783. >
  784. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  785. $drawCircularModules
  786. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  787. <span class="phpdocumentor-element__modifiers">
  788. </span>
  789. </h4>
  790. <aside class="phpdocumentor-element-found-in">
  791. <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>
  792. :
  793. <span class="phpdocumentor-element-found-in__line">183</span>
  794. </aside>
  795. <p class="phpdocumentor-summary">Specify whether to draw the modules as filled circles</p>
  796. <code class="phpdocumentor-code phpdocumentor-signature ">
  797. <span class="phpdocumentor-signature__visibility">protected</span>
  798. <span class="phpdocumentor-signature__type">bool</span>
  799. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  800. = <span class="phpdocumentor-signature__default-value">false</span></code>
  801. <section class="phpdocumentor-description"><p>a note for GDImage output:</p>
  802. <p>if QROptions::$scale is less than 20, the image will be upscaled internally, then the modules will be drawn
  803. using imagefilledellipse() and then scaled back to the expected size</p>
  804. <p>No effect in: QREps, QRFpdf, QRMarkupHTML</p>
  805. </section>
  806. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  807. Tags
  808. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  809. </h5>
  810. <dl class="phpdocumentor-tag-list">
  811. <dt class="phpdocumentor-tag-list__entry">
  812. <span class="phpdocumentor-tag__name">see</span>
  813. </dt>
  814. <dd class="phpdocumentor-tag-list__definition">
  815. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
  816. </dd>
  817. <dt class="phpdocumentor-tag-list__entry">
  818. <span class="phpdocumentor-tag__name">see</span>
  819. </dt>
  820. <dd class="phpdocumentor-tag-list__definition">
  821. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/122">https://github.com/chillerlan/php-qrcode/discussions/122</a></span>
  822. </dd>
  823. </dl>
  824. </article>
  825. <article
  826. class="
  827. phpdocumentor-element
  828. -property
  829. -protected
  830. "
  831. >
  832. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  833. $drawLightModules
  834. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  835. <span class="phpdocumentor-element__modifiers">
  836. </span>
  837. </h4>
  838. <aside class="phpdocumentor-element-found-in">
  839. <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>
  840. :
  841. <span class="phpdocumentor-element-found-in__line">168</span>
  842. </aside>
  843. <p class="phpdocumentor-summary">Whether to draw the light (false) modules</p>
  844. <code class="phpdocumentor-code phpdocumentor-signature ">
  845. <span class="phpdocumentor-signature__visibility">protected</span>
  846. <span class="phpdocumentor-signature__type">bool</span>
  847. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  848. = <span class="phpdocumentor-signature__default-value">true</span></code>
  849. </article>
  850. <article
  851. class="
  852. phpdocumentor-element
  853. -property
  854. -protected
  855. "
  856. >
  857. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  858. $eccLevel
  859. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  860. <span class="phpdocumentor-element__modifiers">
  861. </span>
  862. </h4>
  863. <aside class="phpdocumentor-element-found-in">
  864. <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>
  865. :
  866. <span class="phpdocumentor-element-found-in__line">60</span>
  867. </aside>
  868. <p class="phpdocumentor-summary">Error correct level</p>
  869. <code class="phpdocumentor-code phpdocumentor-signature ">
  870. <span class="phpdocumentor-signature__visibility">protected</span>
  871. <span class="phpdocumentor-signature__type">int</span>
  872. <span class="phpdocumentor-signature__name">$eccLevel</span>
  873. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
  874. <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
  875. <ul>
  876. <li>L =&gt; 7%</li>
  877. <li>M =&gt; 15%</li>
  878. <li>Q =&gt; 25%</li>
  879. <li>H =&gt; 30%</li>
  880. </ul>
  881. </section>
  882. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  883. Tags
  884. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  885. </h5>
  886. <dl class="phpdocumentor-tag-list">
  887. <dt class="phpdocumentor-tag-list__entry">
  888. <span class="phpdocumentor-tag__name">todo:</span>
  889. </dt>
  890. <dd class="phpdocumentor-tag-list__definition">
  891. <section class="phpdocumentor-description"><p>accept string values (PHP8+)</p>
  892. </section>
  893. </dd>
  894. <dt class="phpdocumentor-tag-list__entry">
  895. <span class="phpdocumentor-tag__name">see</span>
  896. </dt>
  897. <dd class="phpdocumentor-tag-list__definition">
  898. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/160">https://github.com/chillerlan/php-qrcode/discussions/160</a></span>
  899. </dd>
  900. </dl>
  901. </article>
  902. <article
  903. class="
  904. phpdocumentor-element
  905. -property
  906. -protected
  907. "
  908. >
  909. <h4 class="phpdocumentor-element__name" id="property_eol">
  910. $eol
  911. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  912. <span class="phpdocumentor-element__modifiers">
  913. </span>
  914. </h4>
  915. <aside class="phpdocumentor-element-found-in">
  916. <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>
  917. :
  918. <span class="phpdocumentor-element-found-in__line">143</span>
  919. </aside>
  920. <p class="phpdocumentor-summary">Newline string</p>
  921. <code class="phpdocumentor-code phpdocumentor-signature ">
  922. <span class="phpdocumentor-signature__visibility">protected</span>
  923. <span class="phpdocumentor-signature__type">string</span>
  924. <span class="phpdocumentor-signature__name">$eol</span>
  925. = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
  926. </article>
  927. <article
  928. class="
  929. phpdocumentor-element
  930. -property
  931. -protected
  932. "
  933. >
  934. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  935. $excludeFromConnect
  936. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  937. <span class="phpdocumentor-element__modifiers">
  938. </span>
  939. </h4>
  940. <aside class="phpdocumentor-element-found-in">
  941. <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>
  942. :
  943. <span class="phpdocumentor-element-found-in__line">205</span>
  944. </aside>
  945. <p class="phpdocumentor-summary">Specify which paths/patterns to exclude from connecting if $connectPaths is set to true</p>
  946. <code class="phpdocumentor-code phpdocumentor-signature ">
  947. <span class="phpdocumentor-signature__visibility">protected</span>
  948. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  949. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  950. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  951. </article>
  952. <article
  953. class="
  954. phpdocumentor-element
  955. -property
  956. -protected
  957. "
  958. >
  959. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  960. $fpdfMeasureUnit
  961. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  962. <span class="phpdocumentor-element__modifiers">
  963. </span>
  964. </h4>
  965. <aside class="phpdocumentor-element-found-in">
  966. <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>
  967. :
  968. <span class="phpdocumentor-element-found-in__line">408</span>
  969. </aside>
  970. <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</p>
  971. <code class="phpdocumentor-code phpdocumentor-signature ">
  972. <span class="phpdocumentor-signature__visibility">protected</span>
  973. <span class="phpdocumentor-signature__type">string</span>
  974. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  975. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  976. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  977. Tags
  978. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  979. </h5>
  980. <dl class="phpdocumentor-tag-list">
  981. <dt class="phpdocumentor-tag-list__entry">
  982. <span class="phpdocumentor-tag__name">see</span>
  983. </dt>
  984. <dd class="phpdocumentor-tag-list__definition">
  985. <span class="phpdocumentor-tag-link"><abbr title="\FPDF::__construct()">FPDF::__construct()</abbr></span>
  986. </dd>
  987. </dl>
  988. </article>
  989. <article
  990. class="
  991. phpdocumentor-element
  992. -property
  993. -protected
  994. -deprecated "
  995. >
  996. <h4 class="phpdocumentor-element__name" id="property_imageBase64">
  997. $imageBase64
  998. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  999. <span class="phpdocumentor-element__modifiers">
  1000. </span>
  1001. </h4>
  1002. <aside class="phpdocumentor-element-found-in">
  1003. <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>
  1004. :
  1005. <span class="phpdocumentor-element-found-in__line">133</span>
  1006. </aside>
  1007. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1008. <span class="phpdocumentor-signature__visibility">protected</span>
  1009. <span class="phpdocumentor-signature__type">bool</span>
  1010. <span class="phpdocumentor-signature__name">$imageBase64</span>
  1011. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1012. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1013. Tags
  1014. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1015. </h5>
  1016. <dl class="phpdocumentor-tag-list">
  1017. <dt class="phpdocumentor-tag-list__entry">
  1018. <span class="phpdocumentor-tag__name">deprecated</span>
  1019. </dt>
  1020. <dd class="phpdocumentor-tag-list__definition">
  1021. <span class="phpdocumentor-tag-link">5.0.0</span>
  1022. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  1023. </section>
  1024. </dd>
  1025. <dt class="phpdocumentor-tag-list__entry">
  1026. <span class="phpdocumentor-tag__name">see</span>
  1027. </dt>
  1028. <dd class="phpdocumentor-tag-list__definition">
  1029. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  1030. </dd>
  1031. </dl>
  1032. </article>
  1033. <article
  1034. class="
  1035. phpdocumentor-element
  1036. -property
  1037. -protected
  1038. "
  1039. >
  1040. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  1041. $imageTransparent
  1042. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  1043. <span class="phpdocumentor-element__modifiers">
  1044. </span>
  1045. </h4>
  1046. <aside class="phpdocumentor-element-found-in">
  1047. <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>
  1048. :
  1049. <span class="phpdocumentor-element-found-in__line">262</span>
  1050. </aside>
  1051. <p class="phpdocumentor-summary">Toggle transparency</p>
  1052. <code class="phpdocumentor-code phpdocumentor-signature ">
  1053. <span class="phpdocumentor-signature__visibility">protected</span>
  1054. <span class="phpdocumentor-signature__type">bool</span>
  1055. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  1056. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1057. <section class="phpdocumentor-description"><ul>
  1058. <li>QRGdImage and QRImagick: the given \chillerlan\QRCode\QROptions::$transparencyColor is set as transparent</li>
  1059. </ul>
  1060. </section>
  1061. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1062. Tags
  1063. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1064. </h5>
  1065. <dl class="phpdocumentor-tag-list">
  1066. <dt class="phpdocumentor-tag-list__entry">
  1067. <span class="phpdocumentor-tag__name">see</span>
  1068. </dt>
  1069. <dd class="phpdocumentor-tag-list__definition">
  1070. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/121">https://github.com/chillerlan/php-qrcode/discussions/121</a></span>
  1071. </dd>
  1072. </dl>
  1073. </article>
  1074. <article
  1075. class="
  1076. phpdocumentor-element
  1077. -property
  1078. -protected
  1079. "
  1080. >
  1081. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  1082. $imagickFormat
  1083. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  1084. <span class="phpdocumentor-element__modifiers">
  1085. </span>
  1086. </h4>
  1087. <aside class="phpdocumentor-element-found-in">
  1088. <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>
  1089. :
  1090. <span class="phpdocumentor-element-found-in__line">299</span>
  1091. </aside>
  1092. <p class="phpdocumentor-summary">Imagick output format</p>
  1093. <code class="phpdocumentor-code phpdocumentor-signature ">
  1094. <span class="phpdocumentor-signature__visibility">protected</span>
  1095. <span class="phpdocumentor-signature__type">string</span>
  1096. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  1097. = <span class="phpdocumentor-signature__default-value">&#039;png32&#039;</span></code>
  1098. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1099. Tags
  1100. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1101. </h5>
  1102. <dl class="phpdocumentor-tag-list">
  1103. <dt class="phpdocumentor-tag-list__entry">
  1104. <span class="phpdocumentor-tag__name">see</span>
  1105. </dt>
  1106. <dd class="phpdocumentor-tag-list__definition">
  1107. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
  1108. </dd>
  1109. <dt class="phpdocumentor-tag-list__entry">
  1110. <span class="phpdocumentor-tag__name">see</span>
  1111. </dt>
  1112. <dd class="phpdocumentor-tag-list__definition">
  1113. <span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</a></span>
  1114. </dd>
  1115. </dl>
  1116. </article>
  1117. <article
  1118. class="
  1119. phpdocumentor-element
  1120. -property
  1121. -protected
  1122. "
  1123. >
  1124. <h4 class="phpdocumentor-element__name" id="property_invertMatrix">
  1125. $invertMatrix
  1126. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1127. <span class="phpdocumentor-element__modifiers">
  1128. </span>
  1129. </h4>
  1130. <aside class="phpdocumentor-element-found-in">
  1131. <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>
  1132. :
  1133. <span class="phpdocumentor-element-found-in__line">163</span>
  1134. </aside>
  1135. <p class="phpdocumentor-summary">Whether to invert the matrix (reflectance reversal)</p>
  1136. <code class="phpdocumentor-code phpdocumentor-signature ">
  1137. <span class="phpdocumentor-signature__visibility">protected</span>
  1138. <span class="phpdocumentor-signature__type">bool</span>
  1139. <span class="phpdocumentor-signature__name">$invertMatrix</span>
  1140. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1141. </article>
  1142. <article
  1143. class="
  1144. phpdocumentor-element
  1145. -property
  1146. -protected
  1147. "
  1148. >
  1149. <h4 class="phpdocumentor-element__name" id="property_jsonAsBooleans">
  1150. $jsonAsBooleans
  1151. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans" class="headerlink"><i class="fas fa-link"></i></a>
  1152. <span class="phpdocumentor-element__modifiers">
  1153. </span>
  1154. </h4>
  1155. <aside class="phpdocumentor-element-found-in">
  1156. <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>
  1157. :
  1158. <span class="phpdocumentor-element-found-in__line">397</span>
  1159. </aside>
  1160. <p class="phpdocumentor-summary">Whether to return matrix values in JSON as booleans or $M_TYPE integers</p>
  1161. <code class="phpdocumentor-code phpdocumentor-signature ">
  1162. <span class="phpdocumentor-signature__visibility">protected</span>
  1163. <span class="phpdocumentor-signature__type">bool</span>
  1164. <span class="phpdocumentor-signature__name">$jsonAsBooleans</span>
  1165. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1166. </article>
  1167. <article
  1168. class="
  1169. phpdocumentor-element
  1170. -property
  1171. -protected
  1172. "
  1173. >
  1174. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  1175. $keepAsSquare
  1176. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  1177. <span class="phpdocumentor-element__modifiers">
  1178. </span>
  1179. </h4>
  1180. <aside class="phpdocumentor-element-found-in">
  1181. <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>
  1182. :
  1183. <span class="phpdocumentor-element-found-in__line">193</span>
  1184. </aside>
  1185. <p class="phpdocumentor-summary">Specifies which module types to exclude when $drawCircularModules is set to true</p>
  1186. <code class="phpdocumentor-code phpdocumentor-signature ">
  1187. <span class="phpdocumentor-signature__visibility">protected</span>
  1188. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1189. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  1190. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1191. </article>
  1192. <article
  1193. class="
  1194. phpdocumentor-element
  1195. -property
  1196. -protected
  1197. "
  1198. >
  1199. <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
  1200. $logoSpaceHeight
  1201. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1202. <span class="phpdocumentor-element__modifiers">
  1203. </span>
  1204. </h4>
  1205. <aside class="phpdocumentor-element-found-in">
  1206. <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>
  1207. :
  1208. <span class="phpdocumentor-element-found-in__line">233</span>
  1209. </aside>
  1210. <p class="phpdocumentor-summary">Height of the logo space</p>
  1211. <code class="phpdocumentor-code phpdocumentor-signature ">
  1212. <span class="phpdocumentor-signature__visibility">protected</span>
  1213. <span class="phpdocumentor-signature__type">int|null</span>
  1214. <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
  1215. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1216. <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
  1217. </section>
  1218. </article>
  1219. <article
  1220. class="
  1221. phpdocumentor-element
  1222. -property
  1223. -protected
  1224. "
  1225. >
  1226. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
  1227. $logoSpaceStartX
  1228. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  1229. <span class="phpdocumentor-element__modifiers">
  1230. </span>
  1231. </h4>
  1232. <aside class="phpdocumentor-element-found-in">
  1233. <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>
  1234. :
  1235. <span class="phpdocumentor-element-found-in__line">238</span>
  1236. </aside>
  1237. <p class="phpdocumentor-summary">Optional horizontal start position of the logo space (top left corner)</p>
  1238. <code class="phpdocumentor-code phpdocumentor-signature ">
  1239. <span class="phpdocumentor-signature__visibility">protected</span>
  1240. <span class="phpdocumentor-signature__type">int|null</span>
  1241. <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
  1242. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1243. </article>
  1244. <article
  1245. class="
  1246. phpdocumentor-element
  1247. -property
  1248. -protected
  1249. "
  1250. >
  1251. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
  1252. $logoSpaceStartY
  1253. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  1254. <span class="phpdocumentor-element__modifiers">
  1255. </span>
  1256. </h4>
  1257. <aside class="phpdocumentor-element-found-in">
  1258. <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>
  1259. :
  1260. <span class="phpdocumentor-element-found-in__line">243</span>
  1261. </aside>
  1262. <p class="phpdocumentor-summary">Optional vertical start position of the logo space (top left corner)</p>
  1263. <code class="phpdocumentor-code phpdocumentor-signature ">
  1264. <span class="phpdocumentor-signature__visibility">protected</span>
  1265. <span class="phpdocumentor-signature__type">int|null</span>
  1266. <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
  1267. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1268. </article>
  1269. <article
  1270. class="
  1271. phpdocumentor-element
  1272. -property
  1273. -protected
  1274. "
  1275. >
  1276. <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
  1277. $logoSpaceWidth
  1278. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1279. <span class="phpdocumentor-element__modifiers">
  1280. </span>
  1281. </h4>
  1282. <aside class="phpdocumentor-element-found-in">
  1283. <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>
  1284. :
  1285. <span class="phpdocumentor-element-found-in__line">226</span>
  1286. </aside>
  1287. <p class="phpdocumentor-summary">Width of the logo space</p>
  1288. <code class="phpdocumentor-code phpdocumentor-signature ">
  1289. <span class="phpdocumentor-signature__visibility">protected</span>
  1290. <span class="phpdocumentor-signature__type">int|null</span>
  1291. <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
  1292. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1293. <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
  1294. </section>
  1295. </article>
  1296. <article
  1297. class="
  1298. phpdocumentor-element
  1299. -property
  1300. -protected
  1301. "
  1302. >
  1303. <h4 class="phpdocumentor-element__name" id="property_markupDark">
  1304. $markupDark
  1305. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" class="headerlink"><i class="fas fa-link"></i></a>
  1306. <span class="phpdocumentor-element__modifiers">
  1307. </span>
  1308. </h4>
  1309. <aside class="phpdocumentor-element-found-in">
  1310. <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>
  1311. :
  1312. <span class="phpdocumentor-element-found-in__line">314</span>
  1313. </aside>
  1314. <p class="phpdocumentor-summary">Markup substitute for dark (CSS value)</p>
  1315. <code class="phpdocumentor-code phpdocumentor-signature ">
  1316. <span class="phpdocumentor-signature__visibility">protected</span>
  1317. <span class="phpdocumentor-signature__type">string</span>
  1318. <span class="phpdocumentor-signature__name">$markupDark</span>
  1319. = <span class="phpdocumentor-signature__default-value">&#039;#000&#039;</span></code>
  1320. </article>
  1321. <article
  1322. class="
  1323. phpdocumentor-element
  1324. -property
  1325. -protected
  1326. "
  1327. >
  1328. <h4 class="phpdocumentor-element__name" id="property_markupLight">
  1329. $markupLight
  1330. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" class="headerlink"><i class="fas fa-link"></i></a>
  1331. <span class="phpdocumentor-element__modifiers">
  1332. </span>
  1333. </h4>
  1334. <aside class="phpdocumentor-element-found-in">
  1335. <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>
  1336. :
  1337. <span class="phpdocumentor-element-found-in__line">319</span>
  1338. </aside>
  1339. <p class="phpdocumentor-summary">Markup substitute for light (CSS value)</p>
  1340. <code class="phpdocumentor-code phpdocumentor-signature ">
  1341. <span class="phpdocumentor-signature__visibility">protected</span>
  1342. <span class="phpdocumentor-signature__type">string</span>
  1343. <span class="phpdocumentor-signature__name">$markupLight</span>
  1344. = <span class="phpdocumentor-signature__default-value">&#039;#fff&#039;</span></code>
  1345. </article>
  1346. <article
  1347. class="
  1348. phpdocumentor-element
  1349. -property
  1350. -protected
  1351. "
  1352. >
  1353. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  1354. $maskPattern
  1355. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1356. <span class="phpdocumentor-element__modifiers">
  1357. </span>
  1358. </h4>
  1359. <aside class="phpdocumentor-element-found-in">
  1360. <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>
  1361. :
  1362. <span class="phpdocumentor-element-found-in__line">67</span>
  1363. </aside>
  1364. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  1365. <code class="phpdocumentor-code phpdocumentor-signature ">
  1366. <span class="phpdocumentor-signature__visibility">protected</span>
  1367. <span class="phpdocumentor-signature__type">int</span>
  1368. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1369. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
  1370. <section class="phpdocumentor-description"><p>[0...7] or MaskPattern::PATTERN_AUTO</p>
  1371. </section>
  1372. </article>
  1373. <article
  1374. class="
  1375. phpdocumentor-element
  1376. -property
  1377. -protected
  1378. "
  1379. >
  1380. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  1381. $moduleValues
  1382. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1383. <span class="phpdocumentor-element__modifiers">
  1384. </span>
  1385. </h4>
  1386. <aside class="phpdocumentor-element-found-in">
  1387. <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>
  1388. :
  1389. <span class="phpdocumentor-element-found-in__line">214</span>
  1390. </aside>
  1391. <p class="phpdocumentor-summary">Module values map</p>
  1392. <code class="phpdocumentor-code phpdocumentor-signature ">
  1393. <span class="phpdocumentor-signature__visibility">protected</span>
  1394. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  1395. <span class="phpdocumentor-signature__name">$moduleValues</span>
  1396. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1397. <section class="phpdocumentor-description"><ul>
  1398. <li>QRImagick, QRMarkupHTML, QRMarkupSVG: #ABCDEF, cssname, rgb(), rgba()...</li>
  1399. <li>QREps, QRFpdf, QRGdImage: [R, G, B] // 0-255</li>
  1400. <li>QREps: [C, M, Y, K] // 0-255</li>
  1401. </ul>
  1402. </section>
  1403. </article>
  1404. <article
  1405. class="
  1406. phpdocumentor-element
  1407. -property
  1408. -protected
  1409. "
  1410. >
  1411. <h4 class="phpdocumentor-element__name" id="property_outputBase64">
  1412. $outputBase64
  1413. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64" class="headerlink"><i class="fas fa-link"></i></a>
  1414. <span class="phpdocumentor-element__modifiers">
  1415. </span>
  1416. </h4>
  1417. <aside class="phpdocumentor-element-found-in">
  1418. <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>
  1419. :
  1420. <span class="phpdocumentor-element-found-in__line">138</span>
  1421. </aside>
  1422. <p class="phpdocumentor-summary">Toggle base64 data URI or raw data output (if applicable)</p>
  1423. <code class="phpdocumentor-code phpdocumentor-signature ">
  1424. <span class="phpdocumentor-signature__visibility">protected</span>
  1425. <span class="phpdocumentor-signature__type">bool</span>
  1426. <span class="phpdocumentor-signature__name">$outputBase64</span>
  1427. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1428. </article>
  1429. <article
  1430. class="
  1431. phpdocumentor-element
  1432. -property
  1433. -protected
  1434. "
  1435. >
  1436. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  1437. $outputInterface
  1438. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1439. <span class="phpdocumentor-element__modifiers">
  1440. </span>
  1441. </h4>
  1442. <aside class="phpdocumentor-element-found-in">
  1443. <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>
  1444. :
  1445. <span class="phpdocumentor-element-found-in__line">104</span>
  1446. </aside>
  1447. <p class="phpdocumentor-summary">The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
  1448. <code class="phpdocumentor-code phpdocumentor-signature ">
  1449. <span class="phpdocumentor-signature__visibility">protected</span>
  1450. <span class="phpdocumentor-signature__type">string|null</span>
  1451. <span class="phpdocumentor-signature__name">$outputInterface</span>
  1452. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1453. </article>
  1454. <article
  1455. class="
  1456. phpdocumentor-element
  1457. -property
  1458. -protected
  1459. "
  1460. >
  1461. <h4 class="phpdocumentor-element__name" id="property_outputType">
  1462. $outputType
  1463. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" class="headerlink"><i class="fas fa-link"></i></a>
  1464. <span class="phpdocumentor-element__modifiers">
  1465. </span>
  1466. </h4>
  1467. <aside class="phpdocumentor-element-found-in">
  1468. <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>
  1469. :
  1470. <span class="phpdocumentor-element-found-in__line">99</span>
  1471. </aside>
  1472. <p class="phpdocumentor-summary">The built-in output type</p>
  1473. <code class="phpdocumentor-code phpdocumentor-signature ">
  1474. <span class="phpdocumentor-signature__visibility">protected</span>
  1475. <span class="phpdocumentor-signature__type">string</span>
  1476. <span class="phpdocumentor-signature__name">$outputType</span>
  1477. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG</span></code>
  1478. <section class="phpdocumentor-description"><ul>
  1479. <li>QROutputInterface::MARKUP_XXXX where XXXX = HTML, SVG</li>
  1480. <li>QROutputInterface::GDIMAGE_XXX where XXX = BMP, GIF, JPG, PNG, WEBP</li>
  1481. <li>QROutputInterface::STRING_XXXX where XXXX = TEXT, JSON</li>
  1482. <li>QROutputInterface::IMAGICK</li>
  1483. <li>QROutputInterface::EPS</li>
  1484. <li>QROutputInterface::FPDF</li>
  1485. <li>QROutputInterface::CUSTOM</li>
  1486. </ul>
  1487. </section>
  1488. </article>
  1489. <article
  1490. class="
  1491. phpdocumentor-element
  1492. -property
  1493. -protected
  1494. "
  1495. >
  1496. <h4 class="phpdocumentor-element__name" id="property_quality">
  1497. $quality
  1498. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" class="headerlink"><i class="fas fa-link"></i></a>
  1499. <span class="phpdocumentor-element__modifiers">
  1500. </span>
  1501. </h4>
  1502. <aside class="phpdocumentor-element-found-in">
  1503. <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>
  1504. :
  1505. <span class="phpdocumentor-element-found-in__line">286</span>
  1506. </aside>
  1507. <p class="phpdocumentor-summary">Compression quality</p>
  1508. <code class="phpdocumentor-code phpdocumentor-signature ">
  1509. <span class="phpdocumentor-signature__visibility">protected</span>
  1510. <span class="phpdocumentor-signature__type">int</span>
  1511. <span class="phpdocumentor-signature__name">$quality</span>
  1512. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  1513. <section class="phpdocumentor-description"><p>The given value depends on the used output type:</p>
  1514. <ul>
  1515. <li>GDIMAGE_BMP <abbr title="\imagebmp()">imagebmp()</abbr> [0-1]</li>
  1516. <li>GDIMAGE_JPG <abbr title="\imagejpeg()">imagejpeg()</abbr> [0-100]</li>
  1517. <li>GDIMAGE_WEBP <abbr title="\imagepng()">imagepng()</abbr> [0-9]</li>
  1518. <li>GDIMAGE_PNG <abbr title="\imagewebp()">imagewebp()</abbr> [0-100]</li>
  1519. <li>IMAGICK <abbr title="\Imagick::setImageCompressionQuality()">Imagick::setImageCompressionQuality()</abbr> [0-100]</li>
  1520. </ul>
  1521. </section>
  1522. </article>
  1523. <article
  1524. class="
  1525. phpdocumentor-element
  1526. -property
  1527. -protected
  1528. "
  1529. >
  1530. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  1531. $quietzoneSize
  1532. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  1533. <span class="phpdocumentor-element__modifiers">
  1534. </span>
  1535. </h4>
  1536. <aside class="phpdocumentor-element-found-in">
  1537. <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>
  1538. :
  1539. <span class="phpdocumentor-element-found-in__line">81</span>
  1540. </aside>
  1541. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  1542. <code class="phpdocumentor-code phpdocumentor-signature ">
  1543. <span class="phpdocumentor-signature__visibility">protected</span>
  1544. <span class="phpdocumentor-signature__type">int</span>
  1545. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  1546. = <span class="phpdocumentor-signature__default-value">4</span></code>
  1547. <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
  1548. </section>
  1549. </article>
  1550. <article
  1551. class="
  1552. phpdocumentor-element
  1553. -property
  1554. -protected
  1555. "
  1556. >
  1557. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  1558. $readerGrayscale
  1559. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  1560. <span class="phpdocumentor-element__modifiers">
  1561. </span>
  1562. </h4>
  1563. <aside class="phpdocumentor-element-found-in">
  1564. <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>
  1565. :
  1566. <span class="phpdocumentor-element-found-in__line">423</span>
  1567. </aside>
  1568. <p class="phpdocumentor-summary">Grayscale the image before reading</p>
  1569. <code class="phpdocumentor-code phpdocumentor-signature ">
  1570. <span class="phpdocumentor-signature__visibility">protected</span>
  1571. <span class="phpdocumentor-signature__type">bool</span>
  1572. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  1573. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1574. </article>
  1575. <article
  1576. class="
  1577. phpdocumentor-element
  1578. -property
  1579. -protected
  1580. "
  1581. >
  1582. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  1583. $readerIncreaseContrast
  1584. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  1585. <span class="phpdocumentor-element__modifiers">
  1586. </span>
  1587. </h4>
  1588. <aside class="phpdocumentor-element-found-in">
  1589. <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>
  1590. :
  1591. <span class="phpdocumentor-element-found-in__line">430</span>
  1592. </aside>
  1593. <p class="phpdocumentor-summary">Increase the contrast before reading</p>
  1594. <code class="phpdocumentor-code phpdocumentor-signature ">
  1595. <span class="phpdocumentor-signature__visibility">protected</span>
  1596. <span class="phpdocumentor-signature__type">bool</span>
  1597. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  1598. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1599. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  1600. </section>
  1601. </article>
  1602. <article
  1603. class="
  1604. phpdocumentor-element
  1605. -property
  1606. -protected
  1607. "
  1608. >
  1609. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  1610. $readerUseImagickIfAvailable
  1611. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1612. <span class="phpdocumentor-element__modifiers">
  1613. </span>
  1614. </h4>
  1615. <aside class="phpdocumentor-element-found-in">
  1616. <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>
  1617. :
  1618. <span class="phpdocumentor-element-found-in__line">418</span>
  1619. </aside>
  1620. <p class="phpdocumentor-summary">Use Imagick (if available) when reading QR Codes</p>
  1621. <code class="phpdocumentor-code phpdocumentor-signature ">
  1622. <span class="phpdocumentor-signature__visibility">protected</span>
  1623. <span class="phpdocumentor-signature__type">bool</span>
  1624. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  1625. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1626. </article>
  1627. <article
  1628. class="
  1629. phpdocumentor-element
  1630. -property
  1631. -protected
  1632. "
  1633. >
  1634. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  1635. $returnResource
  1636. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  1637. <span class="phpdocumentor-element__modifiers">
  1638. </span>
  1639. </h4>
  1640. <aside class="phpdocumentor-element-found-in">
  1641. <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>
  1642. :
  1643. <span class="phpdocumentor-element-found-in__line">120</span>
  1644. </aside>
  1645. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  1646. <code class="phpdocumentor-code phpdocumentor-signature ">
  1647. <span class="phpdocumentor-signature__visibility">protected</span>
  1648. <span class="phpdocumentor-signature__type">bool</span>
  1649. <span class="phpdocumentor-signature__name">$returnResource</span>
  1650. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1651. <section class="phpdocumentor-description"><p>This option overrides/ignores other output options, such as $cachefile and $outputBase64.</p>
  1652. <p>Supported by the following modules:</p>
  1653. <ul>
  1654. <li>QRGdImage: resource (PHP &lt; 8), GdImage</li>
  1655. <li>QRImagick: Imagick</li>
  1656. <li>QRFpdf: FPDF</li>
  1657. </ul>
  1658. </section>
  1659. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1660. Tags
  1661. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1662. </h5>
  1663. <dl class="phpdocumentor-tag-list">
  1664. <dt class="phpdocumentor-tag-list__entry">
  1665. <span class="phpdocumentor-tag__name">see</span>
  1666. </dt>
  1667. <dd class="phpdocumentor-tag-list__definition">
  1668. <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>
  1669. </dd>
  1670. </dl>
  1671. </article>
  1672. <article
  1673. class="
  1674. phpdocumentor-element
  1675. -property
  1676. -protected
  1677. "
  1678. >
  1679. <h4 class="phpdocumentor-element__name" id="property_scale">
  1680. $scale
  1681. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  1682. <span class="phpdocumentor-element__modifiers">
  1683. </span>
  1684. </h4>
  1685. <aside class="phpdocumentor-element-found-in">
  1686. <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>
  1687. :
  1688. <span class="phpdocumentor-element-found-in__line">253</span>
  1689. </aside>
  1690. <p class="phpdocumentor-summary">Pixel size of a QR code module</p>
  1691. <code class="phpdocumentor-code phpdocumentor-signature ">
  1692. <span class="phpdocumentor-signature__visibility">protected</span>
  1693. <span class="phpdocumentor-signature__type">int</span>
  1694. <span class="phpdocumentor-signature__name">$scale</span>
  1695. = <span class="phpdocumentor-signature__default-value">5</span></code>
  1696. </article>
  1697. <article
  1698. class="
  1699. phpdocumentor-element
  1700. -property
  1701. -protected
  1702. "
  1703. >
  1704. <h4 class="phpdocumentor-element__name" id="property_svgAddXmlHeader">
  1705. $svgAddXmlHeader
  1706. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" class="headerlink"><i class="fas fa-link"></i></a>
  1707. <span class="phpdocumentor-element__modifiers">
  1708. </span>
  1709. </h4>
  1710. <aside class="phpdocumentor-element-found-in">
  1711. <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>
  1712. :
  1713. <span class="phpdocumentor-element-found-in__line">331</span>
  1714. </aside>
  1715. <p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p>
  1716. <code class="phpdocumentor-code phpdocumentor-signature ">
  1717. <span class="phpdocumentor-signature__visibility">protected</span>
  1718. <span class="phpdocumentor-signature__type">bool</span>
  1719. <span class="phpdocumentor-signature__name">$svgAddXmlHeader</span>
  1720. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1721. <section class="phpdocumentor-description"><p><code class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</code></p>
  1722. </section>
  1723. </article>
  1724. <article
  1725. class="
  1726. phpdocumentor-element
  1727. -property
  1728. -protected
  1729. "
  1730. >
  1731. <h4 class="phpdocumentor-element__name" id="property_svgDefs">
  1732. $svgDefs
  1733. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
  1734. <span class="phpdocumentor-element__modifiers">
  1735. </span>
  1736. </h4>
  1737. <aside class="phpdocumentor-element-found-in">
  1738. <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>
  1739. :
  1740. <span class="phpdocumentor-element-found-in__line">343</span>
  1741. </aside>
  1742. <p class="phpdocumentor-summary">Anything in the &lt;defs&gt; tag</p>
  1743. <code class="phpdocumentor-code phpdocumentor-signature ">
  1744. <span class="phpdocumentor-signature__visibility">protected</span>
  1745. <span class="phpdocumentor-signature__type">string</span>
  1746. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1747. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1748. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1749. Tags
  1750. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1751. </h5>
  1752. <dl class="phpdocumentor-tag-list">
  1753. <dt class="phpdocumentor-tag-list__entry">
  1754. <span class="phpdocumentor-tag__name">see</span>
  1755. </dt>
  1756. <dd class="phpdocumentor-tag-list__definition">
  1757. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</a></span>
  1758. </dd>
  1759. </dl>
  1760. </article>
  1761. <article
  1762. class="
  1763. phpdocumentor-element
  1764. -property
  1765. -protected
  1766. "
  1767. >
  1768. <h4 class="phpdocumentor-element__name" id="property_svgHeight">
  1769. $svgHeight
  1770. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1771. <span class="phpdocumentor-element__modifiers">
  1772. </span>
  1773. </h4>
  1774. <aside class="phpdocumentor-element-found-in">
  1775. <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>
  1776. :
  1777. <span class="phpdocumentor-element-found-in__line">372</span>
  1778. </aside>
  1779. <p class="phpdocumentor-summary">Optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</p>
  1780. <code class="phpdocumentor-code phpdocumentor-signature ">
  1781. <span class="phpdocumentor-signature__visibility">protected</span>
  1782. <span class="phpdocumentor-signature__type">string|null</span>
  1783. <span class="phpdocumentor-signature__name">$svgHeight</span>
  1784. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1785. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1786. Tags
  1787. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1788. </h5>
  1789. <dl class="phpdocumentor-tag-list">
  1790. <dt class="phpdocumentor-tag-list__entry">
  1791. <span class="phpdocumentor-tag__name">see</span>
  1792. </dt>
  1793. <dd class="phpdocumentor-tag-list__definition">
  1794. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height</a></span>
  1795. </dd>
  1796. </dl>
  1797. </article>
  1798. <article
  1799. class="
  1800. phpdocumentor-element
  1801. -property
  1802. -protected
  1803. "
  1804. >
  1805. <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
  1806. $svgOpacity
  1807. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" class="headerlink"><i class="fas fa-link"></i></a>
  1808. <span class="phpdocumentor-element__modifiers">
  1809. </span>
  1810. </h4>
  1811. <aside class="phpdocumentor-element-found-in">
  1812. <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>
  1813. :
  1814. <span class="phpdocumentor-element-found-in__line">336</span>
  1815. </aside>
  1816. <p class="phpdocumentor-summary">SVG opacity</p>
  1817. <code class="phpdocumentor-code phpdocumentor-signature ">
  1818. <span class="phpdocumentor-signature__visibility">protected</span>
  1819. <span class="phpdocumentor-signature__type">float</span>
  1820. <span class="phpdocumentor-signature__name">$svgOpacity</span>
  1821. = <span class="phpdocumentor-signature__default-value">1.0</span></code>
  1822. </article>
  1823. <article
  1824. class="
  1825. phpdocumentor-element
  1826. -property
  1827. -protected
  1828. "
  1829. >
  1830. <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
  1831. $svgPreserveAspectRatio
  1832. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
  1833. <span class="phpdocumentor-element__modifiers">
  1834. </span>
  1835. </h4>
  1836. <aside class="phpdocumentor-element-found-in">
  1837. <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>
  1838. :
  1839. <span class="phpdocumentor-element-found-in__line">358</span>
  1840. </aside>
  1841. <code class="phpdocumentor-code phpdocumentor-signature ">
  1842. <span class="phpdocumentor-signature__visibility">protected</span>
  1843. <span class="phpdocumentor-signature__type">string</span>
  1844. <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
  1845. = <span class="phpdocumentor-signature__default-value">&#039;xMidYMid&#039;</span></code>
  1846. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1847. Tags
  1848. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1849. </h5>
  1850. <dl class="phpdocumentor-tag-list">
  1851. <dt class="phpdocumentor-tag-list__entry">
  1852. <span class="phpdocumentor-tag__name">see</span>
  1853. </dt>
  1854. <dd class="phpdocumentor-tag-list__definition">
  1855. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</a></span>
  1856. </dd>
  1857. </dl>
  1858. </article>
  1859. <article
  1860. class="
  1861. phpdocumentor-element
  1862. -property
  1863. -protected
  1864. "
  1865. >
  1866. <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
  1867. $svgViewBoxSize
  1868. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" class="headerlink"><i class="fas fa-link"></i></a>
  1869. <span class="phpdocumentor-element__modifiers">
  1870. </span>
  1871. </h4>
  1872. <aside class="phpdocumentor-element-found-in">
  1873. <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>
  1874. :
  1875. <span class="phpdocumentor-element-found-in__line">353</span>
  1876. </aside>
  1877. <p class="phpdocumentor-summary">SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.</p>
  1878. <code class="phpdocumentor-code phpdocumentor-signature ">
  1879. <span class="phpdocumentor-signature__visibility">protected</span>
  1880. <span class="phpdocumentor-signature__type">int|null</span>
  1881. <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
  1882. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1883. <section class="phpdocumentor-description"><p>viewBox=&quot;0 0 x x&quot;</p>
  1884. </section>
  1885. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1886. Tags
  1887. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1888. </h5>
  1889. <dl class="phpdocumentor-tag-list">
  1890. <dt class="phpdocumentor-tag-list__entry">
  1891. <span class="phpdocumentor-tag__name">see</span>
  1892. </dt>
  1893. <dd class="phpdocumentor-tag-list__definition">
  1894. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</a></span>
  1895. </dd>
  1896. <dt class="phpdocumentor-tag-list__entry">
  1897. <span class="phpdocumentor-tag__name">see</span>
  1898. </dt>
  1899. <dd class="phpdocumentor-tag-list__definition">
  1900. <span class="phpdocumentor-tag-link"><a href="https://css-tricks.com/scale-svg/#article-header-id-3">https://css-tricks.com/scale-svg/#article-header-id-3</a></span>
  1901. </dd>
  1902. </dl>
  1903. </article>
  1904. <article
  1905. class="
  1906. phpdocumentor-element
  1907. -property
  1908. -protected
  1909. "
  1910. >
  1911. <h4 class="phpdocumentor-element__name" id="property_svgWidth">
  1912. $svgWidth
  1913. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1914. <span class="phpdocumentor-element__modifiers">
  1915. </span>
  1916. </h4>
  1917. <aside class="phpdocumentor-element-found-in">
  1918. <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>
  1919. :
  1920. <span class="phpdocumentor-element-found-in__line">365</span>
  1921. </aside>
  1922. <p class="phpdocumentor-summary">Optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</p>
  1923. <code class="phpdocumentor-code phpdocumentor-signature ">
  1924. <span class="phpdocumentor-signature__visibility">protected</span>
  1925. <span class="phpdocumentor-signature__type">string|null</span>
  1926. <span class="phpdocumentor-signature__name">$svgWidth</span>
  1927. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1928. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1929. Tags
  1930. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1931. </h5>
  1932. <dl class="phpdocumentor-tag-list">
  1933. <dt class="phpdocumentor-tag-list__entry">
  1934. <span class="phpdocumentor-tag__name">see</span>
  1935. </dt>
  1936. <dd class="phpdocumentor-tag-list__definition">
  1937. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width</a></span>
  1938. </dd>
  1939. </dl>
  1940. </article>
  1941. <article
  1942. class="
  1943. phpdocumentor-element
  1944. -property
  1945. -protected
  1946. "
  1947. >
  1948. <h4 class="phpdocumentor-element__name" id="property_textDark">
  1949. $textDark
  1950. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" class="headerlink"><i class="fas fa-link"></i></a>
  1951. <span class="phpdocumentor-element__modifiers">
  1952. </span>
  1953. </h4>
  1954. <aside class="phpdocumentor-element-found-in">
  1955. <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>
  1956. :
  1957. <span class="phpdocumentor-element-found-in__line">382</span>
  1958. </aside>
  1959. <p class="phpdocumentor-summary">String substitute for dark</p>
  1960. <code class="phpdocumentor-code phpdocumentor-signature ">
  1961. <span class="phpdocumentor-signature__visibility">protected</span>
  1962. <span class="phpdocumentor-signature__type">string</span>
  1963. <span class="phpdocumentor-signature__name">$textDark</span>
  1964. = <span class="phpdocumentor-signature__default-value">&#039;██&#039;</span></code>
  1965. </article>
  1966. <article
  1967. class="
  1968. phpdocumentor-element
  1969. -property
  1970. -protected
  1971. "
  1972. >
  1973. <h4 class="phpdocumentor-element__name" id="property_textLight">
  1974. $textLight
  1975. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" class="headerlink"><i class="fas fa-link"></i></a>
  1976. <span class="phpdocumentor-element__modifiers">
  1977. </span>
  1978. </h4>
  1979. <aside class="phpdocumentor-element-found-in">
  1980. <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>
  1981. :
  1982. <span class="phpdocumentor-element-found-in__line">387</span>
  1983. </aside>
  1984. <p class="phpdocumentor-summary">String substitute for light</p>
  1985. <code class="phpdocumentor-code phpdocumentor-signature ">
  1986. <span class="phpdocumentor-signature__visibility">protected</span>
  1987. <span class="phpdocumentor-signature__type">string</span>
  1988. <span class="phpdocumentor-signature__name">$textLight</span>
  1989. = <span class="phpdocumentor-signature__default-value">&#039;░░&#039;</span></code>
  1990. </article>
  1991. <article
  1992. class="
  1993. phpdocumentor-element
  1994. -property
  1995. -protected
  1996. "
  1997. >
  1998. <h4 class="phpdocumentor-element__name" id="property_textLineStart">
  1999. $textLineStart
  2000. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" class="headerlink"><i class="fas fa-link"></i></a>
  2001. <span class="phpdocumentor-element__modifiers">
  2002. </span>
  2003. </h4>
  2004. <aside class="phpdocumentor-element-found-in">
  2005. <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>
  2006. :
  2007. <span class="phpdocumentor-element-found-in__line">392</span>
  2008. </aside>
  2009. <p class="phpdocumentor-summary">An optional line prefix, e.g. empty space to align the QR Code in a console</p>
  2010. <code class="phpdocumentor-code phpdocumentor-signature ">
  2011. <span class="phpdocumentor-signature__visibility">protected</span>
  2012. <span class="phpdocumentor-signature__type">string</span>
  2013. <span class="phpdocumentor-signature__name">$textLineStart</span>
  2014. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  2015. </article>
  2016. <article
  2017. class="
  2018. phpdocumentor-element
  2019. -property
  2020. -protected
  2021. "
  2022. >
  2023. <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
  2024. $transparencyColor
  2025. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  2026. <span class="phpdocumentor-element__modifiers">
  2027. </span>
  2028. </h4>
  2029. <aside class="phpdocumentor-element-found-in">
  2030. <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>
  2031. :
  2032. <span class="phpdocumentor-element-found-in__line">273</span>
  2033. </aside>
  2034. <p class="phpdocumentor-summary">Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</p>
  2035. <code class="phpdocumentor-code phpdocumentor-signature ">
  2036. <span class="phpdocumentor-signature__visibility">protected</span>
  2037. <span class="phpdocumentor-signature__type">mixed|null</span>
  2038. <span class="phpdocumentor-signature__name">$transparencyColor</span>
  2039. = <span class="phpdocumentor-signature__default-value">null</span></code>
  2040. <section class="phpdocumentor-description"><p>Defaults to \chillerlan\QRCode\QROptions::$bgColor.</p>
  2041. <ul>
  2042. <li>QRGdImage: [R, G, B], this color is set as transparent in <abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr>
  2043. </li>
  2044. <li>QRImagick: &quot;color_str&quot;, this color is set in <abbr title="\chillerlan\QRCode\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr>
  2045. </li>
  2046. </ul>
  2047. </section>
  2048. </article>
  2049. <article
  2050. class="
  2051. phpdocumentor-element
  2052. -property
  2053. -protected
  2054. "
  2055. >
  2056. <h4 class="phpdocumentor-element__name" id="property_version">
  2057. $version
  2058. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  2059. <span class="phpdocumentor-element__modifiers">
  2060. </span>
  2061. </h4>
  2062. <aside class="phpdocumentor-element-found-in">
  2063. <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>
  2064. :
  2065. <span class="phpdocumentor-element-found-in__line">33</span>
  2066. </aside>
  2067. <p class="phpdocumentor-summary">QR Code version number</p>
  2068. <code class="phpdocumentor-code phpdocumentor-signature ">
  2069. <span class="phpdocumentor-signature__visibility">protected</span>
  2070. <span class="phpdocumentor-signature__type">int</span>
  2071. <span class="phpdocumentor-signature__name">$version</span>
  2072. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
  2073. <section class="phpdocumentor-description"><p>[1 ... 40] or Version::AUTO</p>
  2074. </section>
  2075. </article>
  2076. <article
  2077. class="
  2078. phpdocumentor-element
  2079. -property
  2080. -protected
  2081. "
  2082. >
  2083. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  2084. $versionMax
  2085. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2086. <span class="phpdocumentor-element__modifiers">
  2087. </span>
  2088. </h4>
  2089. <aside class="phpdocumentor-element-found-in">
  2090. <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>
  2091. :
  2092. <span class="phpdocumentor-element-found-in__line">45</span>
  2093. </aside>
  2094. <p class="phpdocumentor-summary">Maximum QR version</p>
  2095. <code class="phpdocumentor-code phpdocumentor-signature ">
  2096. <span class="phpdocumentor-signature__visibility">protected</span>
  2097. <span class="phpdocumentor-signature__type">int</span>
  2098. <span class="phpdocumentor-signature__name">$versionMax</span>
  2099. = <span class="phpdocumentor-signature__default-value">40</span></code>
  2100. </article>
  2101. <article
  2102. class="
  2103. phpdocumentor-element
  2104. -property
  2105. -protected
  2106. "
  2107. >
  2108. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  2109. $versionMin
  2110. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2111. <span class="phpdocumentor-element__modifiers">
  2112. </span>
  2113. </h4>
  2114. <aside class="phpdocumentor-element-found-in">
  2115. <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>
  2116. :
  2117. <span class="phpdocumentor-element-found-in__line">40</span>
  2118. </aside>
  2119. <p class="phpdocumentor-summary">Minimum QR version</p>
  2120. <code class="phpdocumentor-code phpdocumentor-signature ">
  2121. <span class="phpdocumentor-signature__visibility">protected</span>
  2122. <span class="phpdocumentor-signature__type">int</span>
  2123. <span class="phpdocumentor-signature__name">$versionMin</span>
  2124. = <span class="phpdocumentor-signature__default-value">1</span></code>
  2125. <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
  2126. </section>
  2127. </article>
  2128. </section>
  2129. <section class="phpdocumentor-methods">
  2130. <h3 class="phpdocumentor-elements__header" id="methods">
  2131. Methods
  2132. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  2133. </h3>
  2134. <article
  2135. class="phpdocumentor-element
  2136. -method
  2137. -protected
  2138. "
  2139. >
  2140. <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
  2141. clampLogoSpaceValue()
  2142. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  2143. </h4>
  2144. <aside class="phpdocumentor-element-found-in">
  2145. <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>
  2146. :
  2147. <span class="phpdocumentor-element-found-in__line">497</span>
  2148. </aside>
  2149. <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
  2150. <code class="phpdocumentor-code phpdocumentor-signature ">
  2151. <span class="phpdocumentor-signature__visibility">protected</span>
  2152. <span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
  2153. <div class="phpdocumentor-label-line">
  2154. </div>
  2155. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2156. <dl class="phpdocumentor-argument-list">
  2157. <dt class="phpdocumentor-argument-list__entry">
  2158. <span class="phpdocumentor-signature__argument__name">$value</span>
  2159. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2160. </dt>
  2161. <dd class="phpdocumentor-argument-list__definition">
  2162. </dd>
  2163. </dl>
  2164. <section>
  2165. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2166. <span class="phpdocumentor-signature__response_type">int|null</span>
  2167. </section>
  2168. </article>
  2169. <article
  2170. class="phpdocumentor-element
  2171. -method
  2172. -protected
  2173. -deprecated "
  2174. >
  2175. <h4 class="phpdocumentor-element__name" id="method_get_imageBase64">
  2176. get_imageBase64()
  2177. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  2178. </h4>
  2179. <aside class="phpdocumentor-element-found-in">
  2180. <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>
  2181. :
  2182. <span class="phpdocumentor-element-found-in__line">559</span>
  2183. </aside>
  2184. <p class="phpdocumentor-summary">redirect call to the new variable</p>
  2185. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2186. <span class="phpdocumentor-signature__visibility">protected</span>
  2187. <span class="phpdocumentor-signature__name">get_imageBase64</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  2188. <div class="phpdocumentor-label-line">
  2189. </div>
  2190. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2191. Tags
  2192. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2193. </h5>
  2194. <dl class="phpdocumentor-tag-list">
  2195. <dt class="phpdocumentor-tag-list__entry">
  2196. <span class="phpdocumentor-tag__name">deprecated</span>
  2197. </dt>
  2198. <dd class="phpdocumentor-tag-list__definition">
  2199. <span class="phpdocumentor-tag-link">5.0.0</span>
  2200. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  2201. </section>
  2202. </dd>
  2203. <dt class="phpdocumentor-tag-list__entry">
  2204. <span class="phpdocumentor-tag__name">see</span>
  2205. </dt>
  2206. <dd class="phpdocumentor-tag-list__definition">
  2207. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  2208. </dd>
  2209. <dt class="phpdocumentor-tag-list__entry">
  2210. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2211. </dt>
  2212. <dd class="phpdocumentor-tag-list__definition">
  2213. </dd>
  2214. </dl>
  2215. <section>
  2216. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2217. <span class="phpdocumentor-signature__response_type">bool</span>
  2218. </section>
  2219. </article>
  2220. <article
  2221. class="phpdocumentor-element
  2222. -method
  2223. -protected
  2224. -deprecated "
  2225. >
  2226. <h4 class="phpdocumentor-element__name" id="method_get_imageTransparencyBG">
  2227. get_imageTransparencyBG()
  2228. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  2229. </h4>
  2230. <aside class="phpdocumentor-element-found-in">
  2231. <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>
  2232. :
  2233. <span class="phpdocumentor-element-found-in__line">617</span>
  2234. </aside>
  2235. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2236. <span class="phpdocumentor-signature__visibility">protected</span>
  2237. <span class="phpdocumentor-signature__name">get_imageTransparencyBG</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  2238. <div class="phpdocumentor-label-line">
  2239. </div>
  2240. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2241. Tags
  2242. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2243. </h5>
  2244. <dl class="phpdocumentor-tag-list">
  2245. <dt class="phpdocumentor-tag-list__entry">
  2246. <span class="phpdocumentor-tag__name">deprecated</span>
  2247. </dt>
  2248. <dd class="phpdocumentor-tag-list__definition">
  2249. <span class="phpdocumentor-tag-link">5.0.0</span>
  2250. <section class="phpdocumentor-description"><p>use QROptions::$transparencyColor instead</p>
  2251. </section>
  2252. </dd>
  2253. <dt class="phpdocumentor-tag-list__entry">
  2254. <span class="phpdocumentor-tag__name">see</span>
  2255. </dt>
  2256. <dd class="phpdocumentor-tag-list__definition">
  2257. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr></span>
  2258. </dd>
  2259. <dt class="phpdocumentor-tag-list__entry">
  2260. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2261. </dt>
  2262. <dd class="phpdocumentor-tag-list__definition">
  2263. </dd>
  2264. </dl>
  2265. </article>
  2266. <article
  2267. class="phpdocumentor-element
  2268. -method
  2269. -protected
  2270. -deprecated "
  2271. >
  2272. <h4 class="phpdocumentor-element__name" id="method_get_imagickBG">
  2273. get_imagickBG()
  2274. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  2275. </h4>
  2276. <aside class="phpdocumentor-element-found-in">
  2277. <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>
  2278. :
  2279. <span class="phpdocumentor-element-found-in__line">635</span>
  2280. </aside>
  2281. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2282. <span class="phpdocumentor-signature__visibility">protected</span>
  2283. <span class="phpdocumentor-signature__name">get_imagickBG</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  2284. <div class="phpdocumentor-label-line">
  2285. </div>
  2286. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2287. Tags
  2288. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2289. </h5>
  2290. <dl class="phpdocumentor-tag-list">
  2291. <dt class="phpdocumentor-tag-list__entry">
  2292. <span class="phpdocumentor-tag__name">deprecated</span>
  2293. </dt>
  2294. <dd class="phpdocumentor-tag-list__definition">
  2295. <span class="phpdocumentor-tag-link">5.0.0</span>
  2296. <section class="phpdocumentor-description"><p>use QROptions::$bgColor instead</p>
  2297. </section>
  2298. </dd>
  2299. <dt class="phpdocumentor-tag-list__entry">
  2300. <span class="phpdocumentor-tag__name">see</span>
  2301. </dt>
  2302. <dd class="phpdocumentor-tag-list__definition">
  2303. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr></span>
  2304. </dd>
  2305. <dt class="phpdocumentor-tag-list__entry">
  2306. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2307. </dt>
  2308. <dd class="phpdocumentor-tag-list__definition">
  2309. </dd>
  2310. </dl>
  2311. </article>
  2312. <article
  2313. class="phpdocumentor-element
  2314. -method
  2315. -protected
  2316. -deprecated "
  2317. >
  2318. <h4 class="phpdocumentor-element__name" id="method_get_jpegQuality">
  2319. get_jpegQuality()
  2320. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  2321. </h4>
  2322. <aside class="phpdocumentor-element-found-in">
  2323. <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>
  2324. :
  2325. <span class="phpdocumentor-element-found-in__line">581</span>
  2326. </aside>
  2327. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2328. <span class="phpdocumentor-signature__visibility">protected</span>
  2329. <span class="phpdocumentor-signature__name">get_jpegQuality</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2330. <div class="phpdocumentor-label-line">
  2331. </div>
  2332. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2333. Tags
  2334. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2335. </h5>
  2336. <dl class="phpdocumentor-tag-list">
  2337. <dt class="phpdocumentor-tag-list__entry">
  2338. <span class="phpdocumentor-tag__name">deprecated</span>
  2339. </dt>
  2340. <dd class="phpdocumentor-tag-list__definition">
  2341. <span class="phpdocumentor-tag-link">5.0.0</span>
  2342. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2343. </section>
  2344. </dd>
  2345. <dt class="phpdocumentor-tag-list__entry">
  2346. <span class="phpdocumentor-tag__name">see</span>
  2347. </dt>
  2348. <dd class="phpdocumentor-tag-list__definition">
  2349. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2350. </dd>
  2351. <dt class="phpdocumentor-tag-list__entry">
  2352. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2353. </dt>
  2354. <dd class="phpdocumentor-tag-list__definition">
  2355. </dd>
  2356. </dl>
  2357. <section>
  2358. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2359. <span class="phpdocumentor-signature__response_type">int</span>
  2360. </section>
  2361. </article>
  2362. <article
  2363. class="phpdocumentor-element
  2364. -method
  2365. -protected
  2366. -deprecated "
  2367. >
  2368. <h4 class="phpdocumentor-element__name" id="method_get_pngCompression">
  2369. get_pngCompression()
  2370. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  2371. </h4>
  2372. <aside class="phpdocumentor-element-found-in">
  2373. <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>
  2374. :
  2375. <span class="phpdocumentor-element-found-in__line">599</span>
  2376. </aside>
  2377. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2378. <span class="phpdocumentor-signature__visibility">protected</span>
  2379. <span class="phpdocumentor-signature__name">get_pngCompression</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2380. <div class="phpdocumentor-label-line">
  2381. </div>
  2382. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2383. Tags
  2384. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2385. </h5>
  2386. <dl class="phpdocumentor-tag-list">
  2387. <dt class="phpdocumentor-tag-list__entry">
  2388. <span class="phpdocumentor-tag__name">deprecated</span>
  2389. </dt>
  2390. <dd class="phpdocumentor-tag-list__definition">
  2391. <span class="phpdocumentor-tag-link">5.0.0</span>
  2392. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2393. </section>
  2394. </dd>
  2395. <dt class="phpdocumentor-tag-list__entry">
  2396. <span class="phpdocumentor-tag__name">see</span>
  2397. </dt>
  2398. <dd class="phpdocumentor-tag-list__definition">
  2399. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2400. </dd>
  2401. <dt class="phpdocumentor-tag-list__entry">
  2402. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2403. </dt>
  2404. <dd class="phpdocumentor-tag-list__definition">
  2405. </dd>
  2406. </dl>
  2407. <section>
  2408. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2409. <span class="phpdocumentor-signature__response_type">int</span>
  2410. </section>
  2411. </article>
  2412. <article
  2413. class="phpdocumentor-element
  2414. -method
  2415. -protected
  2416. "
  2417. >
  2418. <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
  2419. set_circleRadius()
  2420. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  2421. </h4>
  2422. <aside class="phpdocumentor-element-found-in">
  2423. <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>
  2424. :
  2425. <span class="phpdocumentor-element-found-in__line">537</span>
  2426. </aside>
  2427. <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
  2428. <code class="phpdocumentor-code phpdocumentor-signature ">
  2429. <span class="phpdocumentor-signature__visibility">protected</span>
  2430. <span class="phpdocumentor-signature__name">set_circleRadius</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$circleRadius</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2431. <div class="phpdocumentor-label-line">
  2432. </div>
  2433. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2434. <dl class="phpdocumentor-argument-list">
  2435. <dt class="phpdocumentor-argument-list__entry">
  2436. <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
  2437. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  2438. </dt>
  2439. <dd class="phpdocumentor-argument-list__definition">
  2440. </dd>
  2441. </dl>
  2442. </article>
  2443. <article
  2444. class="phpdocumentor-element
  2445. -method
  2446. -protected
  2447. "
  2448. >
  2449. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  2450. set_fpdfMeasureUnit()
  2451. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  2452. </h4>
  2453. <aside class="phpdocumentor-element-found-in">
  2454. <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>
  2455. :
  2456. <span class="phpdocumentor-element-found-in__line">477</span>
  2457. </aside>
  2458. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  2459. <code class="phpdocumentor-code phpdocumentor-signature ">
  2460. <span class="phpdocumentor-signature__visibility">protected</span>
  2461. <span class="phpdocumentor-signature__name">set_fpdfMeasureUnit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$unit</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2462. <div class="phpdocumentor-label-line">
  2463. </div>
  2464. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2465. <dl class="phpdocumentor-argument-list">
  2466. <dt class="phpdocumentor-argument-list__entry">
  2467. <span class="phpdocumentor-signature__argument__name">$unit</span>
  2468. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2469. </dt>
  2470. <dd class="phpdocumentor-argument-list__definition">
  2471. </dd>
  2472. </dl>
  2473. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2474. Tags
  2475. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2476. </h5>
  2477. <dl class="phpdocumentor-tag-list">
  2478. <dt class="phpdocumentor-tag-list__entry">
  2479. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2480. </dt>
  2481. <dd class="phpdocumentor-tag-list__definition">
  2482. </dd>
  2483. </dl>
  2484. </article>
  2485. <article
  2486. class="phpdocumentor-element
  2487. -method
  2488. -protected
  2489. -deprecated "
  2490. >
  2491. <h4 class="phpdocumentor-element__name" id="method_set_imageBase64">
  2492. set_imageBase64()
  2493. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  2494. </h4>
  2495. <aside class="phpdocumentor-element-found-in">
  2496. <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>
  2497. :
  2498. <span class="phpdocumentor-element-found-in__line">548</span>
  2499. </aside>
  2500. <p class="phpdocumentor-summary">redirect call to the new variable</p>
  2501. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2502. <span class="phpdocumentor-signature__visibility">protected</span>
  2503. <span class="phpdocumentor-signature__name">set_imageBase64</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imageBase64</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2504. <div class="phpdocumentor-label-line">
  2505. </div>
  2506. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2507. <dl class="phpdocumentor-argument-list">
  2508. <dt class="phpdocumentor-argument-list__entry">
  2509. <span class="phpdocumentor-signature__argument__name">$imageBase64</span>
  2510. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2511. </dt>
  2512. <dd class="phpdocumentor-argument-list__definition">
  2513. </dd>
  2514. </dl>
  2515. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2516. Tags
  2517. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2518. </h5>
  2519. <dl class="phpdocumentor-tag-list">
  2520. <dt class="phpdocumentor-tag-list__entry">
  2521. <span class="phpdocumentor-tag__name">deprecated</span>
  2522. </dt>
  2523. <dd class="phpdocumentor-tag-list__definition">
  2524. <span class="phpdocumentor-tag-link">5.0.0</span>
  2525. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  2526. </section>
  2527. </dd>
  2528. <dt class="phpdocumentor-tag-list__entry">
  2529. <span class="phpdocumentor-tag__name">see</span>
  2530. </dt>
  2531. <dd class="phpdocumentor-tag-list__definition">
  2532. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  2533. </dd>
  2534. <dt class="phpdocumentor-tag-list__entry">
  2535. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2536. </dt>
  2537. <dd class="phpdocumentor-tag-list__definition">
  2538. </dd>
  2539. </dl>
  2540. </article>
  2541. <article
  2542. class="phpdocumentor-element
  2543. -method
  2544. -protected
  2545. -deprecated "
  2546. >
  2547. <h4 class="phpdocumentor-element__name" id="method_set_imageTransparencyBG">
  2548. set_imageTransparencyBG()
  2549. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  2550. </h4>
  2551. <aside class="phpdocumentor-element-found-in">
  2552. <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>
  2553. :
  2554. <span class="phpdocumentor-element-found-in__line">608</span>
  2555. </aside>
  2556. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2557. <span class="phpdocumentor-signature__visibility">protected</span>
  2558. <span class="phpdocumentor-signature__name">set_imageTransparencyBG</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imageTransparencyBG</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2559. <div class="phpdocumentor-label-line">
  2560. </div>
  2561. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2562. <dl class="phpdocumentor-argument-list">
  2563. <dt class="phpdocumentor-argument-list__entry">
  2564. <span class="phpdocumentor-signature__argument__name">$imageTransparencyBG</span>
  2565. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  2566. </dt>
  2567. <dd class="phpdocumentor-argument-list__definition">
  2568. </dd>
  2569. </dl>
  2570. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2571. Tags
  2572. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2573. </h5>
  2574. <dl class="phpdocumentor-tag-list">
  2575. <dt class="phpdocumentor-tag-list__entry">
  2576. <span class="phpdocumentor-tag__name">deprecated</span>
  2577. </dt>
  2578. <dd class="phpdocumentor-tag-list__definition">
  2579. <span class="phpdocumentor-tag-link">5.0.0</span>
  2580. <section class="phpdocumentor-description"><p>use QROptions::$transparencyColor instead</p>
  2581. </section>
  2582. </dd>
  2583. <dt class="phpdocumentor-tag-list__entry">
  2584. <span class="phpdocumentor-tag__name">see</span>
  2585. </dt>
  2586. <dd class="phpdocumentor-tag-list__definition">
  2587. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr></span>
  2588. </dd>
  2589. <dt class="phpdocumentor-tag-list__entry">
  2590. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2591. </dt>
  2592. <dd class="phpdocumentor-tag-list__definition">
  2593. </dd>
  2594. </dl>
  2595. </article>
  2596. <article
  2597. class="phpdocumentor-element
  2598. -method
  2599. -protected
  2600. -deprecated "
  2601. >
  2602. <h4 class="phpdocumentor-element__name" id="method_set_imagickBG">
  2603. set_imagickBG()
  2604. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  2605. </h4>
  2606. <aside class="phpdocumentor-element-found-in">
  2607. <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>
  2608. :
  2609. <span class="phpdocumentor-element-found-in__line">626</span>
  2610. </aside>
  2611. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2612. <span class="phpdocumentor-signature__visibility">protected</span>
  2613. <span class="phpdocumentor-signature__name">set_imagickBG</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imagickBG</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2614. <div class="phpdocumentor-label-line">
  2615. </div>
  2616. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2617. <dl class="phpdocumentor-argument-list">
  2618. <dt class="phpdocumentor-argument-list__entry">
  2619. <span class="phpdocumentor-signature__argument__name">$imagickBG</span>
  2620. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2621. </dt>
  2622. <dd class="phpdocumentor-argument-list__definition">
  2623. </dd>
  2624. </dl>
  2625. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2626. Tags
  2627. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2628. </h5>
  2629. <dl class="phpdocumentor-tag-list">
  2630. <dt class="phpdocumentor-tag-list__entry">
  2631. <span class="phpdocumentor-tag__name">deprecated</span>
  2632. </dt>
  2633. <dd class="phpdocumentor-tag-list__definition">
  2634. <span class="phpdocumentor-tag-link">5.0.0</span>
  2635. <section class="phpdocumentor-description"><p>use QROptions::$bgColor instead</p>
  2636. </section>
  2637. </dd>
  2638. <dt class="phpdocumentor-tag-list__entry">
  2639. <span class="phpdocumentor-tag__name">see</span>
  2640. </dt>
  2641. <dd class="phpdocumentor-tag-list__definition">
  2642. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr></span>
  2643. </dd>
  2644. <dt class="phpdocumentor-tag-list__entry">
  2645. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2646. </dt>
  2647. <dd class="phpdocumentor-tag-list__definition">
  2648. </dd>
  2649. </dl>
  2650. </article>
  2651. <article
  2652. class="phpdocumentor-element
  2653. -method
  2654. -protected
  2655. -deprecated "
  2656. >
  2657. <h4 class="phpdocumentor-element__name" id="method_set_jpegQuality">
  2658. set_jpegQuality()
  2659. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  2660. </h4>
  2661. <aside class="phpdocumentor-element-found-in">
  2662. <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>
  2663. :
  2664. <span class="phpdocumentor-element-found-in__line">572</span>
  2665. </aside>
  2666. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2667. <span class="phpdocumentor-signature__visibility">protected</span>
  2668. <span class="phpdocumentor-signature__name">set_jpegQuality</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$jpegQuality</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2669. <div class="phpdocumentor-label-line">
  2670. </div>
  2671. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2672. <dl class="phpdocumentor-argument-list">
  2673. <dt class="phpdocumentor-argument-list__entry">
  2674. <span class="phpdocumentor-signature__argument__name">$jpegQuality</span>
  2675. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2676. </dt>
  2677. <dd class="phpdocumentor-argument-list__definition">
  2678. </dd>
  2679. </dl>
  2680. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2681. Tags
  2682. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2683. </h5>
  2684. <dl class="phpdocumentor-tag-list">
  2685. <dt class="phpdocumentor-tag-list__entry">
  2686. <span class="phpdocumentor-tag__name">deprecated</span>
  2687. </dt>
  2688. <dd class="phpdocumentor-tag-list__definition">
  2689. <span class="phpdocumentor-tag-link">5.0.0</span>
  2690. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2691. </section>
  2692. </dd>
  2693. <dt class="phpdocumentor-tag-list__entry">
  2694. <span class="phpdocumentor-tag__name">see</span>
  2695. </dt>
  2696. <dd class="phpdocumentor-tag-list__definition">
  2697. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2698. </dd>
  2699. <dt class="phpdocumentor-tag-list__entry">
  2700. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2701. </dt>
  2702. <dd class="phpdocumentor-tag-list__definition">
  2703. </dd>
  2704. </dl>
  2705. </article>
  2706. <article
  2707. class="phpdocumentor-element
  2708. -method
  2709. -protected
  2710. "
  2711. >
  2712. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
  2713. set_logoSpaceHeight()
  2714. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  2715. </h4>
  2716. <aside class="phpdocumentor-element-found-in">
  2717. <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>
  2718. :
  2719. <span class="phpdocumentor-element-found-in__line">516</span>
  2720. </aside>
  2721. <p class="phpdocumentor-summary">clamp/set logo space height</p>
  2722. <code class="phpdocumentor-code phpdocumentor-signature ">
  2723. <span class="phpdocumentor-signature__visibility">protected</span>
  2724. <span class="phpdocumentor-signature__name">set_logoSpaceHeight</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2725. <div class="phpdocumentor-label-line">
  2726. </div>
  2727. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2728. <dl class="phpdocumentor-argument-list">
  2729. <dt class="phpdocumentor-argument-list__entry">
  2730. <span class="phpdocumentor-signature__argument__name">$value</span>
  2731. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2732. </dt>
  2733. <dd class="phpdocumentor-argument-list__definition">
  2734. </dd>
  2735. </dl>
  2736. </article>
  2737. <article
  2738. class="phpdocumentor-element
  2739. -method
  2740. -protected
  2741. "
  2742. >
  2743. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
  2744. set_logoSpaceStartX()
  2745. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  2746. </h4>
  2747. <aside class="phpdocumentor-element-found-in">
  2748. <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>
  2749. :
  2750. <span class="phpdocumentor-element-found-in__line">523</span>
  2751. </aside>
  2752. <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
  2753. <code class="phpdocumentor-code phpdocumentor-signature ">
  2754. <span class="phpdocumentor-signature__visibility">protected</span>
  2755. <span class="phpdocumentor-signature__name">set_logoSpaceStartX</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2756. <div class="phpdocumentor-label-line">
  2757. </div>
  2758. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2759. <dl class="phpdocumentor-argument-list">
  2760. <dt class="phpdocumentor-argument-list__entry">
  2761. <span class="phpdocumentor-signature__argument__name">$value</span>
  2762. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2763. </dt>
  2764. <dd class="phpdocumentor-argument-list__definition">
  2765. </dd>
  2766. </dl>
  2767. </article>
  2768. <article
  2769. class="phpdocumentor-element
  2770. -method
  2771. -protected
  2772. "
  2773. >
  2774. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
  2775. set_logoSpaceStartY()
  2776. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  2777. </h4>
  2778. <aside class="phpdocumentor-element-found-in">
  2779. <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>
  2780. :
  2781. <span class="phpdocumentor-element-found-in__line">530</span>
  2782. </aside>
  2783. <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
  2784. <code class="phpdocumentor-code phpdocumentor-signature ">
  2785. <span class="phpdocumentor-signature__visibility">protected</span>
  2786. <span class="phpdocumentor-signature__name">set_logoSpaceStartY</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2787. <div class="phpdocumentor-label-line">
  2788. </div>
  2789. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2790. <dl class="phpdocumentor-argument-list">
  2791. <dt class="phpdocumentor-argument-list__entry">
  2792. <span class="phpdocumentor-signature__argument__name">$value</span>
  2793. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2794. </dt>
  2795. <dd class="phpdocumentor-argument-list__definition">
  2796. </dd>
  2797. </dl>
  2798. </article>
  2799. <article
  2800. class="phpdocumentor-element
  2801. -method
  2802. -protected
  2803. "
  2804. >
  2805. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
  2806. set_logoSpaceWidth()
  2807. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  2808. </h4>
  2809. <aside class="phpdocumentor-element-found-in">
  2810. <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>
  2811. :
  2812. <span class="phpdocumentor-element-found-in__line">509</span>
  2813. </aside>
  2814. <p class="phpdocumentor-summary">clamp/set logo space width</p>
  2815. <code class="phpdocumentor-code phpdocumentor-signature ">
  2816. <span class="phpdocumentor-signature__visibility">protected</span>
  2817. <span class="phpdocumentor-signature__name">set_logoSpaceWidth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2818. <div class="phpdocumentor-label-line">
  2819. </div>
  2820. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2821. <dl class="phpdocumentor-argument-list">
  2822. <dt class="phpdocumentor-argument-list__entry">
  2823. <span class="phpdocumentor-signature__argument__name">$value</span>
  2824. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2825. </dt>
  2826. <dd class="phpdocumentor-argument-list__definition">
  2827. </dd>
  2828. </dl>
  2829. </article>
  2830. <article
  2831. class="phpdocumentor-element
  2832. -method
  2833. -protected
  2834. -deprecated "
  2835. >
  2836. <h4 class="phpdocumentor-element__name" id="method_set_pngCompression">
  2837. set_pngCompression()
  2838. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  2839. </h4>
  2840. <aside class="phpdocumentor-element-found-in">
  2841. <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>
  2842. :
  2843. <span class="phpdocumentor-element-found-in__line">590</span>
  2844. </aside>
  2845. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2846. <span class="phpdocumentor-signature__visibility">protected</span>
  2847. <span class="phpdocumentor-signature__name">set_pngCompression</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pngCompression</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2848. <div class="phpdocumentor-label-line">
  2849. </div>
  2850. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2851. <dl class="phpdocumentor-argument-list">
  2852. <dt class="phpdocumentor-argument-list__entry">
  2853. <span class="phpdocumentor-signature__argument__name">$pngCompression</span>
  2854. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2855. </dt>
  2856. <dd class="phpdocumentor-argument-list__definition">
  2857. </dd>
  2858. </dl>
  2859. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2860. Tags
  2861. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2862. </h5>
  2863. <dl class="phpdocumentor-tag-list">
  2864. <dt class="phpdocumentor-tag-list__entry">
  2865. <span class="phpdocumentor-tag__name">deprecated</span>
  2866. </dt>
  2867. <dd class="phpdocumentor-tag-list__definition">
  2868. <span class="phpdocumentor-tag-link">5.0.0</span>
  2869. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2870. </section>
  2871. </dd>
  2872. <dt class="phpdocumentor-tag-list__entry">
  2873. <span class="phpdocumentor-tag__name">see</span>
  2874. </dt>
  2875. <dd class="phpdocumentor-tag-list__definition">
  2876. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2877. </dd>
  2878. <dt class="phpdocumentor-tag-list__entry">
  2879. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2880. </dt>
  2881. <dd class="phpdocumentor-tag-list__definition">
  2882. </dd>
  2883. </dl>
  2884. </article>
  2885. <article
  2886. class="phpdocumentor-element
  2887. -method
  2888. -protected
  2889. "
  2890. >
  2891. <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
  2892. set_quietzoneSize()
  2893. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  2894. </h4>
  2895. <aside class="phpdocumentor-element-found-in">
  2896. <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>
  2897. :
  2898. <span class="phpdocumentor-element-found-in__line">468</span>
  2899. </aside>
  2900. <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
  2901. <code class="phpdocumentor-code phpdocumentor-signature ">
  2902. <span class="phpdocumentor-signature__visibility">protected</span>
  2903. <span class="phpdocumentor-signature__name">set_quietzoneSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$quietzoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2904. <div class="phpdocumentor-label-line">
  2905. </div>
  2906. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2907. <dl class="phpdocumentor-argument-list">
  2908. <dt class="phpdocumentor-argument-list__entry">
  2909. <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
  2910. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2911. </dt>
  2912. <dd class="phpdocumentor-argument-list__definition">
  2913. </dd>
  2914. </dl>
  2915. </article>
  2916. <article
  2917. class="phpdocumentor-element
  2918. -method
  2919. -protected
  2920. "
  2921. >
  2922. <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
  2923. set_readerUseImagickIfAvailable()
  2924. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  2925. </h4>
  2926. <aside class="phpdocumentor-element-found-in">
  2927. <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>
  2928. :
  2929. <span class="phpdocumentor-element-found-in__line">490</span>
  2930. </aside>
  2931. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  2932. <code class="phpdocumentor-code phpdocumentor-signature ">
  2933. <span class="phpdocumentor-signature__visibility">protected</span>
  2934. <span class="phpdocumentor-signature__name">set_readerUseImagickIfAvailable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2935. <div class="phpdocumentor-label-line">
  2936. </div>
  2937. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2938. <dl class="phpdocumentor-argument-list">
  2939. <dt class="phpdocumentor-argument-list__entry">
  2940. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  2941. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2942. </dt>
  2943. <dd class="phpdocumentor-argument-list__definition">
  2944. </dd>
  2945. </dl>
  2946. </article>
  2947. <article
  2948. class="phpdocumentor-element
  2949. -method
  2950. -protected
  2951. "
  2952. >
  2953. <h4 class="phpdocumentor-element__name" id="method_set_version">
  2954. set_version()
  2955. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  2956. </h4>
  2957. <aside class="phpdocumentor-element-found-in">
  2958. <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>
  2959. :
  2960. <span class="phpdocumentor-element-found-in__line">461</span>
  2961. </aside>
  2962. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  2963. <code class="phpdocumentor-code phpdocumentor-signature ">
  2964. <span class="phpdocumentor-signature__visibility">protected</span>
  2965. <span class="phpdocumentor-signature__name">set_version</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2966. <div class="phpdocumentor-label-line">
  2967. </div>
  2968. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2969. <dl class="phpdocumentor-argument-list">
  2970. <dt class="phpdocumentor-argument-list__entry">
  2971. <span class="phpdocumentor-signature__argument__name">$version</span>
  2972. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2973. </dt>
  2974. <dd class="phpdocumentor-argument-list__definition">
  2975. </dd>
  2976. </dl>
  2977. </article>
  2978. <article
  2979. class="phpdocumentor-element
  2980. -method
  2981. -protected
  2982. "
  2983. >
  2984. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  2985. set_versionMax()
  2986. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2987. </h4>
  2988. <aside class="phpdocumentor-element-found-in">
  2989. <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>
  2990. :
  2991. <span class="phpdocumentor-element-found-in__line">454</span>
  2992. </aside>
  2993. <p class="phpdocumentor-summary">sets the maximum version number</p>
  2994. <code class="phpdocumentor-code phpdocumentor-signature ">
  2995. <span class="phpdocumentor-signature__visibility">protected</span>
  2996. <span class="phpdocumentor-signature__name">set_versionMax</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2997. <div class="phpdocumentor-label-line">
  2998. </div>
  2999. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  3000. <dl class="phpdocumentor-argument-list">
  3001. <dt class="phpdocumentor-argument-list__entry">
  3002. <span class="phpdocumentor-signature__argument__name">$version</span>
  3003. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3004. </dt>
  3005. <dd class="phpdocumentor-argument-list__definition">
  3006. </dd>
  3007. </dl>
  3008. </article>
  3009. <article
  3010. class="phpdocumentor-element
  3011. -method
  3012. -protected
  3013. "
  3014. >
  3015. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  3016. set_versionMin()
  3017. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  3018. </h4>
  3019. <aside class="phpdocumentor-element-found-in">
  3020. <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>
  3021. :
  3022. <span class="phpdocumentor-element-found-in__line">447</span>
  3023. </aside>
  3024. <p class="phpdocumentor-summary">sets the minimum version number</p>
  3025. <code class="phpdocumentor-code phpdocumentor-signature ">
  3026. <span class="phpdocumentor-signature__visibility">protected</span>
  3027. <span class="phpdocumentor-signature__name">set_versionMin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  3028. <div class="phpdocumentor-label-line">
  3029. </div>
  3030. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  3031. <dl class="phpdocumentor-argument-list">
  3032. <dt class="phpdocumentor-argument-list__entry">
  3033. <span class="phpdocumentor-signature__argument__name">$version</span>
  3034. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3035. </dt>
  3036. <dd class="phpdocumentor-argument-list__definition">
  3037. </dd>
  3038. </dl>
  3039. </article>
  3040. <article
  3041. class="phpdocumentor-element
  3042. -method
  3043. -protected
  3044. "
  3045. >
  3046. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  3047. setMinMaxVersion()
  3048. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  3049. </h4>
  3050. <aside class="phpdocumentor-element-found-in">
  3051. <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>
  3052. :
  3053. <span class="phpdocumentor-element-found-in__line">436</span>
  3054. </aside>
  3055. <p class="phpdocumentor-summary">clamp min/max version number</p>
  3056. <code class="phpdocumentor-code phpdocumentor-signature ">
  3057. <span class="phpdocumentor-signature__visibility">protected</span>
  3058. <span class="phpdocumentor-signature__name">setMinMaxVersion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionMax</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  3059. <div class="phpdocumentor-label-line">
  3060. </div>
  3061. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  3062. <dl class="phpdocumentor-argument-list">
  3063. <dt class="phpdocumentor-argument-list__entry">
  3064. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  3065. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3066. </dt>
  3067. <dd class="phpdocumentor-argument-list__definition">
  3068. </dd>
  3069. <dt class="phpdocumentor-argument-list__entry">
  3070. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  3071. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3072. </dt>
  3073. <dd class="phpdocumentor-argument-list__definition">
  3074. </dd>
  3075. </dl>
  3076. </article>
  3077. </section>
  3078. <div class="phpdocumentor-modal" id="source-view">
  3079. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  3080. <div class="phpdocumentor-modal-container">
  3081. <div class="phpdocumentor-modal-content">
  3082. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QROptionsTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  3083. </div>
  3084. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  3085. </div>
  3086. </div>
  3087. <script type="text/javascript">
  3088. (function () {
  3089. function loadExternalCodeSnippet(el, url, line) {
  3090. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  3091. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  3092. const language = 'php';
  3093. const code = document.createElement('code');
  3094. code.className = 'language-' + language;
  3095. pre.textContent = '';
  3096. pre.setAttribute('data-line', line)
  3097. code.textContent = 'Loading…';
  3098. pre.appendChild(code);
  3099. var xhr = new XMLHttpRequest();
  3100. xhr.open('GET', src, true);
  3101. xhr.onreadystatechange = function () {
  3102. if (xhr.readyState !== 4) {
  3103. return;
  3104. }
  3105. if (xhr.status < 400 && xhr.responseText) {
  3106. code.textContent = xhr.responseText;
  3107. Prism.highlightElement(code);
  3108. return;
  3109. }
  3110. if (xhr.status === 404) {
  3111. code.textContent = '✖ Error: File could not be found';
  3112. return;
  3113. }
  3114. if (xhr.status >= 400) {
  3115. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  3116. return;
  3117. }
  3118. code.textContent = '✖ Error: An unknown error occurred';
  3119. };
  3120. xhr.send(null);
  3121. });
  3122. }
  3123. const modalButtons = document.querySelectorAll("[data-modal]");
  3124. const openedAsLocalFile = window.location.protocol === 'file:';
  3125. if (modalButtons.length > 0 && openedAsLocalFile) {
  3126. console.warn(
  3127. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  3128. 'browsers block XHR requests when a page is opened this way'
  3129. );
  3130. }
  3131. modalButtons.forEach(function (trigger) {
  3132. if (openedAsLocalFile) {
  3133. trigger.setAttribute("hidden", "hidden");
  3134. }
  3135. trigger.addEventListener("click", function (event) {
  3136. event.preventDefault();
  3137. const modal = document.getElementById(trigger.dataset.modal);
  3138. if (!modal) {
  3139. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  3140. return;
  3141. }
  3142. modal.classList.add("phpdocumentor-modal__open");
  3143. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  3144. const exits = modal.querySelectorAll("[data-exit-button]");
  3145. exits.forEach(function (exit) {
  3146. exit.addEventListener("click", function (event) {
  3147. event.preventDefault();
  3148. modal.classList.remove("phpdocumentor-modal__open");
  3149. });
  3150. });
  3151. });
  3152. });
  3153. })();
  3154. </script>
  3155. </article>
  3156. </section>
  3157. <section class="phpdocumentor-on-this-page__sidebar">
  3158. <section class="phpdocumentor-on-this-page__content">
  3159. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  3160. <ul class="phpdocumentor-list -clean">
  3161. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  3162. <li>
  3163. <ul class="phpdocumentor-list -clean">
  3164. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#toc-properties">Properties</a></li>
  3165. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#toc-methods">Methods</a></li>
  3166. </ul>
  3167. </li>
  3168. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  3169. <li>
  3170. <ul class="phpdocumentor-list -clean">
  3171. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a></li>
  3172. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a></li>
  3173. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a></li>
  3174. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a></li>
  3175. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a></li>
  3176. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a></li>
  3177. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a></li>
  3178. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a></li>
  3179. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a></li>
  3180. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a></li>
  3181. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a></li>
  3182. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a></li>
  3183. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a></li>
  3184. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a></li>
  3185. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a></li>
  3186. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a></li>
  3187. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a></li>
  3188. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans">$jsonAsBooleans</a></li>
  3189. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a></li>
  3190. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a></li>
  3191. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a></li>
  3192. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a></li>
  3193. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a></li>
  3194. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a></li>
  3195. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a></li>
  3196. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a></li>
  3197. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a></li>
  3198. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a></li>
  3199. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a></li>
  3200. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a></li>
  3201. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a></li>
  3202. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a></li>
  3203. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
  3204. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
  3205. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
  3206. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a></li>
  3207. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a></li>
  3208. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a></li>
  3209. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a></li>
  3210. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a></li>
  3211. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a></li>
  3212. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a></li>
  3213. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a></li>
  3214. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a></li>
  3215. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a></li>
  3216. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a></li>
  3217. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a></li>
  3218. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a></li>
  3219. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a></li>
  3220. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a></li>
  3221. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a></li>
  3222. </ul>
  3223. </li>
  3224. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  3225. <li>
  3226. <ul class="phpdocumentor-list -clean">
  3227. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a></li>
  3228. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64">get_imageBase64()</a></li>
  3229. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG">get_imageTransparencyBG()</a></li>
  3230. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG">get_imagickBG()</a></li>
  3231. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality">get_jpegQuality()</a></li>
  3232. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression">get_pngCompression()</a></li>
  3233. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a></li>
  3234. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a></li>
  3235. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64">set_imageBase64()</a></li>
  3236. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a></li>
  3237. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG">set_imagickBG()</a></li>
  3238. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality">set_jpegQuality()</a></li>
  3239. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a></li>
  3240. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a></li>
  3241. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a></li>
  3242. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a></li>
  3243. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression">set_pngCompression()</a></li>
  3244. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a></li>
  3245. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a></li>
  3246. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a></li>
  3247. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a></li>
  3248. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a></li>
  3249. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a></li>
  3250. </ul>
  3251. </li>
  3252. </ul>
  3253. </section>
  3254. </section>
  3255. </div>
  3256. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  3257. <section class="phpdocumentor-search-results__dialog">
  3258. <header class="phpdocumentor-search-results__header">
  3259. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  3260. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  3261. </header>
  3262. <section class="phpdocumentor-search-results__body">
  3263. <ul class="phpdocumentor-search-results__entries"></ul>
  3264. </section>
  3265. </section>
  3266. </section>
  3267. </div>
  3268. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  3269. </main>
  3270. <script>
  3271. cssVars({});
  3272. </script>
  3273. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  3274. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  3275. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  3276. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  3277. </body>
  3278. </html>