chillerlan-QRCode-QROptionsTrait.html 140 KB

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