chillerlan-QRCode-QROptions.html 228 KB

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