chillerlan-QRCode-QROptionsTrait.html 205 KB

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