chillerlan-QRCode-QROptionsTrait.html 227 KB

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