chillerlan-QRCode-QROptions.html 198 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. </ul>
  105. <article class="phpdocumentor-element -class">
  106. <h2 class="phpdocumentor-content__title">
  107. QROptions
  108. <span class="phpdocumentor-element__extends">
  109. extends <abbr title="\chillerlan\Settings\SettingsContainerAbstract">SettingsContainerAbstract</abbr>
  110. </span>
  111. <div class="phpdocumentor-element__package">
  112. in package
  113. <ul class="phpdocumentor-breadcrumbs">
  114. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  115. </ul>
  116. </div>
  117. <span class="phpdocumentor-element__extends">
  118. Uses
  119. <a href="classes/chillerlan-QRCode-QROptionsTrait.html"><abbr title="\chillerlan\QRCode\QROptionsTrait">QROptionsTrait</abbr></a> </span>
  120. </h2>
  121. <div class="phpdocumentor-label-line">
  122. </div>
  123. <aside class="phpdocumentor-element-found-in">
  124. <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>
  125. :
  126. <span class="phpdocumentor-element-found-in__line">18</span>
  127. </aside>
  128. <p class="phpdocumentor-summary">The QRCode settings container</p>
  129. <h3 id="toc">
  130. Table of Contents
  131. <a href="classes/chillerlan-QRCode-QROptions.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  132. </h3>
  133. <h4 id="toc-properties">
  134. Properties
  135. <a href="classes/chillerlan-QRCode-QROptions.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  136. </h4>
  137. <dl class="phpdocumentor-table-of-contents">
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
  140. <span>
  141. &nbsp;: bool </span>
  142. </dt>
  143. <dd>Toggles logo space creation</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
  146. <span>
  147. &nbsp;: bool </span>
  148. </dt>
  149. <dd>Add a &quot;quiet zone&quot; (margin) according to the QR code spec</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
  152. <span>
  153. &nbsp;: mixed|null </span>
  154. </dt>
  155. <dd>Sets the image background color (if applicable)</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
  158. <span>
  159. &nbsp;: string|null </span>
  160. </dt>
  161. <dd>Optional cache file path `/path/to/cache.file`</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
  164. <span>
  165. &nbsp;: float </span>
  166. </dt>
  167. <dd>Specifies the radius of the modules when $drawCircularModules is set to true</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
  170. <span>
  171. &nbsp;: bool </span>
  172. </dt>
  173. <dd>Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
  176. <span>
  177. &nbsp;: string </span>
  178. </dt>
  179. <dd>A common css class</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  181. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
  182. <span>
  183. &nbsp;: bool </span>
  184. </dt>
  185. <dd>Specify whether to draw the modules as filled circles</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  187. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
  188. <span>
  189. &nbsp;: bool </span>
  190. </dt>
  191. <dd>Whether to draw the light (false) modules</dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  193. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
  194. <span>
  195. &nbsp;: int </span>
  196. </dt>
  197. <dd>Error correct level</dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  199. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
  200. <span>
  201. &nbsp;: string </span>
  202. </dt>
  203. <dd>Newline string</dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  205. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
  206. <span>
  207. &nbsp;: array&lt;string|int, mixed&gt; </span>
  208. </dt>
  209. <dd>Specify which paths/patterns to exclude from connecting if $connectPaths is set to true</dd>
  210. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  211. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
  212. <span>
  213. &nbsp;: string </span>
  214. </dt>
  215. <dd>Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</dd>
  216. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  217. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a>
  218. <span>
  219. &nbsp;: bool </span>
  220. </dt>
  221. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  222. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
  223. <span>
  224. &nbsp;: bool </span>
  225. </dt>
  226. <dd>Toggle transparency</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  228. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
  229. <span>
  230. &nbsp;: string </span>
  231. </dt>
  232. <dd>Imagick output format</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  234. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans">$jsonAsBooleans</a>
  235. <span>
  236. &nbsp;: bool </span>
  237. </dt>
  238. <dd>Whether to return matrix values in JSON as booleans or $M_TYPE integers</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  240. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
  241. <span>
  242. &nbsp;: array&lt;string|int, mixed&gt; </span>
  243. </dt>
  244. <dd>Specifies which module types to exclude when $drawCircularModules is set to true</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  246. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
  247. <span>
  248. &nbsp;: int|null </span>
  249. </dt>
  250. <dd>Height of the logo space</dd>
  251. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  252. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
  253. <span>
  254. &nbsp;: int|null </span>
  255. </dt>
  256. <dd>Optional horizontal start position of the logo space (top left corner)</dd>
  257. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  258. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
  259. <span>
  260. &nbsp;: int|null </span>
  261. </dt>
  262. <dd>Optional vertical start position of the logo space (top left corner)</dd>
  263. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  264. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
  265. <span>
  266. &nbsp;: int|null </span>
  267. </dt>
  268. <dd>Width of the logo space</dd>
  269. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  270. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a>
  271. <span>
  272. &nbsp;: string </span>
  273. </dt>
  274. <dd>Markup substitute for dark (CSS value)</dd>
  275. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  276. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a>
  277. <span>
  278. &nbsp;: string </span>
  279. </dt>
  280. <dd>Markup substitute for light (CSS value)</dd>
  281. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  282. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
  283. <span>
  284. &nbsp;: int </span>
  285. </dt>
  286. <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
  287. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  288. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
  289. <span>
  290. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  291. </dt>
  292. <dd>Module values map</dd>
  293. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  294. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64</a>
  295. <span>
  296. &nbsp;: bool </span>
  297. </dt>
  298. <dd>Toggle base64 data URI or raw data output (if applicable)</dd>
  299. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  300. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
  301. <span>
  302. &nbsp;: string|null </span>
  303. </dt>
  304. <dd>The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</dd>
  305. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  306. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a>
  307. <span>
  308. &nbsp;: string </span>
  309. </dt>
  310. <dd>The built-in output type</dd>
  311. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  312. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality</a>
  313. <span>
  314. &nbsp;: int </span>
  315. </dt>
  316. <dd>Compression quality</dd>
  317. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  318. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
  319. <span>
  320. &nbsp;: int </span>
  321. </dt>
  322. <dd>Size of the quiet zone</dd>
  323. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  324. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
  325. <span>
  326. &nbsp;: bool </span>
  327. </dt>
  328. <dd>Grayscale the image before reading</dd>
  329. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  330. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  331. <span>
  332. &nbsp;: bool </span>
  333. </dt>
  334. <dd>Increase the contrast before reading</dd>
  335. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  336. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  337. <span>
  338. &nbsp;: bool </span>
  339. </dt>
  340. <dd>Use Imagick (if available) when reading QR Codes</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  342. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
  343. <span>
  344. &nbsp;: bool </span>
  345. </dt>
  346. <dd>Return the image resource instead of a render if applicable.</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  348. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
  349. <span>
  350. &nbsp;: int </span>
  351. </dt>
  352. <dd>Pixel size of a QR code module</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  354. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader</a>
  355. <span>
  356. &nbsp;: bool </span>
  357. </dt>
  358. <dd>Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  360. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
  361. <span>
  362. &nbsp;: string </span>
  363. </dt>
  364. <dd>Anything in the &lt;defs&gt; tag</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  366. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a>
  367. <span>
  368. &nbsp;: string|null </span>
  369. </dt>
  370. <dd>Optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</dd>
  371. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  372. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
  373. <span>
  374. &nbsp;: float </span>
  375. </dt>
  376. <dd>SVG opacity</dd>
  377. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  378. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
  379. <span>
  380. &nbsp;: string </span>
  381. </dt>
  382. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  383. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
  384. <span>
  385. &nbsp;: int|null </span>
  386. </dt>
  387. <dd>SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.</dd>
  388. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  389. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a>
  390. <span>
  391. &nbsp;: string|null </span>
  392. </dt>
  393. <dd>Optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</dd>
  394. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  395. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
  396. <span>
  397. &nbsp;: string </span>
  398. </dt>
  399. <dd>String substitute for dark</dd>
  400. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  401. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
  402. <span>
  403. &nbsp;: string </span>
  404. </dt>
  405. <dd>String substitute for light</dd>
  406. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  407. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart</a>
  408. <span>
  409. &nbsp;: string </span>
  410. </dt>
  411. <dd>An optional line prefix, e.g. empty space to align the QR Code in a console</dd>
  412. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  413. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
  414. <span>
  415. &nbsp;: mixed|null </span>
  416. </dt>
  417. <dd>Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</dd>
  418. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  419. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
  420. <span>
  421. &nbsp;: int </span>
  422. </dt>
  423. <dd>QR Code version number</dd>
  424. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  425. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
  426. <span>
  427. &nbsp;: int </span>
  428. </dt>
  429. <dd>Maximum QR version</dd>
  430. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  431. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
  432. <span>
  433. &nbsp;: int </span>
  434. </dt>
  435. <dd>Minimum QR version</dd>
  436. </dl>
  437. <h4 id="toc-methods">
  438. Methods
  439. <a href="classes/chillerlan-QRCode-QROptions.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  440. </h4>
  441. <dl class="phpdocumentor-table-of-contents">
  442. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  443. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
  444. <span>
  445. &nbsp;: int|null </span>
  446. </dt>
  447. <dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
  448. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  449. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64">get_imageBase64()</a>
  450. <span>
  451. &nbsp;: bool </span>
  452. </dt>
  453. <dd>redirect call to the new variable</dd>
  454. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  455. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG">get_imageTransparencyBG()</a>
  456. <span>
  457. &nbsp;: mixed </span>
  458. </dt>
  459. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  460. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG">get_imagickBG()</a>
  461. <span>
  462. &nbsp;: mixed </span>
  463. </dt>
  464. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  465. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality">get_jpegQuality()</a>
  466. <span>
  467. &nbsp;: int </span>
  468. </dt>
  469. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  470. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression">get_pngCompression()</a>
  471. <span>
  472. &nbsp;: int </span>
  473. </dt>
  474. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  475. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a>
  476. <span>
  477. &nbsp;: void </span>
  478. </dt>
  479. <dd>clamp/set SVG circle radius</dd>
  480. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  481. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
  482. <span>
  483. &nbsp;: void </span>
  484. </dt>
  485. <dd>sets the FPDF measurement unit</dd>
  486. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  487. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64">set_imageBase64()</a>
  488. <span>
  489. &nbsp;: void </span>
  490. </dt>
  491. <dd>redirect call to the new variable</dd>
  492. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  493. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a>
  494. <span>
  495. &nbsp;: void </span>
  496. </dt>
  497. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  498. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG">set_imagickBG()</a>
  499. <span>
  500. &nbsp;: void </span>
  501. </dt>
  502. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  503. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality">set_jpegQuality()</a>
  504. <span>
  505. &nbsp;: void </span>
  506. </dt>
  507. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  508. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a>
  509. <span>
  510. &nbsp;: void </span>
  511. </dt>
  512. <dd>clamp/set logo space height</dd>
  513. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  514. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a>
  515. <span>
  516. &nbsp;: void </span>
  517. </dt>
  518. <dd>clamp/set horizontal logo space start</dd>
  519. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  520. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a>
  521. <span>
  522. &nbsp;: void </span>
  523. </dt>
  524. <dd>clamp/set vertical logo space start</dd>
  525. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  526. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a>
  527. <span>
  528. &nbsp;: void </span>
  529. </dt>
  530. <dd>clamp/set logo space width</dd>
  531. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  532. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression">set_pngCompression()</a>
  533. <span>
  534. &nbsp;: void </span>
  535. </dt>
  536. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  537. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a>
  538. <span>
  539. &nbsp;: void </span>
  540. </dt>
  541. <dd>sets/clamps the quiet zone size</dd>
  542. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  543. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
  544. <span>
  545. &nbsp;: void </span>
  546. </dt>
  547. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  548. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  549. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
  550. <span>
  551. &nbsp;: void </span>
  552. </dt>
  553. <dd>sets/clamps the version number</dd>
  554. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  555. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
  556. <span>
  557. &nbsp;: void </span>
  558. </dt>
  559. <dd>sets the maximum version number</dd>
  560. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  561. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
  562. <span>
  563. &nbsp;: void </span>
  564. </dt>
  565. <dd>sets the minimum version number</dd>
  566. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  567. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
  568. <span>
  569. &nbsp;: void </span>
  570. </dt>
  571. <dd>clamp min/max version number</dd>
  572. </dl>
  573. <section class="phpdocumentor-properties">
  574. <h3 class="phpdocumentor-elements__header" id="properties">
  575. Properties
  576. <a href="classes/chillerlan-QRCode-QROptions.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  577. </h3>
  578. <article
  579. class="
  580. phpdocumentor-element
  581. -property
  582. -protected
  583. "
  584. >
  585. <h4 class="phpdocumentor-element__name" id="property_addLogoSpace">
  586. $addLogoSpace
  587. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  588. <span class="phpdocumentor-element__modifiers">
  589. </span>
  590. </h4>
  591. <aside class="phpdocumentor-element-found-in">
  592. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  593. :
  594. <span class="phpdocumentor-element-found-in__line">216</span>
  595. </aside>
  596. <p class="phpdocumentor-summary">Toggles logo space creation</p>
  597. <code class="phpdocumentor-code phpdocumentor-signature ">
  598. <span class="phpdocumentor-signature__visibility">protected</span>
  599. <span class="phpdocumentor-signature__type">bool</span>
  600. <span class="phpdocumentor-signature__name">$addLogoSpace</span>
  601. = <span class="phpdocumentor-signature__default-value">false</span></code>
  602. </article>
  603. <article
  604. class="
  605. phpdocumentor-element
  606. -property
  607. -protected
  608. "
  609. >
  610. <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
  611. $addQuietzone
  612. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
  613. <span class="phpdocumentor-element__modifiers">
  614. </span>
  615. </h4>
  616. <aside class="phpdocumentor-element-found-in">
  617. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  618. :
  619. <span class="phpdocumentor-element-found-in__line">74</span>
  620. </aside>
  621. <p class="phpdocumentor-summary">Add a &quot;quiet zone&quot; (margin) according to the QR code spec</p>
  622. <code class="phpdocumentor-code phpdocumentor-signature ">
  623. <span class="phpdocumentor-signature__visibility">protected</span>
  624. <span class="phpdocumentor-signature__type">bool</span>
  625. <span class="phpdocumentor-signature__name">$addQuietzone</span>
  626. = <span class="phpdocumentor-signature__default-value">true</span></code>
  627. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  628. Tags
  629. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone#tags" class="headerlink"><i class="fas fa-link"></i></a>
  630. </h5>
  631. <dl class="phpdocumentor-tag-list">
  632. <dt class="phpdocumentor-tag-list__entry">
  633. <span class="phpdocumentor-tag__name">see</span>
  634. </dt>
  635. <dd class="phpdocumentor-tag-list__definition">
  636. <span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</a></span>
  637. </dd>
  638. </dl>
  639. </article>
  640. <article
  641. class="
  642. phpdocumentor-element
  643. -property
  644. -protected
  645. "
  646. >
  647. <h4 class="phpdocumentor-element__name" id="property_bgColor">
  648. $bgColor
  649. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" class="headerlink"><i class="fas fa-link"></i></a>
  650. <span class="phpdocumentor-element__modifiers">
  651. </span>
  652. </h4>
  653. <aside class="phpdocumentor-element-found-in">
  654. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  655. :
  656. <span class="phpdocumentor-element-found-in__line">158</span>
  657. </aside>
  658. <p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
  659. <code class="phpdocumentor-code phpdocumentor-signature ">
  660. <span class="phpdocumentor-signature__visibility">protected</span>
  661. <span class="phpdocumentor-signature__type">mixed|null</span>
  662. <span class="phpdocumentor-signature__name">$bgColor</span>
  663. = <span class="phpdocumentor-signature__default-value">null</span></code>
  664. <section class="phpdocumentor-description"><ul>
  665. <li>QRImagick: defaults to &quot;white&quot;</li>
  666. <li>QRGdImage: defaults to [255, 255, 255]</li>
  667. <li>QRFpdf: defaults to blank internally (white page)</li>
  668. </ul>
  669. </section>
  670. </article>
  671. <article
  672. class="
  673. phpdocumentor-element
  674. -property
  675. -protected
  676. "
  677. >
  678. <h4 class="phpdocumentor-element__name" id="property_cachefile">
  679. $cachefile
  680. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
  681. <span class="phpdocumentor-element__modifiers">
  682. </span>
  683. </h4>
  684. <aside class="phpdocumentor-element-found-in">
  685. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  686. :
  687. <span class="phpdocumentor-element-found-in__line">127</span>
  688. </aside>
  689. <p class="phpdocumentor-summary">Optional cache file path `/path/to/cache.file`</p>
  690. <code class="phpdocumentor-code phpdocumentor-signature ">
  691. <span class="phpdocumentor-signature__visibility">protected</span>
  692. <span class="phpdocumentor-signature__type">string|null</span>
  693. <span class="phpdocumentor-signature__name">$cachefile</span>
  694. = <span class="phpdocumentor-signature__default-value">null</span></code>
  695. <section class="phpdocumentor-description"><p>please note that the $file parameter in QRCode::render*() takes precedence over the $cachefile value</p>
  696. </section>
  697. </article>
  698. <article
  699. class="
  700. phpdocumentor-element
  701. -property
  702. -protected
  703. "
  704. >
  705. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  706. $circleRadius
  707. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  708. <span class="phpdocumentor-element__modifiers">
  709. </span>
  710. </h4>
  711. <aside class="phpdocumentor-element-found-in">
  712. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  713. :
  714. <span class="phpdocumentor-element-found-in__line">185</span>
  715. </aside>
  716. <p class="phpdocumentor-summary">Specifies the radius of the modules when $drawCircularModules is set to true</p>
  717. <code class="phpdocumentor-code phpdocumentor-signature ">
  718. <span class="phpdocumentor-signature__visibility">protected</span>
  719. <span class="phpdocumentor-signature__type">float</span>
  720. <span class="phpdocumentor-signature__name">$circleRadius</span>
  721. = <span class="phpdocumentor-signature__default-value">0.45</span></code>
  722. </article>
  723. <article
  724. class="
  725. phpdocumentor-element
  726. -property
  727. -protected
  728. "
  729. >
  730. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  731. $connectPaths
  732. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  733. <span class="phpdocumentor-element__modifiers">
  734. </span>
  735. </h4>
  736. <aside class="phpdocumentor-element-found-in">
  737. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  738. :
  739. <span class="phpdocumentor-element-found-in__line">197</span>
  740. </aside>
  741. <p class="phpdocumentor-summary">Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
  742. <code class="phpdocumentor-code phpdocumentor-signature ">
  743. <span class="phpdocumentor-signature__visibility">protected</span>
  744. <span class="phpdocumentor-signature__type">bool</span>
  745. <span class="phpdocumentor-signature__name">$connectPaths</span>
  746. = <span class="phpdocumentor-signature__default-value">false</span></code>
  747. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  748. Tags
  749. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  750. </h5>
  751. <dl class="phpdocumentor-tag-list">
  752. <dt class="phpdocumentor-tag-list__entry">
  753. <span class="phpdocumentor-tag__name">see</span>
  754. </dt>
  755. <dd class="phpdocumentor-tag-list__definition">
  756. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</a></span>
  757. </dd>
  758. </dl>
  759. </article>
  760. <article
  761. class="
  762. phpdocumentor-element
  763. -property
  764. -protected
  765. "
  766. >
  767. <h4 class="phpdocumentor-element__name" id="property_cssClass">
  768. $cssClass
  769. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
  770. <span class="phpdocumentor-element__modifiers">
  771. </span>
  772. </h4>
  773. <aside class="phpdocumentor-element-found-in">
  774. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  775. :
  776. <span class="phpdocumentor-element-found-in__line">306</span>
  777. </aside>
  778. <p class="phpdocumentor-summary">A common css class</p>
  779. <code class="phpdocumentor-code phpdocumentor-signature ">
  780. <span class="phpdocumentor-signature__visibility">protected</span>
  781. <span class="phpdocumentor-signature__type">string</span>
  782. <span class="phpdocumentor-signature__name">$cssClass</span>
  783. = <span class="phpdocumentor-signature__default-value">&#039;qrcode&#039;</span></code>
  784. </article>
  785. <article
  786. class="
  787. phpdocumentor-element
  788. -property
  789. -protected
  790. "
  791. >
  792. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  793. $drawCircularModules
  794. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  795. <span class="phpdocumentor-element__modifiers">
  796. </span>
  797. </h4>
  798. <aside class="phpdocumentor-element-found-in">
  799. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  800. :
  801. <span class="phpdocumentor-element-found-in__line">180</span>
  802. </aside>
  803. <p class="phpdocumentor-summary">Specify whether to draw the modules as filled circles</p>
  804. <code class="phpdocumentor-code phpdocumentor-signature ">
  805. <span class="phpdocumentor-signature__visibility">protected</span>
  806. <span class="phpdocumentor-signature__type">bool</span>
  807. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  808. = <span class="phpdocumentor-signature__default-value">false</span></code>
  809. <section class="phpdocumentor-description"><p>a note for GDImage output:</p>
  810. <p>if QROptions::$scale is less than 20, the image will be upscaled internally, then the modules will be drawn
  811. using imagefilledellipse() and then scaled back to the expected size</p>
  812. <p>No effect in: QREps, QRFpdf, QRMarkupHTML</p>
  813. </section>
  814. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  815. Tags
  816. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  817. </h5>
  818. <dl class="phpdocumentor-tag-list">
  819. <dt class="phpdocumentor-tag-list__entry">
  820. <span class="phpdocumentor-tag__name">see</span>
  821. </dt>
  822. <dd class="phpdocumentor-tag-list__definition">
  823. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
  824. </dd>
  825. <dt class="phpdocumentor-tag-list__entry">
  826. <span class="phpdocumentor-tag__name">see</span>
  827. </dt>
  828. <dd class="phpdocumentor-tag-list__definition">
  829. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/122">https://github.com/chillerlan/php-qrcode/discussions/122</a></span>
  830. </dd>
  831. </dl>
  832. </article>
  833. <article
  834. class="
  835. phpdocumentor-element
  836. -property
  837. -protected
  838. "
  839. >
  840. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  841. $drawLightModules
  842. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  843. <span class="phpdocumentor-element__modifiers">
  844. </span>
  845. </h4>
  846. <aside class="phpdocumentor-element-found-in">
  847. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  848. :
  849. <span class="phpdocumentor-element-found-in__line">165</span>
  850. </aside>
  851. <p class="phpdocumentor-summary">Whether to draw the light (false) modules</p>
  852. <code class="phpdocumentor-code phpdocumentor-signature ">
  853. <span class="phpdocumentor-signature__visibility">protected</span>
  854. <span class="phpdocumentor-signature__type">bool</span>
  855. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  856. = <span class="phpdocumentor-signature__default-value">true</span></code>
  857. </article>
  858. <article
  859. class="
  860. phpdocumentor-element
  861. -property
  862. -protected
  863. "
  864. >
  865. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  866. $eccLevel
  867. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  868. <span class="phpdocumentor-element__modifiers">
  869. </span>
  870. </h4>
  871. <aside class="phpdocumentor-element-found-in">
  872. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  873. :
  874. <span class="phpdocumentor-element-found-in__line">60</span>
  875. </aside>
  876. <p class="phpdocumentor-summary">Error correct level</p>
  877. <code class="phpdocumentor-code phpdocumentor-signature ">
  878. <span class="phpdocumentor-signature__visibility">protected</span>
  879. <span class="phpdocumentor-signature__type">int</span>
  880. <span class="phpdocumentor-signature__name">$eccLevel</span>
  881. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
  882. <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
  883. <ul>
  884. <li>L =&gt; 7%</li>
  885. <li>M =&gt; 15%</li>
  886. <li>Q =&gt; 25%</li>
  887. <li>H =&gt; 30%</li>
  888. </ul>
  889. </section>
  890. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  891. Tags
  892. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel#tags" class="headerlink"><i class="fas fa-link"></i></a>
  893. </h5>
  894. <dl class="phpdocumentor-tag-list">
  895. <dt class="phpdocumentor-tag-list__entry">
  896. <span class="phpdocumentor-tag__name">todo:</span>
  897. </dt>
  898. <dd class="phpdocumentor-tag-list__definition">
  899. <section class="phpdocumentor-description"><p>accept string values (PHP8+)</p>
  900. </section>
  901. </dd>
  902. <dt class="phpdocumentor-tag-list__entry">
  903. <span class="phpdocumentor-tag__name">see</span>
  904. </dt>
  905. <dd class="phpdocumentor-tag-list__definition">
  906. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/160">https://github.com/chillerlan/php-qrcode/discussions/160</a></span>
  907. </dd>
  908. </dl>
  909. </article>
  910. <article
  911. class="
  912. phpdocumentor-element
  913. -property
  914. -protected
  915. "
  916. >
  917. <h4 class="phpdocumentor-element__name" id="property_eol">
  918. $eol
  919. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  920. <span class="phpdocumentor-element__modifiers">
  921. </span>
  922. </h4>
  923. <aside class="phpdocumentor-element-found-in">
  924. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  925. :
  926. <span class="phpdocumentor-element-found-in__line">143</span>
  927. </aside>
  928. <p class="phpdocumentor-summary">Newline string</p>
  929. <code class="phpdocumentor-code phpdocumentor-signature ">
  930. <span class="phpdocumentor-signature__visibility">protected</span>
  931. <span class="phpdocumentor-signature__type">string</span>
  932. <span class="phpdocumentor-signature__name">$eol</span>
  933. = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
  934. </article>
  935. <article
  936. class="
  937. phpdocumentor-element
  938. -property
  939. -protected
  940. "
  941. >
  942. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  943. $excludeFromConnect
  944. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  945. <span class="phpdocumentor-element__modifiers">
  946. </span>
  947. </h4>
  948. <aside class="phpdocumentor-element-found-in">
  949. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  950. :
  951. <span class="phpdocumentor-element-found-in__line">202</span>
  952. </aside>
  953. <p class="phpdocumentor-summary">Specify which paths/patterns to exclude from connecting if $connectPaths is set to true</p>
  954. <code class="phpdocumentor-code phpdocumentor-signature ">
  955. <span class="phpdocumentor-signature__visibility">protected</span>
  956. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  957. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  958. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  959. </article>
  960. <article
  961. class="
  962. phpdocumentor-element
  963. -property
  964. -protected
  965. "
  966. >
  967. <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
  968. $fpdfMeasureUnit
  969. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  970. <span class="phpdocumentor-element__modifiers">
  971. </span>
  972. </h4>
  973. <aside class="phpdocumentor-element-found-in">
  974. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  975. :
  976. <span class="phpdocumentor-element-found-in__line">405</span>
  977. </aside>
  978. <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to &quot;pt&quot;)</p>
  979. <code class="phpdocumentor-code phpdocumentor-signature ">
  980. <span class="phpdocumentor-signature__visibility">protected</span>
  981. <span class="phpdocumentor-signature__type">string</span>
  982. <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
  983. = <span class="phpdocumentor-signature__default-value">&#039;pt&#039;</span></code>
  984. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  985. Tags
  986. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  987. </h5>
  988. <dl class="phpdocumentor-tag-list">
  989. <dt class="phpdocumentor-tag-list__entry">
  990. <span class="phpdocumentor-tag__name">see</span>
  991. </dt>
  992. <dd class="phpdocumentor-tag-list__definition">
  993. <span class="phpdocumentor-tag-link"><abbr title="\FPDF::__construct()">FPDF::__construct()</abbr></span>
  994. </dd>
  995. </dl>
  996. </article>
  997. <article
  998. class="
  999. phpdocumentor-element
  1000. -property
  1001. -protected
  1002. -deprecated "
  1003. >
  1004. <h4 class="phpdocumentor-element__name" id="property_imageBase64">
  1005. $imageBase64
  1006. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  1007. <span class="phpdocumentor-element__modifiers">
  1008. </span>
  1009. </h4>
  1010. <aside class="phpdocumentor-element-found-in">
  1011. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1012. :
  1013. <span class="phpdocumentor-element-found-in__line">133</span>
  1014. </aside>
  1015. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1016. <span class="phpdocumentor-signature__visibility">protected</span>
  1017. <span class="phpdocumentor-signature__type">bool</span>
  1018. <span class="phpdocumentor-signature__name">$imageBase64</span>
  1019. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1020. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1021. Tags
  1022. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1023. </h5>
  1024. <dl class="phpdocumentor-tag-list">
  1025. <dt class="phpdocumentor-tag-list__entry">
  1026. <span class="phpdocumentor-tag__name">deprecated</span>
  1027. </dt>
  1028. <dd class="phpdocumentor-tag-list__definition">
  1029. <span class="phpdocumentor-tag-link">5.0.0</span>
  1030. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  1031. </section>
  1032. </dd>
  1033. <dt class="phpdocumentor-tag-list__entry">
  1034. <span class="phpdocumentor-tag__name">see</span>
  1035. </dt>
  1036. <dd class="phpdocumentor-tag-list__definition">
  1037. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  1038. </dd>
  1039. </dl>
  1040. </article>
  1041. <article
  1042. class="
  1043. phpdocumentor-element
  1044. -property
  1045. -protected
  1046. "
  1047. >
  1048. <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
  1049. $imageTransparent
  1050. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
  1051. <span class="phpdocumentor-element__modifiers">
  1052. </span>
  1053. </h4>
  1054. <aside class="phpdocumentor-element-found-in">
  1055. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1056. :
  1057. <span class="phpdocumentor-element-found-in__line">259</span>
  1058. </aside>
  1059. <p class="phpdocumentor-summary">Toggle transparency</p>
  1060. <code class="phpdocumentor-code phpdocumentor-signature ">
  1061. <span class="phpdocumentor-signature__visibility">protected</span>
  1062. <span class="phpdocumentor-signature__type">bool</span>
  1063. <span class="phpdocumentor-signature__name">$imageTransparent</span>
  1064. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1065. <section class="phpdocumentor-description"><ul>
  1066. <li>QRGdImage and QRImagick: the given \chillerlan\QRCode\QROptions::$transparencyColor is set as transparent</li>
  1067. </ul>
  1068. </section>
  1069. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1070. Tags
  1071. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1072. </h5>
  1073. <dl class="phpdocumentor-tag-list">
  1074. <dt class="phpdocumentor-tag-list__entry">
  1075. <span class="phpdocumentor-tag__name">see</span>
  1076. </dt>
  1077. <dd class="phpdocumentor-tag-list__definition">
  1078. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/121">https://github.com/chillerlan/php-qrcode/discussions/121</a></span>
  1079. </dd>
  1080. </dl>
  1081. </article>
  1082. <article
  1083. class="
  1084. phpdocumentor-element
  1085. -property
  1086. -protected
  1087. "
  1088. >
  1089. <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
  1090. $imagickFormat
  1091. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
  1092. <span class="phpdocumentor-element__modifiers">
  1093. </span>
  1094. </h4>
  1095. <aside class="phpdocumentor-element-found-in">
  1096. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1097. :
  1098. <span class="phpdocumentor-element-found-in__line">296</span>
  1099. </aside>
  1100. <p class="phpdocumentor-summary">Imagick output format</p>
  1101. <code class="phpdocumentor-code phpdocumentor-signature ">
  1102. <span class="phpdocumentor-signature__visibility">protected</span>
  1103. <span class="phpdocumentor-signature__type">string</span>
  1104. <span class="phpdocumentor-signature__name">$imagickFormat</span>
  1105. = <span class="phpdocumentor-signature__default-value">&#039;png32&#039;</span></code>
  1106. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1107. Tags
  1108. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1109. </h5>
  1110. <dl class="phpdocumentor-tag-list">
  1111. <dt class="phpdocumentor-tag-list__entry">
  1112. <span class="phpdocumentor-tag__name">see</span>
  1113. </dt>
  1114. <dd class="phpdocumentor-tag-list__definition">
  1115. <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
  1116. </dd>
  1117. <dt class="phpdocumentor-tag-list__entry">
  1118. <span class="phpdocumentor-tag__name">see</span>
  1119. </dt>
  1120. <dd class="phpdocumentor-tag-list__definition">
  1121. <span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</a></span>
  1122. </dd>
  1123. </dl>
  1124. </article>
  1125. <article
  1126. class="
  1127. phpdocumentor-element
  1128. -property
  1129. -protected
  1130. "
  1131. >
  1132. <h4 class="phpdocumentor-element__name" id="property_jsonAsBooleans">
  1133. $jsonAsBooleans
  1134. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans" class="headerlink"><i class="fas fa-link"></i></a>
  1135. <span class="phpdocumentor-element__modifiers">
  1136. </span>
  1137. </h4>
  1138. <aside class="phpdocumentor-element-found-in">
  1139. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1140. :
  1141. <span class="phpdocumentor-element-found-in__line">394</span>
  1142. </aside>
  1143. <p class="phpdocumentor-summary">Whether to return matrix values in JSON as booleans or $M_TYPE integers</p>
  1144. <code class="phpdocumentor-code phpdocumentor-signature ">
  1145. <span class="phpdocumentor-signature__visibility">protected</span>
  1146. <span class="phpdocumentor-signature__type">bool</span>
  1147. <span class="phpdocumentor-signature__name">$jsonAsBooleans</span>
  1148. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1149. </article>
  1150. <article
  1151. class="
  1152. phpdocumentor-element
  1153. -property
  1154. -protected
  1155. "
  1156. >
  1157. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  1158. $keepAsSquare
  1159. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  1160. <span class="phpdocumentor-element__modifiers">
  1161. </span>
  1162. </h4>
  1163. <aside class="phpdocumentor-element-found-in">
  1164. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1165. :
  1166. <span class="phpdocumentor-element-found-in__line">190</span>
  1167. </aside>
  1168. <p class="phpdocumentor-summary">Specifies which module types to exclude when $drawCircularModules is set to true</p>
  1169. <code class="phpdocumentor-code phpdocumentor-signature ">
  1170. <span class="phpdocumentor-signature__visibility">protected</span>
  1171. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1172. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  1173. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1174. </article>
  1175. <article
  1176. class="
  1177. phpdocumentor-element
  1178. -property
  1179. -protected
  1180. "
  1181. >
  1182. <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
  1183. $logoSpaceHeight
  1184. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1185. <span class="phpdocumentor-element__modifiers">
  1186. </span>
  1187. </h4>
  1188. <aside class="phpdocumentor-element-found-in">
  1189. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1190. :
  1191. <span class="phpdocumentor-element-found-in__line">230</span>
  1192. </aside>
  1193. <p class="phpdocumentor-summary">Height of the logo space</p>
  1194. <code class="phpdocumentor-code phpdocumentor-signature ">
  1195. <span class="phpdocumentor-signature__visibility">protected</span>
  1196. <span class="phpdocumentor-signature__type">int|null</span>
  1197. <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
  1198. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1199. <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
  1200. </section>
  1201. </article>
  1202. <article
  1203. class="
  1204. phpdocumentor-element
  1205. -property
  1206. -protected
  1207. "
  1208. >
  1209. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
  1210. $logoSpaceStartX
  1211. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  1212. <span class="phpdocumentor-element__modifiers">
  1213. </span>
  1214. </h4>
  1215. <aside class="phpdocumentor-element-found-in">
  1216. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1217. :
  1218. <span class="phpdocumentor-element-found-in__line">235</span>
  1219. </aside>
  1220. <p class="phpdocumentor-summary">Optional horizontal start position of the logo space (top left corner)</p>
  1221. <code class="phpdocumentor-code phpdocumentor-signature ">
  1222. <span class="phpdocumentor-signature__visibility">protected</span>
  1223. <span class="phpdocumentor-signature__type">int|null</span>
  1224. <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
  1225. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1226. </article>
  1227. <article
  1228. class="
  1229. phpdocumentor-element
  1230. -property
  1231. -protected
  1232. "
  1233. >
  1234. <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
  1235. $logoSpaceStartY
  1236. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  1237. <span class="phpdocumentor-element__modifiers">
  1238. </span>
  1239. </h4>
  1240. <aside class="phpdocumentor-element-found-in">
  1241. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1242. :
  1243. <span class="phpdocumentor-element-found-in__line">240</span>
  1244. </aside>
  1245. <p class="phpdocumentor-summary">Optional vertical start position of the logo space (top left corner)</p>
  1246. <code class="phpdocumentor-code phpdocumentor-signature ">
  1247. <span class="phpdocumentor-signature__visibility">protected</span>
  1248. <span class="phpdocumentor-signature__type">int|null</span>
  1249. <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
  1250. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1251. </article>
  1252. <article
  1253. class="
  1254. phpdocumentor-element
  1255. -property
  1256. -protected
  1257. "
  1258. >
  1259. <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
  1260. $logoSpaceWidth
  1261. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1262. <span class="phpdocumentor-element__modifiers">
  1263. </span>
  1264. </h4>
  1265. <aside class="phpdocumentor-element-found-in">
  1266. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1267. :
  1268. <span class="phpdocumentor-element-found-in__line">223</span>
  1269. </aside>
  1270. <p class="phpdocumentor-summary">Width of the logo space</p>
  1271. <code class="phpdocumentor-code phpdocumentor-signature ">
  1272. <span class="phpdocumentor-signature__visibility">protected</span>
  1273. <span class="phpdocumentor-signature__type">int|null</span>
  1274. <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
  1275. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1276. <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
  1277. </section>
  1278. </article>
  1279. <article
  1280. class="
  1281. phpdocumentor-element
  1282. -property
  1283. -protected
  1284. "
  1285. >
  1286. <h4 class="phpdocumentor-element__name" id="property_markupDark">
  1287. $markupDark
  1288. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" class="headerlink"><i class="fas fa-link"></i></a>
  1289. <span class="phpdocumentor-element__modifiers">
  1290. </span>
  1291. </h4>
  1292. <aside class="phpdocumentor-element-found-in">
  1293. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1294. :
  1295. <span class="phpdocumentor-element-found-in__line">311</span>
  1296. </aside>
  1297. <p class="phpdocumentor-summary">Markup substitute for dark (CSS value)</p>
  1298. <code class="phpdocumentor-code phpdocumentor-signature ">
  1299. <span class="phpdocumentor-signature__visibility">protected</span>
  1300. <span class="phpdocumentor-signature__type">string</span>
  1301. <span class="phpdocumentor-signature__name">$markupDark</span>
  1302. = <span class="phpdocumentor-signature__default-value">&#039;#000&#039;</span></code>
  1303. </article>
  1304. <article
  1305. class="
  1306. phpdocumentor-element
  1307. -property
  1308. -protected
  1309. "
  1310. >
  1311. <h4 class="phpdocumentor-element__name" id="property_markupLight">
  1312. $markupLight
  1313. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" class="headerlink"><i class="fas fa-link"></i></a>
  1314. <span class="phpdocumentor-element__modifiers">
  1315. </span>
  1316. </h4>
  1317. <aside class="phpdocumentor-element-found-in">
  1318. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1319. :
  1320. <span class="phpdocumentor-element-found-in__line">316</span>
  1321. </aside>
  1322. <p class="phpdocumentor-summary">Markup substitute for light (CSS value)</p>
  1323. <code class="phpdocumentor-code phpdocumentor-signature ">
  1324. <span class="phpdocumentor-signature__visibility">protected</span>
  1325. <span class="phpdocumentor-signature__type">string</span>
  1326. <span class="phpdocumentor-signature__name">$markupLight</span>
  1327. = <span class="phpdocumentor-signature__default-value">&#039;#fff&#039;</span></code>
  1328. </article>
  1329. <article
  1330. class="
  1331. phpdocumentor-element
  1332. -property
  1333. -protected
  1334. "
  1335. >
  1336. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  1337. $maskPattern
  1338. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1339. <span class="phpdocumentor-element__modifiers">
  1340. </span>
  1341. </h4>
  1342. <aside class="phpdocumentor-element-found-in">
  1343. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1344. :
  1345. <span class="phpdocumentor-element-found-in__line">67</span>
  1346. </aside>
  1347. <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
  1348. <code class="phpdocumentor-code phpdocumentor-signature ">
  1349. <span class="phpdocumentor-signature__visibility">protected</span>
  1350. <span class="phpdocumentor-signature__type">int</span>
  1351. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1352. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
  1353. <section class="phpdocumentor-description"><p>[0...7] or MaskPattern::PATTERN_AUTO</p>
  1354. </section>
  1355. </article>
  1356. <article
  1357. class="
  1358. phpdocumentor-element
  1359. -property
  1360. -protected
  1361. "
  1362. >
  1363. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  1364. $moduleValues
  1365. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1366. <span class="phpdocumentor-element__modifiers">
  1367. </span>
  1368. </h4>
  1369. <aside class="phpdocumentor-element-found-in">
  1370. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1371. :
  1372. <span class="phpdocumentor-element-found-in__line">211</span>
  1373. </aside>
  1374. <p class="phpdocumentor-summary">Module values map</p>
  1375. <code class="phpdocumentor-code phpdocumentor-signature ">
  1376. <span class="phpdocumentor-signature__visibility">protected</span>
  1377. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  1378. <span class="phpdocumentor-signature__name">$moduleValues</span>
  1379. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1380. <section class="phpdocumentor-description"><ul>
  1381. <li>QRImagick, QRMarkupHTML, QRMarkupSVG: #ABCDEF, cssname, rgb(), rgba()...</li>
  1382. <li>QREps, QRFpdf, QRGdImage: [R, G, B] // 0-255</li>
  1383. <li>QREps: [C, M, Y, K] // 0-255</li>
  1384. </ul>
  1385. </section>
  1386. </article>
  1387. <article
  1388. class="
  1389. phpdocumentor-element
  1390. -property
  1391. -protected
  1392. "
  1393. >
  1394. <h4 class="phpdocumentor-element__name" id="property_outputBase64">
  1395. $outputBase64
  1396. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64" class="headerlink"><i class="fas fa-link"></i></a>
  1397. <span class="phpdocumentor-element__modifiers">
  1398. </span>
  1399. </h4>
  1400. <aside class="phpdocumentor-element-found-in">
  1401. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1402. :
  1403. <span class="phpdocumentor-element-found-in__line">138</span>
  1404. </aside>
  1405. <p class="phpdocumentor-summary">Toggle base64 data URI or raw data output (if applicable)</p>
  1406. <code class="phpdocumentor-code phpdocumentor-signature ">
  1407. <span class="phpdocumentor-signature__visibility">protected</span>
  1408. <span class="phpdocumentor-signature__type">bool</span>
  1409. <span class="phpdocumentor-signature__name">$outputBase64</span>
  1410. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1411. </article>
  1412. <article
  1413. class="
  1414. phpdocumentor-element
  1415. -property
  1416. -protected
  1417. "
  1418. >
  1419. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  1420. $outputInterface
  1421. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1422. <span class="phpdocumentor-element__modifiers">
  1423. </span>
  1424. </h4>
  1425. <aside class="phpdocumentor-element-found-in">
  1426. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1427. :
  1428. <span class="phpdocumentor-element-found-in__line">104</span>
  1429. </aside>
  1430. <p class="phpdocumentor-summary">The FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
  1431. <code class="phpdocumentor-code phpdocumentor-signature ">
  1432. <span class="phpdocumentor-signature__visibility">protected</span>
  1433. <span class="phpdocumentor-signature__type">string|null</span>
  1434. <span class="phpdocumentor-signature__name">$outputInterface</span>
  1435. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1436. </article>
  1437. <article
  1438. class="
  1439. phpdocumentor-element
  1440. -property
  1441. -protected
  1442. "
  1443. >
  1444. <h4 class="phpdocumentor-element__name" id="property_outputType">
  1445. $outputType
  1446. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" class="headerlink"><i class="fas fa-link"></i></a>
  1447. <span class="phpdocumentor-element__modifiers">
  1448. </span>
  1449. </h4>
  1450. <aside class="phpdocumentor-element-found-in">
  1451. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1452. :
  1453. <span class="phpdocumentor-element-found-in__line">99</span>
  1454. </aside>
  1455. <p class="phpdocumentor-summary">The built-in output type</p>
  1456. <code class="phpdocumentor-code phpdocumentor-signature ">
  1457. <span class="phpdocumentor-signature__visibility">protected</span>
  1458. <span class="phpdocumentor-signature__type">string</span>
  1459. <span class="phpdocumentor-signature__name">$outputType</span>
  1460. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG</span></code>
  1461. <section class="phpdocumentor-description"><ul>
  1462. <li>QROutputInterface::MARKUP_XXXX where XXXX = HTML, SVG</li>
  1463. <li>QROutputInterface::GDIMAGE_XXX where XXX = BMP, GIF, JPG, PNG, WEBP</li>
  1464. <li>QROutputInterface::STRING_XXXX where XXXX = TEXT, JSON</li>
  1465. <li>QROutputInterface::IMAGICK</li>
  1466. <li>QROutputInterface::EPS</li>
  1467. <li>QROutputInterface::FPDF</li>
  1468. <li>QROutputInterface::CUSTOM</li>
  1469. </ul>
  1470. </section>
  1471. </article>
  1472. <article
  1473. class="
  1474. phpdocumentor-element
  1475. -property
  1476. -protected
  1477. "
  1478. >
  1479. <h4 class="phpdocumentor-element__name" id="property_quality">
  1480. $quality
  1481. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality" class="headerlink"><i class="fas fa-link"></i></a>
  1482. <span class="phpdocumentor-element__modifiers">
  1483. </span>
  1484. </h4>
  1485. <aside class="phpdocumentor-element-found-in">
  1486. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1487. :
  1488. <span class="phpdocumentor-element-found-in__line">283</span>
  1489. </aside>
  1490. <p class="phpdocumentor-summary">Compression quality</p>
  1491. <code class="phpdocumentor-code phpdocumentor-signature ">
  1492. <span class="phpdocumentor-signature__visibility">protected</span>
  1493. <span class="phpdocumentor-signature__type">int</span>
  1494. <span class="phpdocumentor-signature__name">$quality</span>
  1495. = <span class="phpdocumentor-signature__default-value">-1</span></code>
  1496. <section class="phpdocumentor-description"><p>The given value depends on the used output type:</p>
  1497. <ul>
  1498. <li>GDIMAGE_BMP <abbr title="\imagebmp()">imagebmp()</abbr> [0-1]</li>
  1499. <li>GDIMAGE_JPG <abbr title="\imagejpeg()">imagejpeg()</abbr> [0-100]</li>
  1500. <li>GDIMAGE_WEBP <abbr title="\imagepng()">imagepng()</abbr> [0-9]</li>
  1501. <li>GDIMAGE_PNG <abbr title="\imagewebp()">imagewebp()</abbr> [0-100]</li>
  1502. <li>IMAGICK <abbr title="\Imagick::setImageCompressionQuality()">Imagick::setImageCompressionQuality()</abbr> [0-100]</li>
  1503. </ul>
  1504. </section>
  1505. </article>
  1506. <article
  1507. class="
  1508. phpdocumentor-element
  1509. -property
  1510. -protected
  1511. "
  1512. >
  1513. <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
  1514. $quietzoneSize
  1515. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  1516. <span class="phpdocumentor-element__modifiers">
  1517. </span>
  1518. </h4>
  1519. <aside class="phpdocumentor-element-found-in">
  1520. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1521. :
  1522. <span class="phpdocumentor-element-found-in__line">81</span>
  1523. </aside>
  1524. <p class="phpdocumentor-summary">Size of the quiet zone</p>
  1525. <code class="phpdocumentor-code phpdocumentor-signature ">
  1526. <span class="phpdocumentor-signature__visibility">protected</span>
  1527. <span class="phpdocumentor-signature__type">int</span>
  1528. <span class="phpdocumentor-signature__name">$quietzoneSize</span>
  1529. = <span class="phpdocumentor-signature__default-value">4</span></code>
  1530. <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
  1531. </section>
  1532. </article>
  1533. <article
  1534. class="
  1535. phpdocumentor-element
  1536. -property
  1537. -protected
  1538. "
  1539. >
  1540. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  1541. $readerGrayscale
  1542. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  1543. <span class="phpdocumentor-element__modifiers">
  1544. </span>
  1545. </h4>
  1546. <aside class="phpdocumentor-element-found-in">
  1547. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1548. :
  1549. <span class="phpdocumentor-element-found-in__line">420</span>
  1550. </aside>
  1551. <p class="phpdocumentor-summary">Grayscale the image before reading</p>
  1552. <code class="phpdocumentor-code phpdocumentor-signature ">
  1553. <span class="phpdocumentor-signature__visibility">protected</span>
  1554. <span class="phpdocumentor-signature__type">bool</span>
  1555. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  1556. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1557. </article>
  1558. <article
  1559. class="
  1560. phpdocumentor-element
  1561. -property
  1562. -protected
  1563. "
  1564. >
  1565. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  1566. $readerIncreaseContrast
  1567. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" 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">427</span>
  1575. </aside>
  1576. <p class="phpdocumentor-summary">Increase the contrast before reading</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">$readerIncreaseContrast</span>
  1581. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1582. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  1583. </section>
  1584. </article>
  1585. <article
  1586. class="
  1587. phpdocumentor-element
  1588. -property
  1589. -protected
  1590. "
  1591. >
  1592. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  1593. $readerUseImagickIfAvailable
  1594. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  1595. <span class="phpdocumentor-element__modifiers">
  1596. </span>
  1597. </h4>
  1598. <aside class="phpdocumentor-element-found-in">
  1599. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1600. :
  1601. <span class="phpdocumentor-element-found-in__line">415</span>
  1602. </aside>
  1603. <p class="phpdocumentor-summary">Use Imagick (if available) when reading QR Codes</p>
  1604. <code class="phpdocumentor-code phpdocumentor-signature ">
  1605. <span class="phpdocumentor-signature__visibility">protected</span>
  1606. <span class="phpdocumentor-signature__type">bool</span>
  1607. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  1608. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1609. </article>
  1610. <article
  1611. class="
  1612. phpdocumentor-element
  1613. -property
  1614. -protected
  1615. "
  1616. >
  1617. <h4 class="phpdocumentor-element__name" id="property_returnResource">
  1618. $returnResource
  1619. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
  1620. <span class="phpdocumentor-element__modifiers">
  1621. </span>
  1622. </h4>
  1623. <aside class="phpdocumentor-element-found-in">
  1624. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1625. :
  1626. <span class="phpdocumentor-element-found-in__line">120</span>
  1627. </aside>
  1628. <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
  1629. <code class="phpdocumentor-code phpdocumentor-signature ">
  1630. <span class="phpdocumentor-signature__visibility">protected</span>
  1631. <span class="phpdocumentor-signature__type">bool</span>
  1632. <span class="phpdocumentor-signature__name">$returnResource</span>
  1633. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1634. <section class="phpdocumentor-description"><p>This option overrides/ignores other output options, such as $cachefile and $outputBase64.</p>
  1635. <p>Supported by the following modules:</p>
  1636. <ul>
  1637. <li>QRGdImage: resource (PHP &lt; 8), GdImage</li>
  1638. <li>QRImagick: Imagick</li>
  1639. <li>QRFpdf: FPDF</li>
  1640. </ul>
  1641. </section>
  1642. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1643. Tags
  1644. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1645. </h5>
  1646. <dl class="phpdocumentor-tag-list">
  1647. <dt class="phpdocumentor-tag-list__entry">
  1648. <span class="phpdocumentor-tag__name">see</span>
  1649. </dt>
  1650. <dd class="phpdocumentor-tag-list__definition">
  1651. <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>
  1652. </dd>
  1653. </dl>
  1654. </article>
  1655. <article
  1656. class="
  1657. phpdocumentor-element
  1658. -property
  1659. -protected
  1660. "
  1661. >
  1662. <h4 class="phpdocumentor-element__name" id="property_scale">
  1663. $scale
  1664. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  1665. <span class="phpdocumentor-element__modifiers">
  1666. </span>
  1667. </h4>
  1668. <aside class="phpdocumentor-element-found-in">
  1669. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1670. :
  1671. <span class="phpdocumentor-element-found-in__line">250</span>
  1672. </aside>
  1673. <p class="phpdocumentor-summary">Pixel size of a QR code module</p>
  1674. <code class="phpdocumentor-code phpdocumentor-signature ">
  1675. <span class="phpdocumentor-signature__visibility">protected</span>
  1676. <span class="phpdocumentor-signature__type">int</span>
  1677. <span class="phpdocumentor-signature__name">$scale</span>
  1678. = <span class="phpdocumentor-signature__default-value">5</span></code>
  1679. </article>
  1680. <article
  1681. class="
  1682. phpdocumentor-element
  1683. -property
  1684. -protected
  1685. "
  1686. >
  1687. <h4 class="phpdocumentor-element__name" id="property_svgAddXmlHeader">
  1688. $svgAddXmlHeader
  1689. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader" class="headerlink"><i class="fas fa-link"></i></a>
  1690. <span class="phpdocumentor-element__modifiers">
  1691. </span>
  1692. </h4>
  1693. <aside class="phpdocumentor-element-found-in">
  1694. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1695. :
  1696. <span class="phpdocumentor-element-found-in__line">328</span>
  1697. </aside>
  1698. <p class="phpdocumentor-summary">Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML</p>
  1699. <code class="phpdocumentor-code phpdocumentor-signature ">
  1700. <span class="phpdocumentor-signature__visibility">protected</span>
  1701. <span class="phpdocumentor-signature__type">bool</span>
  1702. <span class="phpdocumentor-signature__name">$svgAddXmlHeader</span>
  1703. = <span class="phpdocumentor-signature__default-value">true</span></code>
  1704. <section class="phpdocumentor-description"><p><code class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</code></p>
  1705. </section>
  1706. </article>
  1707. <article
  1708. class="
  1709. phpdocumentor-element
  1710. -property
  1711. -protected
  1712. "
  1713. >
  1714. <h4 class="phpdocumentor-element__name" id="property_svgDefs">
  1715. $svgDefs
  1716. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
  1717. <span class="phpdocumentor-element__modifiers">
  1718. </span>
  1719. </h4>
  1720. <aside class="phpdocumentor-element-found-in">
  1721. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1722. :
  1723. <span class="phpdocumentor-element-found-in__line">340</span>
  1724. </aside>
  1725. <p class="phpdocumentor-summary">Anything in the &lt;defs&gt; tag</p>
  1726. <code class="phpdocumentor-code phpdocumentor-signature ">
  1727. <span class="phpdocumentor-signature__visibility">protected</span>
  1728. <span class="phpdocumentor-signature__type">string</span>
  1729. <span class="phpdocumentor-signature__name">$svgDefs</span>
  1730. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1731. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1732. Tags
  1733. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1734. </h5>
  1735. <dl class="phpdocumentor-tag-list">
  1736. <dt class="phpdocumentor-tag-list__entry">
  1737. <span class="phpdocumentor-tag__name">see</span>
  1738. </dt>
  1739. <dd class="phpdocumentor-tag-list__definition">
  1740. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</a></span>
  1741. </dd>
  1742. </dl>
  1743. </article>
  1744. <article
  1745. class="
  1746. phpdocumentor-element
  1747. -property
  1748. -protected
  1749. "
  1750. >
  1751. <h4 class="phpdocumentor-element__name" id="property_svgHeight">
  1752. $svgHeight
  1753. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" class="headerlink"><i class="fas fa-link"></i></a>
  1754. <span class="phpdocumentor-element__modifiers">
  1755. </span>
  1756. </h4>
  1757. <aside class="phpdocumentor-element-found-in">
  1758. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1759. :
  1760. <span class="phpdocumentor-element-found-in__line">369</span>
  1761. </aside>
  1762. <p class="phpdocumentor-summary">Optional &quot;height&quot; attribute with the specified value (note that the value is not checked!)</p>
  1763. <code class="phpdocumentor-code phpdocumentor-signature ">
  1764. <span class="phpdocumentor-signature__visibility">protected</span>
  1765. <span class="phpdocumentor-signature__type">string|null</span>
  1766. <span class="phpdocumentor-signature__name">$svgHeight</span>
  1767. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1768. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1769. Tags
  1770. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1771. </h5>
  1772. <dl class="phpdocumentor-tag-list">
  1773. <dt class="phpdocumentor-tag-list__entry">
  1774. <span class="phpdocumentor-tag__name">see</span>
  1775. </dt>
  1776. <dd class="phpdocumentor-tag-list__definition">
  1777. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height</a></span>
  1778. </dd>
  1779. </dl>
  1780. </article>
  1781. <article
  1782. class="
  1783. phpdocumentor-element
  1784. -property
  1785. -protected
  1786. "
  1787. >
  1788. <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
  1789. $svgOpacity
  1790. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" class="headerlink"><i class="fas fa-link"></i></a>
  1791. <span class="phpdocumentor-element__modifiers">
  1792. </span>
  1793. </h4>
  1794. <aside class="phpdocumentor-element-found-in">
  1795. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1796. :
  1797. <span class="phpdocumentor-element-found-in__line">333</span>
  1798. </aside>
  1799. <p class="phpdocumentor-summary">SVG opacity</p>
  1800. <code class="phpdocumentor-code phpdocumentor-signature ">
  1801. <span class="phpdocumentor-signature__visibility">protected</span>
  1802. <span class="phpdocumentor-signature__type">float</span>
  1803. <span class="phpdocumentor-signature__name">$svgOpacity</span>
  1804. = <span class="phpdocumentor-signature__default-value">1.0</span></code>
  1805. </article>
  1806. <article
  1807. class="
  1808. phpdocumentor-element
  1809. -property
  1810. -protected
  1811. "
  1812. >
  1813. <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
  1814. $svgPreserveAspectRatio
  1815. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
  1816. <span class="phpdocumentor-element__modifiers">
  1817. </span>
  1818. </h4>
  1819. <aside class="phpdocumentor-element-found-in">
  1820. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1821. :
  1822. <span class="phpdocumentor-element-found-in__line">355</span>
  1823. </aside>
  1824. <code class="phpdocumentor-code phpdocumentor-signature ">
  1825. <span class="phpdocumentor-signature__visibility">protected</span>
  1826. <span class="phpdocumentor-signature__type">string</span>
  1827. <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
  1828. = <span class="phpdocumentor-signature__default-value">&#039;xMidYMid&#039;</span></code>
  1829. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1830. Tags
  1831. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1832. </h5>
  1833. <dl class="phpdocumentor-tag-list">
  1834. <dt class="phpdocumentor-tag-list__entry">
  1835. <span class="phpdocumentor-tag__name">see</span>
  1836. </dt>
  1837. <dd class="phpdocumentor-tag-list__definition">
  1838. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</a></span>
  1839. </dd>
  1840. </dl>
  1841. </article>
  1842. <article
  1843. class="
  1844. phpdocumentor-element
  1845. -property
  1846. -protected
  1847. "
  1848. >
  1849. <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
  1850. $svgViewBoxSize
  1851. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" class="headerlink"><i class="fas fa-link"></i></a>
  1852. <span class="phpdocumentor-element__modifiers">
  1853. </span>
  1854. </h4>
  1855. <aside class="phpdocumentor-element-found-in">
  1856. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1857. :
  1858. <span class="phpdocumentor-element-found-in__line">350</span>
  1859. </aside>
  1860. <p class="phpdocumentor-summary">SVG viewBox size. A single integer number which defines width/height of the viewBox attribute.</p>
  1861. <code class="phpdocumentor-code phpdocumentor-signature ">
  1862. <span class="phpdocumentor-signature__visibility">protected</span>
  1863. <span class="phpdocumentor-signature__type">int|null</span>
  1864. <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
  1865. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1866. <section class="phpdocumentor-description"><p>viewBox=&quot;0 0 x x&quot;</p>
  1867. </section>
  1868. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1869. Tags
  1870. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1871. </h5>
  1872. <dl class="phpdocumentor-tag-list">
  1873. <dt class="phpdocumentor-tag-list__entry">
  1874. <span class="phpdocumentor-tag__name">see</span>
  1875. </dt>
  1876. <dd class="phpdocumentor-tag-list__definition">
  1877. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</a></span>
  1878. </dd>
  1879. <dt class="phpdocumentor-tag-list__entry">
  1880. <span class="phpdocumentor-tag__name">see</span>
  1881. </dt>
  1882. <dd class="phpdocumentor-tag-list__definition">
  1883. <span class="phpdocumentor-tag-link"><a href="https://css-tricks.com/scale-svg/#article-header-id-3">https://css-tricks.com/scale-svg/#article-header-id-3</a></span>
  1884. </dd>
  1885. </dl>
  1886. </article>
  1887. <article
  1888. class="
  1889. phpdocumentor-element
  1890. -property
  1891. -protected
  1892. "
  1893. >
  1894. <h4 class="phpdocumentor-element__name" id="property_svgWidth">
  1895. $svgWidth
  1896. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" class="headerlink"><i class="fas fa-link"></i></a>
  1897. <span class="phpdocumentor-element__modifiers">
  1898. </span>
  1899. </h4>
  1900. <aside class="phpdocumentor-element-found-in">
  1901. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1902. :
  1903. <span class="phpdocumentor-element-found-in__line">362</span>
  1904. </aside>
  1905. <p class="phpdocumentor-summary">Optional &quot;width&quot; attribute with the specified value (note that the value is not checked!)</p>
  1906. <code class="phpdocumentor-code phpdocumentor-signature ">
  1907. <span class="phpdocumentor-signature__visibility">protected</span>
  1908. <span class="phpdocumentor-signature__type">string|null</span>
  1909. <span class="phpdocumentor-signature__name">$svgWidth</span>
  1910. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1911. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1912. Tags
  1913. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1914. </h5>
  1915. <dl class="phpdocumentor-tag-list">
  1916. <dt class="phpdocumentor-tag-list__entry">
  1917. <span class="phpdocumentor-tag__name">see</span>
  1918. </dt>
  1919. <dd class="phpdocumentor-tag-list__definition">
  1920. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width</a></span>
  1921. </dd>
  1922. </dl>
  1923. </article>
  1924. <article
  1925. class="
  1926. phpdocumentor-element
  1927. -property
  1928. -protected
  1929. "
  1930. >
  1931. <h4 class="phpdocumentor-element__name" id="property_textDark">
  1932. $textDark
  1933. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" class="headerlink"><i class="fas fa-link"></i></a>
  1934. <span class="phpdocumentor-element__modifiers">
  1935. </span>
  1936. </h4>
  1937. <aside class="phpdocumentor-element-found-in">
  1938. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1939. :
  1940. <span class="phpdocumentor-element-found-in__line">379</span>
  1941. </aside>
  1942. <p class="phpdocumentor-summary">String substitute for dark</p>
  1943. <code class="phpdocumentor-code phpdocumentor-signature ">
  1944. <span class="phpdocumentor-signature__visibility">protected</span>
  1945. <span class="phpdocumentor-signature__type">string</span>
  1946. <span class="phpdocumentor-signature__name">$textDark</span>
  1947. = <span class="phpdocumentor-signature__default-value">&#039;██&#039;</span></code>
  1948. </article>
  1949. <article
  1950. class="
  1951. phpdocumentor-element
  1952. -property
  1953. -protected
  1954. "
  1955. >
  1956. <h4 class="phpdocumentor-element__name" id="property_textLight">
  1957. $textLight
  1958. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" class="headerlink"><i class="fas fa-link"></i></a>
  1959. <span class="phpdocumentor-element__modifiers">
  1960. </span>
  1961. </h4>
  1962. <aside class="phpdocumentor-element-found-in">
  1963. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1964. :
  1965. <span class="phpdocumentor-element-found-in__line">384</span>
  1966. </aside>
  1967. <p class="phpdocumentor-summary">String substitute for light</p>
  1968. <code class="phpdocumentor-code phpdocumentor-signature ">
  1969. <span class="phpdocumentor-signature__visibility">protected</span>
  1970. <span class="phpdocumentor-signature__type">string</span>
  1971. <span class="phpdocumentor-signature__name">$textLight</span>
  1972. = <span class="phpdocumentor-signature__default-value">&#039;░░&#039;</span></code>
  1973. </article>
  1974. <article
  1975. class="
  1976. phpdocumentor-element
  1977. -property
  1978. -protected
  1979. "
  1980. >
  1981. <h4 class="phpdocumentor-element__name" id="property_textLineStart">
  1982. $textLineStart
  1983. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart" class="headerlink"><i class="fas fa-link"></i></a>
  1984. <span class="phpdocumentor-element__modifiers">
  1985. </span>
  1986. </h4>
  1987. <aside class="phpdocumentor-element-found-in">
  1988. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  1989. :
  1990. <span class="phpdocumentor-element-found-in__line">389</span>
  1991. </aside>
  1992. <p class="phpdocumentor-summary">An optional line prefix, e.g. empty space to align the QR Code in a console</p>
  1993. <code class="phpdocumentor-code phpdocumentor-signature ">
  1994. <span class="phpdocumentor-signature__visibility">protected</span>
  1995. <span class="phpdocumentor-signature__type">string</span>
  1996. <span class="phpdocumentor-signature__name">$textLineStart</span>
  1997. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
  1998. </article>
  1999. <article
  2000. class="
  2001. phpdocumentor-element
  2002. -property
  2003. -protected
  2004. "
  2005. >
  2006. <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
  2007. $transparencyColor
  2008. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  2009. <span class="phpdocumentor-element__modifiers">
  2010. </span>
  2011. </h4>
  2012. <aside class="phpdocumentor-element-found-in">
  2013. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2014. :
  2015. <span class="phpdocumentor-element-found-in__line">270</span>
  2016. </aside>
  2017. <p class="phpdocumentor-summary">Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</p>
  2018. <code class="phpdocumentor-code phpdocumentor-signature ">
  2019. <span class="phpdocumentor-signature__visibility">protected</span>
  2020. <span class="phpdocumentor-signature__type">mixed|null</span>
  2021. <span class="phpdocumentor-signature__name">$transparencyColor</span>
  2022. = <span class="phpdocumentor-signature__default-value">null</span></code>
  2023. <section class="phpdocumentor-description"><p>Defaults to \chillerlan\QRCode\QROptions::$bgColor.</p>
  2024. <ul>
  2025. <li>QRGdImage: [R, G, B], this color is set as transparent in <abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr>
  2026. </li>
  2027. <li>QRImagick: &quot;color_str&quot;, this color is set in <abbr title="\chillerlan\QRCode\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr>
  2028. </li>
  2029. </ul>
  2030. </section>
  2031. </article>
  2032. <article
  2033. class="
  2034. phpdocumentor-element
  2035. -property
  2036. -protected
  2037. "
  2038. >
  2039. <h4 class="phpdocumentor-element__name" id="property_version">
  2040. $version
  2041. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  2042. <span class="phpdocumentor-element__modifiers">
  2043. </span>
  2044. </h4>
  2045. <aside class="phpdocumentor-element-found-in">
  2046. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2047. :
  2048. <span class="phpdocumentor-element-found-in__line">33</span>
  2049. </aside>
  2050. <p class="phpdocumentor-summary">QR Code version number</p>
  2051. <code class="phpdocumentor-code phpdocumentor-signature ">
  2052. <span class="phpdocumentor-signature__visibility">protected</span>
  2053. <span class="phpdocumentor-signature__type">int</span>
  2054. <span class="phpdocumentor-signature__name">$version</span>
  2055. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
  2056. <section class="phpdocumentor-description"><p>[1 ... 40] or Version::AUTO</p>
  2057. </section>
  2058. </article>
  2059. <article
  2060. class="
  2061. phpdocumentor-element
  2062. -property
  2063. -protected
  2064. "
  2065. >
  2066. <h4 class="phpdocumentor-element__name" id="property_versionMax">
  2067. $versionMax
  2068. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2069. <span class="phpdocumentor-element__modifiers">
  2070. </span>
  2071. </h4>
  2072. <aside class="phpdocumentor-element-found-in">
  2073. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2074. :
  2075. <span class="phpdocumentor-element-found-in__line">45</span>
  2076. </aside>
  2077. <p class="phpdocumentor-summary">Maximum QR version</p>
  2078. <code class="phpdocumentor-code phpdocumentor-signature ">
  2079. <span class="phpdocumentor-signature__visibility">protected</span>
  2080. <span class="phpdocumentor-signature__type">int</span>
  2081. <span class="phpdocumentor-signature__name">$versionMax</span>
  2082. = <span class="phpdocumentor-signature__default-value">40</span></code>
  2083. </article>
  2084. <article
  2085. class="
  2086. phpdocumentor-element
  2087. -property
  2088. -protected
  2089. "
  2090. >
  2091. <h4 class="phpdocumentor-element__name" id="property_versionMin">
  2092. $versionMin
  2093. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  2094. <span class="phpdocumentor-element__modifiers">
  2095. </span>
  2096. </h4>
  2097. <aside class="phpdocumentor-element-found-in">
  2098. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2099. :
  2100. <span class="phpdocumentor-element-found-in__line">40</span>
  2101. </aside>
  2102. <p class="phpdocumentor-summary">Minimum QR version</p>
  2103. <code class="phpdocumentor-code phpdocumentor-signature ">
  2104. <span class="phpdocumentor-signature__visibility">protected</span>
  2105. <span class="phpdocumentor-signature__type">int</span>
  2106. <span class="phpdocumentor-signature__name">$versionMin</span>
  2107. = <span class="phpdocumentor-signature__default-value">1</span></code>
  2108. <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
  2109. </section>
  2110. </article>
  2111. </section>
  2112. <section class="phpdocumentor-methods">
  2113. <h3 class="phpdocumentor-elements__header" id="methods">
  2114. Methods
  2115. <a href="classes/chillerlan-QRCode-QROptions.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  2116. </h3>
  2117. <article
  2118. class="phpdocumentor-element
  2119. -method
  2120. -protected
  2121. "
  2122. >
  2123. <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
  2124. clampLogoSpaceValue()
  2125. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  2126. </h4>
  2127. <aside class="phpdocumentor-element-found-in">
  2128. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2129. :
  2130. <span class="phpdocumentor-element-found-in__line">494</span>
  2131. </aside>
  2132. <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
  2133. <code class="phpdocumentor-code phpdocumentor-signature ">
  2134. <span class="phpdocumentor-signature__visibility">protected</span>
  2135. <span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
  2136. <div class="phpdocumentor-label-line">
  2137. </div>
  2138. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2139. <dl class="phpdocumentor-argument-list">
  2140. <dt class="phpdocumentor-argument-list__entry">
  2141. <span class="phpdocumentor-signature__argument__name">$value</span>
  2142. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2143. </dt>
  2144. <dd class="phpdocumentor-argument-list__definition">
  2145. </dd>
  2146. </dl>
  2147. <section>
  2148. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2149. <span class="phpdocumentor-signature__response_type">int|null</span>
  2150. </section>
  2151. </article>
  2152. <article
  2153. class="phpdocumentor-element
  2154. -method
  2155. -protected
  2156. -deprecated "
  2157. >
  2158. <h4 class="phpdocumentor-element__name" id="method_get_imageBase64">
  2159. get_imageBase64()
  2160. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  2161. </h4>
  2162. <aside class="phpdocumentor-element-found-in">
  2163. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2164. :
  2165. <span class="phpdocumentor-element-found-in__line">556</span>
  2166. </aside>
  2167. <p class="phpdocumentor-summary">redirect call to the new variable</p>
  2168. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2169. <span class="phpdocumentor-signature__visibility">protected</span>
  2170. <span class="phpdocumentor-signature__name">get_imageBase64</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  2171. <div class="phpdocumentor-label-line">
  2172. </div>
  2173. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2174. Tags
  2175. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2176. </h5>
  2177. <dl class="phpdocumentor-tag-list">
  2178. <dt class="phpdocumentor-tag-list__entry">
  2179. <span class="phpdocumentor-tag__name">deprecated</span>
  2180. </dt>
  2181. <dd class="phpdocumentor-tag-list__definition">
  2182. <span class="phpdocumentor-tag-link">5.0.0</span>
  2183. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  2184. </section>
  2185. </dd>
  2186. <dt class="phpdocumentor-tag-list__entry">
  2187. <span class="phpdocumentor-tag__name">see</span>
  2188. </dt>
  2189. <dd class="phpdocumentor-tag-list__definition">
  2190. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  2191. </dd>
  2192. <dt class="phpdocumentor-tag-list__entry">
  2193. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2194. </dt>
  2195. <dd class="phpdocumentor-tag-list__definition">
  2196. </dd>
  2197. </dl>
  2198. <section>
  2199. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2200. <span class="phpdocumentor-signature__response_type">bool</span>
  2201. </section>
  2202. </article>
  2203. <article
  2204. class="phpdocumentor-element
  2205. -method
  2206. -protected
  2207. -deprecated "
  2208. >
  2209. <h4 class="phpdocumentor-element__name" id="method_get_imageTransparencyBG">
  2210. get_imageTransparencyBG()
  2211. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG" class="headerlink"><i class="fas fa-link"></i></a>
  2212. </h4>
  2213. <aside class="phpdocumentor-element-found-in">
  2214. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2215. :
  2216. <span class="phpdocumentor-element-found-in__line">614</span>
  2217. </aside>
  2218. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2219. <span class="phpdocumentor-signature__visibility">protected</span>
  2220. <span class="phpdocumentor-signature__name">get_imageTransparencyBG</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  2221. <div class="phpdocumentor-label-line">
  2222. </div>
  2223. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2224. Tags
  2225. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2226. </h5>
  2227. <dl class="phpdocumentor-tag-list">
  2228. <dt class="phpdocumentor-tag-list__entry">
  2229. <span class="phpdocumentor-tag__name">deprecated</span>
  2230. </dt>
  2231. <dd class="phpdocumentor-tag-list__definition">
  2232. <span class="phpdocumentor-tag-link">5.0.0</span>
  2233. <section class="phpdocumentor-description"><p>use QROptions::$transparencyColor instead</p>
  2234. </section>
  2235. </dd>
  2236. <dt class="phpdocumentor-tag-list__entry">
  2237. <span class="phpdocumentor-tag__name">see</span>
  2238. </dt>
  2239. <dd class="phpdocumentor-tag-list__definition">
  2240. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr></span>
  2241. </dd>
  2242. <dt class="phpdocumentor-tag-list__entry">
  2243. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2244. </dt>
  2245. <dd class="phpdocumentor-tag-list__definition">
  2246. </dd>
  2247. </dl>
  2248. </article>
  2249. <article
  2250. class="phpdocumentor-element
  2251. -method
  2252. -protected
  2253. -deprecated "
  2254. >
  2255. <h4 class="phpdocumentor-element__name" id="method_get_imagickBG">
  2256. get_imagickBG()
  2257. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  2258. </h4>
  2259. <aside class="phpdocumentor-element-found-in">
  2260. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2261. :
  2262. <span class="phpdocumentor-element-found-in__line">632</span>
  2263. </aside>
  2264. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2265. <span class="phpdocumentor-signature__visibility">protected</span>
  2266. <span class="phpdocumentor-signature__name">get_imagickBG</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  2267. <div class="phpdocumentor-label-line">
  2268. </div>
  2269. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2270. Tags
  2271. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2272. </h5>
  2273. <dl class="phpdocumentor-tag-list">
  2274. <dt class="phpdocumentor-tag-list__entry">
  2275. <span class="phpdocumentor-tag__name">deprecated</span>
  2276. </dt>
  2277. <dd class="phpdocumentor-tag-list__definition">
  2278. <span class="phpdocumentor-tag-link">5.0.0</span>
  2279. <section class="phpdocumentor-description"><p>use QROptions::$bgColor instead</p>
  2280. </section>
  2281. </dd>
  2282. <dt class="phpdocumentor-tag-list__entry">
  2283. <span class="phpdocumentor-tag__name">see</span>
  2284. </dt>
  2285. <dd class="phpdocumentor-tag-list__definition">
  2286. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr></span>
  2287. </dd>
  2288. <dt class="phpdocumentor-tag-list__entry">
  2289. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2290. </dt>
  2291. <dd class="phpdocumentor-tag-list__definition">
  2292. </dd>
  2293. </dl>
  2294. </article>
  2295. <article
  2296. class="phpdocumentor-element
  2297. -method
  2298. -protected
  2299. -deprecated "
  2300. >
  2301. <h4 class="phpdocumentor-element__name" id="method_get_jpegQuality">
  2302. get_jpegQuality()
  2303. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  2304. </h4>
  2305. <aside class="phpdocumentor-element-found-in">
  2306. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2307. :
  2308. <span class="phpdocumentor-element-found-in__line">578</span>
  2309. </aside>
  2310. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2311. <span class="phpdocumentor-signature__visibility">protected</span>
  2312. <span class="phpdocumentor-signature__name">get_jpegQuality</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2313. <div class="phpdocumentor-label-line">
  2314. </div>
  2315. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2316. Tags
  2317. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2318. </h5>
  2319. <dl class="phpdocumentor-tag-list">
  2320. <dt class="phpdocumentor-tag-list__entry">
  2321. <span class="phpdocumentor-tag__name">deprecated</span>
  2322. </dt>
  2323. <dd class="phpdocumentor-tag-list__definition">
  2324. <span class="phpdocumentor-tag-link">5.0.0</span>
  2325. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2326. </section>
  2327. </dd>
  2328. <dt class="phpdocumentor-tag-list__entry">
  2329. <span class="phpdocumentor-tag__name">see</span>
  2330. </dt>
  2331. <dd class="phpdocumentor-tag-list__definition">
  2332. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2333. </dd>
  2334. <dt class="phpdocumentor-tag-list__entry">
  2335. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2336. </dt>
  2337. <dd class="phpdocumentor-tag-list__definition">
  2338. </dd>
  2339. </dl>
  2340. <section>
  2341. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2342. <span class="phpdocumentor-signature__response_type">int</span>
  2343. </section>
  2344. </article>
  2345. <article
  2346. class="phpdocumentor-element
  2347. -method
  2348. -protected
  2349. -deprecated "
  2350. >
  2351. <h4 class="phpdocumentor-element__name" id="method_get_pngCompression">
  2352. get_pngCompression()
  2353. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  2354. </h4>
  2355. <aside class="phpdocumentor-element-found-in">
  2356. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2357. :
  2358. <span class="phpdocumentor-element-found-in__line">596</span>
  2359. </aside>
  2360. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2361. <span class="phpdocumentor-signature__visibility">protected</span>
  2362. <span class="phpdocumentor-signature__name">get_pngCompression</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2363. <div class="phpdocumentor-label-line">
  2364. </div>
  2365. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2366. Tags
  2367. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2368. </h5>
  2369. <dl class="phpdocumentor-tag-list">
  2370. <dt class="phpdocumentor-tag-list__entry">
  2371. <span class="phpdocumentor-tag__name">deprecated</span>
  2372. </dt>
  2373. <dd class="phpdocumentor-tag-list__definition">
  2374. <span class="phpdocumentor-tag-link">5.0.0</span>
  2375. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2376. </section>
  2377. </dd>
  2378. <dt class="phpdocumentor-tag-list__entry">
  2379. <span class="phpdocumentor-tag__name">see</span>
  2380. </dt>
  2381. <dd class="phpdocumentor-tag-list__definition">
  2382. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2383. </dd>
  2384. <dt class="phpdocumentor-tag-list__entry">
  2385. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2386. </dt>
  2387. <dd class="phpdocumentor-tag-list__definition">
  2388. </dd>
  2389. </dl>
  2390. <section>
  2391. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2392. <span class="phpdocumentor-signature__response_type">int</span>
  2393. </section>
  2394. </article>
  2395. <article
  2396. class="phpdocumentor-element
  2397. -method
  2398. -protected
  2399. "
  2400. >
  2401. <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
  2402. set_circleRadius()
  2403. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  2404. </h4>
  2405. <aside class="phpdocumentor-element-found-in">
  2406. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2407. :
  2408. <span class="phpdocumentor-element-found-in__line">534</span>
  2409. </aside>
  2410. <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
  2411. <code class="phpdocumentor-code phpdocumentor-signature ">
  2412. <span class="phpdocumentor-signature__visibility">protected</span>
  2413. <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>
  2414. <div class="phpdocumentor-label-line">
  2415. </div>
  2416. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2417. <dl class="phpdocumentor-argument-list">
  2418. <dt class="phpdocumentor-argument-list__entry">
  2419. <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
  2420. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  2421. </dt>
  2422. <dd class="phpdocumentor-argument-list__definition">
  2423. </dd>
  2424. </dl>
  2425. </article>
  2426. <article
  2427. class="phpdocumentor-element
  2428. -method
  2429. -protected
  2430. "
  2431. >
  2432. <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
  2433. set_fpdfMeasureUnit()
  2434. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
  2435. </h4>
  2436. <aside class="phpdocumentor-element-found-in">
  2437. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2438. :
  2439. <span class="phpdocumentor-element-found-in__line">474</span>
  2440. </aside>
  2441. <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
  2442. <code class="phpdocumentor-code phpdocumentor-signature ">
  2443. <span class="phpdocumentor-signature__visibility">protected</span>
  2444. <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>
  2445. <div class="phpdocumentor-label-line">
  2446. </div>
  2447. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2448. <dl class="phpdocumentor-argument-list">
  2449. <dt class="phpdocumentor-argument-list__entry">
  2450. <span class="phpdocumentor-signature__argument__name">$unit</span>
  2451. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2452. </dt>
  2453. <dd class="phpdocumentor-argument-list__definition">
  2454. </dd>
  2455. </dl>
  2456. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2457. Tags
  2458. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2459. </h5>
  2460. <dl class="phpdocumentor-tag-list">
  2461. <dt class="phpdocumentor-tag-list__entry">
  2462. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2463. </dt>
  2464. <dd class="phpdocumentor-tag-list__definition">
  2465. </dd>
  2466. </dl>
  2467. </article>
  2468. <article
  2469. class="phpdocumentor-element
  2470. -method
  2471. -protected
  2472. -deprecated "
  2473. >
  2474. <h4 class="phpdocumentor-element__name" id="method_set_imageBase64">
  2475. set_imageBase64()
  2476. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
  2477. </h4>
  2478. <aside class="phpdocumentor-element-found-in">
  2479. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2480. :
  2481. <span class="phpdocumentor-element-found-in__line">545</span>
  2482. </aside>
  2483. <p class="phpdocumentor-summary">redirect call to the new variable</p>
  2484. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2485. <span class="phpdocumentor-signature__visibility">protected</span>
  2486. <span class="phpdocumentor-signature__name">set_imageBase64</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imageBase64</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2487. <div class="phpdocumentor-label-line">
  2488. </div>
  2489. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2490. <dl class="phpdocumentor-argument-list">
  2491. <dt class="phpdocumentor-argument-list__entry">
  2492. <span class="phpdocumentor-signature__argument__name">$imageBase64</span>
  2493. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2494. </dt>
  2495. <dd class="phpdocumentor-argument-list__definition">
  2496. </dd>
  2497. </dl>
  2498. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2499. Tags
  2500. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2501. </h5>
  2502. <dl class="phpdocumentor-tag-list">
  2503. <dt class="phpdocumentor-tag-list__entry">
  2504. <span class="phpdocumentor-tag__name">deprecated</span>
  2505. </dt>
  2506. <dd class="phpdocumentor-tag-list__definition">
  2507. <span class="phpdocumentor-tag-link">5.0.0</span>
  2508. <section class="phpdocumentor-description"><p>use QROptions::$outputBase64 instead</p>
  2509. </section>
  2510. </dd>
  2511. <dt class="phpdocumentor-tag-list__entry">
  2512. <span class="phpdocumentor-tag__name">see</span>
  2513. </dt>
  2514. <dd class="phpdocumentor-tag-list__definition">
  2515. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputBase64">QROptions::$outputBase64</abbr></span>
  2516. </dd>
  2517. <dt class="phpdocumentor-tag-list__entry">
  2518. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2519. </dt>
  2520. <dd class="phpdocumentor-tag-list__definition">
  2521. </dd>
  2522. </dl>
  2523. </article>
  2524. <article
  2525. class="phpdocumentor-element
  2526. -method
  2527. -protected
  2528. -deprecated "
  2529. >
  2530. <h4 class="phpdocumentor-element__name" id="method_set_imageTransparencyBG">
  2531. set_imageTransparencyBG()
  2532. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG" 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">605</span>
  2538. </aside>
  2539. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2540. <span class="phpdocumentor-signature__visibility">protected</span>
  2541. <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>
  2542. <div class="phpdocumentor-label-line">
  2543. </div>
  2544. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2545. <dl class="phpdocumentor-argument-list">
  2546. <dt class="phpdocumentor-argument-list__entry">
  2547. <span class="phpdocumentor-signature__argument__name">$imageTransparencyBG</span>
  2548. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  2549. </dt>
  2550. <dd class="phpdocumentor-argument-list__definition">
  2551. </dd>
  2552. </dl>
  2553. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2554. Tags
  2555. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2556. </h5>
  2557. <dl class="phpdocumentor-tag-list">
  2558. <dt class="phpdocumentor-tag-list__entry">
  2559. <span class="phpdocumentor-tag__name">deprecated</span>
  2560. </dt>
  2561. <dd class="phpdocumentor-tag-list__definition">
  2562. <span class="phpdocumentor-tag-link">5.0.0</span>
  2563. <section class="phpdocumentor-description"><p>use QROptions::$transparencyColor instead</p>
  2564. </section>
  2565. </dd>
  2566. <dt class="phpdocumentor-tag-list__entry">
  2567. <span class="phpdocumentor-tag__name">see</span>
  2568. </dt>
  2569. <dd class="phpdocumentor-tag-list__definition">
  2570. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr></span>
  2571. </dd>
  2572. <dt class="phpdocumentor-tag-list__entry">
  2573. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2574. </dt>
  2575. <dd class="phpdocumentor-tag-list__definition">
  2576. </dd>
  2577. </dl>
  2578. </article>
  2579. <article
  2580. class="phpdocumentor-element
  2581. -method
  2582. -protected
  2583. -deprecated "
  2584. >
  2585. <h4 class="phpdocumentor-element__name" id="method_set_imagickBG">
  2586. set_imagickBG()
  2587. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG" class="headerlink"><i class="fas fa-link"></i></a>
  2588. </h4>
  2589. <aside class="phpdocumentor-element-found-in">
  2590. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2591. :
  2592. <span class="phpdocumentor-element-found-in__line">623</span>
  2593. </aside>
  2594. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2595. <span class="phpdocumentor-signature__visibility">protected</span>
  2596. <span class="phpdocumentor-signature__name">set_imagickBG</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imagickBG</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2597. <div class="phpdocumentor-label-line">
  2598. </div>
  2599. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2600. <dl class="phpdocumentor-argument-list">
  2601. <dt class="phpdocumentor-argument-list__entry">
  2602. <span class="phpdocumentor-signature__argument__name">$imagickBG</span>
  2603. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  2604. </dt>
  2605. <dd class="phpdocumentor-argument-list__definition">
  2606. </dd>
  2607. </dl>
  2608. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2609. Tags
  2610. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2611. </h5>
  2612. <dl class="phpdocumentor-tag-list">
  2613. <dt class="phpdocumentor-tag-list__entry">
  2614. <span class="phpdocumentor-tag__name">deprecated</span>
  2615. </dt>
  2616. <dd class="phpdocumentor-tag-list__definition">
  2617. <span class="phpdocumentor-tag-link">5.0.0</span>
  2618. <section class="phpdocumentor-description"><p>use QROptions::$bgColor instead</p>
  2619. </section>
  2620. </dd>
  2621. <dt class="phpdocumentor-tag-list__entry">
  2622. <span class="phpdocumentor-tag__name">see</span>
  2623. </dt>
  2624. <dd class="phpdocumentor-tag-list__definition">
  2625. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr></span>
  2626. </dd>
  2627. <dt class="phpdocumentor-tag-list__entry">
  2628. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2629. </dt>
  2630. <dd class="phpdocumentor-tag-list__definition">
  2631. </dd>
  2632. </dl>
  2633. </article>
  2634. <article
  2635. class="phpdocumentor-element
  2636. -method
  2637. -protected
  2638. -deprecated "
  2639. >
  2640. <h4 class="phpdocumentor-element__name" id="method_set_jpegQuality">
  2641. set_jpegQuality()
  2642. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
  2643. </h4>
  2644. <aside class="phpdocumentor-element-found-in">
  2645. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2646. :
  2647. <span class="phpdocumentor-element-found-in__line">569</span>
  2648. </aside>
  2649. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2650. <span class="phpdocumentor-signature__visibility">protected</span>
  2651. <span class="phpdocumentor-signature__name">set_jpegQuality</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$jpegQuality</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2652. <div class="phpdocumentor-label-line">
  2653. </div>
  2654. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2655. <dl class="phpdocumentor-argument-list">
  2656. <dt class="phpdocumentor-argument-list__entry">
  2657. <span class="phpdocumentor-signature__argument__name">$jpegQuality</span>
  2658. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2659. </dt>
  2660. <dd class="phpdocumentor-argument-list__definition">
  2661. </dd>
  2662. </dl>
  2663. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2664. Tags
  2665. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2666. </h5>
  2667. <dl class="phpdocumentor-tag-list">
  2668. <dt class="phpdocumentor-tag-list__entry">
  2669. <span class="phpdocumentor-tag__name">deprecated</span>
  2670. </dt>
  2671. <dd class="phpdocumentor-tag-list__definition">
  2672. <span class="phpdocumentor-tag-link">5.0.0</span>
  2673. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2674. </section>
  2675. </dd>
  2676. <dt class="phpdocumentor-tag-list__entry">
  2677. <span class="phpdocumentor-tag__name">see</span>
  2678. </dt>
  2679. <dd class="phpdocumentor-tag-list__definition">
  2680. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2681. </dd>
  2682. <dt class="phpdocumentor-tag-list__entry">
  2683. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2684. </dt>
  2685. <dd class="phpdocumentor-tag-list__definition">
  2686. </dd>
  2687. </dl>
  2688. </article>
  2689. <article
  2690. class="phpdocumentor-element
  2691. -method
  2692. -protected
  2693. "
  2694. >
  2695. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
  2696. set_logoSpaceHeight()
  2697. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
  2698. </h4>
  2699. <aside class="phpdocumentor-element-found-in">
  2700. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2701. :
  2702. <span class="phpdocumentor-element-found-in__line">513</span>
  2703. </aside>
  2704. <p class="phpdocumentor-summary">clamp/set logo space height</p>
  2705. <code class="phpdocumentor-code phpdocumentor-signature ">
  2706. <span class="phpdocumentor-signature__visibility">protected</span>
  2707. <span class="phpdocumentor-signature__name">set_logoSpaceHeight</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2708. <div class="phpdocumentor-label-line">
  2709. </div>
  2710. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2711. <dl class="phpdocumentor-argument-list">
  2712. <dt class="phpdocumentor-argument-list__entry">
  2713. <span class="phpdocumentor-signature__argument__name">$value</span>
  2714. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2715. </dt>
  2716. <dd class="phpdocumentor-argument-list__definition">
  2717. </dd>
  2718. </dl>
  2719. </article>
  2720. <article
  2721. class="phpdocumentor-element
  2722. -method
  2723. -protected
  2724. "
  2725. >
  2726. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
  2727. set_logoSpaceStartX()
  2728. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
  2729. </h4>
  2730. <aside class="phpdocumentor-element-found-in">
  2731. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2732. :
  2733. <span class="phpdocumentor-element-found-in__line">520</span>
  2734. </aside>
  2735. <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
  2736. <code class="phpdocumentor-code phpdocumentor-signature ">
  2737. <span class="phpdocumentor-signature__visibility">protected</span>
  2738. <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>
  2739. <div class="phpdocumentor-label-line">
  2740. </div>
  2741. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2742. <dl class="phpdocumentor-argument-list">
  2743. <dt class="phpdocumentor-argument-list__entry">
  2744. <span class="phpdocumentor-signature__argument__name">$value</span>
  2745. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2746. </dt>
  2747. <dd class="phpdocumentor-argument-list__definition">
  2748. </dd>
  2749. </dl>
  2750. </article>
  2751. <article
  2752. class="phpdocumentor-element
  2753. -method
  2754. -protected
  2755. "
  2756. >
  2757. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
  2758. set_logoSpaceStartY()
  2759. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
  2760. </h4>
  2761. <aside class="phpdocumentor-element-found-in">
  2762. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2763. :
  2764. <span class="phpdocumentor-element-found-in__line">527</span>
  2765. </aside>
  2766. <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
  2767. <code class="phpdocumentor-code phpdocumentor-signature ">
  2768. <span class="phpdocumentor-signature__visibility">protected</span>
  2769. <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>
  2770. <div class="phpdocumentor-label-line">
  2771. </div>
  2772. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2773. <dl class="phpdocumentor-argument-list">
  2774. <dt class="phpdocumentor-argument-list__entry">
  2775. <span class="phpdocumentor-signature__argument__name">$value</span>
  2776. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2777. </dt>
  2778. <dd class="phpdocumentor-argument-list__definition">
  2779. </dd>
  2780. </dl>
  2781. </article>
  2782. <article
  2783. class="phpdocumentor-element
  2784. -method
  2785. -protected
  2786. "
  2787. >
  2788. <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
  2789. set_logoSpaceWidth()
  2790. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
  2791. </h4>
  2792. <aside class="phpdocumentor-element-found-in">
  2793. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2794. :
  2795. <span class="phpdocumentor-element-found-in__line">506</span>
  2796. </aside>
  2797. <p class="phpdocumentor-summary">clamp/set logo space width</p>
  2798. <code class="phpdocumentor-code phpdocumentor-signature ">
  2799. <span class="phpdocumentor-signature__visibility">protected</span>
  2800. <span class="phpdocumentor-signature__name">set_logoSpaceWidth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2801. <div class="phpdocumentor-label-line">
  2802. </div>
  2803. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2804. <dl class="phpdocumentor-argument-list">
  2805. <dt class="phpdocumentor-argument-list__entry">
  2806. <span class="phpdocumentor-signature__argument__name">$value</span>
  2807. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2808. </dt>
  2809. <dd class="phpdocumentor-argument-list__definition">
  2810. </dd>
  2811. </dl>
  2812. </article>
  2813. <article
  2814. class="phpdocumentor-element
  2815. -method
  2816. -protected
  2817. -deprecated "
  2818. >
  2819. <h4 class="phpdocumentor-element__name" id="method_set_pngCompression">
  2820. set_pngCompression()
  2821. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
  2822. </h4>
  2823. <aside class="phpdocumentor-element-found-in">
  2824. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2825. :
  2826. <span class="phpdocumentor-element-found-in__line">587</span>
  2827. </aside>
  2828. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2829. <span class="phpdocumentor-signature__visibility">protected</span>
  2830. <span class="phpdocumentor-signature__name">set_pngCompression</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pngCompression</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  2831. <div class="phpdocumentor-label-line">
  2832. </div>
  2833. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2834. <dl class="phpdocumentor-argument-list">
  2835. <dt class="phpdocumentor-argument-list__entry">
  2836. <span class="phpdocumentor-signature__argument__name">$pngCompression</span>
  2837. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2838. </dt>
  2839. <dd class="phpdocumentor-argument-list__definition">
  2840. </dd>
  2841. </dl>
  2842. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2843. Tags
  2844. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2845. </h5>
  2846. <dl class="phpdocumentor-tag-list">
  2847. <dt class="phpdocumentor-tag-list__entry">
  2848. <span class="phpdocumentor-tag__name">deprecated</span>
  2849. </dt>
  2850. <dd class="phpdocumentor-tag-list__definition">
  2851. <span class="phpdocumentor-tag-link">5.0.0</span>
  2852. <section class="phpdocumentor-description"><p>use QROptions::$quality instead</p>
  2853. </section>
  2854. </dd>
  2855. <dt class="phpdocumentor-tag-list__entry">
  2856. <span class="phpdocumentor-tag__name">see</span>
  2857. </dt>
  2858. <dd class="phpdocumentor-tag-list__definition">
  2859. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$quality">QROptions::$quality</abbr></span>
  2860. </dd>
  2861. <dt class="phpdocumentor-tag-list__entry">
  2862. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2863. </dt>
  2864. <dd class="phpdocumentor-tag-list__definition">
  2865. </dd>
  2866. </dl>
  2867. </article>
  2868. <article
  2869. class="phpdocumentor-element
  2870. -method
  2871. -protected
  2872. "
  2873. >
  2874. <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
  2875. set_quietzoneSize()
  2876. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
  2877. </h4>
  2878. <aside class="phpdocumentor-element-found-in">
  2879. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2880. :
  2881. <span class="phpdocumentor-element-found-in__line">465</span>
  2882. </aside>
  2883. <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
  2884. <code class="phpdocumentor-code phpdocumentor-signature ">
  2885. <span class="phpdocumentor-signature__visibility">protected</span>
  2886. <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>
  2887. <div class="phpdocumentor-label-line">
  2888. </div>
  2889. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2890. <dl class="phpdocumentor-argument-list">
  2891. <dt class="phpdocumentor-argument-list__entry">
  2892. <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
  2893. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2894. </dt>
  2895. <dd class="phpdocumentor-argument-list__definition">
  2896. </dd>
  2897. </dl>
  2898. </article>
  2899. <article
  2900. class="phpdocumentor-element
  2901. -method
  2902. -protected
  2903. "
  2904. >
  2905. <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
  2906. set_readerUseImagickIfAvailable()
  2907. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  2908. </h4>
  2909. <aside class="phpdocumentor-element-found-in">
  2910. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2911. :
  2912. <span class="phpdocumentor-element-found-in__line">487</span>
  2913. </aside>
  2914. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  2915. <code class="phpdocumentor-code phpdocumentor-signature ">
  2916. <span class="phpdocumentor-signature__visibility">protected</span>
  2917. <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>
  2918. <div class="phpdocumentor-label-line">
  2919. </div>
  2920. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2921. <dl class="phpdocumentor-argument-list">
  2922. <dt class="phpdocumentor-argument-list__entry">
  2923. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  2924. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2925. </dt>
  2926. <dd class="phpdocumentor-argument-list__definition">
  2927. </dd>
  2928. </dl>
  2929. </article>
  2930. <article
  2931. class="phpdocumentor-element
  2932. -method
  2933. -protected
  2934. "
  2935. >
  2936. <h4 class="phpdocumentor-element__name" id="method_set_version">
  2937. set_version()
  2938. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
  2939. </h4>
  2940. <aside class="phpdocumentor-element-found-in">
  2941. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2942. :
  2943. <span class="phpdocumentor-element-found-in__line">458</span>
  2944. </aside>
  2945. <p class="phpdocumentor-summary">sets/clamps the version number</p>
  2946. <code class="phpdocumentor-code phpdocumentor-signature ">
  2947. <span class="phpdocumentor-signature__visibility">protected</span>
  2948. <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>
  2949. <div class="phpdocumentor-label-line">
  2950. </div>
  2951. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2952. <dl class="phpdocumentor-argument-list">
  2953. <dt class="phpdocumentor-argument-list__entry">
  2954. <span class="phpdocumentor-signature__argument__name">$version</span>
  2955. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2956. </dt>
  2957. <dd class="phpdocumentor-argument-list__definition">
  2958. </dd>
  2959. </dl>
  2960. </article>
  2961. <article
  2962. class="phpdocumentor-element
  2963. -method
  2964. -protected
  2965. "
  2966. >
  2967. <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
  2968. set_versionMax()
  2969. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
  2970. </h4>
  2971. <aside class="phpdocumentor-element-found-in">
  2972. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  2973. :
  2974. <span class="phpdocumentor-element-found-in__line">451</span>
  2975. </aside>
  2976. <p class="phpdocumentor-summary">sets the maximum version number</p>
  2977. <code class="phpdocumentor-code phpdocumentor-signature ">
  2978. <span class="phpdocumentor-signature__visibility">protected</span>
  2979. <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>
  2980. <div class="phpdocumentor-label-line">
  2981. </div>
  2982. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2983. <dl class="phpdocumentor-argument-list">
  2984. <dt class="phpdocumentor-argument-list__entry">
  2985. <span class="phpdocumentor-signature__argument__name">$version</span>
  2986. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2987. </dt>
  2988. <dd class="phpdocumentor-argument-list__definition">
  2989. </dd>
  2990. </dl>
  2991. </article>
  2992. <article
  2993. class="phpdocumentor-element
  2994. -method
  2995. -protected
  2996. "
  2997. >
  2998. <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
  2999. set_versionMin()
  3000. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
  3001. </h4>
  3002. <aside class="phpdocumentor-element-found-in">
  3003. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  3004. :
  3005. <span class="phpdocumentor-element-found-in__line">444</span>
  3006. </aside>
  3007. <p class="phpdocumentor-summary">sets the minimum version number</p>
  3008. <code class="phpdocumentor-code phpdocumentor-signature ">
  3009. <span class="phpdocumentor-signature__visibility">protected</span>
  3010. <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>
  3011. <div class="phpdocumentor-label-line">
  3012. </div>
  3013. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  3014. <dl class="phpdocumentor-argument-list">
  3015. <dt class="phpdocumentor-argument-list__entry">
  3016. <span class="phpdocumentor-signature__argument__name">$version</span>
  3017. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3018. </dt>
  3019. <dd class="phpdocumentor-argument-list__definition">
  3020. </dd>
  3021. </dl>
  3022. </article>
  3023. <article
  3024. class="phpdocumentor-element
  3025. -method
  3026. -protected
  3027. "
  3028. >
  3029. <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
  3030. setMinMaxVersion()
  3031. <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
  3032. </h4>
  3033. <aside class="phpdocumentor-element-found-in">
  3034. <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
  3035. :
  3036. <span class="phpdocumentor-element-found-in__line">433</span>
  3037. </aside>
  3038. <p class="phpdocumentor-summary">clamp min/max version number</p>
  3039. <code class="phpdocumentor-code phpdocumentor-signature ">
  3040. <span class="phpdocumentor-signature__visibility">protected</span>
  3041. <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>
  3042. <div class="phpdocumentor-label-line">
  3043. </div>
  3044. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  3045. <dl class="phpdocumentor-argument-list">
  3046. <dt class="phpdocumentor-argument-list__entry">
  3047. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  3048. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3049. </dt>
  3050. <dd class="phpdocumentor-argument-list__definition">
  3051. </dd>
  3052. <dt class="phpdocumentor-argument-list__entry">
  3053. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  3054. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  3055. </dt>
  3056. <dd class="phpdocumentor-argument-list__definition">
  3057. </dd>
  3058. </dl>
  3059. </article>
  3060. </section>
  3061. <div class="phpdocumentor-modal" id="source-view">
  3062. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  3063. <div class="phpdocumentor-modal-container">
  3064. <div class="phpdocumentor-modal-content">
  3065. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QROptions.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  3066. </div>
  3067. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  3068. </div>
  3069. </div>
  3070. <script type="text/javascript">
  3071. (function () {
  3072. function loadExternalCodeSnippet(el, url, line) {
  3073. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  3074. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  3075. const language = 'php';
  3076. const code = document.createElement('code');
  3077. code.className = 'language-' + language;
  3078. pre.textContent = '';
  3079. pre.setAttribute('data-line', line)
  3080. code.textContent = 'Loading…';
  3081. pre.appendChild(code);
  3082. var xhr = new XMLHttpRequest();
  3083. xhr.open('GET', src, true);
  3084. xhr.onreadystatechange = function () {
  3085. if (xhr.readyState !== 4) {
  3086. return;
  3087. }
  3088. if (xhr.status < 400 && xhr.responseText) {
  3089. code.textContent = xhr.responseText;
  3090. Prism.highlightElement(code);
  3091. return;
  3092. }
  3093. if (xhr.status === 404) {
  3094. code.textContent = '✖ Error: File could not be found';
  3095. return;
  3096. }
  3097. if (xhr.status >= 400) {
  3098. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  3099. return;
  3100. }
  3101. code.textContent = '✖ Error: An unknown error occurred';
  3102. };
  3103. xhr.send(null);
  3104. });
  3105. }
  3106. const modalButtons = document.querySelectorAll("[data-modal]");
  3107. const openedAsLocalFile = window.location.protocol === 'file:';
  3108. if (modalButtons.length > 0 && openedAsLocalFile) {
  3109. console.warn(
  3110. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  3111. 'browsers block XHR requests when a page is opened this way'
  3112. );
  3113. }
  3114. modalButtons.forEach(function (trigger) {
  3115. if (openedAsLocalFile) {
  3116. trigger.setAttribute("hidden", "hidden");
  3117. }
  3118. trigger.addEventListener("click", function (event) {
  3119. event.preventDefault();
  3120. const modal = document.getElementById(trigger.dataset.modal);
  3121. if (!modal) {
  3122. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  3123. return;
  3124. }
  3125. modal.classList.add("phpdocumentor-modal__open");
  3126. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  3127. const exits = modal.querySelectorAll("[data-exit-button]");
  3128. exits.forEach(function (exit) {
  3129. exit.addEventListener("click", function (event) {
  3130. event.preventDefault();
  3131. modal.classList.remove("phpdocumentor-modal__open");
  3132. });
  3133. });
  3134. });
  3135. });
  3136. })();
  3137. </script>
  3138. </article>
  3139. </section>
  3140. <section class="phpdocumentor-on-this-page__sidebar">
  3141. <section class="phpdocumentor-on-this-page__content">
  3142. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  3143. <ul class="phpdocumentor-list -clean">
  3144. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  3145. <li>
  3146. <ul class="phpdocumentor-list -clean">
  3147. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-properties">Properties</a></li>
  3148. <li><a href="classes/chillerlan-QRCode-QROptions.html#toc-methods">Methods</a></li>
  3149. </ul>
  3150. </li>
  3151. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  3152. <li>
  3153. <ul class="phpdocumentor-list -clean">
  3154. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3155. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3156. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3157. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3158. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3159. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3160. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3161. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3162. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3163. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3164. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3165. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3166. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3167. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3168. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3169. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3170. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans">$jsonAsBooleans<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3171. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3172. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3173. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3174. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3175. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3176. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3177. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3178. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3179. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3180. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputBase64">$outputBase64<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3181. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3182. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3183. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quality">$quality<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3184. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3185. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3186. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3187. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3188. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3189. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3190. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgAddXmlHeader">$svgAddXmlHeader<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3191. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3192. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3193. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3194. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3195. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3196. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3197. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3198. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3199. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLineStart">$textLineStart<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3200. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3201. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3202. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3203. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin<a href="classes/chillerlan-QRCode-QROptions.html"></li>
  3204. </ul>
  3205. </li>
  3206. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  3207. <li>
  3208. <ul class="phpdocumentor-list -clean">
  3209. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a></li>
  3210. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64">get_imageBase64()</a></li>
  3211. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG">get_imageTransparencyBG()</a></li>
  3212. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG">get_imagickBG()</a></li>
  3213. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality">get_jpegQuality()</a></li>
  3214. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression">get_pngCompression()</a></li>
  3215. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a></li>
  3216. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a></li>
  3217. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64">set_imageBase64()</a></li>
  3218. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG">set_imageTransparencyBG()</a></li>
  3219. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG">set_imagickBG()</a></li>
  3220. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality">set_jpegQuality()</a></li>
  3221. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a></li>
  3222. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a></li>
  3223. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a></li>
  3224. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a></li>
  3225. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression">set_pngCompression()</a></li>
  3226. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a></li>
  3227. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a></li>
  3228. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a></li>
  3229. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a></li>
  3230. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a></li>
  3231. <li><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a></li>
  3232. </ul>
  3233. </li>
  3234. </ul>
  3235. </section>
  3236. </section>
  3237. </div>
  3238. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  3239. <section class="phpdocumentor-search-results__dialog">
  3240. <header class="phpdocumentor-search-results__header">
  3241. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  3242. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  3243. </header>
  3244. <section class="phpdocumentor-search-results__body">
  3245. <ul class="phpdocumentor-search-results__entries"></ul>
  3246. </section>
  3247. </section>
  3248. </section>
  3249. </div>
  3250. <a href="classes/chillerlan-QRCode-QROptions.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  3251. </main>
  3252. <script>
  3253. cssVars({});
  3254. </script>
  3255. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  3256. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  3257. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  3258. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  3259. </body>
  3260. </html>