chillerlan-QRCode-QROptionsTrait.html 228 KB

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