chillerlan-QRCode-QROptions.html 155 KB

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