chillerlan-QRCode-QROptions.html 172 KB

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