chillerlan-QRCode-QROptionsTrait.html 140 KB

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