chillerlan-QRCode-QROptionsTrait.html 226 KB

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