chillerlan-QRCode-QROptions.html 208 KB

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