chillerlan-QRCode-QROptionsTrait.html 154 KB

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