chillerlan-QRCode-QROptionsTrait.html 162 KB

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