chillerlan-QRCode-QROptions.html 141 KB

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