chillerlan-QRCode-QROptionsTrait.html 152 KB

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