chillerlan-QRCode-QROptionsTrait.html 143 KB

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