chillerlan-QRCode-QROptions.html 144 KB

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