chillerlan-QRCode-QROptions.html 143 KB

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