chillerlan-QRCode-QROptions.html 230 KB

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