chillerlan-QRCode-QROptionsTrait.html 159 KB

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