chillerlan-QRCode-QROptionsTrait.html 139 KB

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