chillerlan-QRCode-QROptionsTrait.html 154 KB

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