chillerlan-QRCode-QROptionsTrait.html 142 KB

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