chillerlan-QRCode-QROptions.html 149 KB

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