chillerlan-QRCode-QROptions.html 174 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834
  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. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. </ul>
  112. <article class="phpdocumentor-element -class">
  113. <h2 class="phpdocumentor-content__title">
  114. QROptions
  115. <span class="phpdocumentor-element__extends">
  116. extends <abbr title="\chillerlan\Settings\SettingsContainerAbstract">SettingsContainerAbstract</abbr>
  117. </span>
  118. <div class="phpdocumentor-element__package">
  119. in package
  120. <ul class="phpdocumentor-breadcrumbs">
  121. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  122. </ul>
  123. </div>
  124. <span class="phpdocumentor-element__extends">
  125. uses
  126. <a href="classes/chillerlan-QRCode-QROptionsTrait.html"><abbr title="\chillerlan\QRCode\QROptionsTrait">QROptionsTrait</abbr></a>, <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html"><abbr title="\chillerlan\QRCode\QRCodeReaderOptionsTrait">QRCodeReaderOptionsTrait</abbr></a> </span>
  127. </h2>
  128. <div class="phpdocumentor-label-line">
  129. </div>
  130. <aside class="phpdocumentor-element-found-in">
  131. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptions.php"><a href="files/src-qroptions.html"><abbr title="src/QROptions.php">QROptions.php</abbr></a></abbr>
  132. :
  133. <span class="phpdocumentor-element-found-in__line">19</span>
  134. </aside>
  135. <p class="phpdocumentor-summary">The QRCode settings container</p>
  136. <h3 id="toc">
  137. Table of Contents
  138. <a href="classes/chillerlan-QRCode-QROptions.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h3>
  140. <h4 id="toc-properties">
  141. Properties
  142. <a href="classes/chillerlan-QRCode-QROptions.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  143. </h4>
  144. <dl class="phpdocumentor-table-of-contents">
  145. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  146. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
  147. <span>
  148. &nbsp;: bool </span>
  149. </dt>
  150. <dd>Toggles logo space creation</dd>
  151. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  152. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
  153. <span>
  154. &nbsp;: bool </span>
  155. </dt>
  156. <dd>Add a &quot;quiet zone&quot; (margin) according to the QR code spec</dd>
  157. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  158. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
  159. <span>
  160. &nbsp;: mixed </span>
  161. </dt>
  162. <dd>Sets the image background color (if applicable)</dd>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
  165. <span>
  166. &nbsp;: string|null </span>
  167. </dt>
  168. <dd>Optional cache file path `/path/to/cache.file`</dd>
  169. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  170. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
  171. <span>
  172. &nbsp;: float </span>
  173. </dt>
  174. <dd>Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  176. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
  177. <span>
  178. &nbsp;: bool </span>
  179. </dt>
  180. <dd>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  182. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
  183. <span>
  184. &nbsp;: string </span>
  185. </dt>
  186. <dd>A common css class</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  188. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
  189. <span>
  190. &nbsp;: bool </span>
  191. </dt>
  192. <dd>Specify whether to draw the modules as filled circles</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
  195. <span>
  196. &nbsp;: bool </span>
  197. </dt>
  198. <dd>Whether to draw the light (false) modules</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  200. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
  201. <span>
  202. &nbsp;: int </span>
  203. </dt>
  204. <dd>Error correct level</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  206. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
  207. <span>
  208. &nbsp;: string </span>
  209. </dt>
  210. <dd>Newline string</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  212. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
  213. <span>
  214. &nbsp;: array&lt;string|int, int&gt; </span>
  215. </dt>
  216. <dd>Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  218. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
  219. <span>
  220. &nbsp;: string </span>
  221. </dt>
  222. <dd>Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  224. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale">$gdImageUseUpscale</a>
  225. <span>
  226. &nbsp;: bool </span>
  227. </dt>
  228. <dd>Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
  229. `QROptions::$scale` is less than 20</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  231. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
  232. <span>
  233. &nbsp;: bool </span>
  234. </dt>
  235. <dd>Toggle transparency</dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  237. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
  238. <span>
  239. &nbsp;: string </span>
  240. </dt>
  241. <dd>Imagick output format</dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  243. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a>
  244. <span>
  245. &nbsp;: bool </span>
  246. </dt>
  247. <dd>Whether to invert the matrix (reflectance reversal)</dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  249. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags">$jsonFlags</a>
  250. <span>
  251. &nbsp;: int </span>
  252. </dt>
  253. <dd>Sets the flags to use for the `json_encode()` call</dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  255. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
  256. <span>
  257. &nbsp;: array&lt;string|int, int&gt; </span>
  258. </dt>
  259. <dd>Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  261. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
  262. <span>
  263. &nbsp;: int|null </span>
  264. </dt>
  265. <dd>Height of the logo space</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  267. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
  268. <span>
  269. &nbsp;: int|null </span>
  270. </dt>
  271. <dd>Optional horizontal start position of the logo space (top left corner)</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  273. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
  274. <span>
  275. &nbsp;: int|null </span>
  276. </dt>
  277. <dd>Optional vertical start position of the logo space (top left corner)</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  279. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
  280. <span>
  281. &nbsp;: int|null </span>
  282. </dt>
  283. <dd>Width of the logo space</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  285. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
  286. <span>
  287. &nbsp;: int </span>
  288. </dt>
  289. <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  291. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
  292. <span>
  293. &nbsp;: array&lt;int, mixed&gt; </span>
  294. </dt>
  295. <dd>Module values map</dd>
  296. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  297. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a>
  298. <span>
  299. &nbsp;: bool </span>
  300. </dt>
  301. <dd>Toggle base64 data URI or raw data output (if applicable)</dd>
  302. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  303. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
  304. <span>
  305. &nbsp;: string </span>
  306. </dt>
  307. <dd>The FQCN of the `QROutputInterface` to use</dd>
  308. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  309. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a>
  310. <span>
  311. &nbsp;: int </span>
  312. </dt>
  313. <dd>Compression quality</dd>
  314. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  315. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
  316. <span>
  317. &nbsp;: int </span>
  318. </dt>
  319. <dd>Size of the quiet zone</dd>
  320. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  321. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
  322. <span>
  323. &nbsp;: bool </span>
  324. </dt>
  325. <dd>Grayscale the image before reading</dd>
  326. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  327. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  328. <span>
  329. &nbsp;: bool </span>
  330. </dt>
  331. <dd>Increase the contrast before reading</dd>
  332. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  333. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a>
  334. <span>
  335. &nbsp;: bool </span>
  336. </dt>
  337. <dd>Invert the colors of the image</dd>
  338. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  339. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  340. <span>
  341. &nbsp;: bool </span>
  342. </dt>
  343. <dd>Use Imagick (if available) when reading QR Codes</dd>
  344. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  345. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
  346. <span>
  347. &nbsp;: bool </span>
  348. </dt>
  349. <dd>Return the image resource instead of a render if applicable.</dd>
  350. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  351. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
  352. <span>
  353. &nbsp;: int </span>
  354. </dt>
  355. <dd>Pixel size of a QR code module</dd>
  356. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  357. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a>
  358. <span>
  359. &nbsp;: bool </span>
  360. </dt>
  361. <dd>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</dd>
  362. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  363. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
  364. <span>
  365. &nbsp;: string </span>
  366. </dt>
  367. <dd>Anything in the SVG `&lt;defs&gt;` tag</dd>
  368. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  369. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
  370. <span>
  371. &nbsp;: string </span>
  372. </dt>
  373. <dd>Sets the value for the &quot;preserveAspectRatio&quot; on the `&lt;svg&gt;` element</dd>
  374. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  375. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes">$svgUseFillAttributes</a>
  376. <span>
  377. &nbsp;: bool </span>
  378. </dt>
  379. <dd>Whether to use the SVG `fill` attributes</dd>
  380. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  381. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a>
  382. <span>
  383. &nbsp;: string </span>
  384. </dt>
  385. <dd>An optional line prefix, e.g. empty space to align the QR Code in a console</dd>
  386. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  387. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
  388. <span>
  389. &nbsp;: mixed </span>
  390. </dt>
  391. <dd>Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.</dd>
  392. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  393. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
  394. <span>
  395. &nbsp;: int </span>
  396. </dt>
  397. <dd>QR Code version number</dd>
  398. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  399. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
  400. <span>
  401. &nbsp;: int </span>
  402. </dt>
  403. <dd>Maximum QR version</dd>
  404. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  405. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
  406. <span>
  407. &nbsp;: int </span>
  408. </dt>
  409. <dd>Minimum QR version</dd>
  410. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  411. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet">$xmlStylesheet</a>
  412. <span>
  413. &nbsp;: string|null </span>
  414. </dt>
  415. <dd>Sets an optional XSLT stylesheet in the XML output</dd>
  416. </dl>
  417. <h4 id="toc-methods">
  418. Methods
  419. <a href="classes/chillerlan-QRCode-QROptions.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  420. </h4>
  421. <dl class="phpdocumentor-table-of-contents">
  422. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  423. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
  424. <span>
  425. &nbsp;: int|null </span>
  426. </dt>
  427. <dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
  428. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  429. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a>
  430. <span>
  431. &nbsp;: void </span>
  432. </dt>
  433. <dd>clamp/set SVG circle radius</dd>
  434. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  435. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel">set_eccLevel()</a>
  436. <span>
  437. &nbsp;: void </span>
  438. </dt>
  439. <dd>sets the ECC level</dd>
  440. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  441. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
  442. <span>
  443. &nbsp;: void </span>
  444. </dt>
  445. <dd>sets the FPDF measurement unit</dd>
  446. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  447. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a>
  448. <span>
  449. &nbsp;: void </span>
  450. </dt>
  451. <dd>clamp/set logo space height</dd>
  452. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  453. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a>
  454. <span>
  455. &nbsp;: void </span>
  456. </dt>
  457. <dd>clamp/set horizontal logo space start</dd>
  458. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  459. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a>
  460. <span>
  461. &nbsp;: void </span>
  462. </dt>
  463. <dd>clamp/set vertical logo space start</dd>
  464. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  465. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a>
  466. <span>
  467. &nbsp;: void </span>
  468. </dt>
  469. <dd>clamp/set logo space width</dd>
  470. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  471. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a>
  472. <span>
  473. &nbsp;: void </span>
  474. </dt>
  475. <dd>sets/clamps the quiet zone size</dd>
  476. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  477. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
  478. <span>
  479. &nbsp;: void </span>
  480. </dt>
  481. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  482. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  483. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
  484. <span>
  485. &nbsp;: void </span>
  486. </dt>
  487. <dd>sets/clamps the version number</dd>
  488. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  489. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
  490. <span>
  491. &nbsp;: void </span>
  492. </dt>
  493. <dd>sets the maximum version number</dd>
  494. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  495. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
  496. <span>
  497. &nbsp;: void </span>
  498. </dt>
  499. <dd>sets the minimum version number</dd>
  500. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  501. <a class="" href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
  502. <span>
  503. &nbsp;: void </span>
  504. </dt>
  505. <dd>clamp min/max version number</dd>
  506. </dl>
  507. <section class="phpdocumentor-properties">
  508. <h3 class="phpdocumentor-elements__header" id="properties">
  509. Properties
  510. <a href="classes/chillerlan-QRCode-QROptions.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  511. </h3>
  512. <article
  513. class="
  514. phpdocumentor-element
  515. -property
  516. -protected
  517. "
  518. >
  519. <h4 class="phpdocumentor-element__name" id="property_addLogoSpace">
  520. $addLogoSpace
  521. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  522. <span class="phpdocumentor-element__modifiers">
  523. </span>
  524. </h4>
  525. <aside class="phpdocumentor-element-found-in">
  526. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  527. :
  528. <span class="phpdocumentor-element-found-in__line">294</span>
  529. </aside>
  530. <p class="phpdocumentor-summary">Toggles logo space creation</p>
  531. <code class="phpdocumentor-code phpdocumentor-signature ">
  532. <span class="phpdocumentor-signature__visibility">protected</span>
  533. <span class="phpdocumentor-signature__type">bool</span>
  534. <span class="phpdocumentor-signature__name">$addLogoSpace</span>
  535. = <span class="phpdocumentor-signature__default-value">false</span></code>
  536. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  537. Tags
  538. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace#tags" class="headerlink"><i class="fas fa-link"></i></a>
  539. </h5>
  540. <dl class="phpdocumentor-tag-list">
  541. <dt class="phpdocumentor-tag-list__entry">
  542. <span class="phpdocumentor-tag__name">see</span>
  543. </dt>
  544. <dd class="phpdocumentor-tag-list__definition">
  545. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_addMatrixModifications"><abbr title="\chillerlan\QRCode\QRCode::addMatrixModifications()">QRCode::addMatrixModifications()</abbr></a></span>
  546. </dd>
  547. <dt class="phpdocumentor-tag-list__entry">
  548. <span class="phpdocumentor-tag__name">see</span>
  549. </dt>
  550. <dd class="phpdocumentor-tag-list__definition">
  551. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace"><abbr title="\chillerlan\QRCode\Data\QRMatrix::setLogoSpace()">QRMatrix::setLogoSpace()</abbr></a></span>
  552. </dd>
  553. </dl>
  554. </article>
  555. <article
  556. class="
  557. phpdocumentor-element
  558. -property
  559. -protected
  560. "
  561. >
  562. <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
  563. $addQuietzone
  564. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
  565. <span class="phpdocumentor-element__modifiers">
  566. </span>
  567. </h4>
  568. <aside class="phpdocumentor-element-found-in">
  569. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  570. :
  571. <span class="phpdocumentor-element-found-in__line">128</span>
  572. </aside>
  573. <p class="phpdocumentor-summary">Add a &quot;quiet zone&quot; (margin) according to the QR code spec</p>
  574. <code class="phpdocumentor-code phpdocumentor-signature ">
  575. <span class="phpdocumentor-signature__visibility">protected</span>
  576. <span class="phpdocumentor-signature__type">bool</span>
  577. <span class="phpdocumentor-signature__name">$addQuietzone</span>
  578. = <span class="phpdocumentor-signature__default-value">true</span></code>
  579. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  580. Tags
  581. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone#tags" class="headerlink"><i class="fas fa-link"></i></a>
  582. </h5>
  583. <dl class="phpdocumentor-tag-list">
  584. <dt class="phpdocumentor-tag-list__entry">
  585. <span class="phpdocumentor-tag__name">see</span>
  586. </dt>
  587. <dd class="phpdocumentor-tag-list__definition">
  588. <span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</a></span>
  589. </dd>
  590. </dl>
  591. </article>
  592. <article
  593. class="
  594. phpdocumentor-element
  595. -property
  596. -protected
  597. "
  598. >
  599. <h4 class="phpdocumentor-element__name" id="property_bgColor">
  600. $bgColor
  601. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" class="headerlink"><i class="fas fa-link"></i></a>
  602. <span class="phpdocumentor-element__modifiers">
  603. </span>
  604. </h4>
  605. <aside class="phpdocumentor-element-found-in">
  606. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  607. :
  608. <span class="phpdocumentor-element-found-in__line">200</span>
  609. </aside>
  610. <p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
  611. <code class="phpdocumentor-code phpdocumentor-signature ">
  612. <span class="phpdocumentor-signature__visibility">protected</span>
  613. <span class="phpdocumentor-signature__type">mixed</span>
  614. <span class="phpdocumentor-signature__name">$bgColor</span>
  615. = <span class="phpdocumentor-signature__default-value">null</span></code>
  616. <section class="phpdocumentor-description"><ul>
  617. <li><code class="prettyprint">QRImagick</code>: defaults to <code class="prettyprint">&quot;white&quot;</code></li>
  618. <li><code class="prettyprint">QRGdImage</code>: defaults to <code class="prettyprint">[255, 255, 255]</code></li>
  619. <li><code class="prettyprint">QRFpdf</code>: defaults to blank internally (white page)</li>
  620. </ul>
  621. </section>
  622. </article>
  623. <article
  624. class="
  625. phpdocumentor-element
  626. -property
  627. -protected
  628. "
  629. >
  630. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  631. $cachefile
  632. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  633. <span class="phpdocumentor-element__modifiers">
  634. </span>
  635. </h4>
  636. <aside class="phpdocumentor-element-found-in">
  637. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  638. :
  639. <span class="phpdocumentor-element-found-in__line">170</span>
  640. </aside>
  641. <p class="phpdocumentor-summary">Optional cache file path `/path/to/cache.file`</p>
  642. <code class="phpdocumentor-code phpdocumentor-signature ">
  643. <span class="phpdocumentor-signature__visibility">protected</span>
  644. <span class="phpdocumentor-signature__type">string|null</span>
  645. <span class="phpdocumentor-signature__name">$cachefile</span>
  646. = <span class="phpdocumentor-signature__default-value">null</span></code>
  647. <section class="phpdocumentor-description"><p>Please note that the <code class="prettyprint">$file</code> parameter in <code class="prettyprint">QRCode::render()</code> and <code class="prettyprint">QRCode::renderMatrix()</code>
  648. takes precedence over the <code class="prettyprint">QROptions::$cachefile</code> value. (default: <code class="prettyprint">null</code>)</p>
  649. </section>
  650. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  651. Tags
  652. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  653. </h5>
  654. <dl class="phpdocumentor-tag-list">
  655. <dt class="phpdocumentor-tag-list__entry">
  656. <span class="phpdocumentor-tag__name">see</span>
  657. </dt>
  658. <dd class="phpdocumentor-tag-list__definition">
  659. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_render"><abbr title="\chillerlan\QRCode\QRCode::render()">QRCode::render()</abbr></a></span>
  660. </dd>
  661. <dt class="phpdocumentor-tag-list__entry">
  662. <span class="phpdocumentor-tag__name">see</span>
  663. </dt>
  664. <dd class="phpdocumentor-tag-list__definition">
  665. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix"><abbr title="\chillerlan\QRCode\QRCode::renderMatrix()">QRCode::renderMatrix()</abbr></a></span>
  666. </dd>
  667. </dl>
  668. </article>
  669. <article
  670. class="
  671. phpdocumentor-element
  672. -property
  673. -protected
  674. "
  675. >
  676. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  677. $circleRadius
  678. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  679. <span class="phpdocumentor-element__modifiers">
  680. </span>
  681. </h4>
  682. <aside class="phpdocumentor-element-found-in">
  683. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  684. :
  685. <span class="phpdocumentor-element-found-in__line">239</span>
  686. </aside>
  687. <p class="phpdocumentor-summary">Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`</p>
  688. <code class="phpdocumentor-code phpdocumentor-signature ">
  689. <span class="phpdocumentor-signature__visibility">protected</span>
  690. <span class="phpdocumentor-signature__type">float</span>
  691. <span class="phpdocumentor-signature__name">$circleRadius</span>
  692. = <span class="phpdocumentor-signature__default-value">0.45</span></code>
  693. <section class="phpdocumentor-description"><p>(default: 0.45)</p>
  694. </section>
  695. </article>
  696. <article
  697. class="
  698. phpdocumentor-element
  699. -property
  700. -protected
  701. "
  702. >
  703. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  704. $connectPaths
  705. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  706. <span class="phpdocumentor-element__modifiers">
  707. </span>
  708. </h4>
  709. <aside class="phpdocumentor-element-found-in">
  710. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  711. :
  712. <span class="phpdocumentor-element-found-in__line">264</span>
  713. </aside>
  714. <p class="phpdocumentor-summary">Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
  715. <code class="phpdocumentor-code phpdocumentor-signature ">
  716. <span class="phpdocumentor-signature__visibility">protected</span>
  717. <span class="phpdocumentor-signature__type">bool</span>
  718. <span class="phpdocumentor-signature__name">$connectPaths</span>
  719. = <span class="phpdocumentor-signature__default-value">false</span></code>
  720. <section class="phpdocumentor-description"><p>This option is exclusive to output classes that use the module collector <code class="prettyprint">QROutputAbstract::collectModules()</code>,
  721. which converts the <code class="prettyprint">$M_TYPE</code> of all modules to <code class="prettyprint">QRMatrix::M_DATA</code> and <code class="prettyprint">QRMatrix::M_DATA_DARK</code> respectively.</p>
  722. <p>Module types that should not be added to the connected path can be excluded via <code class="prettyprint">QROptions::$excludeFromConnect</code>.</p>
  723. <p>Currentty used in <code class="prettyprint">QREps</code> and <code class="prettyprint">QRMarkupSVG</code>.</p>
  724. </section>
  725. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  726. Tags
  727. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  728. </h5>
  729. <dl class="phpdocumentor-tag-list">
  730. <dt class="phpdocumentor-tag-list__entry">
  731. <span class="phpdocumentor-tag__name">see</span>
  732. </dt>
  733. <dd class="phpdocumentor-tag-list__definition">
  734. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::collectModules()">QROutputAbstract::collectModules()</abbr></a></span>
  735. </dd>
  736. <dt class="phpdocumentor-tag-list__entry">
  737. <span class="phpdocumentor-tag__name">see</span>
  738. </dt>
  739. <dd class="phpdocumentor-tag-list__definition">
  740. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect"><abbr title="\chillerlan\QRCode\QROptionsTrait::$excludeFromConnect">QROptionsTrait::$excludeFromConnect</abbr></a></span>
  741. </dd>
  742. <dt class="phpdocumentor-tag-list__entry">
  743. <span class="phpdocumentor-tag__name">see</span>
  744. </dt>
  745. <dd class="phpdocumentor-tag-list__definition">
  746. <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>
  747. </dd>
  748. </dl>
  749. </article>
  750. <article
  751. class="
  752. phpdocumentor-element
  753. -property
  754. -protected
  755. "
  756. >
  757. <h4 class="phpdocumentor-element__name" id="property_cssClass">
  758. $cssClass
  759. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
  760. <span class="phpdocumentor-element__modifiers">
  761. </span>
  762. </h4>
  763. <aside class="phpdocumentor-element-found-in">
  764. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  765. :
  766. <span class="phpdocumentor-element-found-in__line">406</span>
  767. </aside>
  768. <p class="phpdocumentor-summary">A common css class</p>
  769. <code class="phpdocumentor-code phpdocumentor-signature ">
  770. <span class="phpdocumentor-signature__visibility">protected</span>
  771. <span class="phpdocumentor-signature__type">string</span>
  772. <span class="phpdocumentor-signature__name">$cssClass</span>
  773. = <span class="phpdocumentor-signature__default-value">&#039;qrcode&#039;</span></code>
  774. </article>
  775. <article
  776. class="
  777. phpdocumentor-element
  778. -property
  779. -protected
  780. "
  781. >
  782. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  783. $drawCircularModules
  784. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  785. <span class="phpdocumentor-element__modifiers">
  786. </span>
  787. </h4>
  788. <aside class="phpdocumentor-element-found-in">
  789. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  790. :
  791. <span class="phpdocumentor-element-found-in__line">232</span>
  792. </aside>
  793. <p class="phpdocumentor-summary">Specify whether to draw the modules as filled circles</p>
  794. <code class="phpdocumentor-code phpdocumentor-signature ">
  795. <span class="phpdocumentor-signature__visibility">protected</span>
  796. <span class="phpdocumentor-signature__type">bool</span>
  797. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  798. = <span class="phpdocumentor-signature__default-value">false</span></code>
  799. <section class="phpdocumentor-description"><p>a note for <code class="prettyprint">GdImage</code> output:</p>
  800. <p>if <code class="prettyprint">QROptions::$scale</code> is less than 20, the image will be upscaled internally, then the modules will be drawn
  801. using <code class="prettyprint">imagefilledellipse()</code> and then scaled back to the expected size</p>
  802. <p>No effect in: <code class="prettyprint">QREps</code>, <code class="prettyprint">QRFpdf</code>, <code class="prettyprint">QRMarkupHTML</code></p>
  803. </section>
  804. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  805. Tags
  806. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h5>
  808. <dl class="phpdocumentor-tag-list">
  809. <dt class="phpdocumentor-tag-list__entry">
  810. <span class="phpdocumentor-tag__name">see</span>
  811. </dt>
  812. <dd class="phpdocumentor-tag-list__definition">
  813. <span class="phpdocumentor-tag-link"><abbr title="\imagefilledellipse()">imagefilledellipse()</abbr></span>
  814. </dd>
  815. <dt class="phpdocumentor-tag-list__entry">
  816. <span class="phpdocumentor-tag__name">see</span>
  817. </dt>
  818. <dd class="phpdocumentor-tag-list__definition">
  819. <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>
  820. </dd>
  821. <dt class="phpdocumentor-tag-list__entry">
  822. <span class="phpdocumentor-tag__name">see</span>
  823. </dt>
  824. <dd class="phpdocumentor-tag-list__definition">
  825. <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>
  826. </dd>
  827. </dl>
  828. </article>
  829. <article
  830. class="
  831. phpdocumentor-element
  832. -property
  833. -protected
  834. "
  835. >
  836. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  837. $drawLightModules
  838. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  839. <span class="phpdocumentor-element__modifiers">
  840. </span>
  841. </h4>
  842. <aside class="phpdocumentor-element-found-in">
  843. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  844. :
  845. <span class="phpdocumentor-element-found-in__line">216</span>
  846. </aside>
  847. <p class="phpdocumentor-summary">Whether to draw the light (false) modules</p>
  848. <code class="phpdocumentor-code phpdocumentor-signature ">
  849. <span class="phpdocumentor-signature__visibility">protected</span>
  850. <span class="phpdocumentor-signature__type">bool</span>
  851. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  852. = <span class="phpdocumentor-signature__default-value">true</span></code>
  853. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
  854. </section>
  855. </article>
  856. <article
  857. class="
  858. phpdocumentor-element
  859. -property
  860. -protected
  861. "
  862. >
  863. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  864. $eccLevel
  865. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  866. <span class="phpdocumentor-element__modifiers">
  867. </span>
  868. </h4>
  869. <aside class="phpdocumentor-element-found-in">
  870. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  871. :
  872. <span class="phpdocumentor-element-found-in__line">112</span>
  873. </aside>
  874. <p class="phpdocumentor-summary">Error correct level</p>
  875. <code class="phpdocumentor-code phpdocumentor-signature ">
  876. <span class="phpdocumentor-signature__visibility">protected</span>
  877. <span class="phpdocumentor-signature__type">int</span>
  878. <span class="phpdocumentor-signature__name">$eccLevel</span>
  879. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
  880. <section class="phpdocumentor-description"><p>the constant <code class="prettyprint">EccLevel::X</code> where <code class="prettyprint">X</code> is:</p>
  881. <ul>
  882. <li><code class="prettyprint">L</code> =&gt; 7% (default)</li>
  883. <li><code class="prettyprint">M</code> =&gt; 15%</li>
  884. <li><code class="prettyprint">Q</code> =&gt; 25%</li>
  885. <li><code class="prettyprint">H</code> =&gt; 30%</li>
  886. </ul>
  887. <p>alternatively you can just pass the letters L/M/Q/H (case-insensitive) to the magic setter</p>
  888. </section>
  889. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  890. Tags
  891. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  892. </h5>
  893. <dl class="phpdocumentor-tag-list">
  894. <dt class="phpdocumentor-tag-list__entry">
  895. <span class="phpdocumentor-tag__name">see</span>
  896. </dt>
  897. <dd class="phpdocumentor-tag-list__definition">
  898. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  899. </dd>
  900. <dt class="phpdocumentor-tag-list__entry">
  901. <span class="phpdocumentor-tag__name">see</span>
  902. </dt>
  903. <dd class="phpdocumentor-tag-list__definition">
  904. <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>
  905. </dd>
  906. </dl>
  907. </article>
  908. <article
  909. class="
  910. phpdocumentor-element
  911. -property
  912. -protected
  913. "
  914. >
  915. <h4 class="phpdocumentor-element__name" id="property_eol">
  916. $eol
  917. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  918. <span class="phpdocumentor-element__modifiers">
  919. </span>
  920. </h4>
  921. <aside class="phpdocumentor-element-found-in">
  922. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  923. :
  924. <span class="phpdocumentor-element-found-in__line">186</span>
  925. </aside>
  926. <p class="phpdocumentor-summary">Newline string</p>
  927. <code class="phpdocumentor-code phpdocumentor-signature ">
  928. <span class="phpdocumentor-signature__visibility">protected</span>
  929. <span class="phpdocumentor-signature__type">string</span>
  930. <span class="phpdocumentor-signature__name">$eol</span>
  931. = <span class="phpdocumentor-signature__default-value">\PHP_EOL</span></code>
  932. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">PHP_EOL</code>)</p>
  933. </section>
  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">273</span>
  952. </aside>
  953. <p class="phpdocumentor-summary">Specify which paths/patterns to exclude from connecting if `QROptions::$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, int&gt;</span>
  957. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  958. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  959. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  960. Tags
  961. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  962. </h5>
  963. <dl class="phpdocumentor-tag-list">
  964. <dt class="phpdocumentor-tag-list__entry">
  965. <span class="phpdocumentor-tag__name">see</span>
  966. </dt>
  967. <dd class="phpdocumentor-tag-list__definition">
  968. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths"><abbr title="\chillerlan\QRCode\QROptionsTrait::$connectPaths">QROptionsTrait::$connectPaths</abbr></a></span>
  969. </dd>
  970. </dl>
  971. </article>
  972. <article
  973. class="
  974. phpdocumentor-element
  975. -property
  976. -protected
  977. "
  978. >
  979. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  980. $fpdfMeasureUnit
  981. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  982. <span class="phpdocumentor-element__modifiers">
  983. </span>
  984. </h4>
  985. <aside class="phpdocumentor-element-found-in">
  986. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  987. :
  988. <span class="phpdocumentor-element-found-in__line">476</span>
  989. </aside>
  990. <p class="phpdocumentor-summary">Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)</p>
  991. <code class="phpdocumentor-code phpdocumentor-signature ">
  992. <span class="phpdocumentor-signature__visibility">protected</span>
  993. <span class="phpdocumentor-signature__type">string</span>
  994. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  995. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  996. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  997. Tags
  998. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  999. </h5>
  1000. <dl class="phpdocumentor-tag-list">
  1001. <dt class="phpdocumentor-tag-list__entry">
  1002. <span class="phpdocumentor-tag__name">see</span>
  1003. </dt>
  1004. <dd class="phpdocumentor-tag-list__definition">
  1005. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\FPDF::__construct()">FPDF::__construct()</abbr></span>
  1006. </dd>
  1007. </dl>
  1008. </article>
  1009. <article
  1010. class="
  1011. phpdocumentor-element
  1012. -property
  1013. -protected
  1014. "
  1015. >
  1016. <h4 class="phpdocumentor-element__name" id="property_gdImageUseUpscale">
  1017. $gdImageUseUpscale
  1018. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale" class="headerlink"><i class="fas fa-link"></i></a>
  1019. <span class="phpdocumentor-element__modifiers">
  1020. </span>
  1021. </h4>
  1022. <aside class="phpdocumentor-element-found-in">
  1023. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1024. :
  1025. <span class="phpdocumentor-element-found-in__line">383</span>
  1026. </aside>
  1027. <p class="phpdocumentor-summary">Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
  1028. `QROptions::$scale` is less than 20</p>
  1029. <code class="phpdocumentor-code phpdocumentor-signature ">
  1030. <span class="phpdocumentor-signature__visibility">protected</span>
  1031. <span class="phpdocumentor-signature__type">bool</span>
  1032. <span class="phpdocumentor-signature__name">$gdImageUseUpscale</span>
  1033. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1034. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1035. Tags
  1036. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1037. </h5>
  1038. <dl class="phpdocumentor-tag-list">
  1039. <dt class="phpdocumentor-tag-list__entry">
  1040. <span class="phpdocumentor-tag__name">see</span>
  1041. </dt>
  1042. <dd class="phpdocumentor-tag-list__definition">
  1043. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage"><abbr title="\chillerlan\QRCode\Output\QRGdImage::createImage()">QRGdImage::createImage()</abbr></a></span>
  1044. </dd>
  1045. <dt class="phpdocumentor-tag-list__entry">
  1046. <span class="phpdocumentor-tag__name">see</span>
  1047. </dt>
  1048. <dd class="phpdocumentor-tag-list__definition">
  1049. <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>
  1050. </dd>
  1051. </dl>
  1052. </article>
  1053. <article
  1054. class="
  1055. phpdocumentor-element
  1056. -property
  1057. -protected
  1058. "
  1059. >
  1060. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  1061. $imageTransparent
  1062. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  1063. <span class="phpdocumentor-element__modifiers">
  1064. </span>
  1065. </h4>
  1066. <aside class="phpdocumentor-element-found-in">
  1067. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1068. :
  1069. <span class="phpdocumentor-element-found-in__line">337</span>
  1070. </aside>
  1071. <p class="phpdocumentor-summary">Toggle transparency</p>
  1072. <code class="phpdocumentor-code phpdocumentor-signature ">
  1073. <span class="phpdocumentor-signature__visibility">protected</span>
  1074. <span class="phpdocumentor-signature__type">bool</span>
  1075. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  1076. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1077. <section class="phpdocumentor-description"><ul>
  1078. <li><code class="prettyprint">QRGdImage</code> and <code class="prettyprint">QRImagick</code>: the given <code class="prettyprint">QROptions::$transparencyColor</code> is set as transparent</li>
  1079. </ul>
  1080. </section>
  1081. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1082. Tags
  1083. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1084. </h5>
  1085. <dl class="phpdocumentor-tag-list">
  1086. <dt class="phpdocumentor-tag-list__entry">
  1087. <span class="phpdocumentor-tag__name">see</span>
  1088. </dt>
  1089. <dd class="phpdocumentor-tag-list__definition">
  1090. <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>
  1091. </dd>
  1092. </dl>
  1093. </article>
  1094. <article
  1095. class="
  1096. phpdocumentor-element
  1097. -property
  1098. -protected
  1099. "
  1100. >
  1101. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  1102. $imagickFormat
  1103. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  1104. <span class="phpdocumentor-element__modifiers">
  1105. </span>
  1106. </h4>
  1107. <aside class="phpdocumentor-element-found-in">
  1108. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1109. :
  1110. <span class="phpdocumentor-element-found-in__line">396</span>
  1111. </aside>
  1112. <p class="phpdocumentor-summary">Imagick output format</p>
  1113. <code class="phpdocumentor-code phpdocumentor-signature ">
  1114. <span class="phpdocumentor-signature__visibility">protected</span>
  1115. <span class="phpdocumentor-signature__type">string</span>
  1116. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  1117. = <span class="phpdocumentor-signature__default-value">&#039;png32&#039;</span></code>
  1118. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1119. Tags
  1120. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1121. </h5>
  1122. <dl class="phpdocumentor-tag-list">
  1123. <dt class="phpdocumentor-tag-list__entry">
  1124. <span class="phpdocumentor-tag__name">see</span>
  1125. </dt>
  1126. <dd class="phpdocumentor-tag-list__definition">
  1127. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
  1128. </dd>
  1129. <dt class="phpdocumentor-tag-list__entry">
  1130. <span class="phpdocumentor-tag__name">see</span>
  1131. </dt>
  1132. <dd class="phpdocumentor-tag-list__definition">
  1133. <span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</a></span>
  1134. </dd>
  1135. </dl>
  1136. </article>
  1137. <article
  1138. class="
  1139. phpdocumentor-element
  1140. -property
  1141. -protected
  1142. "
  1143. >
  1144. <h4 class="phpdocumentor-element__name" id="property_invertMatrix">
  1145. $invertMatrix
  1146. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1147. <span class="phpdocumentor-element__modifiers">
  1148. </span>
  1149. </h4>
  1150. <aside class="phpdocumentor-element-found-in">
  1151. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1152. :
  1153. <span class="phpdocumentor-element-found-in__line">209</span>
  1154. </aside>
  1155. <p class="phpdocumentor-summary">Whether to invert the matrix (reflectance reversal)</p>
  1156. <code class="phpdocumentor-code phpdocumentor-signature ">
  1157. <span class="phpdocumentor-signature__visibility">protected</span>
  1158. <span class="phpdocumentor-signature__type">bool</span>
  1159. <span class="phpdocumentor-signature__name">$invertMatrix</span>
  1160. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1161. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">false</code>)</p>
  1162. </section>
  1163. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1164. Tags
  1165. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1166. </h5>
  1167. <dl class="phpdocumentor-tag-list">
  1168. <dt class="phpdocumentor-tag-list__entry">
  1169. <span class="phpdocumentor-tag__name">see</span>
  1170. </dt>
  1171. <dd class="phpdocumentor-tag-list__definition">
  1172. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert"><abbr title="\chillerlan\QRCode\Data\QRMatrix::invert()">QRMatrix::invert()</abbr></a></span>
  1173. </dd>
  1174. </dl>
  1175. </article>
  1176. <article
  1177. class="
  1178. phpdocumentor-element
  1179. -property
  1180. -protected
  1181. "
  1182. >
  1183. <h4 class="phpdocumentor-element__name" id="property_jsonFlags">
  1184. $jsonFlags
  1185. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags" class="headerlink"><i class="fas fa-link"></i></a>
  1186. <span class="phpdocumentor-element__modifiers">
  1187. </span>
  1188. </h4>
  1189. <aside class="phpdocumentor-element-found-in">
  1190. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1191. :
  1192. <span class="phpdocumentor-element-found-in__line">464</span>
  1193. </aside>
  1194. <p class="phpdocumentor-summary">Sets the flags to use for the `json_encode()` call</p>
  1195. <code class="phpdocumentor-code phpdocumentor-signature ">
  1196. <span class="phpdocumentor-signature__visibility">protected</span>
  1197. <span class="phpdocumentor-signature__type">int</span>
  1198. <span class="phpdocumentor-signature__name">$jsonFlags</span>
  1199. = <span class="phpdocumentor-signature__default-value">\JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES</span></code>
  1200. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1201. Tags
  1202. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1203. </h5>
  1204. <dl class="phpdocumentor-tag-list">
  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.php.net/manual/json.constants.php">https://www.php.net/manual/json.constants.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_keepAsSquare">
  1221. $keepAsSquare
  1222. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" 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">248</span>
  1230. </aside>
  1231. <p class="phpdocumentor-summary">Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`</p>
  1232. <code class="phpdocumentor-code phpdocumentor-signature ">
  1233. <span class="phpdocumentor-signature__visibility">protected</span>
  1234. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  1235. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  1236. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1237. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">[]</code>)</p>
  1238. </section>
  1239. </article>
  1240. <article
  1241. class="
  1242. phpdocumentor-element
  1243. -property
  1244. -protected
  1245. "
  1246. >
  1247. <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
  1248. $logoSpaceHeight
  1249. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1250. <span class="phpdocumentor-element__modifiers">
  1251. </span>
  1252. </h4>
  1253. <aside class="phpdocumentor-element-found-in">
  1254. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1255. :
  1256. <span class="phpdocumentor-element-found-in__line">308</span>
  1257. </aside>
  1258. <p class="phpdocumentor-summary">Height of the logo space</p>
  1259. <code class="phpdocumentor-code phpdocumentor-signature ">
  1260. <span class="phpdocumentor-signature__visibility">protected</span>
  1261. <span class="phpdocumentor-signature__type">int|null</span>
  1262. <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
  1263. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1264. <section class="phpdocumentor-description"><p>if only <code class="prettyprint">QROptions::$logoSpaceHeight</code> is given, the logo space is assumed a square of that size</p>
  1265. </section>
  1266. </article>
  1267. <article
  1268. class="
  1269. phpdocumentor-element
  1270. -property
  1271. -protected
  1272. "
  1273. >
  1274. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
  1275. $logoSpaceStartX
  1276. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  1277. <span class="phpdocumentor-element__modifiers">
  1278. </span>
  1279. </h4>
  1280. <aside class="phpdocumentor-element-found-in">
  1281. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1282. :
  1283. <span class="phpdocumentor-element-found-in__line">313</span>
  1284. </aside>
  1285. <p class="phpdocumentor-summary">Optional horizontal start position of the logo space (top left corner)</p>
  1286. <code class="phpdocumentor-code phpdocumentor-signature ">
  1287. <span class="phpdocumentor-signature__visibility">protected</span>
  1288. <span class="phpdocumentor-signature__type">int|null</span>
  1289. <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
  1290. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1291. </article>
  1292. <article
  1293. class="
  1294. phpdocumentor-element
  1295. -property
  1296. -protected
  1297. "
  1298. >
  1299. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
  1300. $logoSpaceStartY
  1301. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  1302. <span class="phpdocumentor-element__modifiers">
  1303. </span>
  1304. </h4>
  1305. <aside class="phpdocumentor-element-found-in">
  1306. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1307. :
  1308. <span class="phpdocumentor-element-found-in__line">318</span>
  1309. </aside>
  1310. <p class="phpdocumentor-summary">Optional vertical start position of the logo space (top left corner)</p>
  1311. <code class="phpdocumentor-code phpdocumentor-signature ">
  1312. <span class="phpdocumentor-signature__visibility">protected</span>
  1313. <span class="phpdocumentor-signature__type">int|null</span>
  1314. <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
  1315. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1316. </article>
  1317. <article
  1318. class="
  1319. phpdocumentor-element
  1320. -property
  1321. -protected
  1322. "
  1323. >
  1324. <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
  1325. $logoSpaceWidth
  1326. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1327. <span class="phpdocumentor-element__modifiers">
  1328. </span>
  1329. </h4>
  1330. <aside class="phpdocumentor-element-found-in">
  1331. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1332. :
  1333. <span class="phpdocumentor-element-found-in__line">301</span>
  1334. </aside>
  1335. <p class="phpdocumentor-summary">Width of the logo space</p>
  1336. <code class="phpdocumentor-code phpdocumentor-signature ">
  1337. <span class="phpdocumentor-signature__visibility">protected</span>
  1338. <span class="phpdocumentor-signature__type">int|null</span>
  1339. <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
  1340. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1341. <section class="phpdocumentor-description"><p>if only <code class="prettyprint">QROptions::$logoSpaceWidth</code> is given, the logo space is assumed a square of that size</p>
  1342. </section>
  1343. </article>
  1344. <article
  1345. class="
  1346. phpdocumentor-element
  1347. -property
  1348. -protected
  1349. "
  1350. >
  1351. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  1352. $maskPattern
  1353. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1354. <span class="phpdocumentor-element__modifiers">
  1355. </span>
  1356. </h4>
  1357. <aside class="phpdocumentor-element-found-in">
  1358. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1359. :
  1360. <span class="phpdocumentor-element-found-in__line">121</span>
  1361. </aside>
  1362. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  1363. <code class="phpdocumentor-code phpdocumentor-signature ">
  1364. <span class="phpdocumentor-signature__visibility">protected</span>
  1365. <span class="phpdocumentor-signature__type">int</span>
  1366. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1367. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
  1368. <section class="phpdocumentor-description"><p><code class="prettyprint">0 ... 7</code> or <code class="prettyprint">MaskPattern::PATTERN_AUTO</code> (default)</p>
  1369. </section>
  1370. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1371. Tags
  1372. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1373. </h5>
  1374. <dl class="phpdocumentor-tag-list">
  1375. <dt class="phpdocumentor-tag-list__entry">
  1376. <span class="phpdocumentor-tag__name">see</span>
  1377. </dt>
  1378. <dd class="phpdocumentor-tag-list__definition">
  1379. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  1380. </dd>
  1381. </dl>
  1382. </article>
  1383. <article
  1384. class="
  1385. phpdocumentor-element
  1386. -property
  1387. -protected
  1388. "
  1389. >
  1390. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  1391. $moduleValues
  1392. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1393. <span class="phpdocumentor-element__modifiers">
  1394. </span>
  1395. </h4>
  1396. <aside class="phpdocumentor-element-found-in">
  1397. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1398. :
  1399. <span class="phpdocumentor-element-found-in__line">286</span>
  1400. </aside>
  1401. <p class="phpdocumentor-summary">Module values map</p>
  1402. <code class="phpdocumentor-code phpdocumentor-signature ">
  1403. <span class="phpdocumentor-signature__visibility">protected</span>
  1404. <span class="phpdocumentor-signature__type">array&lt;int, mixed&gt;</span>
  1405. <span class="phpdocumentor-signature__name">$moduleValues</span>
  1406. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1407. <section class="phpdocumentor-description"><ul>
  1408. <li><code class="prettyprint">QRImagick</code>, <code class="prettyprint">QRMarkupHTML</code>, <code class="prettyprint">QRMarkupSVG</code>: #ABCDEF, cssname, rgb(), rgba()...</li>
  1409. <li><code class="prettyprint">QREps</code>, <code class="prettyprint">QRFpdf</code>, <code class="prettyprint">QRGdImage</code>: <code class="prettyprint">[R, G, B]</code> // 0-255</li>
  1410. <li><code class="prettyprint">QREps</code>: <code class="prettyprint">[C, M, Y, K]</code> // 0-255</li>
  1411. </ul>
  1412. </section>
  1413. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1414. Tags
  1415. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1416. </h5>
  1417. <dl class="phpdocumentor-tag-list">
  1418. <dt class="phpdocumentor-tag-list__entry">
  1419. <span class="phpdocumentor-tag__name">see</span>
  1420. </dt>
  1421. <dd class="phpdocumentor-tag-list__definition">
  1422. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::setModuleValues()">QROutputAbstract::setModuleValues()</abbr></a></span>
  1423. </dd>
  1424. </dl>
  1425. </article>
  1426. <article
  1427. class="
  1428. phpdocumentor-element
  1429. -property
  1430. -protected
  1431. "
  1432. >
  1433. <h4 class="phpdocumentor-element__name" id="property_outputBase64">
  1434. $outputBase64
  1435. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64" class="headerlink"><i class="fas fa-link"></i></a>
  1436. <span class="phpdocumentor-element__modifiers">
  1437. </span>
  1438. </h4>
  1439. <aside class="phpdocumentor-element-found-in">
  1440. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1441. :
  1442. <span class="phpdocumentor-element-found-in__line">179</span>
  1443. </aside>
  1444. <p class="phpdocumentor-summary">Toggle base64 data URI or raw data output (if applicable)</p>
  1445. <code class="phpdocumentor-code phpdocumentor-signature ">
  1446. <span class="phpdocumentor-signature__visibility">protected</span>
  1447. <span class="phpdocumentor-signature__type">bool</span>
  1448. <span class="phpdocumentor-signature__name">$outputBase64</span>
  1449. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1450. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
  1451. </section>
  1452. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1453. Tags
  1454. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1455. </h5>
  1456. <dl class="phpdocumentor-tag-list">
  1457. <dt class="phpdocumentor-tag-list__entry">
  1458. <span class="phpdocumentor-tag__name">see</span>
  1459. </dt>
  1460. <dd class="phpdocumentor-tag-list__definition">
  1461. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()">QROutputAbstract::toBase64DataURI()</abbr></a></span>
  1462. </dd>
  1463. </dl>
  1464. </article>
  1465. <article
  1466. class="
  1467. phpdocumentor-element
  1468. -property
  1469. -protected
  1470. "
  1471. >
  1472. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  1473. $outputInterface
  1474. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1475. <span class="phpdocumentor-element__modifiers">
  1476. </span>
  1477. </h4>
  1478. <aside class="phpdocumentor-element-found-in">
  1479. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1480. :
  1481. <span class="phpdocumentor-element-found-in__line">145</span>
  1482. </aside>
  1483. <p class="phpdocumentor-summary">The FQCN of the `QROutputInterface` to use</p>
  1484. <code class="phpdocumentor-code phpdocumentor-signature ">
  1485. <span class="phpdocumentor-signature__visibility">protected</span>
  1486. <span class="phpdocumentor-signature__type">string</span>
  1487. <span class="phpdocumentor-signature__name">$outputInterface</span>
  1488. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QRMarkupSVG::class</span></code>
  1489. </article>
  1490. <article
  1491. class="
  1492. phpdocumentor-element
  1493. -property
  1494. -protected
  1495. "
  1496. >
  1497. <h4 class="phpdocumentor-element__name" id="property_quality">
  1498. $quality
  1499. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" class="headerlink"><i class="fas fa-link"></i></a>
  1500. <span class="phpdocumentor-element__modifiers">
  1501. </span>
  1502. </h4>
  1503. <aside class="phpdocumentor-element-found-in">
  1504. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1505. :
  1506. <span class="phpdocumentor-element-found-in__line">369</span>
  1507. </aside>
  1508. <p class="phpdocumentor-summary">Compression quality</p>
  1509. <code class="phpdocumentor-code phpdocumentor-signature ">
  1510. <span class="phpdocumentor-signature__visibility">protected</span>
  1511. <span class="phpdocumentor-signature__type">int</span>
  1512. <span class="phpdocumentor-signature__name">$quality</span>
  1513. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  1514. <section class="phpdocumentor-description"><p>The given value depends on the used output type:</p>
  1515. <ul>
  1516. <li><code class="prettyprint">QRGdImageBMP</code>: <code class="prettyprint">[0...1]</code></li>
  1517. <li><code class="prettyprint">QRGdImageJPEG</code>: <code class="prettyprint">[0...100]</code></li>
  1518. <li><code class="prettyprint">QRGdImageWEBP</code>: <code class="prettyprint">[0...9]</code></li>
  1519. <li><code class="prettyprint">QRGdImagePNG</code>: <code class="prettyprint">[0...100]</code></li>
  1520. <li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">[0...100]</code></li>
  1521. </ul>
  1522. </section>
  1523. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1524. Tags
  1525. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1526. </h5>
  1527. <dl class="phpdocumentor-tag-list">
  1528. <dt class="phpdocumentor-tag-list__entry">
  1529. <span class="phpdocumentor-tag__name">see</span>
  1530. </dt>
  1531. <dd class="phpdocumentor-tag-list__definition">
  1532. <span class="phpdocumentor-tag-link"><abbr title="\imagebmp()">imagebmp()</abbr></span>
  1533. </dd>
  1534. <dt class="phpdocumentor-tag-list__entry">
  1535. <span class="phpdocumentor-tag__name">see</span>
  1536. </dt>
  1537. <dd class="phpdocumentor-tag-list__definition">
  1538. <span class="phpdocumentor-tag-link"><abbr title="\imagejpeg()">imagejpeg()</abbr></span>
  1539. </dd>
  1540. <dt class="phpdocumentor-tag-list__entry">
  1541. <span class="phpdocumentor-tag__name">see</span>
  1542. </dt>
  1543. <dd class="phpdocumentor-tag-list__definition">
  1544. <span class="phpdocumentor-tag-link"><abbr title="\imagepng()">imagepng()</abbr></span>
  1545. </dd>
  1546. <dt class="phpdocumentor-tag-list__entry">
  1547. <span class="phpdocumentor-tag__name">see</span>
  1548. </dt>
  1549. <dd class="phpdocumentor-tag-list__definition">
  1550. <span class="phpdocumentor-tag-link"><abbr title="\imagewebp()">imagewebp()</abbr></span>
  1551. </dd>
  1552. <dt class="phpdocumentor-tag-list__entry">
  1553. <span class="phpdocumentor-tag__name">see</span>
  1554. </dt>
  1555. <dd class="phpdocumentor-tag-list__definition">
  1556. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageCompressionQuality()">Imagick::setImageCompressionQuality()</abbr></span>
  1557. </dd>
  1558. </dl>
  1559. </article>
  1560. <article
  1561. class="
  1562. phpdocumentor-element
  1563. -property
  1564. -protected
  1565. "
  1566. >
  1567. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  1568. $quietzoneSize
  1569. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  1570. <span class="phpdocumentor-element__modifiers">
  1571. </span>
  1572. </h4>
  1573. <aside class="phpdocumentor-element-found-in">
  1574. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1575. :
  1576. <span class="phpdocumentor-element-found-in__line">135</span>
  1577. </aside>
  1578. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  1579. <code class="phpdocumentor-code phpdocumentor-signature ">
  1580. <span class="phpdocumentor-signature__visibility">protected</span>
  1581. <span class="phpdocumentor-signature__type">int</span>
  1582. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  1583. = <span class="phpdocumentor-signature__default-value">4</span></code>
  1584. <section class="phpdocumentor-description"><p>internally clamped to <code class="prettyprint">0 ... $moduleCount / 2</code> (default: 4)</p>
  1585. </section>
  1586. </article>
  1587. <article
  1588. class="
  1589. phpdocumentor-element
  1590. -property
  1591. -protected
  1592. "
  1593. >
  1594. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  1595. $readerGrayscale
  1596. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  1597. <span class="phpdocumentor-element__modifiers">
  1598. </span>
  1599. </h4>
  1600. <aside class="phpdocumentor-element-found-in">
  1601. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  1602. :
  1603. <span class="phpdocumentor-element-found-in__line">34</span>
  1604. </aside>
  1605. <p class="phpdocumentor-summary">Grayscale the image before reading</p>
  1606. <code class="phpdocumentor-code phpdocumentor-signature ">
  1607. <span class="phpdocumentor-signature__visibility">protected</span>
  1608. <span class="phpdocumentor-signature__type">bool</span>
  1609. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  1610. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1611. </article>
  1612. <article
  1613. class="
  1614. phpdocumentor-element
  1615. -property
  1616. -protected
  1617. "
  1618. >
  1619. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  1620. $readerIncreaseContrast
  1621. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  1622. <span class="phpdocumentor-element__modifiers">
  1623. </span>
  1624. </h4>
  1625. <aside class="phpdocumentor-element-found-in">
  1626. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  1627. :
  1628. <span class="phpdocumentor-element-found-in__line">46</span>
  1629. </aside>
  1630. <p class="phpdocumentor-summary">Increase the contrast before reading</p>
  1631. <code class="phpdocumentor-code phpdocumentor-signature ">
  1632. <span class="phpdocumentor-signature__visibility">protected</span>
  1633. <span class="phpdocumentor-signature__type">bool</span>
  1634. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  1635. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1636. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  1637. </section>
  1638. </article>
  1639. <article
  1640. class="
  1641. phpdocumentor-element
  1642. -property
  1643. -protected
  1644. "
  1645. >
  1646. <h4 class="phpdocumentor-element__name" id="property_readerInvertColors">
  1647. $readerInvertColors
  1648. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors" class="headerlink"><i class="fas fa-link"></i></a>
  1649. <span class="phpdocumentor-element__modifiers">
  1650. </span>
  1651. </h4>
  1652. <aside class="phpdocumentor-element-found-in">
  1653. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  1654. :
  1655. <span class="phpdocumentor-element-found-in__line">39</span>
  1656. </aside>
  1657. <p class="phpdocumentor-summary">Invert the colors of the image</p>
  1658. <code class="phpdocumentor-code phpdocumentor-signature ">
  1659. <span class="phpdocumentor-signature__visibility">protected</span>
  1660. <span class="phpdocumentor-signature__type">bool</span>
  1661. <span class="phpdocumentor-signature__name">$readerInvertColors</span>
  1662. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1663. </article>
  1664. <article
  1665. class="
  1666. phpdocumentor-element
  1667. -property
  1668. -protected
  1669. "
  1670. >
  1671. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  1672. $readerUseImagickIfAvailable
  1673. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1674. <span class="phpdocumentor-element__modifiers">
  1675. </span>
  1676. </h4>
  1677. <aside class="phpdocumentor-element-found-in">
  1678. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  1679. :
  1680. <span class="phpdocumentor-element-found-in__line">29</span>
  1681. </aside>
  1682. <p class="phpdocumentor-summary">Use Imagick (if available) when reading QR Codes</p>
  1683. <code class="phpdocumentor-code phpdocumentor-signature ">
  1684. <span class="phpdocumentor-signature__visibility">protected</span>
  1685. <span class="phpdocumentor-signature__type">bool</span>
  1686. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  1687. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1688. </article>
  1689. <article
  1690. class="
  1691. phpdocumentor-element
  1692. -property
  1693. -protected
  1694. "
  1695. >
  1696. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  1697. $returnResource
  1698. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  1699. <span class="phpdocumentor-element__modifiers">
  1700. </span>
  1701. </h4>
  1702. <aside class="phpdocumentor-element-found-in">
  1703. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1704. :
  1705. <span class="phpdocumentor-element-found-in__line">159</span>
  1706. </aside>
  1707. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  1708. <code class="phpdocumentor-code phpdocumentor-signature ">
  1709. <span class="phpdocumentor-signature__visibility">protected</span>
  1710. <span class="phpdocumentor-signature__type">bool</span>
  1711. <span class="phpdocumentor-signature__name">$returnResource</span>
  1712. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1713. <section class="phpdocumentor-description"><ul>
  1714. <li><code class="prettyprint">QRGdImage</code>: <code class="prettyprint">resource</code> (PHP &lt; 8), <code class="prettyprint">GdImage</code></li>
  1715. <li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">Imagick</code></li>
  1716. <li><code class="prettyprint">QRFpdf</code>: <code class="prettyprint">FPDF</code></li>
  1717. </ul>
  1718. <p>This option overrides/ignores other output settings, such as <code class="prettyprint">QROptions::$cachefile</code>
  1719. and <code class="prettyprint">QROptions::$outputBase64</code>. (default: <code class="prettyprint">false</code>)</p>
  1720. </section>
  1721. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1722. Tags
  1723. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1724. </h5>
  1725. <dl class="phpdocumentor-tag-list">
  1726. <dt class="phpdocumentor-tag-list__entry">
  1727. <span class="phpdocumentor-tag__name">see</span>
  1728. </dt>
  1729. <dd class="phpdocumentor-tag-list__definition">
  1730. <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>
  1731. </dd>
  1732. </dl>
  1733. </article>
  1734. <article
  1735. class="
  1736. phpdocumentor-element
  1737. -property
  1738. -protected
  1739. "
  1740. >
  1741. <h4 class="phpdocumentor-element__name" id="property_scale">
  1742. $scale
  1743. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" 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">328</span>
  1751. </aside>
  1752. <p class="phpdocumentor-summary">Pixel size of a QR code module</p>
  1753. <code class="phpdocumentor-code phpdocumentor-signature ">
  1754. <span class="phpdocumentor-signature__visibility">protected</span>
  1755. <span class="phpdocumentor-signature__type">int</span>
  1756. <span class="phpdocumentor-signature__name">$scale</span>
  1757. = <span class="phpdocumentor-signature__default-value">5</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_svgAddXmlHeader">
  1767. $svgAddXmlHeader
  1768. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" 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">418</span>
  1776. </aside>
  1777. <p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</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">$svgAddXmlHeader</span>
  1782. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1783. <section class="phpdocumentor-description"><p><code class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</code></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_svgDefs">
  1794. $svgDefs
  1795. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" 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">425</span>
  1803. </aside>
  1804. <p class="phpdocumentor-summary">Anything in the SVG `&lt;defs&gt;` tag</p>
  1805. <code class="phpdocumentor-code phpdocumentor-signature ">
  1806. <span class="phpdocumentor-signature__visibility">protected</span>
  1807. <span class="phpdocumentor-signature__type">string</span>
  1808. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1809. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1810. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1811. Tags
  1812. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1813. </h5>
  1814. <dl class="phpdocumentor-tag-list">
  1815. <dt class="phpdocumentor-tag-list__entry">
  1816. <span class="phpdocumentor-tag__name">see</span>
  1817. </dt>
  1818. <dd class="phpdocumentor-tag-list__definition">
  1819. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</a></span>
  1820. </dd>
  1821. </dl>
  1822. </article>
  1823. <article
  1824. class="
  1825. phpdocumentor-element
  1826. -property
  1827. -protected
  1828. "
  1829. >
  1830. <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
  1831. $svgPreserveAspectRatio
  1832. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
  1833. <span class="phpdocumentor-element__modifiers">
  1834. </span>
  1835. </h4>
  1836. <aside class="phpdocumentor-element-found-in">
  1837. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1838. :
  1839. <span class="phpdocumentor-element-found-in__line">432</span>
  1840. </aside>
  1841. <p class="phpdocumentor-summary">Sets the value for the &quot;preserveAspectRatio&quot; on the `&lt;svg&gt;` element</p>
  1842. <code class="phpdocumentor-code phpdocumentor-signature ">
  1843. <span class="phpdocumentor-signature__visibility">protected</span>
  1844. <span class="phpdocumentor-signature__type">string</span>
  1845. <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
  1846. = <span class="phpdocumentor-signature__default-value">&#039;xMidYMid&#039;</span></code>
  1847. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1848. Tags
  1849. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1850. </h5>
  1851. <dl class="phpdocumentor-tag-list">
  1852. <dt class="phpdocumentor-tag-list__entry">
  1853. <span class="phpdocumentor-tag__name">see</span>
  1854. </dt>
  1855. <dd class="phpdocumentor-tag-list__definition">
  1856. <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>
  1857. </dd>
  1858. </dl>
  1859. </article>
  1860. <article
  1861. class="
  1862. phpdocumentor-element
  1863. -property
  1864. -protected
  1865. "
  1866. >
  1867. <h4 class="phpdocumentor-element__name" id="property_svgUseFillAttributes">
  1868. $svgUseFillAttributes
  1869. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes" class="headerlink"><i class="fas fa-link"></i></a>
  1870. <span class="phpdocumentor-element__modifiers">
  1871. </span>
  1872. </h4>
  1873. <aside class="phpdocumentor-element-found-in">
  1874. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1875. :
  1876. <span class="phpdocumentor-element-found-in__line">442</span>
  1877. </aside>
  1878. <p class="phpdocumentor-summary">Whether to use the SVG `fill` attributes</p>
  1879. <code class="phpdocumentor-code phpdocumentor-signature ">
  1880. <span class="phpdocumentor-signature__visibility">protected</span>
  1881. <span class="phpdocumentor-signature__type">bool</span>
  1882. <span class="phpdocumentor-signature__name">$svgUseFillAttributes</span>
  1883. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1884. <section class="phpdocumentor-description"><p>If set to <code class="prettyprint">true</code> (default), the <code class="prettyprint">fill</code> attribute will be set with the module value for the <code class="prettyprint">&lt;path&gt;</code> element's <code class="prettyprint">$M_TYPE</code>.
  1885. When set to <code class="prettyprint">false</code>, the module values map will be ignored and the QR Code may be styled via CSS.</p>
  1886. </section>
  1887. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1888. Tags
  1889. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1890. </h5>
  1891. <dl class="phpdocumentor-tag-list">
  1892. <dt class="phpdocumentor-tag-list__entry">
  1893. <span class="phpdocumentor-tag__name">see</span>
  1894. </dt>
  1895. <dd class="phpdocumentor-tag-list__definition">
  1896. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</a></span>
  1897. </dd>
  1898. </dl>
  1899. </article>
  1900. <article
  1901. class="
  1902. phpdocumentor-element
  1903. -property
  1904. -protected
  1905. "
  1906. >
  1907. <h4 class="phpdocumentor-element__name" id="property_textLineStart">
  1908. $textLineStart
  1909. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" class="headerlink"><i class="fas fa-link"></i></a>
  1910. <span class="phpdocumentor-element__modifiers">
  1911. </span>
  1912. </h4>
  1913. <aside class="phpdocumentor-element-found-in">
  1914. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1915. :
  1916. <span class="phpdocumentor-element-found-in__line">452</span>
  1917. </aside>
  1918. <p class="phpdocumentor-summary">An optional line prefix, e.g. empty space to align the QR Code in a console</p>
  1919. <code class="phpdocumentor-code phpdocumentor-signature ">
  1920. <span class="phpdocumentor-signature__visibility">protected</span>
  1921. <span class="phpdocumentor-signature__type">string</span>
  1922. <span class="phpdocumentor-signature__name">$textLineStart</span>
  1923. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1924. </article>
  1925. <article
  1926. class="
  1927. phpdocumentor-element
  1928. -property
  1929. -protected
  1930. "
  1931. >
  1932. <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
  1933. $transparencyColor
  1934. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1935. <span class="phpdocumentor-element__modifiers">
  1936. </span>
  1937. </h4>
  1938. <aside class="phpdocumentor-element-found-in">
  1939. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1940. :
  1941. <span class="phpdocumentor-element-found-in__line">350</span>
  1942. </aside>
  1943. <p class="phpdocumentor-summary">Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.</p>
  1944. <code class="phpdocumentor-code phpdocumentor-signature ">
  1945. <span class="phpdocumentor-signature__visibility">protected</span>
  1946. <span class="phpdocumentor-signature__type">mixed</span>
  1947. <span class="phpdocumentor-signature__name">$transparencyColor</span>
  1948. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1949. <section class="phpdocumentor-description"><p>Defaults to <code class="prettyprint">QROptions::$bgColor</code>.</p>
  1950. <ul>
  1951. <li><code class="prettyprint">QRGdImage</code>: <code class="prettyprint">[R, G, B]</code>, this color is set as transparent in <code class="prettyprint">imagecolortransparent()</code></li>
  1952. <li><code class="prettyprint">QRImagick</code>: <code class="prettyprint">&quot;color_str&quot;</code>, this color is set in <code class="prettyprint">Imagick::transparentPaintImage()</code></li>
  1953. </ul>
  1954. </section>
  1955. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1956. Tags
  1957. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1958. </h5>
  1959. <dl class="phpdocumentor-tag-list">
  1960. <dt class="phpdocumentor-tag-list__entry">
  1961. <span class="phpdocumentor-tag__name">see</span>
  1962. </dt>
  1963. <dd class="phpdocumentor-tag-list__definition">
  1964. <span class="phpdocumentor-tag-link"><abbr title="\imagecolortransparent()">imagecolortransparent()</abbr></span>
  1965. </dd>
  1966. <dt class="phpdocumentor-tag-list__entry">
  1967. <span class="phpdocumentor-tag__name">see</span>
  1968. </dt>
  1969. <dd class="phpdocumentor-tag-list__definition">
  1970. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr></span>
  1971. </dd>
  1972. </dl>
  1973. </article>
  1974. <article
  1975. class="
  1976. phpdocumentor-element
  1977. -property
  1978. -protected
  1979. "
  1980. >
  1981. <h4 class="phpdocumentor-element__name" id="property_version">
  1982. $version
  1983. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  1984. <span class="phpdocumentor-element__modifiers">
  1985. </span>
  1986. </h4>
  1987. <aside class="phpdocumentor-element-found-in">
  1988. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1989. :
  1990. <span class="phpdocumentor-element-found-in__line">81</span>
  1991. </aside>
  1992. <p class="phpdocumentor-summary">QR Code version number</p>
  1993. <code class="phpdocumentor-code phpdocumentor-signature ">
  1994. <span class="phpdocumentor-signature__visibility">protected</span>
  1995. <span class="phpdocumentor-signature__type">int</span>
  1996. <span class="phpdocumentor-signature__name">$version</span>
  1997. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
  1998. <section class="phpdocumentor-description"><p><code class="prettyprint">1 ... 40</code> or <code class="prettyprint">Version::AUTO</code> (default)</p>
  1999. </section>
  2000. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2001. Tags
  2002. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2003. </h5>
  2004. <dl class="phpdocumentor-tag-list">
  2005. <dt class="phpdocumentor-tag-list__entry">
  2006. <span class="phpdocumentor-tag__name">see</span>
  2007. </dt>
  2008. <dd class="phpdocumentor-tag-list__definition">
  2009. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  2010. </dd>
  2011. </dl>
  2012. </article>
  2013. <article
  2014. class="
  2015. phpdocumentor-element
  2016. -property
  2017. -protected
  2018. "
  2019. >
  2020. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  2021. $versionMax
  2022. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2023. <span class="phpdocumentor-element__modifiers">
  2024. </span>
  2025. </h4>
  2026. <aside class="phpdocumentor-element-found-in">
  2027. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2028. :
  2029. <span class="phpdocumentor-element-found-in__line">95</span>
  2030. </aside>
  2031. <p class="phpdocumentor-summary">Maximum QR version</p>
  2032. <code class="phpdocumentor-code phpdocumentor-signature ">
  2033. <span class="phpdocumentor-signature__visibility">protected</span>
  2034. <span class="phpdocumentor-signature__type">int</span>
  2035. <span class="phpdocumentor-signature__name">$versionMax</span>
  2036. = <span class="phpdocumentor-signature__default-value">40</span></code>
  2037. <section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 40)</p>
  2038. </section>
  2039. </article>
  2040. <article
  2041. class="
  2042. phpdocumentor-element
  2043. -property
  2044. -protected
  2045. "
  2046. >
  2047. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  2048. $versionMin
  2049. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2050. <span class="phpdocumentor-element__modifiers">
  2051. </span>
  2052. </h4>
  2053. <aside class="phpdocumentor-element-found-in">
  2054. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2055. :
  2056. <span class="phpdocumentor-element-found-in__line">88</span>
  2057. </aside>
  2058. <p class="phpdocumentor-summary">Minimum QR version</p>
  2059. <code class="phpdocumentor-code phpdocumentor-signature ">
  2060. <span class="phpdocumentor-signature__visibility">protected</span>
  2061. <span class="phpdocumentor-signature__type">int</span>
  2062. <span class="phpdocumentor-signature__name">$versionMin</span>
  2063. = <span class="phpdocumentor-signature__default-value">1</span></code>
  2064. <section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 1)</p>
  2065. </section>
  2066. </article>
  2067. <article
  2068. class="
  2069. phpdocumentor-element
  2070. -property
  2071. -protected
  2072. "
  2073. >
  2074. <h4 class="phpdocumentor-element__name" id="property_xmlStylesheet">
  2075. $xmlStylesheet
  2076. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet" class="headerlink"><i class="fas fa-link"></i></a>
  2077. <span class="phpdocumentor-element__modifiers">
  2078. </span>
  2079. </h4>
  2080. <aside class="phpdocumentor-element-found-in">
  2081. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2082. :
  2083. <span class="phpdocumentor-element-found-in__line">488</span>
  2084. </aside>
  2085. <p class="phpdocumentor-summary">Sets an optional XSLT stylesheet in the XML output</p>
  2086. <code class="phpdocumentor-code phpdocumentor-signature ">
  2087. <span class="phpdocumentor-signature__visibility">protected</span>
  2088. <span class="phpdocumentor-signature__type">string|null</span>
  2089. <span class="phpdocumentor-signature__name">$xmlStylesheet</span>
  2090. = <span class="phpdocumentor-signature__default-value">null</span></code>
  2091. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2092. Tags
  2093. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2094. </h5>
  2095. <dl class="phpdocumentor-tag-list">
  2096. <dt class="phpdocumentor-tag-list__entry">
  2097. <span class="phpdocumentor-tag__name">see</span>
  2098. </dt>
  2099. <dd class="phpdocumentor-tag-list__definition">
  2100. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/XSLT">https://developer.mozilla.org/en-US/docs/Web/XSLT</a></span>
  2101. </dd>
  2102. </dl>
  2103. </article>
  2104. </section>
  2105. <section class="phpdocumentor-methods">
  2106. <h3 class="phpdocumentor-elements__header" id="methods">
  2107. Methods
  2108. <a href="classes/chillerlan-QRCode-QROptions.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  2109. </h3>
  2110. <article
  2111. class="phpdocumentor-element
  2112. -method
  2113. -protected
  2114. "
  2115. >
  2116. <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
  2117. clampLogoSpaceValue()
  2118. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  2119. </h4>
  2120. <aside class="phpdocumentor-element-found-in">
  2121. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2122. :
  2123. <span class="phpdocumentor-element-found-in__line">575</span>
  2124. </aside>
  2125. <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
  2126. <code class="phpdocumentor-code phpdocumentor-signature ">
  2127. <span class="phpdocumentor-signature__visibility">protected</span>
  2128. <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>
  2129. <div class="phpdocumentor-label-line">
  2130. </div>
  2131. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2132. <dl class="phpdocumentor-argument-list">
  2133. <dt class="phpdocumentor-argument-list__entry">
  2134. <span class="phpdocumentor-signature__argument__name">$value</span>
  2135. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2136. </dt>
  2137. <dd class="phpdocumentor-argument-list__definition">
  2138. </dd>
  2139. </dl>
  2140. <section>
  2141. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2142. <span class="phpdocumentor-signature__response_type">int|null</span>
  2143. </section>
  2144. </article>
  2145. <article
  2146. class="phpdocumentor-element
  2147. -method
  2148. -protected
  2149. "
  2150. >
  2151. <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
  2152. set_circleRadius()
  2153. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  2154. </h4>
  2155. <aside class="phpdocumentor-element-found-in">
  2156. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2157. :
  2158. <span class="phpdocumentor-element-found-in__line">615</span>
  2159. </aside>
  2160. <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
  2161. <code class="phpdocumentor-code phpdocumentor-signature ">
  2162. <span class="phpdocumentor-signature__visibility">protected</span>
  2163. <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>
  2164. <div class="phpdocumentor-label-line">
  2165. </div>
  2166. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2167. <dl class="phpdocumentor-argument-list">
  2168. <dt class="phpdocumentor-argument-list__entry">
  2169. <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
  2170. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  2171. </dt>
  2172. <dd class="phpdocumentor-argument-list__definition">
  2173. </dd>
  2174. </dl>
  2175. </article>
  2176. <article
  2177. class="phpdocumentor-element
  2178. -method
  2179. -protected
  2180. "
  2181. >
  2182. <h4 class="phpdocumentor-element__name" id="method_set_eccLevel">
  2183. set_eccLevel()
  2184. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  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">528</span>
  2190. </aside>
  2191. <p class="phpdocumentor-summary">sets the ECC level</p>
  2192. <code class="phpdocumentor-code phpdocumentor-signature ">
  2193. <span class="phpdocumentor-signature__visibility">protected</span>
  2194. <span class="phpdocumentor-signature__name">set_eccLevel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2195. <div class="phpdocumentor-label-line">
  2196. </div>
  2197. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2198. <dl class="phpdocumentor-argument-list">
  2199. <dt class="phpdocumentor-argument-list__entry">
  2200. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  2201. : <span class="phpdocumentor-signature__argument__return-type">int|string</span>
  2202. </dt>
  2203. <dd class="phpdocumentor-argument-list__definition">
  2204. </dd>
  2205. </dl>
  2206. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2207. Tags
  2208. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2209. </h5>
  2210. <dl class="phpdocumentor-tag-list">
  2211. <dt class="phpdocumentor-tag-list__entry">
  2212. <span class="phpdocumentor-tag__name">throws</span>
  2213. </dt>
  2214. <dd class="phpdocumentor-tag-list__definition">
  2215. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  2216. </dd>
  2217. </dl>
  2218. </article>
  2219. <article
  2220. class="phpdocumentor-element
  2221. -method
  2222. -protected
  2223. "
  2224. >
  2225. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  2226. set_fpdfMeasureUnit()
  2227. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  2228. </h4>
  2229. <aside class="phpdocumentor-element-found-in">
  2230. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2231. :
  2232. <span class="phpdocumentor-element-found-in__line">562</span>
  2233. </aside>
  2234. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  2235. <code class="phpdocumentor-code phpdocumentor-signature ">
  2236. <span class="phpdocumentor-signature__visibility">protected</span>
  2237. <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>
  2238. <div class="phpdocumentor-label-line">
  2239. </div>
  2240. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2241. <dl class="phpdocumentor-argument-list">
  2242. <dt class="phpdocumentor-argument-list__entry">
  2243. <span class="phpdocumentor-signature__argument__name">$unit</span>
  2244. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2245. </dt>
  2246. <dd class="phpdocumentor-argument-list__definition">
  2247. </dd>
  2248. </dl>
  2249. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2250. Tags
  2251. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2252. </h5>
  2253. <dl class="phpdocumentor-tag-list">
  2254. <dt class="phpdocumentor-tag-list__entry">
  2255. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2256. </dt>
  2257. <dd class="phpdocumentor-tag-list__definition">
  2258. </dd>
  2259. </dl>
  2260. </article>
  2261. <article
  2262. class="phpdocumentor-element
  2263. -method
  2264. -protected
  2265. "
  2266. >
  2267. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
  2268. set_logoSpaceHeight()
  2269. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  2270. </h4>
  2271. <aside class="phpdocumentor-element-found-in">
  2272. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2273. :
  2274. <span class="phpdocumentor-element-found-in__line">594</span>
  2275. </aside>
  2276. <p class="phpdocumentor-summary">clamp/set logo space height</p>
  2277. <code class="phpdocumentor-code phpdocumentor-signature ">
  2278. <span class="phpdocumentor-signature__visibility">protected</span>
  2279. <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>
  2280. <div class="phpdocumentor-label-line">
  2281. </div>
  2282. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2283. <dl class="phpdocumentor-argument-list">
  2284. <dt class="phpdocumentor-argument-list__entry">
  2285. <span class="phpdocumentor-signature__argument__name">$value</span>
  2286. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2287. </dt>
  2288. <dd class="phpdocumentor-argument-list__definition">
  2289. </dd>
  2290. </dl>
  2291. </article>
  2292. <article
  2293. class="phpdocumentor-element
  2294. -method
  2295. -protected
  2296. "
  2297. >
  2298. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
  2299. set_logoSpaceStartX()
  2300. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  2301. </h4>
  2302. <aside class="phpdocumentor-element-found-in">
  2303. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2304. :
  2305. <span class="phpdocumentor-element-found-in__line">601</span>
  2306. </aside>
  2307. <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
  2308. <code class="phpdocumentor-code phpdocumentor-signature ">
  2309. <span class="phpdocumentor-signature__visibility">protected</span>
  2310. <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>
  2311. <div class="phpdocumentor-label-line">
  2312. </div>
  2313. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2314. <dl class="phpdocumentor-argument-list">
  2315. <dt class="phpdocumentor-argument-list__entry">
  2316. <span class="phpdocumentor-signature__argument__name">$value</span>
  2317. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2318. </dt>
  2319. <dd class="phpdocumentor-argument-list__definition">
  2320. </dd>
  2321. </dl>
  2322. </article>
  2323. <article
  2324. class="phpdocumentor-element
  2325. -method
  2326. -protected
  2327. "
  2328. >
  2329. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
  2330. set_logoSpaceStartY()
  2331. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  2332. </h4>
  2333. <aside class="phpdocumentor-element-found-in">
  2334. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2335. :
  2336. <span class="phpdocumentor-element-found-in__line">608</span>
  2337. </aside>
  2338. <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
  2339. <code class="phpdocumentor-code phpdocumentor-signature ">
  2340. <span class="phpdocumentor-signature__visibility">protected</span>
  2341. <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>
  2342. <div class="phpdocumentor-label-line">
  2343. </div>
  2344. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2345. <dl class="phpdocumentor-argument-list">
  2346. <dt class="phpdocumentor-argument-list__entry">
  2347. <span class="phpdocumentor-signature__argument__name">$value</span>
  2348. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2349. </dt>
  2350. <dd class="phpdocumentor-argument-list__definition">
  2351. </dd>
  2352. </dl>
  2353. </article>
  2354. <article
  2355. class="phpdocumentor-element
  2356. -method
  2357. -protected
  2358. "
  2359. >
  2360. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
  2361. set_logoSpaceWidth()
  2362. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  2363. </h4>
  2364. <aside class="phpdocumentor-element-found-in">
  2365. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2366. :
  2367. <span class="phpdocumentor-element-found-in__line">587</span>
  2368. </aside>
  2369. <p class="phpdocumentor-summary">clamp/set logo space width</p>
  2370. <code class="phpdocumentor-code phpdocumentor-signature ">
  2371. <span class="phpdocumentor-signature__visibility">protected</span>
  2372. <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>
  2373. <div class="phpdocumentor-label-line">
  2374. </div>
  2375. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2376. <dl class="phpdocumentor-argument-list">
  2377. <dt class="phpdocumentor-argument-list__entry">
  2378. <span class="phpdocumentor-signature__argument__name">$value</span>
  2379. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2380. </dt>
  2381. <dd class="phpdocumentor-argument-list__definition">
  2382. </dd>
  2383. </dl>
  2384. </article>
  2385. <article
  2386. class="phpdocumentor-element
  2387. -method
  2388. -protected
  2389. "
  2390. >
  2391. <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
  2392. set_quietzoneSize()
  2393. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  2394. </h4>
  2395. <aside class="phpdocumentor-element-found-in">
  2396. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2397. :
  2398. <span class="phpdocumentor-element-found-in__line">553</span>
  2399. </aside>
  2400. <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
  2401. <code class="phpdocumentor-code phpdocumentor-signature ">
  2402. <span class="phpdocumentor-signature__visibility">protected</span>
  2403. <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>
  2404. <div class="phpdocumentor-label-line">
  2405. </div>
  2406. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2407. <dl class="phpdocumentor-argument-list">
  2408. <dt class="phpdocumentor-argument-list__entry">
  2409. <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
  2410. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2411. </dt>
  2412. <dd class="phpdocumentor-argument-list__definition">
  2413. </dd>
  2414. </dl>
  2415. </article>
  2416. <article
  2417. class="phpdocumentor-element
  2418. -method
  2419. -protected
  2420. "
  2421. >
  2422. <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
  2423. set_readerUseImagickIfAvailable()
  2424. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  2425. </h4>
  2426. <aside class="phpdocumentor-element-found-in">
  2427. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  2428. :
  2429. <span class="phpdocumentor-element-found-in__line">51</span>
  2430. </aside>
  2431. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  2432. <code class="phpdocumentor-code phpdocumentor-signature ">
  2433. <span class="phpdocumentor-signature__visibility">protected</span>
  2434. <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>
  2435. <div class="phpdocumentor-label-line">
  2436. </div>
  2437. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2438. <dl class="phpdocumentor-argument-list">
  2439. <dt class="phpdocumentor-argument-list__entry">
  2440. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  2441. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2442. </dt>
  2443. <dd class="phpdocumentor-argument-list__definition">
  2444. </dd>
  2445. </dl>
  2446. </article>
  2447. <article
  2448. class="phpdocumentor-element
  2449. -method
  2450. -protected
  2451. "
  2452. >
  2453. <h4 class="phpdocumentor-element__name" id="method_set_version">
  2454. set_version()
  2455. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  2456. </h4>
  2457. <aside class="phpdocumentor-element-found-in">
  2458. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2459. :
  2460. <span class="phpdocumentor-element-found-in__line">519</span>
  2461. </aside>
  2462. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  2463. <code class="phpdocumentor-code phpdocumentor-signature ">
  2464. <span class="phpdocumentor-signature__visibility">protected</span>
  2465. <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>
  2466. <div class="phpdocumentor-label-line">
  2467. </div>
  2468. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2469. <dl class="phpdocumentor-argument-list">
  2470. <dt class="phpdocumentor-argument-list__entry">
  2471. <span class="phpdocumentor-signature__argument__name">$version</span>
  2472. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2473. </dt>
  2474. <dd class="phpdocumentor-argument-list__definition">
  2475. </dd>
  2476. </dl>
  2477. </article>
  2478. <article
  2479. class="phpdocumentor-element
  2480. -method
  2481. -protected
  2482. "
  2483. >
  2484. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  2485. set_versionMax()
  2486. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2487. </h4>
  2488. <aside class="phpdocumentor-element-found-in">
  2489. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2490. :
  2491. <span class="phpdocumentor-element-found-in__line">512</span>
  2492. </aside>
  2493. <p class="phpdocumentor-summary">sets the maximum version number</p>
  2494. <code class="phpdocumentor-code phpdocumentor-signature ">
  2495. <span class="phpdocumentor-signature__visibility">protected</span>
  2496. <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>
  2497. <div class="phpdocumentor-label-line">
  2498. </div>
  2499. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2500. <dl class="phpdocumentor-argument-list">
  2501. <dt class="phpdocumentor-argument-list__entry">
  2502. <span class="phpdocumentor-signature__argument__name">$version</span>
  2503. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2504. </dt>
  2505. <dd class="phpdocumentor-argument-list__definition">
  2506. </dd>
  2507. </dl>
  2508. </article>
  2509. <article
  2510. class="phpdocumentor-element
  2511. -method
  2512. -protected
  2513. "
  2514. >
  2515. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  2516. set_versionMin()
  2517. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2518. </h4>
  2519. <aside class="phpdocumentor-element-found-in">
  2520. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2521. :
  2522. <span class="phpdocumentor-element-found-in__line">505</span>
  2523. </aside>
  2524. <p class="phpdocumentor-summary">sets the minimum version number</p>
  2525. <code class="phpdocumentor-code phpdocumentor-signature ">
  2526. <span class="phpdocumentor-signature__visibility">protected</span>
  2527. <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>
  2528. <div class="phpdocumentor-label-line">
  2529. </div>
  2530. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2531. <dl class="phpdocumentor-argument-list">
  2532. <dt class="phpdocumentor-argument-list__entry">
  2533. <span class="phpdocumentor-signature__argument__name">$version</span>
  2534. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2535. </dt>
  2536. <dd class="phpdocumentor-argument-list__definition">
  2537. </dd>
  2538. </dl>
  2539. </article>
  2540. <article
  2541. class="phpdocumentor-element
  2542. -method
  2543. -protected
  2544. "
  2545. >
  2546. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  2547. setMinMaxVersion()
  2548. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  2549. </h4>
  2550. <aside class="phpdocumentor-element-found-in">
  2551. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2552. :
  2553. <span class="phpdocumentor-element-found-in__line">494</span>
  2554. </aside>
  2555. <p class="phpdocumentor-summary">clamp min/max version number</p>
  2556. <code class="phpdocumentor-code phpdocumentor-signature ">
  2557. <span class="phpdocumentor-signature__visibility">protected</span>
  2558. <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>
  2559. <div class="phpdocumentor-label-line">
  2560. </div>
  2561. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2562. <dl class="phpdocumentor-argument-list">
  2563. <dt class="phpdocumentor-argument-list__entry">
  2564. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  2565. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2566. </dt>
  2567. <dd class="phpdocumentor-argument-list__definition">
  2568. </dd>
  2569. <dt class="phpdocumentor-argument-list__entry">
  2570. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  2571. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2572. </dt>
  2573. <dd class="phpdocumentor-argument-list__definition">
  2574. </dd>
  2575. </dl>
  2576. </article>
  2577. </section>
  2578. <div class="phpdocumentor-modal" id="source-view">
  2579. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  2580. <div class="phpdocumentor-modal-container">
  2581. <div class="phpdocumentor-modal-content">
  2582. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QROptions.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  2583. </div>
  2584. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  2585. </div>
  2586. </div>
  2587. <script type="text/javascript">
  2588. (function () {
  2589. function loadExternalCodeSnippet(el, url, line) {
  2590. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2591. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  2592. const language = 'php';
  2593. const code = document.createElement('code');
  2594. code.className = 'language-' + language;
  2595. pre.textContent = '';
  2596. pre.setAttribute('data-line', line)
  2597. code.textContent = 'Loading…';
  2598. pre.appendChild(code);
  2599. var xhr = new XMLHttpRequest();
  2600. xhr.open('GET', src, true);
  2601. xhr.onreadystatechange = function () {
  2602. if (xhr.readyState !== 4) {
  2603. return;
  2604. }
  2605. if (xhr.status < 400 && xhr.responseText) {
  2606. code.textContent = xhr.responseText;
  2607. Prism.highlightElement(code);
  2608. d=document.getElementsByClassName("line-numbers");
  2609. d[0].scrollTop = d[0].children[1].offsetTop;
  2610. return;
  2611. }
  2612. if (xhr.status === 404) {
  2613. code.textContent = '✖ Error: File could not be found';
  2614. return;
  2615. }
  2616. if (xhr.status >= 400) {
  2617. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2618. return;
  2619. }
  2620. code.textContent = '✖ Error: An unknown error occurred';
  2621. };
  2622. xhr.send(null);
  2623. });
  2624. }
  2625. const modalButtons = document.querySelectorAll("[data-modal]");
  2626. const openedAsLocalFile = window.location.protocol === 'file:';
  2627. if (modalButtons.length > 0 && openedAsLocalFile) {
  2628. console.warn(
  2629. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  2630. 'browsers block XHR requests when a page is opened this way'
  2631. );
  2632. }
  2633. modalButtons.forEach(function (trigger) {
  2634. if (openedAsLocalFile) {
  2635. trigger.setAttribute("hidden", "hidden");
  2636. }
  2637. trigger.addEventListener("click", function (event) {
  2638. event.preventDefault();
  2639. const modal = document.getElementById(trigger.dataset.modal);
  2640. if (!modal) {
  2641. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  2642. return;
  2643. }
  2644. modal.classList.add("phpdocumentor-modal__open");
  2645. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  2646. const exits = modal.querySelectorAll("[data-exit-button]");
  2647. exits.forEach(function (exit) {
  2648. exit.addEventListener("click", function (event) {
  2649. event.preventDefault();
  2650. modal.classList.remove("phpdocumentor-modal__open");
  2651. });
  2652. });
  2653. });
  2654. });
  2655. })();
  2656. </script>
  2657. </article>
  2658. </section>
  2659. <section class="phpdocumentor-on-this-page__sidebar">
  2660. <section class="phpdocumentor-on-this-page__content">
  2661. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  2662. <ul class="phpdocumentor-list -clean">
  2663. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  2664. <li>
  2665. <ul class="phpdocumentor-list -clean">
  2666. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-properties">Properties</a></li>
  2667. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-methods">Methods</a></li>
  2668. </ul>
  2669. </li>
  2670. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  2671. <li>
  2672. <ul class="phpdocumentor-list -clean">
  2673. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a></li>
  2674. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a></li>
  2675. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a></li>
  2676. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a></li>
  2677. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a></li>
  2678. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a></li>
  2679. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a></li>
  2680. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a></li>
  2681. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a></li>
  2682. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a></li>
  2683. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a></li>
  2684. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a></li>
  2685. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a></li>
  2686. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale">$gdImageUseUpscale</a></li>
  2687. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a></li>
  2688. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a></li>
  2689. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a></li>
  2690. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags">$jsonFlags</a></li>
  2691. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a></li>
  2692. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a></li>
  2693. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a></li>
  2694. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a></li>
  2695. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a></li>
  2696. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a></li>
  2697. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a></li>
  2698. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a></li>
  2699. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a></li>
  2700. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a></li>
  2701. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a></li>
  2702. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
  2703. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
  2704. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a></li>
  2705. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
  2706. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a></li>
  2707. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a></li>
  2708. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a></li>
  2709. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a></li>
  2710. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a></li>
  2711. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes">$svgUseFillAttributes</a></li>
  2712. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a></li>
  2713. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a></li>
  2714. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a></li>
  2715. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a></li>
  2716. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a></li>
  2717. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet">$xmlStylesheet</a></li>
  2718. </ul>
  2719. </li>
  2720. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  2721. <li>
  2722. <ul class="phpdocumentor-list -clean">
  2723. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a></li>
  2724. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a></li>
  2725. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel">set_eccLevel()</a></li>
  2726. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a></li>
  2727. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a></li>
  2728. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a></li>
  2729. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a></li>
  2730. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a></li>
  2731. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a></li>
  2732. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a></li>
  2733. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a></li>
  2734. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a></li>
  2735. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a></li>
  2736. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a></li>
  2737. </ul>
  2738. </li>
  2739. </ul>
  2740. </section>
  2741. </section>
  2742. </div>
  2743. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2744. <section class="phpdocumentor-search-results__dialog">
  2745. <header class="phpdocumentor-search-results__header">
  2746. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2747. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2748. </header>
  2749. <section class="phpdocumentor-search-results__body">
  2750. <ul class="phpdocumentor-search-results__entries"></ul>
  2751. </section>
  2752. </section>
  2753. </section>
  2754. </div>
  2755. <a href="classes/chillerlan-QRCode-QROptions.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2756. </main>
  2757. <script>
  2758. cssVars({});
  2759. </script>
  2760. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2761. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2762. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2763. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2764. </body>
  2765. </html>