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