chillerlan-QRCode-QROptions.html 141 KB

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