chillerlan-QRCode-QROptionsTrait.html 224 KB

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