chillerlan-QRCode-QROptions.html 174 KB

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