chillerlan-QRCode-QROptions.html 232 KB

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