chillerlan-QRCode-QROptionsTrait.html 160 KB

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