chillerlan-QRCode-QROptionsTrait.html 94 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171
  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 -trait">
  86. <h2 class="phpdocumentor-content__title">
  87. QROptionsTrait
  88. </h2>
  89. <aside class="phpdocumentor-element-found-in">
  90. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  91. :
  92. <span class="phpdocumentor-element-found-in__line">22</span>
  93. </aside>
  94. <p class="phpdocumentor-summary">The QRCode plug-in settings &amp; setter functionality</p>
  95. <h3 id="toc">
  96. Table of Contents
  97. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  98. </h3>
  99. <dl class="phpdocumentor-table-of-contents">
  100. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  101. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
  102. <span>
  103. &nbsp;: bool </span>
  104. </dt>
  105. <dd>Add a &quot;quiet zone&quot; (margin) according to the QR code spec</dd>
  106. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  107. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
  108. <span>
  109. &nbsp;: string|null </span>
  110. </dt>
  111. <dd>/path/to/cache.file</dd>
  112. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  113. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
  114. <span>
  115. &nbsp;: string </span>
  116. </dt>
  117. <dd>a common css class</dd>
  118. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  119. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
  120. <span>
  121. &nbsp;: int </span>
  122. </dt>
  123. <dd>Error correct level</dd>
  124. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  125. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
  126. <span>
  127. &nbsp;: string </span>
  128. </dt>
  129. <dd>newline string [HTML, SVG, TEXT]</dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  131. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
  132. <span>
  133. &nbsp;: string </span>
  134. </dt>
  135. <dd>Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  137. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a>
  138. <span>
  139. &nbsp;: bool </span>
  140. </dt>
  141. <dd>toggle base64 or raw image data</dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  143. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparencyBG">$imageTransparencyBG</a>
  144. <span>
  145. &nbsp;: array&lt;string|int, mixed&gt; </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  149. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
  150. <span>
  151. &nbsp;: bool </span>
  152. </dt>
  153. <dd>toggle transparency, not supported by jpg</dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickBG">$imagickBG</a>
  156. <span>
  157. &nbsp;: string|null </span>
  158. </dt>
  159. <dd>Imagick background color (defaults to &quot;transparent&quot;)</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  161. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
  162. <span>
  163. &nbsp;: string </span>
  164. </dt>
  165. <dd>Imagick output format</dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality">$jpegQuality</a>
  168. <span>
  169. &nbsp;: int </span>
  170. </dt>
  171. <dd></dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  173. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a>
  174. <span>
  175. &nbsp;: string </span>
  176. </dt>
  177. <dd>markup substitute for dark (CSS value)</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a>
  180. <span>
  181. &nbsp;: string </span>
  182. </dt>
  183. <dd>markup substitute for light (CSS value)</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  185. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
  186. <span>
  187. &nbsp;: int </span>
  188. </dt>
  189. <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
  192. <span>
  193. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  194. </dt>
  195. <dd>Module values map</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  197. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
  198. <span>
  199. &nbsp;: string|null </span>
  200. </dt>
  201. <dd>the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  203. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a>
  204. <span>
  205. &nbsp;: string </span>
  206. </dt>
  207. <dd>The output type</dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  209. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression">$pngCompression</a>
  210. <span>
  211. &nbsp;: int </span>
  212. </dt>
  213. <dd></dd>
  214. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  215. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
  216. <span>
  217. &nbsp;: int </span>
  218. </dt>
  219. <dd>Size of the quiet zone</dd>
  220. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  221. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
  222. <span>
  223. &nbsp;: bool </span>
  224. </dt>
  225. <dd>Return the image resource instead of a render if applicable.</dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  227. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
  228. <span>
  229. &nbsp;: int </span>
  230. </dt>
  231. <dd>size of a QR code pixel [SVG, IMAGE_*], HTML via CSS</dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  233. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
  234. <span>
  235. &nbsp;: string </span>
  236. </dt>
  237. <dd>anything between &lt;defs&gt;</dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  239. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
  240. <span>
  241. &nbsp;: float </span>
  242. </dt>
  243. <dd>SVG opacity</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  245. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
  246. <span>
  247. &nbsp;: int|null </span>
  248. </dt>
  249. <dd>SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  251. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
  252. <span>
  253. &nbsp;: string </span>
  254. </dt>
  255. <dd>string substitute for dark</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  257. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
  258. <span>
  259. &nbsp;: string </span>
  260. </dt>
  261. <dd>string substitute for light</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  263. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_useImagickIfAvailable">$useImagickIfAvailable</a>
  264. <span>
  265. &nbsp;: bool </span>
  266. </dt>
  267. <dd>use Imaagick (if available) when reading QR Codes</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  269. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
  270. <span>
  271. &nbsp;: int </span>
  272. </dt>
  273. <dd>QR Code version number</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  275. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
  276. <span>
  277. &nbsp;: int </span>
  278. </dt>
  279. <dd>Maximum QR version</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  281. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
  282. <span>
  283. &nbsp;: int </span>
  284. </dt>
  285. <dd>Minimum QR version</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  287. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel">set_eccLevel()</a>
  288. <span>
  289. &nbsp;: void </span>
  290. </dt>
  291. <dd>sets the error correction level</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  293. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
  294. <span>
  295. &nbsp;: void </span>
  296. </dt>
  297. <dd>sets the FPDF measurement unit</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  299. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a>
  300. <span>
  301. &nbsp;: void </span>
  302. </dt>
  303. <dd>sets the transparency background color</dd>
  304. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  305. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_maskPattern">set_maskPattern()</a>
  306. <span>
  307. &nbsp;: void </span>
  308. </dt>
  309. <dd>sets/clamps the mask pattern</dd>
  310. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  311. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_useImagickIfAvailable">set_useImagickIfAvailable()</a>
  312. <span>
  313. &nbsp;: void </span>
  314. </dt>
  315. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  316. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  317. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
  318. <span>
  319. &nbsp;: void </span>
  320. </dt>
  321. <dd>sets/clamps the version number</dd>
  322. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  323. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
  324. <span>
  325. &nbsp;: void </span>
  326. </dt>
  327. <dd>sets the maximum version number</dd>
  328. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  329. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
  330. <span>
  331. &nbsp;: void </span>
  332. </dt>
  333. <dd>sets the minimum version number</dd>
  334. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  335. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
  336. <span>
  337. &nbsp;: void </span>
  338. </dt>
  339. <dd>clamp min/max version number</dd>
  340. </dl>
  341. <section class="phpdocumentor-properties">
  342. <h3 class="phpdocumentor-elements__header" id="properties">
  343. Properties
  344. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  345. </h3>
  346. <article
  347. class="
  348. phpdocumentor-element
  349. -property
  350. -protected
  351. "
  352. >
  353. <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
  354. $addQuietzone
  355. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
  356. <span class="phpdocumentor-element__modifiers">
  357. </span>
  358. </h4>
  359. <aside class="phpdocumentor-element-found-in">
  360. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  361. :
  362. <span class="phpdocumentor-element-found-in__line">65</span>
  363. </aside>
  364. <p class="phpdocumentor-summary">Add a &quot;quiet zone&quot; (margin) according to the QR code spec</p>
  365. <code class="phpdocumentor-code phpdocumentor-signature ">
  366. <span class="phpdocumentor-signature__visibility">protected</span>
  367. <span class="phpdocumentor-signature__type">bool</span>
  368. <span class="phpdocumentor-signature__name">$addQuietzone</span>
  369. = <span class="phpdocumentor-signature__default-value">true</span></code>
  370. <section class="phpdocumentor-description"></section>
  371. </article>
  372. <article
  373. class="
  374. phpdocumentor-element
  375. -property
  376. -protected
  377. "
  378. >
  379. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  380. $cachefile
  381. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  382. <span class="phpdocumentor-element__modifiers">
  383. </span>
  384. </h4>
  385. <aside class="phpdocumentor-element-found-in">
  386. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  387. :
  388. <span class="phpdocumentor-element-found-in__line">92</span>
  389. </aside>
  390. <p class="phpdocumentor-summary">/path/to/cache.file</p>
  391. <code class="phpdocumentor-code phpdocumentor-signature ">
  392. <span class="phpdocumentor-signature__visibility">protected</span>
  393. <span class="phpdocumentor-signature__type">string|null</span>
  394. <span class="phpdocumentor-signature__name">$cachefile</span>
  395. = <span class="phpdocumentor-signature__default-value">null</span></code>
  396. <section class="phpdocumentor-description"></section>
  397. </article>
  398. <article
  399. class="
  400. phpdocumentor-element
  401. -property
  402. -protected
  403. "
  404. >
  405. <h4 class="phpdocumentor-element__name" id="property_cssClass">
  406. $cssClass
  407. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
  408. <span class="phpdocumentor-element__modifiers">
  409. </span>
  410. </h4>
  411. <aside class="phpdocumentor-element-found-in">
  412. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  413. :
  414. <span class="phpdocumentor-element-found-in__line">107</span>
  415. </aside>
  416. <p class="phpdocumentor-summary">a common css class</p>
  417. <code class="phpdocumentor-code phpdocumentor-signature ">
  418. <span class="phpdocumentor-signature__visibility">protected</span>
  419. <span class="phpdocumentor-signature__type">string</span>
  420. <span class="phpdocumentor-signature__name">$cssClass</span>
  421. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  422. <section class="phpdocumentor-description"></section>
  423. </article>
  424. <article
  425. class="
  426. phpdocumentor-element
  427. -property
  428. -protected
  429. "
  430. >
  431. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  432. $eccLevel
  433. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  434. <span class="phpdocumentor-element__modifiers">
  435. </span>
  436. </h4>
  437. <aside class="phpdocumentor-element-found-in">
  438. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  439. :
  440. <span class="phpdocumentor-element-found-in__line">53</span>
  441. </aside>
  442. <p class="phpdocumentor-summary">Error correct level</p>
  443. <code class="phpdocumentor-code phpdocumentor-signature ">
  444. <span class="phpdocumentor-signature__visibility">protected</span>
  445. <span class="phpdocumentor-signature__type">int</span>
  446. <span class="phpdocumentor-signature__name">$eccLevel</span>
  447. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeCommonEccLevel::L</span></code>
  448. <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
  449. <ul>
  450. <li>L =&gt; 7%</li>
  451. <li>M =&gt; 15%</li>
  452. <li>Q =&gt; 25%</li>
  453. <li>H =&gt; 30%</li>
  454. </ul>
  455. </section>
  456. <section class="phpdocumentor-description"></section>
  457. </article>
  458. <article
  459. class="
  460. phpdocumentor-element
  461. -property
  462. -protected
  463. "
  464. >
  465. <h4 class="phpdocumentor-element__name" id="property_eol">
  466. $eol
  467. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  468. <span class="phpdocumentor-element__modifiers">
  469. </span>
  470. </h4>
  471. <aside class="phpdocumentor-element-found-in">
  472. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  473. :
  474. <span class="phpdocumentor-element-found-in__line">97</span>
  475. </aside>
  476. <p class="phpdocumentor-summary">newline string [HTML, SVG, TEXT]</p>
  477. <code class="phpdocumentor-code phpdocumentor-signature ">
  478. <span class="phpdocumentor-signature__visibility">protected</span>
  479. <span class="phpdocumentor-signature__type">string</span>
  480. <span class="phpdocumentor-signature__name">$eol</span>
  481. = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
  482. <section class="phpdocumentor-description"></section>
  483. </article>
  484. <article
  485. class="
  486. phpdocumentor-element
  487. -property
  488. -protected
  489. "
  490. >
  491. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  492. $fpdfMeasureUnit
  493. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" 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">212</span>
  501. </aside>
  502. <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</p>
  503. <code class="phpdocumentor-code phpdocumentor-signature ">
  504. <span class="phpdocumentor-signature__visibility">protected</span>
  505. <span class="phpdocumentor-signature__type">string</span>
  506. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  507. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  508. <section class="phpdocumentor-description"></section>
  509. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  510. Tags
  511. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  512. </h5>
  513. <dl class="phpdocumentor-tag-list">
  514. <dt class="phpdocumentor-tag-list__entry">
  515. <span class="phpdocumentor-tag__name">see</span>
  516. </dt>
  517. <dd class="phpdocumentor-tag-list__definition">
  518. <span class="phpdocumentor-tag-link"><abbr title="\FPDF::__construct()">FPDF::__construct()</abbr></span>
  519. </dd>
  520. </dl>
  521. </article>
  522. <article
  523. class="
  524. phpdocumentor-element
  525. -property
  526. -protected
  527. "
  528. >
  529. <h4 class="phpdocumentor-element__name" id="property_imageBase64">
  530. $imageBase64
  531. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  532. <span class="phpdocumentor-element__modifiers">
  533. </span>
  534. </h4>
  535. <aside class="phpdocumentor-element-found-in">
  536. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  537. :
  538. <span class="phpdocumentor-element-found-in__line">169</span>
  539. </aside>
  540. <p class="phpdocumentor-summary">toggle base64 or raw image data</p>
  541. <code class="phpdocumentor-code phpdocumentor-signature ">
  542. <span class="phpdocumentor-signature__visibility">protected</span>
  543. <span class="phpdocumentor-signature__type">bool</span>
  544. <span class="phpdocumentor-signature__name">$imageBase64</span>
  545. = <span class="phpdocumentor-signature__default-value">true</span></code>
  546. <section class="phpdocumentor-description"></section>
  547. </article>
  548. <article
  549. class="
  550. phpdocumentor-element
  551. -property
  552. -protected
  553. "
  554. >
  555. <h4 class="phpdocumentor-element__name" id="property_imageTransparencyBG">
  556. $imageTransparencyBG
  557. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  558. <span class="phpdocumentor-element__modifiers">
  559. </span>
  560. </h4>
  561. <aside class="phpdocumentor-element-found-in">
  562. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  563. :
  564. <span class="phpdocumentor-element-found-in__line">181</span>
  565. </aside>
  566. <code class="phpdocumentor-code phpdocumentor-signature ">
  567. <span class="phpdocumentor-signature__visibility">protected</span>
  568. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  569. <span class="phpdocumentor-signature__name">$imageTransparencyBG</span>
  570. = <span class="phpdocumentor-signature__default-value">[255, 255, 255]</span></code>
  571. <section class="phpdocumentor-description"></section>
  572. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  573. Tags
  574. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h5>
  576. <dl class="phpdocumentor-tag-list">
  577. <dt class="phpdocumentor-tag-list__entry">
  578. <span class="phpdocumentor-tag__name">see</span>
  579. </dt>
  580. <dd class="phpdocumentor-tag-list__definition">
  581. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr></span>
  582. <section class="phpdocumentor-description"><p>[R, G, B]</p>
  583. </section>
  584. </dd>
  585. </dl>
  586. </article>
  587. <article
  588. class="
  589. phpdocumentor-element
  590. -property
  591. -protected
  592. "
  593. >
  594. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  595. $imageTransparent
  596. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  597. <span class="phpdocumentor-element__modifiers">
  598. </span>
  599. </h4>
  600. <aside class="phpdocumentor-element-found-in">
  601. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  602. :
  603. <span class="phpdocumentor-element-found-in__line">174</span>
  604. </aside>
  605. <p class="phpdocumentor-summary">toggle transparency, not supported by jpg</p>
  606. <code class="phpdocumentor-code phpdocumentor-signature ">
  607. <span class="phpdocumentor-signature__visibility">protected</span>
  608. <span class="phpdocumentor-signature__type">bool</span>
  609. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  610. = <span class="phpdocumentor-signature__default-value">true</span></code>
  611. <section class="phpdocumentor-description"></section>
  612. </article>
  613. <article
  614. class="
  615. phpdocumentor-element
  616. -property
  617. -protected
  618. "
  619. >
  620. <h4 class="phpdocumentor-element__name" id="property_imagickBG">
  621. $imagickBG
  622. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  623. <span class="phpdocumentor-element__modifiers">
  624. </span>
  625. </h4>
  626. <aside class="phpdocumentor-element-found-in">
  627. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  628. :
  629. <span class="phpdocumentor-element-found-in__line">205</span>
  630. </aside>
  631. <p class="phpdocumentor-summary">Imagick background color (defaults to &quot;transparent&quot;)</p>
  632. <code class="phpdocumentor-code phpdocumentor-signature ">
  633. <span class="phpdocumentor-signature__visibility">protected</span>
  634. <span class="phpdocumentor-signature__type">string|null</span>
  635. <span class="phpdocumentor-signature__name">$imagickBG</span>
  636. = <span class="phpdocumentor-signature__default-value">null</span></code>
  637. <section class="phpdocumentor-description"></section>
  638. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  639. Tags
  640. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  641. </h5>
  642. <dl class="phpdocumentor-tag-list">
  643. <dt class="phpdocumentor-tag-list__entry">
  644. <span class="phpdocumentor-tag__name">see</span>
  645. </dt>
  646. <dd class="phpdocumentor-tag-list__definition">
  647. <span class="phpdocumentor-tag-link"><abbr title="\ImagickPixel::__construct()">ImagickPixel::__construct()</abbr></span>
  648. </dd>
  649. </dl>
  650. </article>
  651. <article
  652. class="
  653. phpdocumentor-element
  654. -property
  655. -protected
  656. "
  657. >
  658. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  659. $imagickFormat
  660. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  661. <span class="phpdocumentor-element__modifiers">
  662. </span>
  663. </h4>
  664. <aside class="phpdocumentor-element-found-in">
  665. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  666. :
  667. <span class="phpdocumentor-element-found-in__line">198</span>
  668. </aside>
  669. <p class="phpdocumentor-summary">Imagick output format</p>
  670. <code class="phpdocumentor-code phpdocumentor-signature ">
  671. <span class="phpdocumentor-signature__visibility">protected</span>
  672. <span class="phpdocumentor-signature__type">string</span>
  673. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  674. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span></code>
  675. <section class="phpdocumentor-description"></section>
  676. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  677. Tags
  678. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  679. </h5>
  680. <dl class="phpdocumentor-tag-list">
  681. <dt class="phpdocumentor-tag-list__entry">
  682. <span class="phpdocumentor-tag__name">see</span>
  683. </dt>
  684. <dd class="phpdocumentor-tag-list__definition">
  685. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setType()">Imagick::setType()</abbr></span>
  686. </dd>
  687. </dl>
  688. </article>
  689. <article
  690. class="
  691. phpdocumentor-element
  692. -property
  693. -protected
  694. "
  695. >
  696. <h4 class="phpdocumentor-element__name" id="property_jpegQuality">
  697. $jpegQuality
  698. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  699. <span class="phpdocumentor-element__modifiers">
  700. </span>
  701. </h4>
  702. <aside class="phpdocumentor-element-found-in">
  703. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  704. :
  705. <span class="phpdocumentor-element-found-in__line">191</span>
  706. </aside>
  707. <code class="phpdocumentor-code phpdocumentor-signature ">
  708. <span class="phpdocumentor-signature__visibility">protected</span>
  709. <span class="phpdocumentor-signature__type">int</span>
  710. <span class="phpdocumentor-signature__name">$jpegQuality</span>
  711. = <span class="phpdocumentor-signature__default-value">85</span></code>
  712. <section class="phpdocumentor-description"></section>
  713. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  714. Tags
  715. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  716. </h5>
  717. <dl class="phpdocumentor-tag-list">
  718. <dt class="phpdocumentor-tag-list__entry">
  719. <span class="phpdocumentor-tag__name">see</span>
  720. </dt>
  721. <dd class="phpdocumentor-tag-list__definition">
  722. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagejpeg()">imagejpeg()</abbr></span>
  723. </dd>
  724. </dl>
  725. </article>
  726. <article
  727. class="
  728. phpdocumentor-element
  729. -property
  730. -protected
  731. "
  732. >
  733. <h4 class="phpdocumentor-element__name" id="property_markupDark">
  734. $markupDark
  735. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" class="headerlink"><i class="fas fa-link"></i></a>
  736. <span class="phpdocumentor-element__modifiers">
  737. </span>
  738. </h4>
  739. <aside class="phpdocumentor-element-found-in">
  740. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  741. :
  742. <span class="phpdocumentor-element-found-in__line">143</span>
  743. </aside>
  744. <p class="phpdocumentor-summary">markup substitute for dark (CSS value)</p>
  745. <code class="phpdocumentor-code phpdocumentor-signature ">
  746. <span class="phpdocumentor-signature__visibility">protected</span>
  747. <span class="phpdocumentor-signature__type">string</span>
  748. <span class="phpdocumentor-signature__name">$markupDark</span>
  749. = <span class="phpdocumentor-signature__default-value">&#039;#000&#039;</span></code>
  750. <section class="phpdocumentor-description"></section>
  751. </article>
  752. <article
  753. class="
  754. phpdocumentor-element
  755. -property
  756. -protected
  757. "
  758. >
  759. <h4 class="phpdocumentor-element__name" id="property_markupLight">
  760. $markupLight
  761. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" class="headerlink"><i class="fas fa-link"></i></a>
  762. <span class="phpdocumentor-element__modifiers">
  763. </span>
  764. </h4>
  765. <aside class="phpdocumentor-element-found-in">
  766. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  767. :
  768. <span class="phpdocumentor-element-found-in__line">148</span>
  769. </aside>
  770. <p class="phpdocumentor-summary">markup substitute for light (CSS value)</p>
  771. <code class="phpdocumentor-code phpdocumentor-signature ">
  772. <span class="phpdocumentor-signature__visibility">protected</span>
  773. <span class="phpdocumentor-signature__type">string</span>
  774. <span class="phpdocumentor-signature__name">$markupLight</span>
  775. = <span class="phpdocumentor-signature__default-value">&#039;#fff&#039;</span></code>
  776. <section class="phpdocumentor-description"></section>
  777. </article>
  778. <article
  779. class="
  780. phpdocumentor-element
  781. -property
  782. -protected
  783. "
  784. >
  785. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  786. $maskPattern
  787. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  788. <span class="phpdocumentor-element__modifiers">
  789. </span>
  790. </h4>
  791. <aside class="phpdocumentor-element-found-in">
  792. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  793. :
  794. <span class="phpdocumentor-element-found-in__line">60</span>
  795. </aside>
  796. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  797. <code class="phpdocumentor-code phpdocumentor-signature ">
  798. <span class="phpdocumentor-signature__visibility">protected</span>
  799. <span class="phpdocumentor-signature__type">int</span>
  800. <span class="phpdocumentor-signature__name">$maskPattern</span>
  801. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::MASK_PATTERN_AUTO</span></code>
  802. <section class="phpdocumentor-description"><p>[0...7] or QRCode::MASK_PATTERN_AUTO</p>
  803. </section>
  804. <section class="phpdocumentor-description"></section>
  805. </article>
  806. <article
  807. class="
  808. phpdocumentor-element
  809. -property
  810. -protected
  811. "
  812. >
  813. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  814. $moduleValues
  815. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  816. <span class="phpdocumentor-element__modifiers">
  817. </span>
  818. </h4>
  819. <aside class="phpdocumentor-element-found-in">
  820. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  821. :
  822. <span class="phpdocumentor-element-found-in__line">220</span>
  823. </aside>
  824. <p class="phpdocumentor-summary">Module values map</p>
  825. <code class="phpdocumentor-code phpdocumentor-signature ">
  826. <span class="phpdocumentor-signature__visibility">protected</span>
  827. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  828. <span class="phpdocumentor-signature__name">$moduleValues</span>
  829. = <span class="phpdocumentor-signature__default-value">null</span></code>
  830. <section class="phpdocumentor-description"><ul>
  831. <li>HTML, IMAGICK: #ABCDEF, cssname, rgb(), rgba()...</li>
  832. <li>IMAGE: [63, 127, 255] // R, G, B</li>
  833. </ul>
  834. </section>
  835. <section class="phpdocumentor-description"></section>
  836. </article>
  837. <article
  838. class="
  839. phpdocumentor-element
  840. -property
  841. -protected
  842. "
  843. >
  844. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  845. $outputInterface
  846. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  847. <span class="phpdocumentor-element__modifiers">
  848. </span>
  849. </h4>
  850. <aside class="phpdocumentor-element-found-in">
  851. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  852. :
  853. <span class="phpdocumentor-element-found-in__line">87</span>
  854. </aside>
  855. <p class="phpdocumentor-summary">the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
  856. <code class="phpdocumentor-code phpdocumentor-signature ">
  857. <span class="phpdocumentor-signature__visibility">protected</span>
  858. <span class="phpdocumentor-signature__type">string|null</span>
  859. <span class="phpdocumentor-signature__name">$outputInterface</span>
  860. = <span class="phpdocumentor-signature__default-value">null</span></code>
  861. <section class="phpdocumentor-description"></section>
  862. </article>
  863. <article
  864. class="
  865. phpdocumentor-element
  866. -property
  867. -protected
  868. "
  869. >
  870. <h4 class="phpdocumentor-element__name" id="property_outputType">
  871. $outputType
  872. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" class="headerlink"><i class="fas fa-link"></i></a>
  873. <span class="phpdocumentor-element__modifiers">
  874. </span>
  875. </h4>
  876. <aside class="phpdocumentor-element-found-in">
  877. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  878. :
  879. <span class="phpdocumentor-element-found-in__line">82</span>
  880. </aside>
  881. <p class="phpdocumentor-summary">The output type</p>
  882. <code class="phpdocumentor-code phpdocumentor-signature ">
  883. <span class="phpdocumentor-signature__visibility">protected</span>
  884. <span class="phpdocumentor-signature__type">string</span>
  885. <span class="phpdocumentor-signature__name">$outputType</span>
  886. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::OUTPUT_IMAGE_PNG</span></code>
  887. <section class="phpdocumentor-description"><ul>
  888. <li>QRCode::OUTPUT_MARKUP_XXXX where XXXX = HTML, SVG</li>
  889. <li>QRCode::OUTPUT_IMAGE_XXX where XXX = PNG, GIF, JPG</li>
  890. <li>QRCode::OUTPUT_STRING_XXXX where XXXX = TEXT, JSON</li>
  891. <li>QRCode::OUTPUT_CUSTOM</li>
  892. </ul>
  893. </section>
  894. <section class="phpdocumentor-description"></section>
  895. </article>
  896. <article
  897. class="
  898. phpdocumentor-element
  899. -property
  900. -protected
  901. "
  902. >
  903. <h4 class="phpdocumentor-element__name" id="property_pngCompression">
  904. $pngCompression
  905. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  906. <span class="phpdocumentor-element__modifiers">
  907. </span>
  908. </h4>
  909. <aside class="phpdocumentor-element-found-in">
  910. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  911. :
  912. <span class="phpdocumentor-element-found-in__line">186</span>
  913. </aside>
  914. <code class="phpdocumentor-code phpdocumentor-signature ">
  915. <span class="phpdocumentor-signature__visibility">protected</span>
  916. <span class="phpdocumentor-signature__type">int</span>
  917. <span class="phpdocumentor-signature__name">$pngCompression</span>
  918. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  919. <section class="phpdocumentor-description"></section>
  920. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  921. Tags
  922. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  923. </h5>
  924. <dl class="phpdocumentor-tag-list">
  925. <dt class="phpdocumentor-tag-list__entry">
  926. <span class="phpdocumentor-tag__name">see</span>
  927. </dt>
  928. <dd class="phpdocumentor-tag-list__definition">
  929. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagepng()">imagepng()</abbr></span>
  930. </dd>
  931. </dl>
  932. </article>
  933. <article
  934. class="
  935. phpdocumentor-element
  936. -property
  937. -protected
  938. "
  939. >
  940. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  941. $quietzoneSize
  942. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  943. <span class="phpdocumentor-element__modifiers">
  944. </span>
  945. </h4>
  946. <aside class="phpdocumentor-element-found-in">
  947. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  948. :
  949. <span class="phpdocumentor-element-found-in__line">72</span>
  950. </aside>
  951. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  952. <code class="phpdocumentor-code phpdocumentor-signature ">
  953. <span class="phpdocumentor-signature__visibility">protected</span>
  954. <span class="phpdocumentor-signature__type">int</span>
  955. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  956. = <span class="phpdocumentor-signature__default-value">4</span></code>
  957. <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
  958. </section>
  959. <section class="phpdocumentor-description"></section>
  960. </article>
  961. <article
  962. class="
  963. phpdocumentor-element
  964. -property
  965. -protected
  966. "
  967. >
  968. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  969. $returnResource
  970. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  971. <span class="phpdocumentor-element__modifiers">
  972. </span>
  973. </h4>
  974. <aside class="phpdocumentor-element-found-in">
  975. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  976. :
  977. <span class="phpdocumentor-element-found-in__line">164</span>
  978. </aside>
  979. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  980. <code class="phpdocumentor-code phpdocumentor-signature ">
  981. <span class="phpdocumentor-signature__visibility">protected</span>
  982. <span class="phpdocumentor-signature__type">bool</span>
  983. <span class="phpdocumentor-signature__name">$returnResource</span>
  984. = <span class="phpdocumentor-signature__default-value">false</span></code>
  985. <section class="phpdocumentor-description"><p>This option overrides other output options, such as $cachefile and $imageBase64.</p>
  986. <p>Supported by the following modules:</p>
  987. <ul>
  988. <li>QRImage: resource (PHP &lt; 8), GdImage</li>
  989. <li>QRImagick: Imagick</li>
  990. <li>QRFpdf: FPDF</li>
  991. </ul>
  992. </section>
  993. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  994. Tags
  995. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  996. </h5>
  997. <dl class="phpdocumentor-tag-list">
  998. <dt class="phpdocumentor-tag-list__entry">
  999. <span class="phpdocumentor-tag__name">see</span>
  1000. </dt>
  1001. <dd class="phpdocumentor-tag-list__definition">
  1002. <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>
  1003. </dd>
  1004. </dl>
  1005. </article>
  1006. <article
  1007. class="
  1008. phpdocumentor-element
  1009. -property
  1010. -protected
  1011. "
  1012. >
  1013. <h4 class="phpdocumentor-element__name" id="property_scale">
  1014. $scale
  1015. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  1016. <span class="phpdocumentor-element__modifiers">
  1017. </span>
  1018. </h4>
  1019. <aside class="phpdocumentor-element-found-in">
  1020. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1021. :
  1022. <span class="phpdocumentor-element-found-in__line">102</span>
  1023. </aside>
  1024. <p class="phpdocumentor-summary">size of a QR code pixel [SVG, IMAGE_*], HTML via CSS</p>
  1025. <code class="phpdocumentor-code phpdocumentor-signature ">
  1026. <span class="phpdocumentor-signature__visibility">protected</span>
  1027. <span class="phpdocumentor-signature__type">int</span>
  1028. <span class="phpdocumentor-signature__name">$scale</span>
  1029. = <span class="phpdocumentor-signature__default-value">5</span></code>
  1030. <section class="phpdocumentor-description"></section>
  1031. </article>
  1032. <article
  1033. class="
  1034. phpdocumentor-element
  1035. -property
  1036. -protected
  1037. "
  1038. >
  1039. <h4 class="phpdocumentor-element__name" id="property_svgDefs">
  1040. $svgDefs
  1041. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
  1042. <span class="phpdocumentor-element__modifiers">
  1043. </span>
  1044. </h4>
  1045. <aside class="phpdocumentor-element-found-in">
  1046. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1047. :
  1048. <span class="phpdocumentor-element-found-in__line">119</span>
  1049. </aside>
  1050. <p class="phpdocumentor-summary">anything between &lt;defs&gt;</p>
  1051. <code class="phpdocumentor-code phpdocumentor-signature ">
  1052. <span class="phpdocumentor-signature__visibility">protected</span>
  1053. <span class="phpdocumentor-signature__type">string</span>
  1054. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1055. = <span class="phpdocumentor-signature__default-value">&#039;&lt;style&gt;rect{shape-rendering:crispEdges}&lt;/style&gt;&#039;</span></code>
  1056. <section class="phpdocumentor-description"></section>
  1057. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1058. Tags
  1059. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1060. </h5>
  1061. <dl class="phpdocumentor-tag-list">
  1062. <dt class="phpdocumentor-tag-list__entry">
  1063. <span class="phpdocumentor-tag__name">see</span>
  1064. </dt>
  1065. <dd class="phpdocumentor-tag-list__definition">
  1066. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/docs/Web/SVG/Element/defs"><abbr title="https://developer.mozilla.org/docs/Web/SVG/Element/defs">https://developer.mozilla.org/docs/Web/SVG/Element/defs</abbr></a></span>
  1067. </dd>
  1068. </dl>
  1069. </article>
  1070. <article
  1071. class="
  1072. phpdocumentor-element
  1073. -property
  1074. -protected
  1075. "
  1076. >
  1077. <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
  1078. $svgOpacity
  1079. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" class="headerlink"><i class="fas fa-link"></i></a>
  1080. <span class="phpdocumentor-element__modifiers">
  1081. </span>
  1082. </h4>
  1083. <aside class="phpdocumentor-element-found-in">
  1084. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1085. :
  1086. <span class="phpdocumentor-element-found-in__line">112</span>
  1087. </aside>
  1088. <p class="phpdocumentor-summary">SVG opacity</p>
  1089. <code class="phpdocumentor-code phpdocumentor-signature ">
  1090. <span class="phpdocumentor-signature__visibility">protected</span>
  1091. <span class="phpdocumentor-signature__type">float</span>
  1092. <span class="phpdocumentor-signature__name">$svgOpacity</span>
  1093. = <span class="phpdocumentor-signature__default-value">1.0</span></code>
  1094. <section class="phpdocumentor-description"></section>
  1095. </article>
  1096. <article
  1097. class="
  1098. phpdocumentor-element
  1099. -property
  1100. -protected
  1101. "
  1102. >
  1103. <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
  1104. $svgViewBoxSize
  1105. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" class="headerlink"><i class="fas fa-link"></i></a>
  1106. <span class="phpdocumentor-element__modifiers">
  1107. </span>
  1108. </h4>
  1109. <aside class="phpdocumentor-element-found-in">
  1110. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1111. :
  1112. <span class="phpdocumentor-element-found-in__line">128</span>
  1113. </aside>
  1114. <p class="phpdocumentor-summary">SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</p>
  1115. <code class="phpdocumentor-code phpdocumentor-signature ">
  1116. <span class="phpdocumentor-signature__visibility">protected</span>
  1117. <span class="phpdocumentor-signature__type">int|null</span>
  1118. <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
  1119. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1120. <section class="phpdocumentor-description"><p>viewBox=&quot;0 0 x x&quot;</p>
  1121. </section>
  1122. <section class="phpdocumentor-description"></section>
  1123. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1124. Tags
  1125. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1126. </h5>
  1127. <dl class="phpdocumentor-tag-list">
  1128. <dt class="phpdocumentor-tag-list__entry">
  1129. <span class="phpdocumentor-tag__name">see</span>
  1130. </dt>
  1131. <dd class="phpdocumentor-tag-list__definition">
  1132. <span class="phpdocumentor-tag-link"><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>
  1133. </dd>
  1134. </dl>
  1135. </article>
  1136. <article
  1137. class="
  1138. phpdocumentor-element
  1139. -property
  1140. -protected
  1141. "
  1142. >
  1143. <h4 class="phpdocumentor-element__name" id="property_textDark">
  1144. $textDark
  1145. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" class="headerlink"><i class="fas fa-link"></i></a>
  1146. <span class="phpdocumentor-element__modifiers">
  1147. </span>
  1148. </h4>
  1149. <aside class="phpdocumentor-element-found-in">
  1150. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1151. :
  1152. <span class="phpdocumentor-element-found-in__line">133</span>
  1153. </aside>
  1154. <p class="phpdocumentor-summary">string substitute for dark</p>
  1155. <code class="phpdocumentor-code phpdocumentor-signature ">
  1156. <span class="phpdocumentor-signature__visibility">protected</span>
  1157. <span class="phpdocumentor-signature__type">string</span>
  1158. <span class="phpdocumentor-signature__name">$textDark</span>
  1159. = <span class="phpdocumentor-signature__default-value">&#039;🔴&#039;</span></code>
  1160. <section class="phpdocumentor-description"></section>
  1161. </article>
  1162. <article
  1163. class="
  1164. phpdocumentor-element
  1165. -property
  1166. -protected
  1167. "
  1168. >
  1169. <h4 class="phpdocumentor-element__name" id="property_textLight">
  1170. $textLight
  1171. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" class="headerlink"><i class="fas fa-link"></i></a>
  1172. <span class="phpdocumentor-element__modifiers">
  1173. </span>
  1174. </h4>
  1175. <aside class="phpdocumentor-element-found-in">
  1176. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1177. :
  1178. <span class="phpdocumentor-element-found-in__line">138</span>
  1179. </aside>
  1180. <p class="phpdocumentor-summary">string substitute for light</p>
  1181. <code class="phpdocumentor-code phpdocumentor-signature ">
  1182. <span class="phpdocumentor-signature__visibility">protected</span>
  1183. <span class="phpdocumentor-signature__type">string</span>
  1184. <span class="phpdocumentor-signature__name">$textLight</span>
  1185. = <span class="phpdocumentor-signature__default-value">&#039;⭕&#039;</span></code>
  1186. <section class="phpdocumentor-description"></section>
  1187. </article>
  1188. <article
  1189. class="
  1190. phpdocumentor-element
  1191. -property
  1192. -protected
  1193. "
  1194. >
  1195. <h4 class="phpdocumentor-element__name" id="property_useImagickIfAvailable">
  1196. $useImagickIfAvailable
  1197. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_useImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1198. <span class="phpdocumentor-element__modifiers">
  1199. </span>
  1200. </h4>
  1201. <aside class="phpdocumentor-element-found-in">
  1202. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1203. :
  1204. <span class="phpdocumentor-element-found-in__line">225</span>
  1205. </aside>
  1206. <p class="phpdocumentor-summary">use Imaagick (if available) when reading QR Codes</p>
  1207. <code class="phpdocumentor-code phpdocumentor-signature ">
  1208. <span class="phpdocumentor-signature__visibility">protected</span>
  1209. <span class="phpdocumentor-signature__type">bool</span>
  1210. <span class="phpdocumentor-signature__name">$useImagickIfAvailable</span>
  1211. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1212. <section class="phpdocumentor-description"></section>
  1213. </article>
  1214. <article
  1215. class="
  1216. phpdocumentor-element
  1217. -property
  1218. -protected
  1219. "
  1220. >
  1221. <h4 class="phpdocumentor-element__name" id="property_version">
  1222. $version
  1223. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  1224. <span class="phpdocumentor-element__modifiers">
  1225. </span>
  1226. </h4>
  1227. <aside class="phpdocumentor-element-found-in">
  1228. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1229. :
  1230. <span class="phpdocumentor-element-found-in__line">29</span>
  1231. </aside>
  1232. <p class="phpdocumentor-summary">QR Code version number</p>
  1233. <code class="phpdocumentor-code phpdocumentor-signature ">
  1234. <span class="phpdocumentor-signature__visibility">protected</span>
  1235. <span class="phpdocumentor-signature__type">int</span>
  1236. <span class="phpdocumentor-signature__name">$version</span>
  1237. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::VERSION_AUTO</span></code>
  1238. <section class="phpdocumentor-description"><p>[1 ... 40] or QRCode::VERSION_AUTO</p>
  1239. </section>
  1240. <section class="phpdocumentor-description"></section>
  1241. </article>
  1242. <article
  1243. class="
  1244. phpdocumentor-element
  1245. -property
  1246. -protected
  1247. "
  1248. >
  1249. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  1250. $versionMax
  1251. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  1252. <span class="phpdocumentor-element__modifiers">
  1253. </span>
  1254. </h4>
  1255. <aside class="phpdocumentor-element-found-in">
  1256. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1257. :
  1258. <span class="phpdocumentor-element-found-in__line">41</span>
  1259. </aside>
  1260. <p class="phpdocumentor-summary">Maximum QR version</p>
  1261. <code class="phpdocumentor-code phpdocumentor-signature ">
  1262. <span class="phpdocumentor-signature__visibility">protected</span>
  1263. <span class="phpdocumentor-signature__type">int</span>
  1264. <span class="phpdocumentor-signature__name">$versionMax</span>
  1265. = <span class="phpdocumentor-signature__default-value">40</span></code>
  1266. <section class="phpdocumentor-description"></section>
  1267. </article>
  1268. <article
  1269. class="
  1270. phpdocumentor-element
  1271. -property
  1272. -protected
  1273. "
  1274. >
  1275. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  1276. $versionMin
  1277. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  1278. <span class="phpdocumentor-element__modifiers">
  1279. </span>
  1280. </h4>
  1281. <aside class="phpdocumentor-element-found-in">
  1282. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1283. :
  1284. <span class="phpdocumentor-element-found-in__line">36</span>
  1285. </aside>
  1286. <p class="phpdocumentor-summary">Minimum QR version</p>
  1287. <code class="phpdocumentor-code phpdocumentor-signature ">
  1288. <span class="phpdocumentor-signature__visibility">protected</span>
  1289. <span class="phpdocumentor-signature__type">int</span>
  1290. <span class="phpdocumentor-signature__name">$versionMin</span>
  1291. = <span class="phpdocumentor-signature__default-value">1</span></code>
  1292. <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
  1293. </section>
  1294. <section class="phpdocumentor-description"></section>
  1295. </article>
  1296. </section>
  1297. <section class="phpdocumentor-methods">
  1298. <h3 class="phpdocumentor-elements__header" id="methods">
  1299. Methods
  1300. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1301. </h3>
  1302. <article
  1303. class="phpdocumentor-element
  1304. -method
  1305. -protected
  1306. "
  1307. >
  1308. <h4 class="phpdocumentor-element__name" id="method_set_eccLevel">
  1309. set_eccLevel()
  1310. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1311. </h4>
  1312. <aside class="phpdocumentor-element-found-in">
  1313. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1314. :
  1315. <span class="phpdocumentor-element-found-in__line">257</span>
  1316. </aside>
  1317. <p class="phpdocumentor-summary">sets the error correction level</p>
  1318. <code class="phpdocumentor-code phpdocumentor-signature ">
  1319. <span class="phpdocumentor-signature__visibility">protected</span>
  1320. <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>
  1321. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1322. <dl class="phpdocumentor-argument-list">
  1323. <dt class="phpdocumentor-argument-list__entry">
  1324. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1325. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1326. </dt>
  1327. <dd class="phpdocumentor-argument-list__definition">
  1328. <section class="phpdocumentor-description"></section>
  1329. </dd>
  1330. </dl>
  1331. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1332. Tags
  1333. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1334. </h5>
  1335. <dl class="phpdocumentor-tag-list">
  1336. <dt class="phpdocumentor-tag-list__entry">
  1337. <span class="phpdocumentor-tag__name">throws</span>
  1338. </dt>
  1339. <dd class="phpdocumentor-tag-list__definition">
  1340. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1341. </dd>
  1342. </dl>
  1343. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1344. <span class="phpdocumentor-signature__response_type">void</span>
  1345. &mdash;
  1346. </article>
  1347. <article
  1348. class="phpdocumentor-element
  1349. -method
  1350. -protected
  1351. "
  1352. >
  1353. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  1354. set_fpdfMeasureUnit()
  1355. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  1356. </h4>
  1357. <aside class="phpdocumentor-element-found-in">
  1358. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1359. :
  1360. <span class="phpdocumentor-element-found-in__line">326</span>
  1361. </aside>
  1362. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  1363. <code class="phpdocumentor-code phpdocumentor-signature ">
  1364. <span class="phpdocumentor-signature__visibility">protected</span>
  1365. <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>
  1366. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1367. <dl class="phpdocumentor-argument-list">
  1368. <dt class="phpdocumentor-argument-list__entry">
  1369. <span class="phpdocumentor-signature__argument__name">$unit</span>
  1370. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1371. </dt>
  1372. <dd class="phpdocumentor-argument-list__definition">
  1373. <section class="phpdocumentor-description"></section>
  1374. </dd>
  1375. </dl>
  1376. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1377. Tags
  1378. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1379. </h5>
  1380. <dl class="phpdocumentor-tag-list">
  1381. <dt class="phpdocumentor-tag-list__entry">
  1382. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1383. </dt>
  1384. <dd class="phpdocumentor-tag-list__definition">
  1385. </dd>
  1386. </dl>
  1387. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1388. <span class="phpdocumentor-signature__response_type">void</span>
  1389. &mdash;
  1390. </article>
  1391. <article
  1392. class="phpdocumentor-element
  1393. -method
  1394. -protected
  1395. "
  1396. >
  1397. <h4 class="phpdocumentor-element__name" id="method_set_imageTransparencyBG">
  1398. set_imageTransparencyBG()
  1399. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  1400. </h4>
  1401. <aside class="phpdocumentor-element-found-in">
  1402. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1403. :
  1404. <span class="phpdocumentor-element-found-in__line">282</span>
  1405. </aside>
  1406. <p class="phpdocumentor-summary">sets the transparency background color</p>
  1407. <code class="phpdocumentor-code phpdocumentor-signature ">
  1408. <span class="phpdocumentor-signature__visibility">protected</span>
  1409. <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>
  1410. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1411. <dl class="phpdocumentor-argument-list">
  1412. <dt class="phpdocumentor-argument-list__entry">
  1413. <span class="phpdocumentor-signature__argument__name">$imageTransparencyBG</span>
  1414. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1415. </dt>
  1416. <dd class="phpdocumentor-argument-list__definition">
  1417. <section class="phpdocumentor-description"></section>
  1418. </dd>
  1419. </dl>
  1420. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1421. Tags
  1422. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1423. </h5>
  1424. <dl class="phpdocumentor-tag-list">
  1425. <dt class="phpdocumentor-tag-list__entry">
  1426. <span class="phpdocumentor-tag__name">throws</span>
  1427. </dt>
  1428. <dd class="phpdocumentor-tag-list__definition">
  1429. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1430. </dd>
  1431. </dl>
  1432. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1433. <span class="phpdocumentor-signature__response_type">void</span>
  1434. &mdash;
  1435. </article>
  1436. <article
  1437. class="phpdocumentor-element
  1438. -method
  1439. -protected
  1440. "
  1441. >
  1442. <h4 class="phpdocumentor-element__name" id="method_set_maskPattern">
  1443. set_maskPattern()
  1444. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1445. </h4>
  1446. <aside class="phpdocumentor-element-found-in">
  1447. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1448. :
  1449. <span class="phpdocumentor-element-found-in__line">269</span>
  1450. </aside>
  1451. <p class="phpdocumentor-summary">sets/clamps the mask pattern</p>
  1452. <code class="phpdocumentor-code phpdocumentor-signature ">
  1453. <span class="phpdocumentor-signature__visibility">protected</span>
  1454. <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>
  1455. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1456. <dl class="phpdocumentor-argument-list">
  1457. <dt class="phpdocumentor-argument-list__entry">
  1458. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1459. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1460. </dt>
  1461. <dd class="phpdocumentor-argument-list__definition">
  1462. <section class="phpdocumentor-description"></section>
  1463. </dd>
  1464. </dl>
  1465. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1466. <span class="phpdocumentor-signature__response_type">void</span>
  1467. &mdash;
  1468. </article>
  1469. <article
  1470. class="phpdocumentor-element
  1471. -method
  1472. -protected
  1473. "
  1474. >
  1475. <h4 class="phpdocumentor-element__name" id="method_set_useImagickIfAvailable">
  1476. set_useImagickIfAvailable()
  1477. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_useImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1478. </h4>
  1479. <aside class="phpdocumentor-element-found-in">
  1480. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1481. :
  1482. <span class="phpdocumentor-element-found-in__line">339</span>
  1483. </aside>
  1484. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  1485. <code class="phpdocumentor-code phpdocumentor-signature ">
  1486. <span class="phpdocumentor-signature__visibility">protected</span>
  1487. <span class="phpdocumentor-signature__name">set_useImagickIfAvailable</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>
  1488. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1489. <dl class="phpdocumentor-argument-list">
  1490. <dt class="phpdocumentor-argument-list__entry">
  1491. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  1492. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1493. </dt>
  1494. <dd class="phpdocumentor-argument-list__definition">
  1495. <section class="phpdocumentor-description"></section>
  1496. </dd>
  1497. </dl>
  1498. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1499. <span class="phpdocumentor-signature__response_type">void</span>
  1500. &mdash;
  1501. </article>
  1502. <article
  1503. class="phpdocumentor-element
  1504. -method
  1505. -protected
  1506. "
  1507. >
  1508. <h4 class="phpdocumentor-element__name" id="method_set_version">
  1509. set_version()
  1510. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  1511. </h4>
  1512. <aside class="phpdocumentor-element-found-in">
  1513. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1514. :
  1515. <span class="phpdocumentor-element-found-in__line">313</span>
  1516. </aside>
  1517. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  1518. <code class="phpdocumentor-code phpdocumentor-signature ">
  1519. <span class="phpdocumentor-signature__visibility">protected</span>
  1520. <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>
  1521. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1522. <dl class="phpdocumentor-argument-list">
  1523. <dt class="phpdocumentor-argument-list__entry">
  1524. <span class="phpdocumentor-signature__argument__name">$version</span>
  1525. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1526. </dt>
  1527. <dd class="phpdocumentor-argument-list__definition">
  1528. <section class="phpdocumentor-description"></section>
  1529. </dd>
  1530. </dl>
  1531. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1532. <span class="phpdocumentor-signature__response_type">void</span>
  1533. &mdash;
  1534. </article>
  1535. <article
  1536. class="phpdocumentor-element
  1537. -method
  1538. -protected
  1539. "
  1540. >
  1541. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  1542. set_versionMax()
  1543. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  1544. </h4>
  1545. <aside class="phpdocumentor-element-found-in">
  1546. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1547. :
  1548. <span class="phpdocumentor-element-found-in__line">248</span>
  1549. </aside>
  1550. <p class="phpdocumentor-summary">sets the maximum version number</p>
  1551. <code class="phpdocumentor-code phpdocumentor-signature ">
  1552. <span class="phpdocumentor-signature__visibility">protected</span>
  1553. <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>
  1554. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1555. <dl class="phpdocumentor-argument-list">
  1556. <dt class="phpdocumentor-argument-list__entry">
  1557. <span class="phpdocumentor-signature__argument__name">$version</span>
  1558. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1559. </dt>
  1560. <dd class="phpdocumentor-argument-list__definition">
  1561. <section class="phpdocumentor-description"></section>
  1562. </dd>
  1563. </dl>
  1564. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1565. <span class="phpdocumentor-signature__response_type">void</span>
  1566. &mdash;
  1567. </article>
  1568. <article
  1569. class="phpdocumentor-element
  1570. -method
  1571. -protected
  1572. "
  1573. >
  1574. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  1575. set_versionMin()
  1576. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  1577. </h4>
  1578. <aside class="phpdocumentor-element-found-in">
  1579. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1580. :
  1581. <span class="phpdocumentor-element-found-in__line">241</span>
  1582. </aside>
  1583. <p class="phpdocumentor-summary">sets the minimum version number</p>
  1584. <code class="phpdocumentor-code phpdocumentor-signature ">
  1585. <span class="phpdocumentor-signature__visibility">protected</span>
  1586. <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>
  1587. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1588. <dl class="phpdocumentor-argument-list">
  1589. <dt class="phpdocumentor-argument-list__entry">
  1590. <span class="phpdocumentor-signature__argument__name">$version</span>
  1591. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1592. </dt>
  1593. <dd class="phpdocumentor-argument-list__definition">
  1594. <section class="phpdocumentor-description"></section>
  1595. </dd>
  1596. </dl>
  1597. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1598. <span class="phpdocumentor-signature__response_type">void</span>
  1599. &mdash;
  1600. </article>
  1601. <article
  1602. class="phpdocumentor-element
  1603. -method
  1604. -protected
  1605. "
  1606. >
  1607. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  1608. setMinMaxVersion()
  1609. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  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">230</span>
  1615. </aside>
  1616. <p class="phpdocumentor-summary">clamp min/max version number</p>
  1617. <code class="phpdocumentor-code phpdocumentor-signature ">
  1618. <span class="phpdocumentor-signature__visibility">protected</span>
  1619. <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>
  1620. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1621. <dl class="phpdocumentor-argument-list">
  1622. <dt class="phpdocumentor-argument-list__entry">
  1623. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  1624. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1625. </dt>
  1626. <dd class="phpdocumentor-argument-list__definition">
  1627. <section class="phpdocumentor-description"></section>
  1628. </dd>
  1629. <dt class="phpdocumentor-argument-list__entry">
  1630. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  1631. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1632. </dt>
  1633. <dd class="phpdocumentor-argument-list__definition">
  1634. <section class="phpdocumentor-description"></section>
  1635. </dd>
  1636. </dl>
  1637. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1638. <span class="phpdocumentor-signature__response_type">void</span>
  1639. &mdash;
  1640. </article>
  1641. </section>
  1642. <script type="text/javascript">
  1643. function loadExternalCodeSnippets(line) {
  1644. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1645. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1646. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1647. var language = 'php';
  1648. var code = document.createElement('code');
  1649. code.className = 'language-' + language;
  1650. pre.textContent = '';
  1651. pre.setAttribute('data-line', line)
  1652. code.textContent = 'Loading…';
  1653. pre.appendChild(code);
  1654. var xhr = new XMLHttpRequest();
  1655. xhr.open('GET', src, true);
  1656. xhr.onreadystatechange = function () {
  1657. if (xhr.readyState == 4) {
  1658. if (xhr.status < 400 && xhr.responseText) {
  1659. code.textContent = xhr.responseText;
  1660. Prism.highlightElement(code);
  1661. }
  1662. else if (xhr.status >= 400) {
  1663. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1664. }
  1665. else {
  1666. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1667. }
  1668. }
  1669. };
  1670. xhr.send(null);
  1671. });
  1672. }
  1673. var modals = document.querySelectorAll("[data-modal]");
  1674. modals.forEach(function (trigger) {
  1675. trigger.addEventListener("click", function (event) {
  1676. //event.preventDefault();
  1677. const modal = document.getElementById(trigger.dataset.modal);
  1678. modal.classList.add("phpdocumentor-modal__open");
  1679. loadExternalCodeSnippets(trigger.dataset.line)
  1680. const exits = modal.querySelectorAll("[data-exit-button]");
  1681. exits.forEach(function (exit) {
  1682. exit.addEventListener("click", function (event) {
  1683. event.preventDefault();
  1684. modal.classList.remove("phpdocumentor-modal__open");
  1685. });
  1686. });
  1687. });
  1688. });
  1689. </script>
  1690. </article>
  1691. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1692. <section class="phpdocumentor-search-results__dialog">
  1693. <header class="phpdocumentor-search-results__header">
  1694. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1695. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1696. </header>
  1697. <section class="phpdocumentor-search-results__body">
  1698. <ul class="phpdocumentor-search-results__entries"></ul>
  1699. </section>
  1700. </section>
  1701. </section>
  1702. </div>
  1703. </div>
  1704. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1705. </main>
  1706. <script>
  1707. cssVars({});
  1708. </script>
  1709. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1710. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1711. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1712. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1713. </body>
  1714. </html>