chillerlan-QRCode-QROptionsTrait.html 148 KB

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