chillerlan-QRCode-QROptions.html 149 KB

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