chillerlan-QRCode-QROptionsTrait.html 151 KB

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