chillerlan-QRCode-QROptions.html 140 KB

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