chillerlan-QRCode-QROptions.html 173 KB

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