chillerlan-QRCode-QROptionsTrait.html 97 KB

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