chillerlan-QRCode-QROptionsTrait.html 115 KB

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