chillerlan-QRCode-QROptions.html 142 KB

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