chillerlan-QRCode-QROptions.html 149 KB

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