chillerlan-QRCode-QROptions.html 172 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775
  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>
  618. <code class="prettyprint">QRImagick</code>: defaults to <code class="prettyprint">&quot;white&quot;</code>
  619. </li>
  620. <li>
  621. <code class="prettyprint">QRGdImage</code>: defaults to <code class="prettyprint">[255, 255, 255]</code>
  622. </li>
  623. <li>
  624. <code class="prettyprint">QRFpdf</code>: defaults to blank internally (white page)</li>
  625. </ul>
  626. </section>
  627. </article>
  628. <article
  629. class="
  630. phpdocumentor-element
  631. -property
  632. -protected
  633. "
  634. >
  635. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  636. $cachefile
  637. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  638. <span class="phpdocumentor-element__modifiers">
  639. </span>
  640. </h4>
  641. <aside class="phpdocumentor-element-found-in">
  642. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  643. :
  644. <span class="phpdocumentor-element-found-in__line">170</span>
  645. </aside>
  646. <p class="phpdocumentor-summary">Optional cache file path `/path/to/cache.file`</p>
  647. <code class="phpdocumentor-code phpdocumentor-signature ">
  648. <span class="phpdocumentor-signature__visibility">protected</span>
  649. <span class="phpdocumentor-signature__type">string|null</span>
  650. <span class="phpdocumentor-signature__name">$cachefile</span>
  651. = <span class="phpdocumentor-signature__default-value">null</span></code>
  652. <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>
  653. takes precedence over the <code class="prettyprint">QROptions::$cachefile</code> value. (default: <code class="prettyprint">null</code>)</p>
  654. </section>
  655. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  656. Tags
  657. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  658. </h5>
  659. <dl class="phpdocumentor-tag-list">
  660. <dt class="phpdocumentor-tag-list__entry">
  661. <span class="phpdocumentor-tag__name">see</span>
  662. </dt>
  663. <dd class="phpdocumentor-tag-list__definition">
  664. <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>
  665. </dd>
  666. <dt class="phpdocumentor-tag-list__entry">
  667. <span class="phpdocumentor-tag__name">see</span>
  668. </dt>
  669. <dd class="phpdocumentor-tag-list__definition">
  670. <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>
  671. </dd>
  672. </dl>
  673. </article>
  674. <article
  675. class="
  676. phpdocumentor-element
  677. -property
  678. -protected
  679. "
  680. >
  681. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  682. $circleRadius
  683. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  684. <span class="phpdocumentor-element__modifiers">
  685. </span>
  686. </h4>
  687. <aside class="phpdocumentor-element-found-in">
  688. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  689. :
  690. <span class="phpdocumentor-element-found-in__line">239</span>
  691. </aside>
  692. <p class="phpdocumentor-summary">Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`</p>
  693. <code class="phpdocumentor-code phpdocumentor-signature ">
  694. <span class="phpdocumentor-signature__visibility">protected</span>
  695. <span class="phpdocumentor-signature__type">float</span>
  696. <span class="phpdocumentor-signature__name">$circleRadius</span>
  697. = <span class="phpdocumentor-signature__default-value">0.45</span></code>
  698. <section class="phpdocumentor-description"><p>(default: 0.45)</p>
  699. </section>
  700. </article>
  701. <article
  702. class="
  703. phpdocumentor-element
  704. -property
  705. -protected
  706. "
  707. >
  708. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  709. $connectPaths
  710. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  711. <span class="phpdocumentor-element__modifiers">
  712. </span>
  713. </h4>
  714. <aside class="phpdocumentor-element-found-in">
  715. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  716. :
  717. <span class="phpdocumentor-element-found-in__line">264</span>
  718. </aside>
  719. <p class="phpdocumentor-summary">Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
  720. <code class="phpdocumentor-code phpdocumentor-signature ">
  721. <span class="phpdocumentor-signature__visibility">protected</span>
  722. <span class="phpdocumentor-signature__type">bool</span>
  723. <span class="phpdocumentor-signature__name">$connectPaths</span>
  724. = <span class="phpdocumentor-signature__default-value">false</span></code>
  725. <section class="phpdocumentor-description"><p>This option is exclusive to output classes that use the module collector <code class="prettyprint">QROutputAbstract::collectModules()</code>,
  726. 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>
  727. <p>Module types that should not be added to the connected path can be excluded via <code class="prettyprint">QROptions::$excludeFromConnect</code>.</p>
  728. <p>Currentty used in <code class="prettyprint">QREps</code> and <code class="prettyprint">QRMarkupSVG</code>.</p>
  729. </section>
  730. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  731. Tags
  732. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  733. </h5>
  734. <dl class="phpdocumentor-tag-list">
  735. <dt class="phpdocumentor-tag-list__entry">
  736. <span class="phpdocumentor-tag__name">see</span>
  737. </dt>
  738. <dd class="phpdocumentor-tag-list__definition">
  739. <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>
  740. </dd>
  741. <dt class="phpdocumentor-tag-list__entry">
  742. <span class="phpdocumentor-tag__name">see</span>
  743. </dt>
  744. <dd class="phpdocumentor-tag-list__definition">
  745. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect"><abbr title="\chillerlan\QRCode\QROptionsTrait::$excludeFromConnect">QROptionsTrait::$excludeFromConnect</abbr></a></span>
  746. </dd>
  747. <dt class="phpdocumentor-tag-list__entry">
  748. <span class="phpdocumentor-tag__name">see</span>
  749. </dt>
  750. <dd class="phpdocumentor-tag-list__definition">
  751. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</a></span>
  752. </dd>
  753. </dl>
  754. </article>
  755. <article
  756. class="
  757. phpdocumentor-element
  758. -property
  759. -protected
  760. "
  761. >
  762. <h4 class="phpdocumentor-element__name" id="property_cssClass">
  763. $cssClass
  764. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
  765. <span class="phpdocumentor-element__modifiers">
  766. </span>
  767. </h4>
  768. <aside class="phpdocumentor-element-found-in">
  769. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  770. :
  771. <span class="phpdocumentor-element-found-in__line">406</span>
  772. </aside>
  773. <p class="phpdocumentor-summary">A common css class</p>
  774. <code class="phpdocumentor-code phpdocumentor-signature ">
  775. <span class="phpdocumentor-signature__visibility">protected</span>
  776. <span class="phpdocumentor-signature__type">string</span>
  777. <span class="phpdocumentor-signature__name">$cssClass</span>
  778. = <span class="phpdocumentor-signature__default-value">&#039;qrcode&#039;</span></code>
  779. </article>
  780. <article
  781. class="
  782. phpdocumentor-element
  783. -property
  784. -protected
  785. "
  786. >
  787. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  788. $drawCircularModules
  789. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  790. <span class="phpdocumentor-element__modifiers">
  791. </span>
  792. </h4>
  793. <aside class="phpdocumentor-element-found-in">
  794. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  795. :
  796. <span class="phpdocumentor-element-found-in__line">232</span>
  797. </aside>
  798. <p class="phpdocumentor-summary">Specify whether to draw the modules as filled circles</p>
  799. <code class="phpdocumentor-code phpdocumentor-signature ">
  800. <span class="phpdocumentor-signature__visibility">protected</span>
  801. <span class="phpdocumentor-signature__type">bool</span>
  802. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  803. = <span class="phpdocumentor-signature__default-value">false</span></code>
  804. <section class="phpdocumentor-description"><p>a note for <code class="prettyprint">GdImage</code> output:</p>
  805. <p>if <code class="prettyprint">QROptions::$scale</code> is less than 20, the image will be upscaled internally, then the modules will be drawn
  806. using <code class="prettyprint">imagefilledellipse()</code> and then scaled back to the expected size</p>
  807. <p>No effect in: <code class="prettyprint">QREps</code>, <code class="prettyprint">QRFpdf</code>, <code class="prettyprint">QRMarkupHTML</code></p>
  808. </section>
  809. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  810. Tags
  811. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  812. </h5>
  813. <dl class="phpdocumentor-tag-list">
  814. <dt class="phpdocumentor-tag-list__entry">
  815. <span class="phpdocumentor-tag__name">see</span>
  816. </dt>
  817. <dd class="phpdocumentor-tag-list__definition">
  818. <span class="phpdocumentor-tag-link"><abbr title="\imagefilledellipse()">imagefilledellipse()</abbr></span>
  819. </dd>
  820. <dt class="phpdocumentor-tag-list__entry">
  821. <span class="phpdocumentor-tag__name">see</span>
  822. </dt>
  823. <dd class="phpdocumentor-tag-list__definition">
  824. <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>
  825. </dd>
  826. <dt class="phpdocumentor-tag-list__entry">
  827. <span class="phpdocumentor-tag__name">see</span>
  828. </dt>
  829. <dd class="phpdocumentor-tag-list__definition">
  830. <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>
  831. </dd>
  832. </dl>
  833. </article>
  834. <article
  835. class="
  836. phpdocumentor-element
  837. -property
  838. -protected
  839. "
  840. >
  841. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  842. $drawLightModules
  843. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  844. <span class="phpdocumentor-element__modifiers">
  845. </span>
  846. </h4>
  847. <aside class="phpdocumentor-element-found-in">
  848. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  849. :
  850. <span class="phpdocumentor-element-found-in__line">216</span>
  851. </aside>
  852. <p class="phpdocumentor-summary">Whether to draw the light (false) modules</p>
  853. <code class="phpdocumentor-code phpdocumentor-signature ">
  854. <span class="phpdocumentor-signature__visibility">protected</span>
  855. <span class="phpdocumentor-signature__type">bool</span>
  856. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  857. = <span class="phpdocumentor-signature__default-value">true</span></code>
  858. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
  859. </section>
  860. </article>
  861. <article
  862. class="
  863. phpdocumentor-element
  864. -property
  865. -protected
  866. "
  867. >
  868. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  869. $eccLevel
  870. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  871. <span class="phpdocumentor-element__modifiers">
  872. </span>
  873. </h4>
  874. <aside class="phpdocumentor-element-found-in">
  875. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  876. :
  877. <span class="phpdocumentor-element-found-in__line">112</span>
  878. </aside>
  879. <p class="phpdocumentor-summary">Error correct level</p>
  880. <code class="phpdocumentor-code phpdocumentor-signature ">
  881. <span class="phpdocumentor-signature__visibility">protected</span>
  882. <span class="phpdocumentor-signature__type">int</span>
  883. <span class="phpdocumentor-signature__name">$eccLevel</span>
  884. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
  885. <section class="phpdocumentor-description"><p>the constant <code class="prettyprint">EccLevel::X</code> where <code class="prettyprint">X</code> is:</p>
  886. <ul>
  887. <li>
  888. <code class="prettyprint">L</code> =&gt; 7% (default)</li>
  889. <li>
  890. <code class="prettyprint">M</code> =&gt; 15%</li>
  891. <li>
  892. <code class="prettyprint">Q</code> =&gt; 25%</li>
  893. <li>
  894. <code class="prettyprint">H</code> =&gt; 30%</li>
  895. </ul>
  896. <p>alternatively you can just pass the letters L/M/Q/H (case-insensitive) to the magic setter</p>
  897. </section>
  898. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  899. Tags
  900. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  901. </h5>
  902. <dl class="phpdocumentor-tag-list">
  903. <dt class="phpdocumentor-tag-list__entry">
  904. <span class="phpdocumentor-tag__name">see</span>
  905. </dt>
  906. <dd class="phpdocumentor-tag-list__definition">
  907. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  908. </dd>
  909. <dt class="phpdocumentor-tag-list__entry">
  910. <span class="phpdocumentor-tag__name">see</span>
  911. </dt>
  912. <dd class="phpdocumentor-tag-list__definition">
  913. <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>
  914. </dd>
  915. </dl>
  916. </article>
  917. <article
  918. class="
  919. phpdocumentor-element
  920. -property
  921. -protected
  922. "
  923. >
  924. <h4 class="phpdocumentor-element__name" id="property_eol">
  925. $eol
  926. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  927. <span class="phpdocumentor-element__modifiers">
  928. </span>
  929. </h4>
  930. <aside class="phpdocumentor-element-found-in">
  931. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  932. :
  933. <span class="phpdocumentor-element-found-in__line">186</span>
  934. </aside>
  935. <p class="phpdocumentor-summary">Newline string</p>
  936. <code class="phpdocumentor-code phpdocumentor-signature ">
  937. <span class="phpdocumentor-signature__visibility">protected</span>
  938. <span class="phpdocumentor-signature__type">string</span>
  939. <span class="phpdocumentor-signature__name">$eol</span>
  940. = <span class="phpdocumentor-signature__default-value">\PHP_EOL</span></code>
  941. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">PHP_EOL</code>)</p>
  942. </section>
  943. </article>
  944. <article
  945. class="
  946. phpdocumentor-element
  947. -property
  948. -protected
  949. "
  950. >
  951. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  952. $excludeFromConnect
  953. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  954. <span class="phpdocumentor-element__modifiers">
  955. </span>
  956. </h4>
  957. <aside class="phpdocumentor-element-found-in">
  958. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  959. :
  960. <span class="phpdocumentor-element-found-in__line">273</span>
  961. </aside>
  962. <p class="phpdocumentor-summary">Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`</p>
  963. <code class="phpdocumentor-code phpdocumentor-signature ">
  964. <span class="phpdocumentor-signature__visibility">protected</span>
  965. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  966. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  967. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  968. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  969. Tags
  970. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  971. </h5>
  972. <dl class="phpdocumentor-tag-list">
  973. <dt class="phpdocumentor-tag-list__entry">
  974. <span class="phpdocumentor-tag__name">see</span>
  975. </dt>
  976. <dd class="phpdocumentor-tag-list__definition">
  977. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths"><abbr title="\chillerlan\QRCode\QROptionsTrait::$connectPaths">QROptionsTrait::$connectPaths</abbr></a></span>
  978. </dd>
  979. </dl>
  980. </article>
  981. <article
  982. class="
  983. phpdocumentor-element
  984. -property
  985. -protected
  986. "
  987. >
  988. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  989. $fpdfMeasureUnit
  990. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  991. <span class="phpdocumentor-element__modifiers">
  992. </span>
  993. </h4>
  994. <aside class="phpdocumentor-element-found-in">
  995. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  996. :
  997. <span class="phpdocumentor-element-found-in__line">476</span>
  998. </aside>
  999. <p class="phpdocumentor-summary">Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)</p>
  1000. <code class="phpdocumentor-code phpdocumentor-signature ">
  1001. <span class="phpdocumentor-signature__visibility">protected</span>
  1002. <span class="phpdocumentor-signature__type">string</span>
  1003. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  1004. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  1005. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1006. Tags
  1007. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1008. </h5>
  1009. <dl class="phpdocumentor-tag-list">
  1010. <dt class="phpdocumentor-tag-list__entry">
  1011. <span class="phpdocumentor-tag__name">see</span>
  1012. </dt>
  1013. <dd class="phpdocumentor-tag-list__definition">
  1014. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\FPDF::__construct()">FPDF::__construct()</abbr></span>
  1015. </dd>
  1016. </dl>
  1017. </article>
  1018. <article
  1019. class="
  1020. phpdocumentor-element
  1021. -property
  1022. -protected
  1023. "
  1024. >
  1025. <h4 class="phpdocumentor-element__name" id="property_gdImageUseUpscale">
  1026. $gdImageUseUpscale
  1027. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale" class="headerlink"><i class="fas fa-link"></i></a>
  1028. <span class="phpdocumentor-element__modifiers">
  1029. </span>
  1030. </h4>
  1031. <aside class="phpdocumentor-element-found-in">
  1032. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1033. :
  1034. <span class="phpdocumentor-element-found-in__line">383</span>
  1035. </aside>
  1036. <p class="phpdocumentor-summary">Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
  1037. `QROptions::$scale` is less than 20</p>
  1038. <code class="phpdocumentor-code phpdocumentor-signature ">
  1039. <span class="phpdocumentor-signature__visibility">protected</span>
  1040. <span class="phpdocumentor-signature__type">bool</span>
  1041. <span class="phpdocumentor-signature__name">$gdImageUseUpscale</span>
  1042. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1043. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1044. Tags
  1045. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1046. </h5>
  1047. <dl class="phpdocumentor-tag-list">
  1048. <dt class="phpdocumentor-tag-list__entry">
  1049. <span class="phpdocumentor-tag__name">see</span>
  1050. </dt>
  1051. <dd class="phpdocumentor-tag-list__definition">
  1052. <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>
  1053. </dd>
  1054. <dt class="phpdocumentor-tag-list__entry">
  1055. <span class="phpdocumentor-tag__name">see</span>
  1056. </dt>
  1057. <dd class="phpdocumentor-tag-list__definition">
  1058. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
  1059. </dd>
  1060. </dl>
  1061. </article>
  1062. <article
  1063. class="
  1064. phpdocumentor-element
  1065. -property
  1066. -protected
  1067. "
  1068. >
  1069. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  1070. $imageTransparent
  1071. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  1072. <span class="phpdocumentor-element__modifiers">
  1073. </span>
  1074. </h4>
  1075. <aside class="phpdocumentor-element-found-in">
  1076. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1077. :
  1078. <span class="phpdocumentor-element-found-in__line">337</span>
  1079. </aside>
  1080. <p class="phpdocumentor-summary">Toggle transparency</p>
  1081. <code class="phpdocumentor-code phpdocumentor-signature ">
  1082. <span class="phpdocumentor-signature__visibility">protected</span>
  1083. <span class="phpdocumentor-signature__type">bool</span>
  1084. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  1085. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1086. <section class="phpdocumentor-description"><ul>
  1087. <li>
  1088. <code class="prettyprint">QRGdImage</code> and <code class="prettyprint">QRImagick</code>: the given <code class="prettyprint">QROptions::$transparencyColor</code> is set as transparent</li>
  1089. </ul>
  1090. </section>
  1091. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1092. Tags
  1093. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1094. </h5>
  1095. <dl class="phpdocumentor-tag-list">
  1096. <dt class="phpdocumentor-tag-list__entry">
  1097. <span class="phpdocumentor-tag__name">see</span>
  1098. </dt>
  1099. <dd class="phpdocumentor-tag-list__definition">
  1100. <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>
  1101. </dd>
  1102. </dl>
  1103. </article>
  1104. <article
  1105. class="
  1106. phpdocumentor-element
  1107. -property
  1108. -protected
  1109. "
  1110. >
  1111. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  1112. $imagickFormat
  1113. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  1114. <span class="phpdocumentor-element__modifiers">
  1115. </span>
  1116. </h4>
  1117. <aside class="phpdocumentor-element-found-in">
  1118. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1119. :
  1120. <span class="phpdocumentor-element-found-in__line">396</span>
  1121. </aside>
  1122. <p class="phpdocumentor-summary">Imagick output format</p>
  1123. <code class="phpdocumentor-code phpdocumentor-signature ">
  1124. <span class="phpdocumentor-signature__visibility">protected</span>
  1125. <span class="phpdocumentor-signature__type">string</span>
  1126. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  1127. = <span class="phpdocumentor-signature__default-value">&#039;png32&#039;</span></code>
  1128. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1129. Tags
  1130. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1131. </h5>
  1132. <dl class="phpdocumentor-tag-list">
  1133. <dt class="phpdocumentor-tag-list__entry">
  1134. <span class="phpdocumentor-tag__name">see</span>
  1135. </dt>
  1136. <dd class="phpdocumentor-tag-list__definition">
  1137. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
  1138. </dd>
  1139. <dt class="phpdocumentor-tag-list__entry">
  1140. <span class="phpdocumentor-tag__name">see</span>
  1141. </dt>
  1142. <dd class="phpdocumentor-tag-list__definition">
  1143. <span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</a></span>
  1144. </dd>
  1145. </dl>
  1146. </article>
  1147. <article
  1148. class="
  1149. phpdocumentor-element
  1150. -property
  1151. -protected
  1152. "
  1153. >
  1154. <h4 class="phpdocumentor-element__name" id="property_invertMatrix">
  1155. $invertMatrix
  1156. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1157. <span class="phpdocumentor-element__modifiers">
  1158. </span>
  1159. </h4>
  1160. <aside class="phpdocumentor-element-found-in">
  1161. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1162. :
  1163. <span class="phpdocumentor-element-found-in__line">209</span>
  1164. </aside>
  1165. <p class="phpdocumentor-summary">Whether to invert the matrix (reflectance reversal)</p>
  1166. <code class="phpdocumentor-code phpdocumentor-signature ">
  1167. <span class="phpdocumentor-signature__visibility">protected</span>
  1168. <span class="phpdocumentor-signature__type">bool</span>
  1169. <span class="phpdocumentor-signature__name">$invertMatrix</span>
  1170. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1171. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">false</code>)</p>
  1172. </section>
  1173. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1174. Tags
  1175. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1176. </h5>
  1177. <dl class="phpdocumentor-tag-list">
  1178. <dt class="phpdocumentor-tag-list__entry">
  1179. <span class="phpdocumentor-tag__name">see</span>
  1180. </dt>
  1181. <dd class="phpdocumentor-tag-list__definition">
  1182. <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>
  1183. </dd>
  1184. </dl>
  1185. </article>
  1186. <article
  1187. class="
  1188. phpdocumentor-element
  1189. -property
  1190. -protected
  1191. "
  1192. >
  1193. <h4 class="phpdocumentor-element__name" id="property_jsonFlags">
  1194. $jsonFlags
  1195. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags" class="headerlink"><i class="fas fa-link"></i></a>
  1196. <span class="phpdocumentor-element__modifiers">
  1197. </span>
  1198. </h4>
  1199. <aside class="phpdocumentor-element-found-in">
  1200. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1201. :
  1202. <span class="phpdocumentor-element-found-in__line">464</span>
  1203. </aside>
  1204. <p class="phpdocumentor-summary">Sets the flags to use for the `json_encode()` call</p>
  1205. <code class="phpdocumentor-code phpdocumentor-signature ">
  1206. <span class="phpdocumentor-signature__visibility">protected</span>
  1207. <span class="phpdocumentor-signature__type">int</span>
  1208. <span class="phpdocumentor-signature__name">$jsonFlags</span>
  1209. = <span class="phpdocumentor-signature__default-value">\JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES</span></code>
  1210. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1211. Tags
  1212. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1213. </h5>
  1214. <dl class="phpdocumentor-tag-list">
  1215. <dt class="phpdocumentor-tag-list__entry">
  1216. <span class="phpdocumentor-tag__name">see</span>
  1217. </dt>
  1218. <dd class="phpdocumentor-tag-list__definition">
  1219. <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>
  1220. </dd>
  1221. </dl>
  1222. </article>
  1223. <article
  1224. class="
  1225. phpdocumentor-element
  1226. -property
  1227. -protected
  1228. "
  1229. >
  1230. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  1231. $keepAsSquare
  1232. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  1233. <span class="phpdocumentor-element__modifiers">
  1234. </span>
  1235. </h4>
  1236. <aside class="phpdocumentor-element-found-in">
  1237. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1238. :
  1239. <span class="phpdocumentor-element-found-in__line">248</span>
  1240. </aside>
  1241. <p class="phpdocumentor-summary">Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`</p>
  1242. <code class="phpdocumentor-code phpdocumentor-signature ">
  1243. <span class="phpdocumentor-signature__visibility">protected</span>
  1244. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  1245. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  1246. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1247. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">[]</code>)</p>
  1248. </section>
  1249. </article>
  1250. <article
  1251. class="
  1252. phpdocumentor-element
  1253. -property
  1254. -protected
  1255. "
  1256. >
  1257. <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
  1258. $logoSpaceHeight
  1259. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1260. <span class="phpdocumentor-element__modifiers">
  1261. </span>
  1262. </h4>
  1263. <aside class="phpdocumentor-element-found-in">
  1264. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1265. :
  1266. <span class="phpdocumentor-element-found-in__line">308</span>
  1267. </aside>
  1268. <p class="phpdocumentor-summary">Height of the logo space</p>
  1269. <code class="phpdocumentor-code phpdocumentor-signature ">
  1270. <span class="phpdocumentor-signature__visibility">protected</span>
  1271. <span class="phpdocumentor-signature__type">int|null</span>
  1272. <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
  1273. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1274. <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>
  1275. </section>
  1276. </article>
  1277. <article
  1278. class="
  1279. phpdocumentor-element
  1280. -property
  1281. -protected
  1282. "
  1283. >
  1284. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
  1285. $logoSpaceStartX
  1286. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  1287. <span class="phpdocumentor-element__modifiers">
  1288. </span>
  1289. </h4>
  1290. <aside class="phpdocumentor-element-found-in">
  1291. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1292. :
  1293. <span class="phpdocumentor-element-found-in__line">313</span>
  1294. </aside>
  1295. <p class="phpdocumentor-summary">Optional horizontal start position of the logo space (top left corner)</p>
  1296. <code class="phpdocumentor-code phpdocumentor-signature ">
  1297. <span class="phpdocumentor-signature__visibility">protected</span>
  1298. <span class="phpdocumentor-signature__type">int|null</span>
  1299. <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
  1300. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1301. </article>
  1302. <article
  1303. class="
  1304. phpdocumentor-element
  1305. -property
  1306. -protected
  1307. "
  1308. >
  1309. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
  1310. $logoSpaceStartY
  1311. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  1312. <span class="phpdocumentor-element__modifiers">
  1313. </span>
  1314. </h4>
  1315. <aside class="phpdocumentor-element-found-in">
  1316. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1317. :
  1318. <span class="phpdocumentor-element-found-in__line">318</span>
  1319. </aside>
  1320. <p class="phpdocumentor-summary">Optional vertical start position of the logo space (top left corner)</p>
  1321. <code class="phpdocumentor-code phpdocumentor-signature ">
  1322. <span class="phpdocumentor-signature__visibility">protected</span>
  1323. <span class="phpdocumentor-signature__type">int|null</span>
  1324. <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
  1325. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1326. </article>
  1327. <article
  1328. class="
  1329. phpdocumentor-element
  1330. -property
  1331. -protected
  1332. "
  1333. >
  1334. <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
  1335. $logoSpaceWidth
  1336. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1337. <span class="phpdocumentor-element__modifiers">
  1338. </span>
  1339. </h4>
  1340. <aside class="phpdocumentor-element-found-in">
  1341. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1342. :
  1343. <span class="phpdocumentor-element-found-in__line">301</span>
  1344. </aside>
  1345. <p class="phpdocumentor-summary">Width of the logo space</p>
  1346. <code class="phpdocumentor-code phpdocumentor-signature ">
  1347. <span class="phpdocumentor-signature__visibility">protected</span>
  1348. <span class="phpdocumentor-signature__type">int|null</span>
  1349. <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
  1350. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1351. <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>
  1352. </section>
  1353. </article>
  1354. <article
  1355. class="
  1356. phpdocumentor-element
  1357. -property
  1358. -protected
  1359. "
  1360. >
  1361. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  1362. $maskPattern
  1363. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1364. <span class="phpdocumentor-element__modifiers">
  1365. </span>
  1366. </h4>
  1367. <aside class="phpdocumentor-element-found-in">
  1368. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1369. :
  1370. <span class="phpdocumentor-element-found-in__line">121</span>
  1371. </aside>
  1372. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  1373. <code class="phpdocumentor-code phpdocumentor-signature ">
  1374. <span class="phpdocumentor-signature__visibility">protected</span>
  1375. <span class="phpdocumentor-signature__type">int</span>
  1376. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1377. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
  1378. <section class="phpdocumentor-description"><p><code class="prettyprint">0 ... 7</code> or <code class="prettyprint">MaskPattern::PATTERN_AUTO</code> (default)</p>
  1379. </section>
  1380. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1381. Tags
  1382. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1383. </h5>
  1384. <dl class="phpdocumentor-tag-list">
  1385. <dt class="phpdocumentor-tag-list__entry">
  1386. <span class="phpdocumentor-tag__name">see</span>
  1387. </dt>
  1388. <dd class="phpdocumentor-tag-list__definition">
  1389. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  1390. </dd>
  1391. </dl>
  1392. </article>
  1393. <article
  1394. class="
  1395. phpdocumentor-element
  1396. -property
  1397. -protected
  1398. "
  1399. >
  1400. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  1401. $moduleValues
  1402. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1403. <span class="phpdocumentor-element__modifiers">
  1404. </span>
  1405. </h4>
  1406. <aside class="phpdocumentor-element-found-in">
  1407. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1408. :
  1409. <span class="phpdocumentor-element-found-in__line">286</span>
  1410. </aside>
  1411. <p class="phpdocumentor-summary">Module values map</p>
  1412. <code class="phpdocumentor-code phpdocumentor-signature ">
  1413. <span class="phpdocumentor-signature__visibility">protected</span>
  1414. <span class="phpdocumentor-signature__type">array&lt;int, mixed&gt;</span>
  1415. <span class="phpdocumentor-signature__name">$moduleValues</span>
  1416. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1417. <section class="phpdocumentor-description"><ul>
  1418. <li>
  1419. <code class="prettyprint">QRImagick</code>, <code class="prettyprint">QRMarkupHTML</code>, <code class="prettyprint">QRMarkupSVG</code>: #ABCDEF, cssname, rgb(), rgba()...</li>
  1420. <li>
  1421. <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>
  1422. <li>
  1423. <code class="prettyprint">QREps</code>: <code class="prettyprint">[C, M, Y, K]</code> // 0-255</li>
  1424. </ul>
  1425. </section>
  1426. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1427. Tags
  1428. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1429. </h5>
  1430. <dl class="phpdocumentor-tag-list">
  1431. <dt class="phpdocumentor-tag-list__entry">
  1432. <span class="phpdocumentor-tag__name">see</span>
  1433. </dt>
  1434. <dd class="phpdocumentor-tag-list__definition">
  1435. <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>
  1436. </dd>
  1437. </dl>
  1438. </article>
  1439. <article
  1440. class="
  1441. phpdocumentor-element
  1442. -property
  1443. -protected
  1444. "
  1445. >
  1446. <h4 class="phpdocumentor-element__name" id="property_outputBase64">
  1447. $outputBase64
  1448. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64" class="headerlink"><i class="fas fa-link"></i></a>
  1449. <span class="phpdocumentor-element__modifiers">
  1450. </span>
  1451. </h4>
  1452. <aside class="phpdocumentor-element-found-in">
  1453. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1454. :
  1455. <span class="phpdocumentor-element-found-in__line">179</span>
  1456. </aside>
  1457. <p class="phpdocumentor-summary">Toggle base64 data URI or raw data output (if applicable)</p>
  1458. <code class="phpdocumentor-code phpdocumentor-signature ">
  1459. <span class="phpdocumentor-signature__visibility">protected</span>
  1460. <span class="phpdocumentor-signature__type">bool</span>
  1461. <span class="phpdocumentor-signature__name">$outputBase64</span>
  1462. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1463. <section class="phpdocumentor-description"><p>(default: <code class="prettyprint">true</code>)</p>
  1464. </section>
  1465. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1466. Tags
  1467. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1468. </h5>
  1469. <dl class="phpdocumentor-tag-list">
  1470. <dt class="phpdocumentor-tag-list__entry">
  1471. <span class="phpdocumentor-tag__name">see</span>
  1472. </dt>
  1473. <dd class="phpdocumentor-tag-list__definition">
  1474. <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>
  1475. </dd>
  1476. </dl>
  1477. </article>
  1478. <article
  1479. class="
  1480. phpdocumentor-element
  1481. -property
  1482. -protected
  1483. "
  1484. >
  1485. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  1486. $outputInterface
  1487. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1488. <span class="phpdocumentor-element__modifiers">
  1489. </span>
  1490. </h4>
  1491. <aside class="phpdocumentor-element-found-in">
  1492. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1493. :
  1494. <span class="phpdocumentor-element-found-in__line">145</span>
  1495. </aside>
  1496. <p class="phpdocumentor-summary">The FQCN of the `QROutputInterface` to use</p>
  1497. <code class="phpdocumentor-code phpdocumentor-signature ">
  1498. <span class="phpdocumentor-signature__visibility">protected</span>
  1499. <span class="phpdocumentor-signature__type">string</span>
  1500. <span class="phpdocumentor-signature__name">$outputInterface</span>
  1501. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QRMarkupSVG::class</span></code>
  1502. </article>
  1503. <article
  1504. class="
  1505. phpdocumentor-element
  1506. -property
  1507. -protected
  1508. "
  1509. >
  1510. <h4 class="phpdocumentor-element__name" id="property_quality">
  1511. $quality
  1512. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" class="headerlink"><i class="fas fa-link"></i></a>
  1513. <span class="phpdocumentor-element__modifiers">
  1514. </span>
  1515. </h4>
  1516. <aside class="phpdocumentor-element-found-in">
  1517. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1518. :
  1519. <span class="phpdocumentor-element-found-in__line">369</span>
  1520. </aside>
  1521. <p class="phpdocumentor-summary">Compression quality</p>
  1522. <code class="phpdocumentor-code phpdocumentor-signature ">
  1523. <span class="phpdocumentor-signature__visibility">protected</span>
  1524. <span class="phpdocumentor-signature__type">int</span>
  1525. <span class="phpdocumentor-signature__name">$quality</span>
  1526. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  1527. <section class="phpdocumentor-description"><p>The given value depends on the used output type:</p>
  1528. <ul>
  1529. <li>
  1530. <code class="prettyprint">QRGdImageBMP</code>: <code class="prettyprint">[0...1]</code>
  1531. </li>
  1532. <li>
  1533. <code class="prettyprint">QRGdImageJPEG</code>: <code class="prettyprint">[0...100]</code>
  1534. </li>
  1535. <li>
  1536. <code class="prettyprint">QRGdImageWEBP</code>: <code class="prettyprint">[0...9]</code>
  1537. </li>
  1538. <li>
  1539. <code class="prettyprint">QRGdImagePNG</code>: <code class="prettyprint">[0...100]</code>
  1540. </li>
  1541. <li>
  1542. <code class="prettyprint">QRImagick</code>: <code class="prettyprint">[0...100]</code>
  1543. </li>
  1544. </ul>
  1545. </section>
  1546. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1547. Tags
  1548. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1549. </h5>
  1550. <dl class="phpdocumentor-tag-list">
  1551. <dt class="phpdocumentor-tag-list__entry">
  1552. <span class="phpdocumentor-tag__name">see</span>
  1553. </dt>
  1554. <dd class="phpdocumentor-tag-list__definition">
  1555. <span class="phpdocumentor-tag-link"><abbr title="\imagebmp()">imagebmp()</abbr></span>
  1556. </dd>
  1557. <dt class="phpdocumentor-tag-list__entry">
  1558. <span class="phpdocumentor-tag__name">see</span>
  1559. </dt>
  1560. <dd class="phpdocumentor-tag-list__definition">
  1561. <span class="phpdocumentor-tag-link"><abbr title="\imagejpeg()">imagejpeg()</abbr></span>
  1562. </dd>
  1563. <dt class="phpdocumentor-tag-list__entry">
  1564. <span class="phpdocumentor-tag__name">see</span>
  1565. </dt>
  1566. <dd class="phpdocumentor-tag-list__definition">
  1567. <span class="phpdocumentor-tag-link"><abbr title="\imagepng()">imagepng()</abbr></span>
  1568. </dd>
  1569. <dt class="phpdocumentor-tag-list__entry">
  1570. <span class="phpdocumentor-tag__name">see</span>
  1571. </dt>
  1572. <dd class="phpdocumentor-tag-list__definition">
  1573. <span class="phpdocumentor-tag-link"><abbr title="\imagewebp()">imagewebp()</abbr></span>
  1574. </dd>
  1575. <dt class="phpdocumentor-tag-list__entry">
  1576. <span class="phpdocumentor-tag__name">see</span>
  1577. </dt>
  1578. <dd class="phpdocumentor-tag-list__definition">
  1579. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageCompressionQuality()">Imagick::setImageCompressionQuality()</abbr></span>
  1580. </dd>
  1581. </dl>
  1582. </article>
  1583. <article
  1584. class="
  1585. phpdocumentor-element
  1586. -property
  1587. -protected
  1588. "
  1589. >
  1590. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  1591. $quietzoneSize
  1592. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  1593. <span class="phpdocumentor-element__modifiers">
  1594. </span>
  1595. </h4>
  1596. <aside class="phpdocumentor-element-found-in">
  1597. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1598. :
  1599. <span class="phpdocumentor-element-found-in__line">135</span>
  1600. </aside>
  1601. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  1602. <code class="phpdocumentor-code phpdocumentor-signature ">
  1603. <span class="phpdocumentor-signature__visibility">protected</span>
  1604. <span class="phpdocumentor-signature__type">int</span>
  1605. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  1606. = <span class="phpdocumentor-signature__default-value">4</span></code>
  1607. <section class="phpdocumentor-description"><p>internally clamped to <code class="prettyprint">0 ... $moduleCount / 2</code> (default: 4)</p>
  1608. </section>
  1609. </article>
  1610. <article
  1611. class="
  1612. phpdocumentor-element
  1613. -property
  1614. -protected
  1615. "
  1616. >
  1617. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  1618. $readerGrayscale
  1619. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  1620. <span class="phpdocumentor-element__modifiers">
  1621. </span>
  1622. </h4>
  1623. <aside class="phpdocumentor-element-found-in">
  1624. <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>
  1625. :
  1626. <span class="phpdocumentor-element-found-in__line">34</span>
  1627. </aside>
  1628. <p class="phpdocumentor-summary">Grayscale the image before reading</p>
  1629. <code class="phpdocumentor-code phpdocumentor-signature ">
  1630. <span class="phpdocumentor-signature__visibility">protected</span>
  1631. <span class="phpdocumentor-signature__type">bool</span>
  1632. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  1633. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1634. </article>
  1635. <article
  1636. class="
  1637. phpdocumentor-element
  1638. -property
  1639. -protected
  1640. "
  1641. >
  1642. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  1643. $readerIncreaseContrast
  1644. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  1645. <span class="phpdocumentor-element__modifiers">
  1646. </span>
  1647. </h4>
  1648. <aside class="phpdocumentor-element-found-in">
  1649. <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>
  1650. :
  1651. <span class="phpdocumentor-element-found-in__line">46</span>
  1652. </aside>
  1653. <p class="phpdocumentor-summary">Increase the contrast before reading</p>
  1654. <code class="phpdocumentor-code phpdocumentor-signature ">
  1655. <span class="phpdocumentor-signature__visibility">protected</span>
  1656. <span class="phpdocumentor-signature__type">bool</span>
  1657. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  1658. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1659. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  1660. </section>
  1661. </article>
  1662. <article
  1663. class="
  1664. phpdocumentor-element
  1665. -property
  1666. -protected
  1667. "
  1668. >
  1669. <h4 class="phpdocumentor-element__name" id="property_readerInvertColors">
  1670. $readerInvertColors
  1671. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors" class="headerlink"><i class="fas fa-link"></i></a>
  1672. <span class="phpdocumentor-element__modifiers">
  1673. </span>
  1674. </h4>
  1675. <aside class="phpdocumentor-element-found-in">
  1676. <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>
  1677. :
  1678. <span class="phpdocumentor-element-found-in__line">39</span>
  1679. </aside>
  1680. <p class="phpdocumentor-summary">Invert the colors of the image</p>
  1681. <code class="phpdocumentor-code phpdocumentor-signature ">
  1682. <span class="phpdocumentor-signature__visibility">protected</span>
  1683. <span class="phpdocumentor-signature__type">bool</span>
  1684. <span class="phpdocumentor-signature__name">$readerInvertColors</span>
  1685. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1686. </article>
  1687. <article
  1688. class="
  1689. phpdocumentor-element
  1690. -property
  1691. -protected
  1692. "
  1693. >
  1694. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  1695. $readerUseImagickIfAvailable
  1696. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1697. <span class="phpdocumentor-element__modifiers">
  1698. </span>
  1699. </h4>
  1700. <aside class="phpdocumentor-element-found-in">
  1701. <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>
  1702. :
  1703. <span class="phpdocumentor-element-found-in__line">29</span>
  1704. </aside>
  1705. <p class="phpdocumentor-summary">Use Imagick (if available) when reading QR Codes</p>
  1706. <code class="phpdocumentor-code phpdocumentor-signature ">
  1707. <span class="phpdocumentor-signature__visibility">protected</span>
  1708. <span class="phpdocumentor-signature__type">bool</span>
  1709. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  1710. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1711. </article>
  1712. <article
  1713. class="
  1714. phpdocumentor-element
  1715. -property
  1716. -protected
  1717. "
  1718. >
  1719. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  1720. $returnResource
  1721. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  1722. <span class="phpdocumentor-element__modifiers">
  1723. </span>
  1724. </h4>
  1725. <aside class="phpdocumentor-element-found-in">
  1726. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1727. :
  1728. <span class="phpdocumentor-element-found-in__line">159</span>
  1729. </aside>
  1730. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  1731. <code class="phpdocumentor-code phpdocumentor-signature ">
  1732. <span class="phpdocumentor-signature__visibility">protected</span>
  1733. <span class="phpdocumentor-signature__type">bool</span>
  1734. <span class="phpdocumentor-signature__name">$returnResource</span>
  1735. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1736. <section class="phpdocumentor-description"><ul>
  1737. <li>
  1738. <code class="prettyprint">QRGdImage</code>: <code class="prettyprint">resource</code> (PHP &lt; 8), <code class="prettyprint">GdImage</code>
  1739. </li>
  1740. <li>
  1741. <code class="prettyprint">QRImagick</code>: <code class="prettyprint">Imagick</code>
  1742. </li>
  1743. <li>
  1744. <code class="prettyprint">QRFpdf</code>: <code class="prettyprint">FPDF</code>
  1745. </li>
  1746. </ul>
  1747. <p>This option overrides/ignores other output settings, such as <code class="prettyprint">QROptions::$cachefile</code>
  1748. and <code class="prettyprint">QROptions::$outputBase64</code>. (default: <code class="prettyprint">false</code>)</p>
  1749. </section>
  1750. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1751. Tags
  1752. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1753. </h5>
  1754. <dl class="phpdocumentor-tag-list">
  1755. <dt class="phpdocumentor-tag-list__entry">
  1756. <span class="phpdocumentor-tag__name">see</span>
  1757. </dt>
  1758. <dd class="phpdocumentor-tag-list__definition">
  1759. <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>
  1760. </dd>
  1761. </dl>
  1762. </article>
  1763. <article
  1764. class="
  1765. phpdocumentor-element
  1766. -property
  1767. -protected
  1768. "
  1769. >
  1770. <h4 class="phpdocumentor-element__name" id="property_scale">
  1771. $scale
  1772. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  1773. <span class="phpdocumentor-element__modifiers">
  1774. </span>
  1775. </h4>
  1776. <aside class="phpdocumentor-element-found-in">
  1777. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1778. :
  1779. <span class="phpdocumentor-element-found-in__line">328</span>
  1780. </aside>
  1781. <p class="phpdocumentor-summary">Pixel size of a QR code module</p>
  1782. <code class="phpdocumentor-code phpdocumentor-signature ">
  1783. <span class="phpdocumentor-signature__visibility">protected</span>
  1784. <span class="phpdocumentor-signature__type">int</span>
  1785. <span class="phpdocumentor-signature__name">$scale</span>
  1786. = <span class="phpdocumentor-signature__default-value">5</span></code>
  1787. </article>
  1788. <article
  1789. class="
  1790. phpdocumentor-element
  1791. -property
  1792. -protected
  1793. "
  1794. >
  1795. <h4 class="phpdocumentor-element__name" id="property_svgAddXmlHeader">
  1796. $svgAddXmlHeader
  1797. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" class="headerlink"><i class="fas fa-link"></i></a>
  1798. <span class="phpdocumentor-element__modifiers">
  1799. </span>
  1800. </h4>
  1801. <aside class="phpdocumentor-element-found-in">
  1802. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1803. :
  1804. <span class="phpdocumentor-element-found-in__line">418</span>
  1805. </aside>
  1806. <p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p>
  1807. <code class="phpdocumentor-code phpdocumentor-signature ">
  1808. <span class="phpdocumentor-signature__visibility">protected</span>
  1809. <span class="phpdocumentor-signature__type">bool</span>
  1810. <span class="phpdocumentor-signature__name">$svgAddXmlHeader</span>
  1811. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1812. <section class="phpdocumentor-description"><p><code class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</code></p>
  1813. </section>
  1814. </article>
  1815. <article
  1816. class="
  1817. phpdocumentor-element
  1818. -property
  1819. -protected
  1820. "
  1821. >
  1822. <h4 class="phpdocumentor-element__name" id="property_svgDefs">
  1823. $svgDefs
  1824. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
  1825. <span class="phpdocumentor-element__modifiers">
  1826. </span>
  1827. </h4>
  1828. <aside class="phpdocumentor-element-found-in">
  1829. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1830. :
  1831. <span class="phpdocumentor-element-found-in__line">425</span>
  1832. </aside>
  1833. <p class="phpdocumentor-summary">Anything in the SVG `&lt;defs&gt;` tag</p>
  1834. <code class="phpdocumentor-code phpdocumentor-signature ">
  1835. <span class="phpdocumentor-signature__visibility">protected</span>
  1836. <span class="phpdocumentor-signature__type">string</span>
  1837. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1838. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1839. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1840. Tags
  1841. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1842. </h5>
  1843. <dl class="phpdocumentor-tag-list">
  1844. <dt class="phpdocumentor-tag-list__entry">
  1845. <span class="phpdocumentor-tag__name">see</span>
  1846. </dt>
  1847. <dd class="phpdocumentor-tag-list__definition">
  1848. <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>
  1849. </dd>
  1850. </dl>
  1851. </article>
  1852. <article
  1853. class="
  1854. phpdocumentor-element
  1855. -property
  1856. -protected
  1857. "
  1858. >
  1859. <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
  1860. $svgPreserveAspectRatio
  1861. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
  1862. <span class="phpdocumentor-element__modifiers">
  1863. </span>
  1864. </h4>
  1865. <aside class="phpdocumentor-element-found-in">
  1866. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1867. :
  1868. <span class="phpdocumentor-element-found-in__line">432</span>
  1869. </aside>
  1870. <p class="phpdocumentor-summary">Sets the value for the &quot;preserveAspectRatio&quot; on the `&lt;svg&gt;` element</p>
  1871. <code class="phpdocumentor-code phpdocumentor-signature ">
  1872. <span class="phpdocumentor-signature__visibility">protected</span>
  1873. <span class="phpdocumentor-signature__type">string</span>
  1874. <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
  1875. = <span class="phpdocumentor-signature__default-value">&#039;xMidYMid&#039;</span></code>
  1876. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1877. Tags
  1878. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1879. </h5>
  1880. <dl class="phpdocumentor-tag-list">
  1881. <dt class="phpdocumentor-tag-list__entry">
  1882. <span class="phpdocumentor-tag__name">see</span>
  1883. </dt>
  1884. <dd class="phpdocumentor-tag-list__definition">
  1885. <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>
  1886. </dd>
  1887. </dl>
  1888. </article>
  1889. <article
  1890. class="
  1891. phpdocumentor-element
  1892. -property
  1893. -protected
  1894. "
  1895. >
  1896. <h4 class="phpdocumentor-element__name" id="property_svgUseFillAttributes">
  1897. $svgUseFillAttributes
  1898. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes" class="headerlink"><i class="fas fa-link"></i></a>
  1899. <span class="phpdocumentor-element__modifiers">
  1900. </span>
  1901. </h4>
  1902. <aside class="phpdocumentor-element-found-in">
  1903. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1904. :
  1905. <span class="phpdocumentor-element-found-in__line">442</span>
  1906. </aside>
  1907. <p class="phpdocumentor-summary">Whether to use the SVG `fill` attributes</p>
  1908. <code class="phpdocumentor-code phpdocumentor-signature ">
  1909. <span class="phpdocumentor-signature__visibility">protected</span>
  1910. <span class="phpdocumentor-signature__type">bool</span>
  1911. <span class="phpdocumentor-signature__name">$svgUseFillAttributes</span>
  1912. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1913. <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>.
  1914. 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>
  1915. </section>
  1916. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1917. Tags
  1918. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1919. </h5>
  1920. <dl class="phpdocumentor-tag-list">
  1921. <dt class="phpdocumentor-tag-list__entry">
  1922. <span class="phpdocumentor-tag__name">see</span>
  1923. </dt>
  1924. <dd class="phpdocumentor-tag-list__definition">
  1925. <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>
  1926. </dd>
  1927. </dl>
  1928. </article>
  1929. <article
  1930. class="
  1931. phpdocumentor-element
  1932. -property
  1933. -protected
  1934. "
  1935. >
  1936. <h4 class="phpdocumentor-element__name" id="property_textLineStart">
  1937. $textLineStart
  1938. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" class="headerlink"><i class="fas fa-link"></i></a>
  1939. <span class="phpdocumentor-element__modifiers">
  1940. </span>
  1941. </h4>
  1942. <aside class="phpdocumentor-element-found-in">
  1943. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1944. :
  1945. <span class="phpdocumentor-element-found-in__line">452</span>
  1946. </aside>
  1947. <p class="phpdocumentor-summary">An optional line prefix, e.g. empty space to align the QR Code in a console</p>
  1948. <code class="phpdocumentor-code phpdocumentor-signature ">
  1949. <span class="phpdocumentor-signature__visibility">protected</span>
  1950. <span class="phpdocumentor-signature__type">string</span>
  1951. <span class="phpdocumentor-signature__name">$textLineStart</span>
  1952. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1953. </article>
  1954. <article
  1955. class="
  1956. phpdocumentor-element
  1957. -property
  1958. -protected
  1959. "
  1960. >
  1961. <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
  1962. $transparencyColor
  1963. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1964. <span class="phpdocumentor-element__modifiers">
  1965. </span>
  1966. </h4>
  1967. <aside class="phpdocumentor-element-found-in">
  1968. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1969. :
  1970. <span class="phpdocumentor-element-found-in__line">350</span>
  1971. </aside>
  1972. <p class="phpdocumentor-summary">Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.</p>
  1973. <code class="phpdocumentor-code phpdocumentor-signature ">
  1974. <span class="phpdocumentor-signature__visibility">protected</span>
  1975. <span class="phpdocumentor-signature__type">mixed</span>
  1976. <span class="phpdocumentor-signature__name">$transparencyColor</span>
  1977. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1978. <section class="phpdocumentor-description"><p>Defaults to <code class="prettyprint">QROptions::$bgColor</code>.</p>
  1979. <ul>
  1980. <li>
  1981. <code class="prettyprint">QRGdImage</code>: <code class="prettyprint">[R, G, B]</code>, this color is set as transparent in <code class="prettyprint">imagecolortransparent()</code>
  1982. </li>
  1983. <li>
  1984. <code class="prettyprint">QRImagick</code>: <code class="prettyprint">&quot;color_str&quot;</code>, this color is set in <code class="prettyprint">Imagick::transparentPaintImage()</code>
  1985. </li>
  1986. </ul>
  1987. </section>
  1988. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1989. Tags
  1990. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1991. </h5>
  1992. <dl class="phpdocumentor-tag-list">
  1993. <dt class="phpdocumentor-tag-list__entry">
  1994. <span class="phpdocumentor-tag__name">see</span>
  1995. </dt>
  1996. <dd class="phpdocumentor-tag-list__definition">
  1997. <span class="phpdocumentor-tag-link"><abbr title="\imagecolortransparent()">imagecolortransparent()</abbr></span>
  1998. </dd>
  1999. <dt class="phpdocumentor-tag-list__entry">
  2000. <span class="phpdocumentor-tag__name">see</span>
  2001. </dt>
  2002. <dd class="phpdocumentor-tag-list__definition">
  2003. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr></span>
  2004. </dd>
  2005. </dl>
  2006. </article>
  2007. <article
  2008. class="
  2009. phpdocumentor-element
  2010. -property
  2011. -protected
  2012. "
  2013. >
  2014. <h4 class="phpdocumentor-element__name" id="property_version">
  2015. $version
  2016. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  2017. <span class="phpdocumentor-element__modifiers">
  2018. </span>
  2019. </h4>
  2020. <aside class="phpdocumentor-element-found-in">
  2021. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2022. :
  2023. <span class="phpdocumentor-element-found-in__line">81</span>
  2024. </aside>
  2025. <p class="phpdocumentor-summary">QR Code version number</p>
  2026. <code class="phpdocumentor-code phpdocumentor-signature ">
  2027. <span class="phpdocumentor-signature__visibility">protected</span>
  2028. <span class="phpdocumentor-signature__type">int</span>
  2029. <span class="phpdocumentor-signature__name">$version</span>
  2030. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
  2031. <section class="phpdocumentor-description"><p><code class="prettyprint">1 ... 40</code> or <code class="prettyprint">Version::AUTO</code> (default)</p>
  2032. </section>
  2033. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2034. Tags
  2035. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2036. </h5>
  2037. <dl class="phpdocumentor-tag-list">
  2038. <dt class="phpdocumentor-tag-list__entry">
  2039. <span class="phpdocumentor-tag__name">see</span>
  2040. </dt>
  2041. <dd class="phpdocumentor-tag-list__definition">
  2042. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  2043. </dd>
  2044. </dl>
  2045. </article>
  2046. <article
  2047. class="
  2048. phpdocumentor-element
  2049. -property
  2050. -protected
  2051. "
  2052. >
  2053. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  2054. $versionMax
  2055. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2056. <span class="phpdocumentor-element__modifiers">
  2057. </span>
  2058. </h4>
  2059. <aside class="phpdocumentor-element-found-in">
  2060. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2061. :
  2062. <span class="phpdocumentor-element-found-in__line">95</span>
  2063. </aside>
  2064. <p class="phpdocumentor-summary">Maximum QR version</p>
  2065. <code class="phpdocumentor-code phpdocumentor-signature ">
  2066. <span class="phpdocumentor-signature__visibility">protected</span>
  2067. <span class="phpdocumentor-signature__type">int</span>
  2068. <span class="phpdocumentor-signature__name">$versionMax</span>
  2069. = <span class="phpdocumentor-signature__default-value">40</span></code>
  2070. <section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 40)</p>
  2071. </section>
  2072. </article>
  2073. <article
  2074. class="
  2075. phpdocumentor-element
  2076. -property
  2077. -protected
  2078. "
  2079. >
  2080. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  2081. $versionMin
  2082. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2083. <span class="phpdocumentor-element__modifiers">
  2084. </span>
  2085. </h4>
  2086. <aside class="phpdocumentor-element-found-in">
  2087. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2088. :
  2089. <span class="phpdocumentor-element-found-in__line">88</span>
  2090. </aside>
  2091. <p class="phpdocumentor-summary">Minimum QR version</p>
  2092. <code class="phpdocumentor-code phpdocumentor-signature ">
  2093. <span class="phpdocumentor-signature__visibility">protected</span>
  2094. <span class="phpdocumentor-signature__type">int</span>
  2095. <span class="phpdocumentor-signature__name">$versionMin</span>
  2096. = <span class="phpdocumentor-signature__default-value">1</span></code>
  2097. <section class="phpdocumentor-description"><p>if <code class="prettyprint">QROptions::$version</code> is set to <code class="prettyprint">Version::AUTO</code> (default: 1)</p>
  2098. </section>
  2099. </article>
  2100. <article
  2101. class="
  2102. phpdocumentor-element
  2103. -property
  2104. -protected
  2105. "
  2106. >
  2107. <h4 class="phpdocumentor-element__name" id="property_xmlStylesheet">
  2108. $xmlStylesheet
  2109. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet" class="headerlink"><i class="fas fa-link"></i></a>
  2110. <span class="phpdocumentor-element__modifiers">
  2111. </span>
  2112. </h4>
  2113. <aside class="phpdocumentor-element-found-in">
  2114. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2115. :
  2116. <span class="phpdocumentor-element-found-in__line">488</span>
  2117. </aside>
  2118. <p class="phpdocumentor-summary">Sets an optional XSLT stylesheet in the XML output</p>
  2119. <code class="phpdocumentor-code phpdocumentor-signature ">
  2120. <span class="phpdocumentor-signature__visibility">protected</span>
  2121. <span class="phpdocumentor-signature__type">string|null</span>
  2122. <span class="phpdocumentor-signature__name">$xmlStylesheet</span>
  2123. = <span class="phpdocumentor-signature__default-value">null</span></code>
  2124. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2125. Tags
  2126. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2127. </h5>
  2128. <dl class="phpdocumentor-tag-list">
  2129. <dt class="phpdocumentor-tag-list__entry">
  2130. <span class="phpdocumentor-tag__name">see</span>
  2131. </dt>
  2132. <dd class="phpdocumentor-tag-list__definition">
  2133. <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>
  2134. </dd>
  2135. </dl>
  2136. </article>
  2137. </section>
  2138. <section class="phpdocumentor-methods">
  2139. <h3 class="phpdocumentor-elements__header" id="methods">
  2140. Methods
  2141. <a href="classes/chillerlan-QRCode-QROptions.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  2142. </h3>
  2143. <article
  2144. class="phpdocumentor-element
  2145. -method
  2146. -protected
  2147. "
  2148. >
  2149. <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
  2150. clampLogoSpaceValue()
  2151. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  2152. </h4>
  2153. <aside class="phpdocumentor-element-found-in">
  2154. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2155. :
  2156. <span class="phpdocumentor-element-found-in__line">575</span>
  2157. </aside>
  2158. <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
  2159. <code class="phpdocumentor-code phpdocumentor-signature ">
  2160. <span class="phpdocumentor-signature__visibility">protected</span>
  2161. <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>
  2162. <div class="phpdocumentor-label-line">
  2163. </div>
  2164. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2165. <dl class="phpdocumentor-argument-list">
  2166. <dt class="phpdocumentor-argument-list__entry">
  2167. <span class="phpdocumentor-signature__argument__name">$value</span>
  2168. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2169. </dt>
  2170. <dd class="phpdocumentor-argument-list__definition">
  2171. </dd>
  2172. </dl>
  2173. <section>
  2174. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2175. <span class="phpdocumentor-signature__response_type">int|null</span>
  2176. </section>
  2177. </article>
  2178. <article
  2179. class="phpdocumentor-element
  2180. -method
  2181. -protected
  2182. "
  2183. >
  2184. <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
  2185. set_circleRadius()
  2186. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  2187. </h4>
  2188. <aside class="phpdocumentor-element-found-in">
  2189. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2190. :
  2191. <span class="phpdocumentor-element-found-in__line">615</span>
  2192. </aside>
  2193. <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
  2194. <code class="phpdocumentor-code phpdocumentor-signature ">
  2195. <span class="phpdocumentor-signature__visibility">protected</span>
  2196. <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>
  2197. <div class="phpdocumentor-label-line">
  2198. </div>
  2199. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2200. <dl class="phpdocumentor-argument-list">
  2201. <dt class="phpdocumentor-argument-list__entry">
  2202. <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
  2203. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  2204. </dt>
  2205. <dd class="phpdocumentor-argument-list__definition">
  2206. </dd>
  2207. </dl>
  2208. </article>
  2209. <article
  2210. class="phpdocumentor-element
  2211. -method
  2212. -protected
  2213. "
  2214. >
  2215. <h4 class="phpdocumentor-element__name" id="method_set_eccLevel">
  2216. set_eccLevel()
  2217. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  2218. </h4>
  2219. <aside class="phpdocumentor-element-found-in">
  2220. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2221. :
  2222. <span class="phpdocumentor-element-found-in__line">528</span>
  2223. </aside>
  2224. <p class="phpdocumentor-summary">sets the ECC level</p>
  2225. <code class="phpdocumentor-code phpdocumentor-signature ">
  2226. <span class="phpdocumentor-signature__visibility">protected</span>
  2227. <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>
  2228. <div class="phpdocumentor-label-line">
  2229. </div>
  2230. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2231. <dl class="phpdocumentor-argument-list">
  2232. <dt class="phpdocumentor-argument-list__entry">
  2233. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  2234. : <span class="phpdocumentor-signature__argument__return-type">int|string</span>
  2235. </dt>
  2236. <dd class="phpdocumentor-argument-list__definition">
  2237. </dd>
  2238. </dl>
  2239. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2240. Tags
  2241. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2242. </h5>
  2243. <dl class="phpdocumentor-tag-list">
  2244. <dt class="phpdocumentor-tag-list__entry">
  2245. <span class="phpdocumentor-tag__name">throws</span>
  2246. </dt>
  2247. <dd class="phpdocumentor-tag-list__definition">
  2248. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  2249. </dd>
  2250. </dl>
  2251. </article>
  2252. <article
  2253. class="phpdocumentor-element
  2254. -method
  2255. -protected
  2256. "
  2257. >
  2258. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  2259. set_fpdfMeasureUnit()
  2260. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  2261. </h4>
  2262. <aside class="phpdocumentor-element-found-in">
  2263. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2264. :
  2265. <span class="phpdocumentor-element-found-in__line">562</span>
  2266. </aside>
  2267. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  2268. <code class="phpdocumentor-code phpdocumentor-signature ">
  2269. <span class="phpdocumentor-signature__visibility">protected</span>
  2270. <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>
  2271. <div class="phpdocumentor-label-line">
  2272. </div>
  2273. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2274. <dl class="phpdocumentor-argument-list">
  2275. <dt class="phpdocumentor-argument-list__entry">
  2276. <span class="phpdocumentor-signature__argument__name">$unit</span>
  2277. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2278. </dt>
  2279. <dd class="phpdocumentor-argument-list__definition">
  2280. </dd>
  2281. </dl>
  2282. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2283. Tags
  2284. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2285. </h5>
  2286. <dl class="phpdocumentor-tag-list">
  2287. <dt class="phpdocumentor-tag-list__entry">
  2288. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2289. </dt>
  2290. <dd class="phpdocumentor-tag-list__definition">
  2291. </dd>
  2292. </dl>
  2293. </article>
  2294. <article
  2295. class="phpdocumentor-element
  2296. -method
  2297. -protected
  2298. "
  2299. >
  2300. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
  2301. set_logoSpaceHeight()
  2302. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  2303. </h4>
  2304. <aside class="phpdocumentor-element-found-in">
  2305. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2306. :
  2307. <span class="phpdocumentor-element-found-in__line">594</span>
  2308. </aside>
  2309. <p class="phpdocumentor-summary">clamp/set logo space height</p>
  2310. <code class="phpdocumentor-code phpdocumentor-signature ">
  2311. <span class="phpdocumentor-signature__visibility">protected</span>
  2312. <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>
  2313. <div class="phpdocumentor-label-line">
  2314. </div>
  2315. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2316. <dl class="phpdocumentor-argument-list">
  2317. <dt class="phpdocumentor-argument-list__entry">
  2318. <span class="phpdocumentor-signature__argument__name">$value</span>
  2319. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2320. </dt>
  2321. <dd class="phpdocumentor-argument-list__definition">
  2322. </dd>
  2323. </dl>
  2324. </article>
  2325. <article
  2326. class="phpdocumentor-element
  2327. -method
  2328. -protected
  2329. "
  2330. >
  2331. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
  2332. set_logoSpaceStartX()
  2333. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  2334. </h4>
  2335. <aside class="phpdocumentor-element-found-in">
  2336. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2337. :
  2338. <span class="phpdocumentor-element-found-in__line">601</span>
  2339. </aside>
  2340. <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
  2341. <code class="phpdocumentor-code phpdocumentor-signature ">
  2342. <span class="phpdocumentor-signature__visibility">protected</span>
  2343. <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>
  2344. <div class="phpdocumentor-label-line">
  2345. </div>
  2346. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2347. <dl class="phpdocumentor-argument-list">
  2348. <dt class="phpdocumentor-argument-list__entry">
  2349. <span class="phpdocumentor-signature__argument__name">$value</span>
  2350. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2351. </dt>
  2352. <dd class="phpdocumentor-argument-list__definition">
  2353. </dd>
  2354. </dl>
  2355. </article>
  2356. <article
  2357. class="phpdocumentor-element
  2358. -method
  2359. -protected
  2360. "
  2361. >
  2362. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
  2363. set_logoSpaceStartY()
  2364. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  2365. </h4>
  2366. <aside class="phpdocumentor-element-found-in">
  2367. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2368. :
  2369. <span class="phpdocumentor-element-found-in__line">608</span>
  2370. </aside>
  2371. <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
  2372. <code class="phpdocumentor-code phpdocumentor-signature ">
  2373. <span class="phpdocumentor-signature__visibility">protected</span>
  2374. <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>
  2375. <div class="phpdocumentor-label-line">
  2376. </div>
  2377. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2378. <dl class="phpdocumentor-argument-list">
  2379. <dt class="phpdocumentor-argument-list__entry">
  2380. <span class="phpdocumentor-signature__argument__name">$value</span>
  2381. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2382. </dt>
  2383. <dd class="phpdocumentor-argument-list__definition">
  2384. </dd>
  2385. </dl>
  2386. </article>
  2387. <article
  2388. class="phpdocumentor-element
  2389. -method
  2390. -protected
  2391. "
  2392. >
  2393. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
  2394. set_logoSpaceWidth()
  2395. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  2396. </h4>
  2397. <aside class="phpdocumentor-element-found-in">
  2398. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2399. :
  2400. <span class="phpdocumentor-element-found-in__line">587</span>
  2401. </aside>
  2402. <p class="phpdocumentor-summary">clamp/set logo space width</p>
  2403. <code class="phpdocumentor-code phpdocumentor-signature ">
  2404. <span class="phpdocumentor-signature__visibility">protected</span>
  2405. <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>
  2406. <div class="phpdocumentor-label-line">
  2407. </div>
  2408. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2409. <dl class="phpdocumentor-argument-list">
  2410. <dt class="phpdocumentor-argument-list__entry">
  2411. <span class="phpdocumentor-signature__argument__name">$value</span>
  2412. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2413. </dt>
  2414. <dd class="phpdocumentor-argument-list__definition">
  2415. </dd>
  2416. </dl>
  2417. </article>
  2418. <article
  2419. class="phpdocumentor-element
  2420. -method
  2421. -protected
  2422. "
  2423. >
  2424. <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
  2425. set_quietzoneSize()
  2426. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  2427. </h4>
  2428. <aside class="phpdocumentor-element-found-in">
  2429. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2430. :
  2431. <span class="phpdocumentor-element-found-in__line">553</span>
  2432. </aside>
  2433. <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
  2434. <code class="phpdocumentor-code phpdocumentor-signature ">
  2435. <span class="phpdocumentor-signature__visibility">protected</span>
  2436. <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>
  2437. <div class="phpdocumentor-label-line">
  2438. </div>
  2439. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2440. <dl class="phpdocumentor-argument-list">
  2441. <dt class="phpdocumentor-argument-list__entry">
  2442. <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
  2443. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2444. </dt>
  2445. <dd class="phpdocumentor-argument-list__definition">
  2446. </dd>
  2447. </dl>
  2448. </article>
  2449. <article
  2450. class="phpdocumentor-element
  2451. -method
  2452. -protected
  2453. "
  2454. >
  2455. <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
  2456. set_readerUseImagickIfAvailable()
  2457. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  2458. </h4>
  2459. <aside class="phpdocumentor-element-found-in">
  2460. <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>
  2461. :
  2462. <span class="phpdocumentor-element-found-in__line">51</span>
  2463. </aside>
  2464. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  2465. <code class="phpdocumentor-code phpdocumentor-signature ">
  2466. <span class="phpdocumentor-signature__visibility">protected</span>
  2467. <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>
  2468. <div class="phpdocumentor-label-line">
  2469. </div>
  2470. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2471. <dl class="phpdocumentor-argument-list">
  2472. <dt class="phpdocumentor-argument-list__entry">
  2473. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  2474. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2475. </dt>
  2476. <dd class="phpdocumentor-argument-list__definition">
  2477. </dd>
  2478. </dl>
  2479. </article>
  2480. <article
  2481. class="phpdocumentor-element
  2482. -method
  2483. -protected
  2484. "
  2485. >
  2486. <h4 class="phpdocumentor-element__name" id="method_set_version">
  2487. set_version()
  2488. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  2489. </h4>
  2490. <aside class="phpdocumentor-element-found-in">
  2491. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2492. :
  2493. <span class="phpdocumentor-element-found-in__line">519</span>
  2494. </aside>
  2495. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  2496. <code class="phpdocumentor-code phpdocumentor-signature ">
  2497. <span class="phpdocumentor-signature__visibility">protected</span>
  2498. <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>
  2499. <div class="phpdocumentor-label-line">
  2500. </div>
  2501. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2502. <dl class="phpdocumentor-argument-list">
  2503. <dt class="phpdocumentor-argument-list__entry">
  2504. <span class="phpdocumentor-signature__argument__name">$version</span>
  2505. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2506. </dt>
  2507. <dd class="phpdocumentor-argument-list__definition">
  2508. </dd>
  2509. </dl>
  2510. </article>
  2511. <article
  2512. class="phpdocumentor-element
  2513. -method
  2514. -protected
  2515. "
  2516. >
  2517. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  2518. set_versionMax()
  2519. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2520. </h4>
  2521. <aside class="phpdocumentor-element-found-in">
  2522. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2523. :
  2524. <span class="phpdocumentor-element-found-in__line">512</span>
  2525. </aside>
  2526. <p class="phpdocumentor-summary">sets the maximum version number</p>
  2527. <code class="phpdocumentor-code phpdocumentor-signature ">
  2528. <span class="phpdocumentor-signature__visibility">protected</span>
  2529. <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>
  2530. <div class="phpdocumentor-label-line">
  2531. </div>
  2532. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2533. <dl class="phpdocumentor-argument-list">
  2534. <dt class="phpdocumentor-argument-list__entry">
  2535. <span class="phpdocumentor-signature__argument__name">$version</span>
  2536. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2537. </dt>
  2538. <dd class="phpdocumentor-argument-list__definition">
  2539. </dd>
  2540. </dl>
  2541. </article>
  2542. <article
  2543. class="phpdocumentor-element
  2544. -method
  2545. -protected
  2546. "
  2547. >
  2548. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  2549. set_versionMin()
  2550. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2551. </h4>
  2552. <aside class="phpdocumentor-element-found-in">
  2553. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2554. :
  2555. <span class="phpdocumentor-element-found-in__line">505</span>
  2556. </aside>
  2557. <p class="phpdocumentor-summary">sets the minimum version number</p>
  2558. <code class="phpdocumentor-code phpdocumentor-signature ">
  2559. <span class="phpdocumentor-signature__visibility">protected</span>
  2560. <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>
  2561. <div class="phpdocumentor-label-line">
  2562. </div>
  2563. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2564. <dl class="phpdocumentor-argument-list">
  2565. <dt class="phpdocumentor-argument-list__entry">
  2566. <span class="phpdocumentor-signature__argument__name">$version</span>
  2567. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2568. </dt>
  2569. <dd class="phpdocumentor-argument-list__definition">
  2570. </dd>
  2571. </dl>
  2572. </article>
  2573. <article
  2574. class="phpdocumentor-element
  2575. -method
  2576. -protected
  2577. "
  2578. >
  2579. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  2580. setMinMaxVersion()
  2581. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  2582. </h4>
  2583. <aside class="phpdocumentor-element-found-in">
  2584. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2585. :
  2586. <span class="phpdocumentor-element-found-in__line">494</span>
  2587. </aside>
  2588. <p class="phpdocumentor-summary">clamp min/max version number</p>
  2589. <code class="phpdocumentor-code phpdocumentor-signature ">
  2590. <span class="phpdocumentor-signature__visibility">protected</span>
  2591. <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>
  2592. <div class="phpdocumentor-label-line">
  2593. </div>
  2594. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2595. <dl class="phpdocumentor-argument-list">
  2596. <dt class="phpdocumentor-argument-list__entry">
  2597. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  2598. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2599. </dt>
  2600. <dd class="phpdocumentor-argument-list__definition">
  2601. </dd>
  2602. <dt class="phpdocumentor-argument-list__entry">
  2603. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  2604. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2605. </dt>
  2606. <dd class="phpdocumentor-argument-list__definition">
  2607. </dd>
  2608. </dl>
  2609. </article>
  2610. </section>
  2611. <div class="phpdocumentor-modal" id="source-view">
  2612. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  2613. <div class="phpdocumentor-modal-container">
  2614. <div class="phpdocumentor-modal-content">
  2615. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QROptions.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  2616. </div>
  2617. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  2618. </div>
  2619. </div>
  2620. <script type="text/javascript">
  2621. (function () {
  2622. function loadExternalCodeSnippet(el, url, line) {
  2623. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2624. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  2625. const language = 'php';
  2626. const code = document.createElement('code');
  2627. code.className = 'language-' + language;
  2628. pre.textContent = '';
  2629. pre.setAttribute('data-line', line)
  2630. code.textContent = 'Loading…';
  2631. pre.appendChild(code);
  2632. var xhr = new XMLHttpRequest();
  2633. xhr.open('GET', src, true);
  2634. xhr.onreadystatechange = function () {
  2635. if (xhr.readyState !== 4) {
  2636. return;
  2637. }
  2638. if (xhr.status < 400 && xhr.responseText) {
  2639. code.textContent = xhr.responseText;
  2640. Prism.highlightElement(code);
  2641. return;
  2642. }
  2643. if (xhr.status === 404) {
  2644. code.textContent = '✖ Error: File could not be found';
  2645. return;
  2646. }
  2647. if (xhr.status >= 400) {
  2648. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2649. return;
  2650. }
  2651. code.textContent = '✖ Error: An unknown error occurred';
  2652. };
  2653. xhr.send(null);
  2654. });
  2655. }
  2656. const modalButtons = document.querySelectorAll("[data-modal]");
  2657. const openedAsLocalFile = window.location.protocol === 'file:';
  2658. if (modalButtons.length > 0 && openedAsLocalFile) {
  2659. console.warn(
  2660. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  2661. 'browsers block XHR requests when a page is opened this way'
  2662. );
  2663. }
  2664. modalButtons.forEach(function (trigger) {
  2665. if (openedAsLocalFile) {
  2666. trigger.setAttribute("hidden", "hidden");
  2667. }
  2668. trigger.addEventListener("click", function (event) {
  2669. event.preventDefault();
  2670. const modal = document.getElementById(trigger.dataset.modal);
  2671. if (!modal) {
  2672. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  2673. return;
  2674. }
  2675. modal.classList.add("phpdocumentor-modal__open");
  2676. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  2677. const exits = modal.querySelectorAll("[data-exit-button]");
  2678. exits.forEach(function (exit) {
  2679. exit.addEventListener("click", function (event) {
  2680. event.preventDefault();
  2681. modal.classList.remove("phpdocumentor-modal__open");
  2682. });
  2683. });
  2684. });
  2685. });
  2686. })();
  2687. </script>
  2688. </article>
  2689. </section>
  2690. <section class="phpdocumentor-on-this-page__sidebar">
  2691. <section class="phpdocumentor-on-this-page__content">
  2692. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  2693. <ul class="phpdocumentor-list -clean">
  2694. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  2695. <li>
  2696. <ul class="phpdocumentor-list -clean">
  2697. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-properties">Properties</a></li>
  2698. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-methods">Methods</a></li>
  2699. </ul>
  2700. </li>
  2701. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  2702. <li>
  2703. <ul class="phpdocumentor-list -clean">
  2704. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a></li>
  2705. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a></li>
  2706. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a></li>
  2707. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a></li>
  2708. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a></li>
  2709. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a></li>
  2710. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a></li>
  2711. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a></li>
  2712. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a></li>
  2713. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a></li>
  2714. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a></li>
  2715. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a></li>
  2716. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a></li>
  2717. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_gdImageUseUpscale">$gdImageUseUpscale</a></li>
  2718. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a></li>
  2719. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a></li>
  2720. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_invertMatrix">$invertMatrix</a></li>
  2721. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonFlags">$jsonFlags</a></li>
  2722. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a></li>
  2723. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a></li>
  2724. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a></li>
  2725. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a></li>
  2726. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a></li>
  2727. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a></li>
  2728. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a></li>
  2729. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a></li>
  2730. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a></li>
  2731. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a></li>
  2732. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a></li>
  2733. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
  2734. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
  2735. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a></li>
  2736. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
  2737. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a></li>
  2738. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a></li>
  2739. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a></li>
  2740. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a></li>
  2741. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a></li>
  2742. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgUseFillAttributes">$svgUseFillAttributes</a></li>
  2743. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a></li>
  2744. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a></li>
  2745. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a></li>
  2746. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a></li>
  2747. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a></li>
  2748. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_xmlStylesheet">$xmlStylesheet</a></li>
  2749. </ul>
  2750. </li>
  2751. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  2752. <li>
  2753. <ul class="phpdocumentor-list -clean">
  2754. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a></li>
  2755. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a></li>
  2756. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel">set_eccLevel()</a></li>
  2757. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a></li>
  2758. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a></li>
  2759. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a></li>
  2760. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a></li>
  2761. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a></li>
  2762. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a></li>
  2763. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a></li>
  2764. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a></li>
  2765. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a></li>
  2766. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a></li>
  2767. <li class=""><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a></li>
  2768. </ul>
  2769. </li>
  2770. </ul>
  2771. </section>
  2772. </section>
  2773. </div>
  2774. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2775. <section class="phpdocumentor-search-results__dialog">
  2776. <header class="phpdocumentor-search-results__header">
  2777. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2778. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2779. </header>
  2780. <section class="phpdocumentor-search-results__body">
  2781. <ul class="phpdocumentor-search-results__entries"></ul>
  2782. </section>
  2783. </section>
  2784. </section>
  2785. </div>
  2786. <a href="classes/chillerlan-QRCode-QROptions.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2787. </main>
  2788. <script>
  2789. cssVars({});
  2790. </script>
  2791. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2792. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2793. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2794. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2795. </body>
  2796. </html>