chillerlan-QRCode-QROptionsTrait.html 221 KB

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