chillerlan-QRCode-QROptionsTrait.html 140 KB

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