chillerlan-QRCode-QROptionsTrait.html 119 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700
  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_readerGrayscale">$readerGrayscale</a>
  222. <span>
  223. &nbsp;: bool </span>
  224. </dt>
  225. <dd>grayscale the image before reading</dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  227. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  228. <span>
  229. &nbsp;: bool </span>
  230. </dt>
  231. <dd>increase the contrast before reading</dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  233. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  234. <span>
  235. &nbsp;: bool </span>
  236. </dt>
  237. <dd>use Imaagick (if available) when reading QR Codes</dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  239. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
  240. <span>
  241. &nbsp;: bool </span>
  242. </dt>
  243. <dd>Return the image resource instead of a render if applicable.</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  245. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
  246. <span>
  247. &nbsp;: int </span>
  248. </dt>
  249. <dd>size of a QR code pixel [SVG, IMAGE_*], HTML via CSS</dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  251. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgCircleRadius">$svgCircleRadius</a>
  252. <span>
  253. &nbsp;: float </span>
  254. </dt>
  255. <dd>specifies the radius of the modules when $svgDrawCircularModules is set to true</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  257. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgConnectPaths">$svgConnectPaths</a>
  258. <span>
  259. &nbsp;: bool </span>
  260. </dt>
  261. <dd>whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  263. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
  264. <span>
  265. &nbsp;: string </span>
  266. </dt>
  267. <dd>anything between &lt;defs&gt;</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  269. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDrawCircularModules">$svgDrawCircularModules</a>
  270. <span>
  271. &nbsp;: bool </span>
  272. </dt>
  273. <dd>specify whether to draw the modules as filled circles</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  275. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgExcludeFromConnect">$svgExcludeFromConnect</a>
  276. <span>
  277. &nbsp;: array&lt;string|int, mixed&gt; </span>
  278. </dt>
  279. <dd>specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  281. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a>
  282. <span>
  283. &nbsp;: string|null </span>
  284. </dt>
  285. <dd>optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  287. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgKeepAsSquare">$svgKeepAsSquare</a>
  288. <span>
  289. &nbsp;: array&lt;string|int, mixed&gt; </span>
  290. </dt>
  291. <dd>specifies which module types to exclude when $svgDrawCircularModules is set to true</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  293. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
  294. <span>
  295. &nbsp;: float </span>
  296. </dt>
  297. <dd>SVG opacity</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  299. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
  300. <span>
  301. &nbsp;: string </span>
  302. </dt>
  303. <dd></dd>
  304. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  305. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
  306. <span>
  307. &nbsp;: int|null </span>
  308. </dt>
  309. <dd>SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</dd>
  310. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  311. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a>
  312. <span>
  313. &nbsp;: string|null </span>
  314. </dt>
  315. <dd>optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</dd>
  316. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  317. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
  318. <span>
  319. &nbsp;: string </span>
  320. </dt>
  321. <dd>string substitute for dark</dd>
  322. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  323. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
  324. <span>
  325. &nbsp;: string </span>
  326. </dt>
  327. <dd>string substitute for light</dd>
  328. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  329. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
  330. <span>
  331. &nbsp;: int </span>
  332. </dt>
  333. <dd>QR Code version number</dd>
  334. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  335. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
  336. <span>
  337. &nbsp;: int </span>
  338. </dt>
  339. <dd>Maximum QR version</dd>
  340. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  341. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
  342. <span>
  343. &nbsp;: int </span>
  344. </dt>
  345. <dd>Minimum QR version</dd>
  346. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  347. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_getLuminanceSourceFQCN">getLuminanceSourceFQCN()</a>
  348. <span>
  349. &nbsp;: string </span>
  350. </dt>
  351. <dd>returns the FQCN of the luminance source class to use in the reader (GD or Imagick)</dd>
  352. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  353. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel">set_eccLevel()</a>
  354. <span>
  355. &nbsp;: void </span>
  356. </dt>
  357. <dd>sets the error correction level</dd>
  358. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  359. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
  360. <span>
  361. &nbsp;: void </span>
  362. </dt>
  363. <dd>sets the FPDF measurement unit</dd>
  364. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  365. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a>
  366. <span>
  367. &nbsp;: void </span>
  368. </dt>
  369. <dd>sets the transparency background color</dd>
  370. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  371. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_maskPattern">set_maskPattern()</a>
  372. <span>
  373. &nbsp;: void </span>
  374. </dt>
  375. <dd>sets/clamps the mask pattern</dd>
  376. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  377. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_useImagickIfAvailable">set_useImagickIfAvailable()</a>
  378. <span>
  379. &nbsp;: void </span>
  380. </dt>
  381. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  382. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  383. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
  384. <span>
  385. &nbsp;: void </span>
  386. </dt>
  387. <dd>sets/clamps the version number</dd>
  388. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  389. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
  390. <span>
  391. &nbsp;: void </span>
  392. </dt>
  393. <dd>sets the maximum version number</dd>
  394. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  395. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
  396. <span>
  397. &nbsp;: void </span>
  398. </dt>
  399. <dd>sets the minimum version number</dd>
  400. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  401. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
  402. <span>
  403. &nbsp;: void </span>
  404. </dt>
  405. <dd>clamp min/max version number</dd>
  406. </dl>
  407. <section class="phpdocumentor-properties">
  408. <h3 class="phpdocumentor-elements__header" id="properties">
  409. Properties
  410. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  411. </h3>
  412. <article
  413. class="
  414. phpdocumentor-element
  415. -property
  416. -protected
  417. "
  418. >
  419. <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
  420. $addQuietzone
  421. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
  422. <span class="phpdocumentor-element__modifiers">
  423. </span>
  424. </h4>
  425. <aside class="phpdocumentor-element-found-in">
  426. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  427. :
  428. <span class="phpdocumentor-element-found-in__line">66</span>
  429. </aside>
  430. <p class="phpdocumentor-summary">Add a &quot;quiet zone&quot; (margin) according to the QR code spec</p>
  431. <code class="phpdocumentor-code phpdocumentor-signature ">
  432. <span class="phpdocumentor-signature__visibility">protected</span>
  433. <span class="phpdocumentor-signature__type">bool</span>
  434. <span class="phpdocumentor-signature__name">$addQuietzone</span>
  435. = <span class="phpdocumentor-signature__default-value">true</span></code>
  436. <section class="phpdocumentor-description"></section>
  437. </article>
  438. <article
  439. class="
  440. phpdocumentor-element
  441. -property
  442. -protected
  443. "
  444. >
  445. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  446. $cachefile
  447. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  448. <span class="phpdocumentor-element__modifiers">
  449. </span>
  450. </h4>
  451. <aside class="phpdocumentor-element-found-in">
  452. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  453. :
  454. <span class="phpdocumentor-element-found-in__line">93</span>
  455. </aside>
  456. <p class="phpdocumentor-summary">/path/to/cache.file</p>
  457. <code class="phpdocumentor-code phpdocumentor-signature ">
  458. <span class="phpdocumentor-signature__visibility">protected</span>
  459. <span class="phpdocumentor-signature__type">string|null</span>
  460. <span class="phpdocumentor-signature__name">$cachefile</span>
  461. = <span class="phpdocumentor-signature__default-value">null</span></code>
  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_cssClass">
  472. $cssClass
  473. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" 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">108</span>
  481. </aside>
  482. <p class="phpdocumentor-summary">a common css class</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">$cssClass</span>
  487. = <span class="phpdocumentor-signature__default-value">&#039;qrcode&#039;</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_eccLevel">
  498. $eccLevel
  499. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" 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">54</span>
  507. </aside>
  508. <p class="phpdocumentor-summary">Error correct level</p>
  509. <code class="phpdocumentor-code phpdocumentor-signature ">
  510. <span class="phpdocumentor-signature__visibility">protected</span>
  511. <span class="phpdocumentor-signature__type">int</span>
  512. <span class="phpdocumentor-signature__name">$eccLevel</span>
  513. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeCommonEccLevel::L</span></code>
  514. <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
  515. <ul>
  516. <li>L =&gt; 7%</li>
  517. <li>M =&gt; 15%</li>
  518. <li>Q =&gt; 25%</li>
  519. <li>H =&gt; 30%</li>
  520. </ul>
  521. </section>
  522. <section class="phpdocumentor-description"></section>
  523. </article>
  524. <article
  525. class="
  526. phpdocumentor-element
  527. -property
  528. -protected
  529. "
  530. >
  531. <h4 class="phpdocumentor-element__name" id="property_eol">
  532. $eol
  533. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  534. <span class="phpdocumentor-element__modifiers">
  535. </span>
  536. </h4>
  537. <aside class="phpdocumentor-element-found-in">
  538. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  539. :
  540. <span class="phpdocumentor-element-found-in__line">98</span>
  541. </aside>
  542. <p class="phpdocumentor-summary">newline string [HTML, SVG, TEXT]</p>
  543. <code class="phpdocumentor-code phpdocumentor-signature ">
  544. <span class="phpdocumentor-signature__visibility">protected</span>
  545. <span class="phpdocumentor-signature__type">string</span>
  546. <span class="phpdocumentor-signature__name">$eol</span>
  547. = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
  548. <section class="phpdocumentor-description"></section>
  549. </article>
  550. <article
  551. class="
  552. phpdocumentor-element
  553. -property
  554. -protected
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  558. $fpdfMeasureUnit
  559. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  560. <span class="phpdocumentor-element__modifiers">
  561. </span>
  562. </h4>
  563. <aside class="phpdocumentor-element-found-in">
  564. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  565. :
  566. <span class="phpdocumentor-element-found-in__line">260</span>
  567. </aside>
  568. <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</p>
  569. <code class="phpdocumentor-code phpdocumentor-signature ">
  570. <span class="phpdocumentor-signature__visibility">protected</span>
  571. <span class="phpdocumentor-signature__type">string</span>
  572. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  573. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  574. <section class="phpdocumentor-description"></section>
  575. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  576. Tags
  577. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h5>
  579. <dl class="phpdocumentor-tag-list">
  580. <dt class="phpdocumentor-tag-list__entry">
  581. <span class="phpdocumentor-tag__name">see</span>
  582. </dt>
  583. <dd class="phpdocumentor-tag-list__definition">
  584. <span class="phpdocumentor-tag-link"><abbr title="\FPDF::__construct()">FPDF::__construct()</abbr></span>
  585. </dd>
  586. </dl>
  587. </article>
  588. <article
  589. class="
  590. phpdocumentor-element
  591. -property
  592. -protected
  593. "
  594. >
  595. <h4 class="phpdocumentor-element__name" id="property_imageBase64">
  596. $imageBase64
  597. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  598. <span class="phpdocumentor-element__modifiers">
  599. </span>
  600. </h4>
  601. <aside class="phpdocumentor-element-found-in">
  602. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  603. :
  604. <span class="phpdocumentor-element-found-in__line">217</span>
  605. </aside>
  606. <p class="phpdocumentor-summary">toggle base64 or raw image data</p>
  607. <code class="phpdocumentor-code phpdocumentor-signature ">
  608. <span class="phpdocumentor-signature__visibility">protected</span>
  609. <span class="phpdocumentor-signature__type">bool</span>
  610. <span class="phpdocumentor-signature__name">$imageBase64</span>
  611. = <span class="phpdocumentor-signature__default-value">true</span></code>
  612. <section class="phpdocumentor-description"></section>
  613. </article>
  614. <article
  615. class="
  616. phpdocumentor-element
  617. -property
  618. -protected
  619. "
  620. >
  621. <h4 class="phpdocumentor-element__name" id="property_imageTransparencyBG">
  622. $imageTransparencyBG
  623. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  624. <span class="phpdocumentor-element__modifiers">
  625. </span>
  626. </h4>
  627. <aside class="phpdocumentor-element-found-in">
  628. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  629. :
  630. <span class="phpdocumentor-element-found-in__line">229</span>
  631. </aside>
  632. <code class="phpdocumentor-code phpdocumentor-signature ">
  633. <span class="phpdocumentor-signature__visibility">protected</span>
  634. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  635. <span class="phpdocumentor-signature__name">$imageTransparencyBG</span>
  636. = <span class="phpdocumentor-signature__default-value">[255, 255, 255]</span></code>
  637. <section class="phpdocumentor-description"></section>
  638. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  639. Tags
  640. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  641. </h5>
  642. <dl class="phpdocumentor-tag-list">
  643. <dt class="phpdocumentor-tag-list__entry">
  644. <span class="phpdocumentor-tag__name">see</span>
  645. </dt>
  646. <dd class="phpdocumentor-tag-list__definition">
  647. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr></span>
  648. <section class="phpdocumentor-description"><p>[R, G, B]</p>
  649. </section>
  650. </dd>
  651. </dl>
  652. </article>
  653. <article
  654. class="
  655. phpdocumentor-element
  656. -property
  657. -protected
  658. "
  659. >
  660. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  661. $imageTransparent
  662. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  663. <span class="phpdocumentor-element__modifiers">
  664. </span>
  665. </h4>
  666. <aside class="phpdocumentor-element-found-in">
  667. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  668. :
  669. <span class="phpdocumentor-element-found-in__line">222</span>
  670. </aside>
  671. <p class="phpdocumentor-summary">toggle transparency, not supported by jpg</p>
  672. <code class="phpdocumentor-code phpdocumentor-signature ">
  673. <span class="phpdocumentor-signature__visibility">protected</span>
  674. <span class="phpdocumentor-signature__type">bool</span>
  675. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  676. = <span class="phpdocumentor-signature__default-value">true</span></code>
  677. <section class="phpdocumentor-description"></section>
  678. </article>
  679. <article
  680. class="
  681. phpdocumentor-element
  682. -property
  683. -protected
  684. "
  685. >
  686. <h4 class="phpdocumentor-element__name" id="property_imagickBG">
  687. $imagickBG
  688. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  689. <span class="phpdocumentor-element__modifiers">
  690. </span>
  691. </h4>
  692. <aside class="phpdocumentor-element-found-in">
  693. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  694. :
  695. <span class="phpdocumentor-element-found-in__line">253</span>
  696. </aside>
  697. <p class="phpdocumentor-summary">Imagick background color (defaults to &quot;transparent&quot;)</p>
  698. <code class="phpdocumentor-code phpdocumentor-signature ">
  699. <span class="phpdocumentor-signature__visibility">protected</span>
  700. <span class="phpdocumentor-signature__type">string|null</span>
  701. <span class="phpdocumentor-signature__name">$imagickBG</span>
  702. = <span class="phpdocumentor-signature__default-value">null</span></code>
  703. <section class="phpdocumentor-description"></section>
  704. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  705. Tags
  706. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  707. </h5>
  708. <dl class="phpdocumentor-tag-list">
  709. <dt class="phpdocumentor-tag-list__entry">
  710. <span class="phpdocumentor-tag__name">see</span>
  711. </dt>
  712. <dd class="phpdocumentor-tag-list__definition">
  713. <span class="phpdocumentor-tag-link"><abbr title="\ImagickPixel::__construct()">ImagickPixel::__construct()</abbr></span>
  714. </dd>
  715. </dl>
  716. </article>
  717. <article
  718. class="
  719. phpdocumentor-element
  720. -property
  721. -protected
  722. "
  723. >
  724. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  725. $imagickFormat
  726. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  727. <span class="phpdocumentor-element__modifiers">
  728. </span>
  729. </h4>
  730. <aside class="phpdocumentor-element-found-in">
  731. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  732. :
  733. <span class="phpdocumentor-element-found-in__line">246</span>
  734. </aside>
  735. <p class="phpdocumentor-summary">Imagick output format</p>
  736. <code class="phpdocumentor-code phpdocumentor-signature ">
  737. <span class="phpdocumentor-signature__visibility">protected</span>
  738. <span class="phpdocumentor-signature__type">string</span>
  739. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  740. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span></code>
  741. <section class="phpdocumentor-description"></section>
  742. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  743. Tags
  744. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  745. </h5>
  746. <dl class="phpdocumentor-tag-list">
  747. <dt class="phpdocumentor-tag-list__entry">
  748. <span class="phpdocumentor-tag__name">see</span>
  749. </dt>
  750. <dd class="phpdocumentor-tag-list__definition">
  751. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setType()">Imagick::setType()</abbr></span>
  752. </dd>
  753. </dl>
  754. </article>
  755. <article
  756. class="
  757. phpdocumentor-element
  758. -property
  759. -protected
  760. "
  761. >
  762. <h4 class="phpdocumentor-element__name" id="property_jpegQuality">
  763. $jpegQuality
  764. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  765. <span class="phpdocumentor-element__modifiers">
  766. </span>
  767. </h4>
  768. <aside class="phpdocumentor-element-found-in">
  769. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  770. :
  771. <span class="phpdocumentor-element-found-in__line">239</span>
  772. </aside>
  773. <code class="phpdocumentor-code phpdocumentor-signature ">
  774. <span class="phpdocumentor-signature__visibility">protected</span>
  775. <span class="phpdocumentor-signature__type">int</span>
  776. <span class="phpdocumentor-signature__name">$jpegQuality</span>
  777. = <span class="phpdocumentor-signature__default-value">85</span></code>
  778. <section class="phpdocumentor-description"></section>
  779. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  780. Tags
  781. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  782. </h5>
  783. <dl class="phpdocumentor-tag-list">
  784. <dt class="phpdocumentor-tag-list__entry">
  785. <span class="phpdocumentor-tag__name">see</span>
  786. </dt>
  787. <dd class="phpdocumentor-tag-list__definition">
  788. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagejpeg()">imagejpeg()</abbr></span>
  789. </dd>
  790. </dl>
  791. </article>
  792. <article
  793. class="
  794. phpdocumentor-element
  795. -property
  796. -protected
  797. "
  798. >
  799. <h4 class="phpdocumentor-element__name" id="property_markupDark">
  800. $markupDark
  801. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" class="headerlink"><i class="fas fa-link"></i></a>
  802. <span class="phpdocumentor-element__modifiers">
  803. </span>
  804. </h4>
  805. <aside class="phpdocumentor-element-found-in">
  806. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  807. :
  808. <span class="phpdocumentor-element-found-in__line">191</span>
  809. </aside>
  810. <p class="phpdocumentor-summary">markup substitute for dark (CSS value)</p>
  811. <code class="phpdocumentor-code phpdocumentor-signature ">
  812. <span class="phpdocumentor-signature__visibility">protected</span>
  813. <span class="phpdocumentor-signature__type">string</span>
  814. <span class="phpdocumentor-signature__name">$markupDark</span>
  815. = <span class="phpdocumentor-signature__default-value">&#039;#000&#039;</span></code>
  816. <section class="phpdocumentor-description"></section>
  817. </article>
  818. <article
  819. class="
  820. phpdocumentor-element
  821. -property
  822. -protected
  823. "
  824. >
  825. <h4 class="phpdocumentor-element__name" id="property_markupLight">
  826. $markupLight
  827. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" class="headerlink"><i class="fas fa-link"></i></a>
  828. <span class="phpdocumentor-element__modifiers">
  829. </span>
  830. </h4>
  831. <aside class="phpdocumentor-element-found-in">
  832. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  833. :
  834. <span class="phpdocumentor-element-found-in__line">196</span>
  835. </aside>
  836. <p class="phpdocumentor-summary">markup substitute for light (CSS value)</p>
  837. <code class="phpdocumentor-code phpdocumentor-signature ">
  838. <span class="phpdocumentor-signature__visibility">protected</span>
  839. <span class="phpdocumentor-signature__type">string</span>
  840. <span class="phpdocumentor-signature__name">$markupLight</span>
  841. = <span class="phpdocumentor-signature__default-value">&#039;#fff&#039;</span></code>
  842. <section class="phpdocumentor-description"></section>
  843. </article>
  844. <article
  845. class="
  846. phpdocumentor-element
  847. -property
  848. -protected
  849. "
  850. >
  851. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  852. $maskPattern
  853. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  854. <span class="phpdocumentor-element__modifiers">
  855. </span>
  856. </h4>
  857. <aside class="phpdocumentor-element-found-in">
  858. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  859. :
  860. <span class="phpdocumentor-element-found-in__line">61</span>
  861. </aside>
  862. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  863. <code class="phpdocumentor-code phpdocumentor-signature ">
  864. <span class="phpdocumentor-signature__visibility">protected</span>
  865. <span class="phpdocumentor-signature__type">int</span>
  866. <span class="phpdocumentor-signature__name">$maskPattern</span>
  867. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::MASK_PATTERN_AUTO</span></code>
  868. <section class="phpdocumentor-description"><p>[0...7] or QRCode::MASK_PATTERN_AUTO</p>
  869. </section>
  870. <section class="phpdocumentor-description"></section>
  871. </article>
  872. <article
  873. class="
  874. phpdocumentor-element
  875. -property
  876. -protected
  877. "
  878. >
  879. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  880. $moduleValues
  881. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  882. <span class="phpdocumentor-element__modifiers">
  883. </span>
  884. </h4>
  885. <aside class="phpdocumentor-element-found-in">
  886. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  887. :
  888. <span class="phpdocumentor-element-found-in__line">268</span>
  889. </aside>
  890. <p class="phpdocumentor-summary">Module values map</p>
  891. <code class="phpdocumentor-code phpdocumentor-signature ">
  892. <span class="phpdocumentor-signature__visibility">protected</span>
  893. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  894. <span class="phpdocumentor-signature__name">$moduleValues</span>
  895. = <span class="phpdocumentor-signature__default-value">null</span></code>
  896. <section class="phpdocumentor-description"><ul>
  897. <li>HTML, IMAGICK: #ABCDEF, cssname, rgb(), rgba()...</li>
  898. <li>IMAGE: [63, 127, 255] // R, G, B</li>
  899. </ul>
  900. </section>
  901. <section class="phpdocumentor-description"></section>
  902. </article>
  903. <article
  904. class="
  905. phpdocumentor-element
  906. -property
  907. -protected
  908. "
  909. >
  910. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  911. $outputInterface
  912. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  913. <span class="phpdocumentor-element__modifiers">
  914. </span>
  915. </h4>
  916. <aside class="phpdocumentor-element-found-in">
  917. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  918. :
  919. <span class="phpdocumentor-element-found-in__line">88</span>
  920. </aside>
  921. <p class="phpdocumentor-summary">the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
  922. <code class="phpdocumentor-code phpdocumentor-signature ">
  923. <span class="phpdocumentor-signature__visibility">protected</span>
  924. <span class="phpdocumentor-signature__type">string|null</span>
  925. <span class="phpdocumentor-signature__name">$outputInterface</span>
  926. = <span class="phpdocumentor-signature__default-value">null</span></code>
  927. <section class="phpdocumentor-description"></section>
  928. </article>
  929. <article
  930. class="
  931. phpdocumentor-element
  932. -property
  933. -protected
  934. "
  935. >
  936. <h4 class="phpdocumentor-element__name" id="property_outputType">
  937. $outputType
  938. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" class="headerlink"><i class="fas fa-link"></i></a>
  939. <span class="phpdocumentor-element__modifiers">
  940. </span>
  941. </h4>
  942. <aside class="phpdocumentor-element-found-in">
  943. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  944. :
  945. <span class="phpdocumentor-element-found-in__line">83</span>
  946. </aside>
  947. <p class="phpdocumentor-summary">The output type</p>
  948. <code class="phpdocumentor-code phpdocumentor-signature ">
  949. <span class="phpdocumentor-signature__visibility">protected</span>
  950. <span class="phpdocumentor-signature__type">string</span>
  951. <span class="phpdocumentor-signature__name">$outputType</span>
  952. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::OUTPUT_MARKUP_SVG</span></code>
  953. <section class="phpdocumentor-description"><ul>
  954. <li>QRCode::OUTPUT_MARKUP_XXXX where XXXX = HTML, SVG</li>
  955. <li>QRCode::OUTPUT_IMAGE_XXX where XXX = PNG, GIF, JPG</li>
  956. <li>QRCode::OUTPUT_STRING_XXXX where XXXX = TEXT, JSON</li>
  957. <li>QRCode::OUTPUT_CUSTOM</li>
  958. </ul>
  959. </section>
  960. <section class="phpdocumentor-description"></section>
  961. </article>
  962. <article
  963. class="
  964. phpdocumentor-element
  965. -property
  966. -protected
  967. "
  968. >
  969. <h4 class="phpdocumentor-element__name" id="property_pngCompression">
  970. $pngCompression
  971. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  972. <span class="phpdocumentor-element__modifiers">
  973. </span>
  974. </h4>
  975. <aside class="phpdocumentor-element-found-in">
  976. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  977. :
  978. <span class="phpdocumentor-element-found-in__line">234</span>
  979. </aside>
  980. <code class="phpdocumentor-code phpdocumentor-signature ">
  981. <span class="phpdocumentor-signature__visibility">protected</span>
  982. <span class="phpdocumentor-signature__type">int</span>
  983. <span class="phpdocumentor-signature__name">$pngCompression</span>
  984. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  985. <section class="phpdocumentor-description"></section>
  986. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  987. Tags
  988. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  989. </h5>
  990. <dl class="phpdocumentor-tag-list">
  991. <dt class="phpdocumentor-tag-list__entry">
  992. <span class="phpdocumentor-tag__name">see</span>
  993. </dt>
  994. <dd class="phpdocumentor-tag-list__definition">
  995. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagepng()">imagepng()</abbr></span>
  996. </dd>
  997. </dl>
  998. </article>
  999. <article
  1000. class="
  1001. phpdocumentor-element
  1002. -property
  1003. -protected
  1004. "
  1005. >
  1006. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  1007. $quietzoneSize
  1008. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  1009. <span class="phpdocumentor-element__modifiers">
  1010. </span>
  1011. </h4>
  1012. <aside class="phpdocumentor-element-found-in">
  1013. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1014. :
  1015. <span class="phpdocumentor-element-found-in__line">73</span>
  1016. </aside>
  1017. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  1018. <code class="phpdocumentor-code phpdocumentor-signature ">
  1019. <span class="phpdocumentor-signature__visibility">protected</span>
  1020. <span class="phpdocumentor-signature__type">int</span>
  1021. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  1022. = <span class="phpdocumentor-signature__default-value">4</span></code>
  1023. <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
  1024. </section>
  1025. <section class="phpdocumentor-description"></section>
  1026. </article>
  1027. <article
  1028. class="
  1029. phpdocumentor-element
  1030. -property
  1031. -protected
  1032. "
  1033. >
  1034. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  1035. $readerGrayscale
  1036. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  1037. <span class="phpdocumentor-element__modifiers">
  1038. </span>
  1039. </h4>
  1040. <aside class="phpdocumentor-element-found-in">
  1041. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1042. :
  1043. <span class="phpdocumentor-element-found-in__line">278</span>
  1044. </aside>
  1045. <p class="phpdocumentor-summary">grayscale the image before reading</p>
  1046. <code class="phpdocumentor-code phpdocumentor-signature ">
  1047. <span class="phpdocumentor-signature__visibility">protected</span>
  1048. <span class="phpdocumentor-signature__type">bool</span>
  1049. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  1050. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1051. <section class="phpdocumentor-description"></section>
  1052. </article>
  1053. <article
  1054. class="
  1055. phpdocumentor-element
  1056. -property
  1057. -protected
  1058. "
  1059. >
  1060. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  1061. $readerIncreaseContrast
  1062. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  1063. <span class="phpdocumentor-element__modifiers">
  1064. </span>
  1065. </h4>
  1066. <aside class="phpdocumentor-element-found-in">
  1067. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1068. :
  1069. <span class="phpdocumentor-element-found-in__line">285</span>
  1070. </aside>
  1071. <p class="phpdocumentor-summary">increase the contrast before reading</p>
  1072. <code class="phpdocumentor-code phpdocumentor-signature ">
  1073. <span class="phpdocumentor-signature__visibility">protected</span>
  1074. <span class="phpdocumentor-signature__type">bool</span>
  1075. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  1076. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1077. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  1078. </section>
  1079. <section class="phpdocumentor-description"></section>
  1080. </article>
  1081. <article
  1082. class="
  1083. phpdocumentor-element
  1084. -property
  1085. -protected
  1086. "
  1087. >
  1088. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  1089. $readerUseImagickIfAvailable
  1090. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1091. <span class="phpdocumentor-element__modifiers">
  1092. </span>
  1093. </h4>
  1094. <aside class="phpdocumentor-element-found-in">
  1095. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1096. :
  1097. <span class="phpdocumentor-element-found-in__line">273</span>
  1098. </aside>
  1099. <p class="phpdocumentor-summary">use Imaagick (if available) when reading QR Codes</p>
  1100. <code class="phpdocumentor-code phpdocumentor-signature ">
  1101. <span class="phpdocumentor-signature__visibility">protected</span>
  1102. <span class="phpdocumentor-signature__type">bool</span>
  1103. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  1104. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1105. <section class="phpdocumentor-description"></section>
  1106. </article>
  1107. <article
  1108. class="
  1109. phpdocumentor-element
  1110. -property
  1111. -protected
  1112. "
  1113. >
  1114. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  1115. $returnResource
  1116. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  1117. <span class="phpdocumentor-element__modifiers">
  1118. </span>
  1119. </h4>
  1120. <aside class="phpdocumentor-element-found-in">
  1121. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1122. :
  1123. <span class="phpdocumentor-element-found-in__line">212</span>
  1124. </aside>
  1125. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  1126. <code class="phpdocumentor-code phpdocumentor-signature ">
  1127. <span class="phpdocumentor-signature__visibility">protected</span>
  1128. <span class="phpdocumentor-signature__type">bool</span>
  1129. <span class="phpdocumentor-signature__name">$returnResource</span>
  1130. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1131. <section class="phpdocumentor-description"><p>This option overrides other output options, such as $cachefile and $imageBase64.</p>
  1132. <p>Supported by the following modules:</p>
  1133. <ul>
  1134. <li>QRImage: resource (PHP &lt; 8), GdImage</li>
  1135. <li>QRImagick: Imagick</li>
  1136. <li>QRFpdf: FPDF</li>
  1137. </ul>
  1138. </section>
  1139. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1140. Tags
  1141. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1142. </h5>
  1143. <dl class="phpdocumentor-tag-list">
  1144. <dt class="phpdocumentor-tag-list__entry">
  1145. <span class="phpdocumentor-tag__name">see</span>
  1146. </dt>
  1147. <dd class="phpdocumentor-tag-list__definition">
  1148. <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>
  1149. </dd>
  1150. </dl>
  1151. </article>
  1152. <article
  1153. class="
  1154. phpdocumentor-element
  1155. -property
  1156. -protected
  1157. "
  1158. >
  1159. <h4 class="phpdocumentor-element__name" id="property_scale">
  1160. $scale
  1161. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  1162. <span class="phpdocumentor-element__modifiers">
  1163. </span>
  1164. </h4>
  1165. <aside class="phpdocumentor-element-found-in">
  1166. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1167. :
  1168. <span class="phpdocumentor-element-found-in__line">103</span>
  1169. </aside>
  1170. <p class="phpdocumentor-summary">size of a QR code pixel [SVG, IMAGE_*], HTML via CSS</p>
  1171. <code class="phpdocumentor-code phpdocumentor-signature ">
  1172. <span class="phpdocumentor-signature__visibility">protected</span>
  1173. <span class="phpdocumentor-signature__type">int</span>
  1174. <span class="phpdocumentor-signature__name">$scale</span>
  1175. = <span class="phpdocumentor-signature__default-value">5</span></code>
  1176. <section class="phpdocumentor-description"></section>
  1177. </article>
  1178. <article
  1179. class="
  1180. phpdocumentor-element
  1181. -property
  1182. -protected
  1183. "
  1184. >
  1185. <h4 class="phpdocumentor-element__name" id="property_svgCircleRadius">
  1186. $svgCircleRadius
  1187. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgCircleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  1188. <span class="phpdocumentor-element__modifiers">
  1189. </span>
  1190. </h4>
  1191. <aside class="phpdocumentor-element-found-in">
  1192. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1193. :
  1194. <span class="phpdocumentor-element-found-in__line">171</span>
  1195. </aside>
  1196. <p class="phpdocumentor-summary">specifies the radius of the modules when $svgDrawCircularModules is set to true</p>
  1197. <code class="phpdocumentor-code phpdocumentor-signature ">
  1198. <span class="phpdocumentor-signature__visibility">protected</span>
  1199. <span class="phpdocumentor-signature__type">float</span>
  1200. <span class="phpdocumentor-signature__name">$svgCircleRadius</span>
  1201. = <span class="phpdocumentor-signature__default-value">0.45</span></code>
  1202. <section class="phpdocumentor-description"></section>
  1203. </article>
  1204. <article
  1205. class="
  1206. phpdocumentor-element
  1207. -property
  1208. -protected
  1209. "
  1210. >
  1211. <h4 class="phpdocumentor-element__name" id="property_svgConnectPaths">
  1212. $svgConnectPaths
  1213. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgConnectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  1214. <span class="phpdocumentor-element__modifiers">
  1215. </span>
  1216. </h4>
  1217. <aside class="phpdocumentor-element-found-in">
  1218. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1219. :
  1220. <span class="phpdocumentor-element-found-in__line">156</span>
  1221. </aside>
  1222. <p class="phpdocumentor-summary">whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
  1223. <code class="phpdocumentor-code phpdocumentor-signature ">
  1224. <span class="phpdocumentor-signature__visibility">protected</span>
  1225. <span class="phpdocumentor-signature__type">bool</span>
  1226. <span class="phpdocumentor-signature__name">$svgConnectPaths</span>
  1227. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1228. <section class="phpdocumentor-description"></section>
  1229. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1230. Tags
  1231. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1232. </h5>
  1233. <dl class="phpdocumentor-tag-list">
  1234. <dt class="phpdocumentor-tag-list__entry">
  1235. <span class="phpdocumentor-tag__name">see</span>
  1236. </dt>
  1237. <dd class="phpdocumentor-tag-list__definition">
  1238. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57"><abbr title="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</abbr></a></span>
  1239. </dd>
  1240. </dl>
  1241. </article>
  1242. <article
  1243. class="
  1244. phpdocumentor-element
  1245. -property
  1246. -protected
  1247. "
  1248. >
  1249. <h4 class="phpdocumentor-element__name" id="property_svgDefs">
  1250. $svgDefs
  1251. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
  1252. <span class="phpdocumentor-element__modifiers">
  1253. </span>
  1254. </h4>
  1255. <aside class="phpdocumentor-element-found-in">
  1256. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1257. :
  1258. <span class="phpdocumentor-element-found-in__line">120</span>
  1259. </aside>
  1260. <p class="phpdocumentor-summary">anything between &lt;defs&gt;</p>
  1261. <code class="phpdocumentor-code phpdocumentor-signature ">
  1262. <span class="phpdocumentor-signature__visibility">protected</span>
  1263. <span class="phpdocumentor-signature__type">string</span>
  1264. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1265. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1266. <section class="phpdocumentor-description"></section>
  1267. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1268. Tags
  1269. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1270. </h5>
  1271. <dl class="phpdocumentor-tag-list">
  1272. <dt class="phpdocumentor-tag-list__entry">
  1273. <span class="phpdocumentor-tag__name">see</span>
  1274. </dt>
  1275. <dd class="phpdocumentor-tag-list__definition">
  1276. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</abbr></a></span>
  1277. </dd>
  1278. </dl>
  1279. </article>
  1280. <article
  1281. class="
  1282. phpdocumentor-element
  1283. -property
  1284. -protected
  1285. "
  1286. >
  1287. <h4 class="phpdocumentor-element__name" id="property_svgDrawCircularModules">
  1288. $svgDrawCircularModules
  1289. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDrawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  1290. <span class="phpdocumentor-element__modifiers">
  1291. </span>
  1292. </h4>
  1293. <aside class="phpdocumentor-element-found-in">
  1294. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1295. :
  1296. <span class="phpdocumentor-element-found-in__line">166</span>
  1297. </aside>
  1298. <p class="phpdocumentor-summary">specify whether to draw the modules as filled circles</p>
  1299. <code class="phpdocumentor-code phpdocumentor-signature ">
  1300. <span class="phpdocumentor-signature__visibility">protected</span>
  1301. <span class="phpdocumentor-signature__type">bool</span>
  1302. <span class="phpdocumentor-signature__name">$svgDrawCircularModules</span>
  1303. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1304. <section class="phpdocumentor-description"></section>
  1305. </article>
  1306. <article
  1307. class="
  1308. phpdocumentor-element
  1309. -property
  1310. -protected
  1311. "
  1312. >
  1313. <h4 class="phpdocumentor-element__name" id="property_svgExcludeFromConnect">
  1314. $svgExcludeFromConnect
  1315. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgExcludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  1316. <span class="phpdocumentor-element__modifiers">
  1317. </span>
  1318. </h4>
  1319. <aside class="phpdocumentor-element-found-in">
  1320. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1321. :
  1322. <span class="phpdocumentor-element-found-in__line">161</span>
  1323. </aside>
  1324. <p class="phpdocumentor-summary">specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</p>
  1325. <code class="phpdocumentor-code phpdocumentor-signature ">
  1326. <span class="phpdocumentor-signature__visibility">protected</span>
  1327. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1328. <span class="phpdocumentor-signature__name">$svgExcludeFromConnect</span>
  1329. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1330. <section class="phpdocumentor-description"></section>
  1331. </article>
  1332. <article
  1333. class="
  1334. phpdocumentor-element
  1335. -property
  1336. -protected
  1337. "
  1338. >
  1339. <h4 class="phpdocumentor-element__name" id="property_svgHeight">
  1340. $svgHeight
  1341. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1342. <span class="phpdocumentor-element__modifiers">
  1343. </span>
  1344. </h4>
  1345. <aside class="phpdocumentor-element-found-in">
  1346. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1347. :
  1348. <span class="phpdocumentor-element-found-in__line">149</span>
  1349. </aside>
  1350. <p class="phpdocumentor-summary">optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</p>
  1351. <code class="phpdocumentor-code phpdocumentor-signature ">
  1352. <span class="phpdocumentor-signature__visibility">protected</span>
  1353. <span class="phpdocumentor-signature__type">string|null</span>
  1354. <span class="phpdocumentor-signature__name">$svgHeight</span>
  1355. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1356. <section class="phpdocumentor-description"></section>
  1357. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1358. Tags
  1359. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1360. </h5>
  1361. <dl class="phpdocumentor-tag-list">
  1362. <dt class="phpdocumentor-tag-list__entry">
  1363. <span class="phpdocumentor-tag__name">see</span>
  1364. </dt>
  1365. <dd class="phpdocumentor-tag-list__definition">
  1366. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height</abbr></a></span>
  1367. </dd>
  1368. </dl>
  1369. </article>
  1370. <article
  1371. class="
  1372. phpdocumentor-element
  1373. -property
  1374. -protected
  1375. "
  1376. >
  1377. <h4 class="phpdocumentor-element__name" id="property_svgKeepAsSquare">
  1378. $svgKeepAsSquare
  1379. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgKeepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  1380. <span class="phpdocumentor-element__modifiers">
  1381. </span>
  1382. </h4>
  1383. <aside class="phpdocumentor-element-found-in">
  1384. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1385. :
  1386. <span class="phpdocumentor-element-found-in__line">176</span>
  1387. </aside>
  1388. <p class="phpdocumentor-summary">specifies which module types to exclude when $svgDrawCircularModules is set to true</p>
  1389. <code class="phpdocumentor-code phpdocumentor-signature ">
  1390. <span class="phpdocumentor-signature__visibility">protected</span>
  1391. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1392. <span class="phpdocumentor-signature__name">$svgKeepAsSquare</span>
  1393. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1394. <section class="phpdocumentor-description"></section>
  1395. </article>
  1396. <article
  1397. class="
  1398. phpdocumentor-element
  1399. -property
  1400. -protected
  1401. "
  1402. >
  1403. <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
  1404. $svgOpacity
  1405. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" class="headerlink"><i class="fas fa-link"></i></a>
  1406. <span class="phpdocumentor-element__modifiers">
  1407. </span>
  1408. </h4>
  1409. <aside class="phpdocumentor-element-found-in">
  1410. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1411. :
  1412. <span class="phpdocumentor-element-found-in__line">113</span>
  1413. </aside>
  1414. <p class="phpdocumentor-summary">SVG opacity</p>
  1415. <code class="phpdocumentor-code phpdocumentor-signature ">
  1416. <span class="phpdocumentor-signature__visibility">protected</span>
  1417. <span class="phpdocumentor-signature__type">float</span>
  1418. <span class="phpdocumentor-signature__name">$svgOpacity</span>
  1419. = <span class="phpdocumentor-signature__default-value">1.0</span></code>
  1420. <section class="phpdocumentor-description"></section>
  1421. </article>
  1422. <article
  1423. class="
  1424. phpdocumentor-element
  1425. -property
  1426. -protected
  1427. "
  1428. >
  1429. <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
  1430. $svgPreserveAspectRatio
  1431. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
  1432. <span class="phpdocumentor-element__modifiers">
  1433. </span>
  1434. </h4>
  1435. <aside class="phpdocumentor-element-found-in">
  1436. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1437. :
  1438. <span class="phpdocumentor-element-found-in__line">135</span>
  1439. </aside>
  1440. <code class="phpdocumentor-code phpdocumentor-signature ">
  1441. <span class="phpdocumentor-signature__visibility">protected</span>
  1442. <span class="phpdocumentor-signature__type">string</span>
  1443. <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
  1444. = <span class="phpdocumentor-signature__default-value">&#039;xMidYMid&#039;</span></code>
  1445. <section class="phpdocumentor-description"></section>
  1446. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1447. Tags
  1448. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1449. </h5>
  1450. <dl class="phpdocumentor-tag-list">
  1451. <dt class="phpdocumentor-tag-list__entry">
  1452. <span class="phpdocumentor-tag__name">see</span>
  1453. </dt>
  1454. <dd class="phpdocumentor-tag-list__definition">
  1455. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</abbr></a></span>
  1456. </dd>
  1457. </dl>
  1458. </article>
  1459. <article
  1460. class="
  1461. phpdocumentor-element
  1462. -property
  1463. -protected
  1464. "
  1465. >
  1466. <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
  1467. $svgViewBoxSize
  1468. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" class="headerlink"><i class="fas fa-link"></i></a>
  1469. <span class="phpdocumentor-element__modifiers">
  1470. </span>
  1471. </h4>
  1472. <aside class="phpdocumentor-element-found-in">
  1473. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1474. :
  1475. <span class="phpdocumentor-element-found-in__line">130</span>
  1476. </aside>
  1477. <p class="phpdocumentor-summary">SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</p>
  1478. <code class="phpdocumentor-code phpdocumentor-signature ">
  1479. <span class="phpdocumentor-signature__visibility">protected</span>
  1480. <span class="phpdocumentor-signature__type">int|null</span>
  1481. <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
  1482. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1483. <section class="phpdocumentor-description"><p>viewBox=&quot;0 0 x x&quot;</p>
  1484. </section>
  1485. <section class="phpdocumentor-description"></section>
  1486. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1487. Tags
  1488. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1489. </h5>
  1490. <dl class="phpdocumentor-tag-list">
  1491. <dt class="phpdocumentor-tag-list__entry">
  1492. <span class="phpdocumentor-tag__name">see</span>
  1493. </dt>
  1494. <dd class="phpdocumentor-tag-list__definition">
  1495. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</abbr></a></span>
  1496. </dd>
  1497. <dt class="phpdocumentor-tag-list__entry">
  1498. <span class="phpdocumentor-tag__name">see</span>
  1499. </dt>
  1500. <dd class="phpdocumentor-tag-list__definition">
  1501. <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>
  1502. </dd>
  1503. </dl>
  1504. </article>
  1505. <article
  1506. class="
  1507. phpdocumentor-element
  1508. -property
  1509. -protected
  1510. "
  1511. >
  1512. <h4 class="phpdocumentor-element__name" id="property_svgWidth">
  1513. $svgWidth
  1514. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1515. <span class="phpdocumentor-element__modifiers">
  1516. </span>
  1517. </h4>
  1518. <aside class="phpdocumentor-element-found-in">
  1519. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1520. :
  1521. <span class="phpdocumentor-element-found-in__line">142</span>
  1522. </aside>
  1523. <p class="phpdocumentor-summary">optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</p>
  1524. <code class="phpdocumentor-code phpdocumentor-signature ">
  1525. <span class="phpdocumentor-signature__visibility">protected</span>
  1526. <span class="phpdocumentor-signature__type">string|null</span>
  1527. <span class="phpdocumentor-signature__name">$svgWidth</span>
  1528. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1529. <section class="phpdocumentor-description"></section>
  1530. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1531. Tags
  1532. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1533. </h5>
  1534. <dl class="phpdocumentor-tag-list">
  1535. <dt class="phpdocumentor-tag-list__entry">
  1536. <span class="phpdocumentor-tag__name">see</span>
  1537. </dt>
  1538. <dd class="phpdocumentor-tag-list__definition">
  1539. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width</abbr></a></span>
  1540. </dd>
  1541. </dl>
  1542. </article>
  1543. <article
  1544. class="
  1545. phpdocumentor-element
  1546. -property
  1547. -protected
  1548. "
  1549. >
  1550. <h4 class="phpdocumentor-element__name" id="property_textDark">
  1551. $textDark
  1552. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" class="headerlink"><i class="fas fa-link"></i></a>
  1553. <span class="phpdocumentor-element__modifiers">
  1554. </span>
  1555. </h4>
  1556. <aside class="phpdocumentor-element-found-in">
  1557. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1558. :
  1559. <span class="phpdocumentor-element-found-in__line">181</span>
  1560. </aside>
  1561. <p class="phpdocumentor-summary">string substitute for dark</p>
  1562. <code class="phpdocumentor-code phpdocumentor-signature ">
  1563. <span class="phpdocumentor-signature__visibility">protected</span>
  1564. <span class="phpdocumentor-signature__type">string</span>
  1565. <span class="phpdocumentor-signature__name">$textDark</span>
  1566. = <span class="phpdocumentor-signature__default-value">&#039;🔴&#039;</span></code>
  1567. <section class="phpdocumentor-description"></section>
  1568. </article>
  1569. <article
  1570. class="
  1571. phpdocumentor-element
  1572. -property
  1573. -protected
  1574. "
  1575. >
  1576. <h4 class="phpdocumentor-element__name" id="property_textLight">
  1577. $textLight
  1578. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" class="headerlink"><i class="fas fa-link"></i></a>
  1579. <span class="phpdocumentor-element__modifiers">
  1580. </span>
  1581. </h4>
  1582. <aside class="phpdocumentor-element-found-in">
  1583. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1584. :
  1585. <span class="phpdocumentor-element-found-in__line">186</span>
  1586. </aside>
  1587. <p class="phpdocumentor-summary">string substitute for light</p>
  1588. <code class="phpdocumentor-code phpdocumentor-signature ">
  1589. <span class="phpdocumentor-signature__visibility">protected</span>
  1590. <span class="phpdocumentor-signature__type">string</span>
  1591. <span class="phpdocumentor-signature__name">$textLight</span>
  1592. = <span class="phpdocumentor-signature__default-value">&#039;⭕&#039;</span></code>
  1593. <section class="phpdocumentor-description"></section>
  1594. </article>
  1595. <article
  1596. class="
  1597. phpdocumentor-element
  1598. -property
  1599. -protected
  1600. "
  1601. >
  1602. <h4 class="phpdocumentor-element__name" id="property_version">
  1603. $version
  1604. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  1605. <span class="phpdocumentor-element__modifiers">
  1606. </span>
  1607. </h4>
  1608. <aside class="phpdocumentor-element-found-in">
  1609. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1610. :
  1611. <span class="phpdocumentor-element-found-in__line">30</span>
  1612. </aside>
  1613. <p class="phpdocumentor-summary">QR Code version number</p>
  1614. <code class="phpdocumentor-code phpdocumentor-signature ">
  1615. <span class="phpdocumentor-signature__visibility">protected</span>
  1616. <span class="phpdocumentor-signature__type">int</span>
  1617. <span class="phpdocumentor-signature__name">$version</span>
  1618. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::VERSION_AUTO</span></code>
  1619. <section class="phpdocumentor-description"><p>[1 ... 40] or QRCode::VERSION_AUTO</p>
  1620. </section>
  1621. <section class="phpdocumentor-description"></section>
  1622. </article>
  1623. <article
  1624. class="
  1625. phpdocumentor-element
  1626. -property
  1627. -protected
  1628. "
  1629. >
  1630. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  1631. $versionMax
  1632. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  1633. <span class="phpdocumentor-element__modifiers">
  1634. </span>
  1635. </h4>
  1636. <aside class="phpdocumentor-element-found-in">
  1637. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1638. :
  1639. <span class="phpdocumentor-element-found-in__line">42</span>
  1640. </aside>
  1641. <p class="phpdocumentor-summary">Maximum QR version</p>
  1642. <code class="phpdocumentor-code phpdocumentor-signature ">
  1643. <span class="phpdocumentor-signature__visibility">protected</span>
  1644. <span class="phpdocumentor-signature__type">int</span>
  1645. <span class="phpdocumentor-signature__name">$versionMax</span>
  1646. = <span class="phpdocumentor-signature__default-value">40</span></code>
  1647. <section class="phpdocumentor-description"></section>
  1648. </article>
  1649. <article
  1650. class="
  1651. phpdocumentor-element
  1652. -property
  1653. -protected
  1654. "
  1655. >
  1656. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  1657. $versionMin
  1658. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  1659. <span class="phpdocumentor-element__modifiers">
  1660. </span>
  1661. </h4>
  1662. <aside class="phpdocumentor-element-found-in">
  1663. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1664. :
  1665. <span class="phpdocumentor-element-found-in__line">37</span>
  1666. </aside>
  1667. <p class="phpdocumentor-summary">Minimum QR version</p>
  1668. <code class="phpdocumentor-code phpdocumentor-signature ">
  1669. <span class="phpdocumentor-signature__visibility">protected</span>
  1670. <span class="phpdocumentor-signature__type">int</span>
  1671. <span class="phpdocumentor-signature__name">$versionMin</span>
  1672. = <span class="phpdocumentor-signature__default-value">1</span></code>
  1673. <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
  1674. </section>
  1675. <section class="phpdocumentor-description"></section>
  1676. </article>
  1677. </section>
  1678. <section class="phpdocumentor-methods">
  1679. <h3 class="phpdocumentor-elements__header" id="methods">
  1680. Methods
  1681. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1682. </h3>
  1683. <article
  1684. class="phpdocumentor-element
  1685. -method
  1686. -public
  1687. "
  1688. >
  1689. <h4 class="phpdocumentor-element__name" id="method_getLuminanceSourceFQCN">
  1690. getLuminanceSourceFQCN()
  1691. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_getLuminanceSourceFQCN" class="headerlink"><i class="fas fa-link"></i></a>
  1692. </h4>
  1693. <aside class="phpdocumentor-element-found-in">
  1694. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1695. :
  1696. <span class="phpdocumentor-element-found-in__line">408</span>
  1697. </aside>
  1698. <p class="phpdocumentor-summary">returns the FQCN of the luminance source class to use in the reader (GD or Imagick)</p>
  1699. <code class="phpdocumentor-code phpdocumentor-signature ">
  1700. <span class="phpdocumentor-signature__visibility">public</span>
  1701. <span class="phpdocumentor-signature__name">getLuminanceSourceFQCN</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1702. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1703. Tags
  1704. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1705. </h5>
  1706. <dl class="phpdocumentor-tag-list">
  1707. <dt class="phpdocumentor-tag-list__entry">
  1708. <span class="phpdocumentor-tag__name">see</span>
  1709. </dt>
  1710. <dd class="phpdocumentor-tag-list__definition">
  1711. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></span>
  1712. </dd>
  1713. </dl>
  1714. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1715. <span class="phpdocumentor-signature__response_type">string</span>
  1716. &mdash;
  1717. </article>
  1718. <article
  1719. class="phpdocumentor-element
  1720. -method
  1721. -protected
  1722. "
  1723. >
  1724. <h4 class="phpdocumentor-element__name" id="method_set_eccLevel">
  1725. set_eccLevel()
  1726. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1727. </h4>
  1728. <aside class="phpdocumentor-element-found-in">
  1729. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1730. :
  1731. <span class="phpdocumentor-element-found-in__line">317</span>
  1732. </aside>
  1733. <p class="phpdocumentor-summary">sets the error correction level</p>
  1734. <code class="phpdocumentor-code phpdocumentor-signature ">
  1735. <span class="phpdocumentor-signature__visibility">protected</span>
  1736. <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>
  1737. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1738. <dl class="phpdocumentor-argument-list">
  1739. <dt class="phpdocumentor-argument-list__entry">
  1740. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1741. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1742. </dt>
  1743. <dd class="phpdocumentor-argument-list__definition">
  1744. <section class="phpdocumentor-description"></section>
  1745. </dd>
  1746. </dl>
  1747. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1748. Tags
  1749. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1750. </h5>
  1751. <dl class="phpdocumentor-tag-list">
  1752. <dt class="phpdocumentor-tag-list__entry">
  1753. <span class="phpdocumentor-tag__name">throws</span>
  1754. </dt>
  1755. <dd class="phpdocumentor-tag-list__definition">
  1756. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1757. </dd>
  1758. </dl>
  1759. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1760. <span class="phpdocumentor-signature__response_type">void</span>
  1761. &mdash;
  1762. </article>
  1763. <article
  1764. class="phpdocumentor-element
  1765. -method
  1766. -protected
  1767. "
  1768. >
  1769. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  1770. set_fpdfMeasureUnit()
  1771. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  1772. </h4>
  1773. <aside class="phpdocumentor-element-found-in">
  1774. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1775. :
  1776. <span class="phpdocumentor-element-found-in__line">386</span>
  1777. </aside>
  1778. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  1779. <code class="phpdocumentor-code phpdocumentor-signature ">
  1780. <span class="phpdocumentor-signature__visibility">protected</span>
  1781. <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>
  1782. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1783. <dl class="phpdocumentor-argument-list">
  1784. <dt class="phpdocumentor-argument-list__entry">
  1785. <span class="phpdocumentor-signature__argument__name">$unit</span>
  1786. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1787. </dt>
  1788. <dd class="phpdocumentor-argument-list__definition">
  1789. <section class="phpdocumentor-description"></section>
  1790. </dd>
  1791. </dl>
  1792. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1793. Tags
  1794. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1795. </h5>
  1796. <dl class="phpdocumentor-tag-list">
  1797. <dt class="phpdocumentor-tag-list__entry">
  1798. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1799. </dt>
  1800. <dd class="phpdocumentor-tag-list__definition">
  1801. </dd>
  1802. </dl>
  1803. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1804. <span class="phpdocumentor-signature__response_type">void</span>
  1805. &mdash;
  1806. </article>
  1807. <article
  1808. class="phpdocumentor-element
  1809. -method
  1810. -protected
  1811. "
  1812. >
  1813. <h4 class="phpdocumentor-element__name" id="method_set_imageTransparencyBG">
  1814. set_imageTransparencyBG()
  1815. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  1816. </h4>
  1817. <aside class="phpdocumentor-element-found-in">
  1818. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1819. :
  1820. <span class="phpdocumentor-element-found-in__line">342</span>
  1821. </aside>
  1822. <p class="phpdocumentor-summary">sets the transparency background color</p>
  1823. <code class="phpdocumentor-code phpdocumentor-signature ">
  1824. <span class="phpdocumentor-signature__visibility">protected</span>
  1825. <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>
  1826. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1827. <dl class="phpdocumentor-argument-list">
  1828. <dt class="phpdocumentor-argument-list__entry">
  1829. <span class="phpdocumentor-signature__argument__name">$imageTransparencyBG</span>
  1830. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1831. </dt>
  1832. <dd class="phpdocumentor-argument-list__definition">
  1833. <section class="phpdocumentor-description"></section>
  1834. </dd>
  1835. </dl>
  1836. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1837. Tags
  1838. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1839. </h5>
  1840. <dl class="phpdocumentor-tag-list">
  1841. <dt class="phpdocumentor-tag-list__entry">
  1842. <span class="phpdocumentor-tag__name">throws</span>
  1843. </dt>
  1844. <dd class="phpdocumentor-tag-list__definition">
  1845. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1846. </dd>
  1847. </dl>
  1848. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1849. <span class="phpdocumentor-signature__response_type">void</span>
  1850. &mdash;
  1851. </article>
  1852. <article
  1853. class="phpdocumentor-element
  1854. -method
  1855. -protected
  1856. "
  1857. >
  1858. <h4 class="phpdocumentor-element__name" id="method_set_maskPattern">
  1859. set_maskPattern()
  1860. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1861. </h4>
  1862. <aside class="phpdocumentor-element-found-in">
  1863. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1864. :
  1865. <span class="phpdocumentor-element-found-in__line">329</span>
  1866. </aside>
  1867. <p class="phpdocumentor-summary">sets/clamps the mask pattern</p>
  1868. <code class="phpdocumentor-code phpdocumentor-signature ">
  1869. <span class="phpdocumentor-signature__visibility">protected</span>
  1870. <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>
  1871. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1872. <dl class="phpdocumentor-argument-list">
  1873. <dt class="phpdocumentor-argument-list__entry">
  1874. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1875. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1876. </dt>
  1877. <dd class="phpdocumentor-argument-list__definition">
  1878. <section class="phpdocumentor-description"></section>
  1879. </dd>
  1880. </dl>
  1881. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1882. <span class="phpdocumentor-signature__response_type">void</span>
  1883. &mdash;
  1884. </article>
  1885. <article
  1886. class="phpdocumentor-element
  1887. -method
  1888. -protected
  1889. "
  1890. >
  1891. <h4 class="phpdocumentor-element__name" id="method_set_useImagickIfAvailable">
  1892. set_useImagickIfAvailable()
  1893. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_useImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1894. </h4>
  1895. <aside class="phpdocumentor-element-found-in">
  1896. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1897. :
  1898. <span class="phpdocumentor-element-found-in__line">399</span>
  1899. </aside>
  1900. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  1901. <code class="phpdocumentor-code phpdocumentor-signature ">
  1902. <span class="phpdocumentor-signature__visibility">protected</span>
  1903. <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>
  1904. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1905. <dl class="phpdocumentor-argument-list">
  1906. <dt class="phpdocumentor-argument-list__entry">
  1907. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  1908. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1909. </dt>
  1910. <dd class="phpdocumentor-argument-list__definition">
  1911. <section class="phpdocumentor-description"></section>
  1912. </dd>
  1913. </dl>
  1914. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1915. <span class="phpdocumentor-signature__response_type">void</span>
  1916. &mdash;
  1917. </article>
  1918. <article
  1919. class="phpdocumentor-element
  1920. -method
  1921. -protected
  1922. "
  1923. >
  1924. <h4 class="phpdocumentor-element__name" id="method_set_version">
  1925. set_version()
  1926. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  1927. </h4>
  1928. <aside class="phpdocumentor-element-found-in">
  1929. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1930. :
  1931. <span class="phpdocumentor-element-found-in__line">373</span>
  1932. </aside>
  1933. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  1934. <code class="phpdocumentor-code phpdocumentor-signature ">
  1935. <span class="phpdocumentor-signature__visibility">protected</span>
  1936. <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>
  1937. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1938. <dl class="phpdocumentor-argument-list">
  1939. <dt class="phpdocumentor-argument-list__entry">
  1940. <span class="phpdocumentor-signature__argument__name">$version</span>
  1941. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1942. </dt>
  1943. <dd class="phpdocumentor-argument-list__definition">
  1944. <section class="phpdocumentor-description"></section>
  1945. </dd>
  1946. </dl>
  1947. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1948. <span class="phpdocumentor-signature__response_type">void</span>
  1949. &mdash;
  1950. </article>
  1951. <article
  1952. class="phpdocumentor-element
  1953. -method
  1954. -protected
  1955. "
  1956. >
  1957. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  1958. set_versionMax()
  1959. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  1960. </h4>
  1961. <aside class="phpdocumentor-element-found-in">
  1962. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1963. :
  1964. <span class="phpdocumentor-element-found-in__line">308</span>
  1965. </aside>
  1966. <p class="phpdocumentor-summary">sets the maximum version number</p>
  1967. <code class="phpdocumentor-code phpdocumentor-signature ">
  1968. <span class="phpdocumentor-signature__visibility">protected</span>
  1969. <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>
  1970. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1971. <dl class="phpdocumentor-argument-list">
  1972. <dt class="phpdocumentor-argument-list__entry">
  1973. <span class="phpdocumentor-signature__argument__name">$version</span>
  1974. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1975. </dt>
  1976. <dd class="phpdocumentor-argument-list__definition">
  1977. <section class="phpdocumentor-description"></section>
  1978. </dd>
  1979. </dl>
  1980. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1981. <span class="phpdocumentor-signature__response_type">void</span>
  1982. &mdash;
  1983. </article>
  1984. <article
  1985. class="phpdocumentor-element
  1986. -method
  1987. -protected
  1988. "
  1989. >
  1990. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  1991. set_versionMin()
  1992. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  1993. </h4>
  1994. <aside class="phpdocumentor-element-found-in">
  1995. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1996. :
  1997. <span class="phpdocumentor-element-found-in__line">301</span>
  1998. </aside>
  1999. <p class="phpdocumentor-summary">sets the minimum version number</p>
  2000. <code class="phpdocumentor-code phpdocumentor-signature ">
  2001. <span class="phpdocumentor-signature__visibility">protected</span>
  2002. <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>
  2003. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2004. <dl class="phpdocumentor-argument-list">
  2005. <dt class="phpdocumentor-argument-list__entry">
  2006. <span class="phpdocumentor-signature__argument__name">$version</span>
  2007. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2008. </dt>
  2009. <dd class="phpdocumentor-argument-list__definition">
  2010. <section class="phpdocumentor-description"></section>
  2011. </dd>
  2012. </dl>
  2013. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2014. <span class="phpdocumentor-signature__response_type">void</span>
  2015. &mdash;
  2016. </article>
  2017. <article
  2018. class="phpdocumentor-element
  2019. -method
  2020. -protected
  2021. "
  2022. >
  2023. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  2024. setMinMaxVersion()
  2025. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  2026. </h4>
  2027. <aside class="phpdocumentor-element-found-in">
  2028. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2029. :
  2030. <span class="phpdocumentor-element-found-in__line">290</span>
  2031. </aside>
  2032. <p class="phpdocumentor-summary">clamp min/max version number</p>
  2033. <code class="phpdocumentor-code phpdocumentor-signature ">
  2034. <span class="phpdocumentor-signature__visibility">protected</span>
  2035. <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>
  2036. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2037. <dl class="phpdocumentor-argument-list">
  2038. <dt class="phpdocumentor-argument-list__entry">
  2039. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  2040. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2041. </dt>
  2042. <dd class="phpdocumentor-argument-list__definition">
  2043. <section class="phpdocumentor-description"></section>
  2044. </dd>
  2045. <dt class="phpdocumentor-argument-list__entry">
  2046. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  2047. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2048. </dt>
  2049. <dd class="phpdocumentor-argument-list__definition">
  2050. <section class="phpdocumentor-description"></section>
  2051. </dd>
  2052. </dl>
  2053. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2054. <span class="phpdocumentor-signature__response_type">void</span>
  2055. &mdash;
  2056. </article>
  2057. </section>
  2058. <script type="text/javascript">
  2059. function loadExternalCodeSnippets(line) {
  2060. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2061. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  2062. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  2063. var language = 'php';
  2064. var code = document.createElement('code');
  2065. code.className = 'language-' + language;
  2066. pre.textContent = '';
  2067. pre.setAttribute('data-line', line)
  2068. code.textContent = 'Loading…';
  2069. pre.appendChild(code);
  2070. var xhr = new XMLHttpRequest();
  2071. xhr.open('GET', src, true);
  2072. xhr.onreadystatechange = function () {
  2073. if (xhr.readyState == 4) {
  2074. if (xhr.status < 400 && xhr.responseText) {
  2075. code.textContent = xhr.responseText;
  2076. Prism.highlightElement(code);
  2077. }
  2078. else if (xhr.status >= 400) {
  2079. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2080. }
  2081. else {
  2082. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  2083. }
  2084. }
  2085. };
  2086. xhr.send(null);
  2087. });
  2088. }
  2089. var modals = document.querySelectorAll("[data-modal]");
  2090. modals.forEach(function (trigger) {
  2091. trigger.addEventListener("click", function (event) {
  2092. //event.preventDefault();
  2093. const modal = document.getElementById(trigger.dataset.modal);
  2094. modal.classList.add("phpdocumentor-modal__open");
  2095. loadExternalCodeSnippets(trigger.dataset.line)
  2096. const exits = modal.querySelectorAll("[data-exit-button]");
  2097. exits.forEach(function (exit) {
  2098. exit.addEventListener("click", function (event) {
  2099. event.preventDefault();
  2100. modal.classList.remove("phpdocumentor-modal__open");
  2101. });
  2102. });
  2103. });
  2104. });
  2105. </script>
  2106. </article>
  2107. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2108. <section class="phpdocumentor-search-results__dialog">
  2109. <header class="phpdocumentor-search-results__header">
  2110. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2111. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2112. </header>
  2113. <section class="phpdocumentor-search-results__body">
  2114. <ul class="phpdocumentor-search-results__entries"></ul>
  2115. </section>
  2116. </section>
  2117. </section>
  2118. </div>
  2119. </div>
  2120. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2121. </main>
  2122. <script>
  2123. cssVars({});
  2124. </script>
  2125. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2126. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2127. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2128. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2129. </body>
  2130. </html>