chillerlan-QRCode-QROptions.html 152 KB

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