chillerlan-QRCode-QROptionsTrait.html 141 KB

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