chillerlan-QRCode-QROptions.html 150 KB

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