chillerlan-QRCode-QROptions.html 155 KB

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