chillerlan-QRCode-QROptionsTrait.html 149 KB

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