chillerlan-QRCode-QROptionsTrait.html 167 KB

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