chillerlan-QRCode-QROptions.html 141 KB

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