| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Documentation</title>
-
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <base href="../">
- <link rel="icon" href="images/favicon.ico"/>
- <link rel="stylesheet" href="css/normalize.css">
- <link rel="stylesheet" href="css/base.css">
- <link rel="preconnect" href="https://fonts.gstatic.com">
- <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
- <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
- <link rel="stylesheet" href="css/template.css">
- <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" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
- <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
- <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
- <script src="js/search.js"></script>
- <script defer src="js/searchIndex.js"></script>
- </head>
- <body id="top">
- <header class="phpdocumentor-header phpdocumentor-section">
- <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
- <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
- <label class="phpdocumentor-header__menu-icon" for="menu-button">
- <i class="fas fa-bars"></i>
- </label>
- <section data-search-form class="phpdocumentor-search">
- <label>
- <span class="visually-hidden">Search for</span>
- <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
- <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
- <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
- </svg>
- <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
- </label>
- </section>
- <nav class="phpdocumentor-topnav">
- <ul class="phpdocumentor-topnav__menu">
- </ul>
- </nav>
- </header>
- <main class="phpdocumentor">
- <div class="phpdocumentor-section">
- <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
- <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
- Menu
- </label>
- <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
- <h4 class="phpdocumentor-sidebar__root-namespace">
- <a href="namespaces/chillerlan.html" class="">chillerlan</a>
- </h4>
- <ul class="phpdocumentor-list">
- <li>
- <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
-
- </li>
- <li>
- <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
-
- </li>
- </ul>
- </section>
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
- <h4 class="phpdocumentor-sidebar__root-namespace">
- <a href="packages/Application.html" class="">Application</a>
- </h4>
- </section>
-
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
- </section>
- <section class="phpdocumentor-sidebar__category">
- <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
- <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
- </section>
- </aside>
- <div class="phpdocumentor-column -eight phpdocumentor-content">
- <ul class="phpdocumentor-breadcrumbs">
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
- </ul>
- <article class="phpdocumentor-element -trait">
- <h2 class="phpdocumentor-content__title">
- QROptionsTrait
- </h2>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">22</span>
- </aside>
- <p class="phpdocumentor-summary">The QRCode plug-in settings & setter functionality</p>
- <h3 id="toc">
- Table of Contents
- <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <dl class="phpdocumentor-table-of-contents">
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace">$addLogoSpace</a>
- <span>
- : bool </span>
- </dt>
- <dd>Toggles logo space creation</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone">$addQuietzone</a>
- <span>
- : bool </span>
- </dt>
- <dd>Add a "quiet zone" (margin) according to the QR code spec</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor">$bgColor</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Sets the image background color (if applicable)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile">$cachefile</a>
- <span>
- : string|null </span>
- </dt>
- <dd>/path/to/cache.file</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius">$circleRadius</a>
- <span>
- : float </span>
- </dt>
- <dd>specifies the radius of the modules when $svgDrawCircularModules is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths">$connectPaths</a>
- <span>
- : bool </span>
- </dt>
- <dd>whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass">$cssClass</a>
- <span>
- : string </span>
- </dt>
- <dd>a common css class</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules">$drawCircularModules</a>
- <span>
- : bool </span>
- </dt>
- <dd>specify whether to draw the modules as filled circles</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules">$drawLightModules</a>
- <span>
- : bool </span>
- </dt>
- <dd>whether to draw the light (false) modules</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel">$eccLevel</a>
- <span>
- : int </span>
- </dt>
- <dd>Error correct level</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol">$eol</a>
- <span>
- : string </span>
- </dt>
- <dd>newline string</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect">$excludeFromConnect</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit">$fpdfMeasureUnit</a>
- <span>
- : string </span>
- </dt>
- <dd>Measurement unit for FPDF output: pt, mm, cm, in (defaults to "pt")</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64">$imageBase64</a>
- <span>
- : bool </span>
- </dt>
- <dd>toggle base64 or raw image data (if applicable)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent">$imageTransparent</a>
- <span>
- : bool </span>
- </dt>
- <dd>toggle transparency</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat">$imagickFormat</a>
- <span>
- : string </span>
- </dt>
- <dd>Imagick output format</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality">$jpegQuality</a>
- <span>
- : int </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare">$keepAsSquare</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>specifies which module types to exclude when $svgDrawCircularModules is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight">$logoSpaceHeight</a>
- <span>
- : int|null </span>
- </dt>
- <dd>height of the logo space</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX">$logoSpaceStartX</a>
- <span>
- : int|null </span>
- </dt>
- <dd>optional horizontal start position of the logo space (top left corner)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY">$logoSpaceStartY</a>
- <span>
- : int|null </span>
- </dt>
- <dd>optional vertical start position of the logo space (top left corner)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth">$logoSpaceWidth</a>
- <span>
- : int|null </span>
- </dt>
- <dd>width of the logo space</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark">$markupDark</a>
- <span>
- : string </span>
- </dt>
- <dd>markup substitute for dark (CSS value)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight">$markupLight</a>
- <span>
- : string </span>
- </dt>
- <dd>markup substitute for light (CSS value)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern">$maskPattern</a>
- <span>
- : int </span>
- </dt>
- <dd>Mask Pattern to use (no value in using, mostly for unit testing purposes)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues">$moduleValues</a>
- <span>
- : array<string|int, mixed>|null </span>
- </dt>
- <dd>Module values map</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface">$outputInterface</a>
- <span>
- : string|null </span>
- </dt>
- <dd>the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType">$outputType</a>
- <span>
- : string </span>
- </dt>
- <dd>The output type</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression">$pngCompression</a>
- <span>
- : int </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize">$quietzoneSize</a>
- <span>
- : int </span>
- </dt>
- <dd>Size of the quiet zone</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
- <span>
- : bool </span>
- </dt>
- <dd>grayscale the image before reading</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
- <span>
- : bool </span>
- </dt>
- <dd>increase the contrast before reading</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
- <span>
- : bool </span>
- </dt>
- <dd>use Imagick (if available) when reading QR Codes</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource">$returnResource</a>
- <span>
- : bool </span>
- </dt>
- <dd>Return the image resource instead of a render if applicable.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale">$scale</a>
- <span>
- : int </span>
- </dt>
- <dd>pixel size of a QR code module</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs">$svgDefs</a>
- <span>
- : string </span>
- </dt>
- <dd>anything between <defs></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight">$svgHeight</a>
- <span>
- : string|null </span>
- </dt>
- <dd>optional "height" attribute with the specified value (note that the value is not checked!)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity">$svgOpacity</a>
- <span>
- : float </span>
- </dt>
- <dd>SVG opacity</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio">$svgPreserveAspectRatio</a>
- <span>
- : string </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize">$svgViewBoxSize</a>
- <span>
- : int|null </span>
- </dt>
- <dd>SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth">$svgWidth</a>
- <span>
- : string|null </span>
- </dt>
- <dd>optional "width" attribute with the specified value (note that the value is not checked!)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark">$textDark</a>
- <span>
- : string </span>
- </dt>
- <dd>string substitute for dark</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight">$textLight</a>
- <span>
- : string </span>
- </dt>
- <dd>string substitute for light</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor">$transparencyColor</a>
- <span>
- : mixed|null </span>
- </dt>
- <dd>Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version">$version</a>
- <span>
- : int </span>
- </dt>
- <dd>QR Code version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax">$versionMax</a>
- <span>
- : int </span>
- </dt>
- <dd>Maximum QR version</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin">$versionMin</a>
- <span>
- : int </span>
- </dt>
- <dd>Minimum QR version</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
- <span>
- : int|null </span>
- </dt>
- <dd>clamp the logo space values between 0 and maximum length (177 modules at version 40)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius">set_circleRadius()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set SVG circle radius</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit">set_fpdfMeasureUnit()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the FPDF measurement unit</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight">set_logoSpaceHeight()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set logo space height</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX">set_logoSpaceStartX()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set horizontal logo space start</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY">set_logoSpaceStartY()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set vertical logo space start</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth">set_logoSpaceWidth()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp/set logo space width</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize">set_quietzoneSize()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets/clamps the quiet zone size</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
- <span>
- : void </span>
- </dt>
- <dd>enables Imagick for the QR Code reader if the extension is available</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version">set_version()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets/clamps the version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax">set_versionMax()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the maximum version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin">set_versionMin()</a>
- <span>
- : void </span>
- </dt>
- <dd>sets the minimum version number</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -protected">
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion">setMinMaxVersion()</a>
- <span>
- : void </span>
- </dt>
- <dd>clamp min/max version number</dd>
- </dl>
-
- <section class="phpdocumentor-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_addLogoSpace">
- $addLogoSpace
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">197</span>
- </aside>
- <p class="phpdocumentor-summary">Toggles logo space creation</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$addLogoSpace</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_addQuietzone">
- $addQuietzone
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_addQuietzone" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">74</span>
- </aside>
- <p class="phpdocumentor-summary">Add a "quiet zone" (margin) according to the QR code spec</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$addQuietzone</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/howto/code.html"><abbr title="https://www.qrcode.com/en/howto/code.html">https://www.qrcode.com/en/howto/code.html</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_bgColor">
- $bgColor
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_bgColor" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">152</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the image background color (if applicable)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">mixed|null</span>
- <span class="phpdocumentor-signature__name">$bgColor</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRGdImage: defaults to "white"</li>
- <li>QRImagick: defaults to [255, 255, 255]</li>
- <li>QRFpdf: defaults to blank internally (white page)</li>
- </ul>
- </section>
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_cachefile">
- $cachefile
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cachefile" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">127</span>
- </aside>
- <p class="phpdocumentor-summary">/path/to/cache.file</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$cachefile</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>please note that the $file parameter in QRCode::render*() takes precedence over the $cachefile value</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_circleRadius">
- $circleRadius
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">179</span>
- </aside>
- <p class="phpdocumentor-summary">specifies the radius of the modules when $svgDrawCircularModules is set to true</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">float</span>
- <span class="phpdocumentor-signature__name">$circleRadius</span>
- = <span class="phpdocumentor-signature__default-value">0.45</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_connectPaths">
- $connectPaths
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">352</span>
- </aside>
- <p class="phpdocumentor-summary">whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$connectPaths</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/57"><abbr title="https://github.com/chillerlan/php-qrcode/issues/57">https://github.com/chillerlan/php-qrcode/issues/57</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_cssClass">
- $cssClass
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_cssClass" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">289</span>
- </aside>
- <p class="phpdocumentor-summary">a common css class</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$cssClass</span>
- = <span class="phpdocumentor-signature__default-value">'qrcode'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
- $drawCircularModules
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">174</span>
- </aside>
- <p class="phpdocumentor-summary">specify whether to draw the modules as filled circles</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$drawCircularModules</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>a note for GDImage output:</p>
- <p>if QROptions::$scale is less than 20, the image will be upscaled internally, then the modules will be drawn
- using imagefilledellipse() and then scaled back to the expected size</p>
- <p>No effect in: QREps, QRFpdf, QRMarkupHTML</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23"><abbr title="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</abbr></a></span>
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/122"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/122">https://github.com/chillerlan/php-qrcode/discussions/122</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
- $drawLightModules
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">159</span>
- </aside>
- <p class="phpdocumentor-summary">whether to draw the light (false) modules</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$drawLightModules</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
-
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_eccLevel">
- $eccLevel
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">60</span>
- </aside>
- <p class="phpdocumentor-summary">Error correct level</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$eccLevel</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span></code>
- <section class="phpdocumentor-description"><p>QRCode::ECC_X where X is:</p>
- <ul>
- <li>L => 7%</li>
- <li>M => 15%</li>
- <li>Q => 25%</li>
- <li>H => 30%</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">todo:</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
- <section class="phpdocumentor-description"><p>accept string values (PHP8+)</p>
- </section>
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/160"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/160">https://github.com/chillerlan/php-qrcode/discussions/160</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_eol">
- $eol
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">137</span>
- </aside>
- <p class="phpdocumentor-summary">newline string</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$eol</span>
- = <span class="phpdocumentor-signature__default-value">PHP_EOL</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
- $excludeFromConnect
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">357</span>
- </aside>
- <p class="phpdocumentor-summary">specify which paths/patterns to exclude from connecting if $svgConnectPaths is set to true</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
- <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
- = <span class="phpdocumentor-signature__default-value">[]</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_fpdfMeasureUnit">
- $fpdfMeasureUnit
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">384</span>
- </aside>
- <p class="phpdocumentor-summary">Measurement unit for FPDF output: pt, mm, cm, in (defaults to "pt")</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$fpdfMeasureUnit</span>
- = <span class="phpdocumentor-signature__default-value">'pt'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\FPDF::__construct()">FPDF::__construct()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imageBase64">
- $imageBase64
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">132</span>
- </aside>
- <p class="phpdocumentor-summary">toggle base64 or raw image data (if applicable)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$imageBase64</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imageTransparent">
- $imageTransparent
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparent" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">240</span>
- </aside>
- <p class="phpdocumentor-summary">toggle transparency</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$imageTransparent</span>
- = <span class="phpdocumentor-signature__default-value">true</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRGdImage and QRImagick: the given <abbr title="\chillerlan\QRCode\QROptions::$transparencyColor">QROptions::$transparencyColor</abbr> is set as transparent</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/121"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/121">https://github.com/chillerlan/php-qrcode/discussions/121</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_imagickFormat">
- $imagickFormat
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickFormat" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">279</span>
- </aside>
- <p class="phpdocumentor-summary">Imagick output format</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$imagickFormat</span>
- = <span class="phpdocumentor-signature__default-value">'png32'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\Imagick::setImageFormat()">Imagick::setImageFormat()</abbr></span>
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://www.imagemagick.org/script/formats.php"><abbr title="https://www.imagemagick.org/script/formats.php">https://www.imagemagick.org/script/formats.php</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_jpegQuality">
- $jpegQuality
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">266</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$jpegQuality</span>
- = <span class="phpdocumentor-signature__default-value">85</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagejpeg()">imagejpeg()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
- $keepAsSquare
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">184</span>
- </aside>
- <p class="phpdocumentor-summary">specifies which module types to exclude when $svgDrawCircularModules is set to true</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
- <span class="phpdocumentor-signature__name">$keepAsSquare</span>
- = <span class="phpdocumentor-signature__default-value">[]</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceHeight">
- $logoSpaceHeight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">211</span>
- </aside>
- <p class="phpdocumentor-summary">height of the logo space</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceHeight</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartX">
- $logoSpaceStartX
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">216</span>
- </aside>
- <p class="phpdocumentor-summary">optional horizontal start position of the logo space (top left corner)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceStartX</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceStartY">
- $logoSpaceStartY
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">221</span>
- </aside>
- <p class="phpdocumentor-summary">optional vertical start position of the logo space (top left corner)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceStartY</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_logoSpaceWidth">
- $logoSpaceWidth
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">204</span>
- </aside>
- <p class="phpdocumentor-summary">width of the logo space</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$logoSpaceWidth</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>if only either $logoSpaceWidth or $logoSpaceHeight is given, the logo space is assumed a square of that size</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_markupDark">
- $markupDark
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupDark" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">294</span>
- </aside>
- <p class="phpdocumentor-summary">markup substitute for dark (CSS value)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$markupDark</span>
- = <span class="phpdocumentor-signature__default-value">'#000'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_markupLight">
- $markupLight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_markupLight" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">299</span>
- </aside>
- <p class="phpdocumentor-summary">markup substitute for light (CSS value)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$markupLight</span>
- = <span class="phpdocumentor-signature__default-value">'#fff'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_maskPattern">
- $maskPattern
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">67</span>
- </aside>
- <p class="phpdocumentor-summary">Mask Pattern to use (no value in using, mostly for unit testing purposes)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$maskPattern</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span></code>
- <section class="phpdocumentor-description"><p>[0...7] or MaskPattern::PATTERN_AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_moduleValues">
- $moduleValues
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">192</span>
- </aside>
- <p class="phpdocumentor-summary">Module values map</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed>|null</span>
- <span class="phpdocumentor-signature__name">$moduleValues</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QRImagick, QRMarkupHTML, QRMarkupSVG: #ABCDEF, cssname, rgb(), rgba()...</li>
- <li>QREps, QRFpdf, QRGdImage: [63, 127, 255] // R, G, B</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_outputInterface">
- $outputInterface
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">104</span>
- </aside>
- <p class="phpdocumentor-summary">the FQCN of the custom QROutputInterface if $outputType is set to QRCode::OUTPUT_CUSTOM</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$outputInterface</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_outputType">
- $outputType
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_outputType" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">99</span>
- </aside>
- <p class="phpdocumentor-summary">The output type</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$outputType</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG</span></code>
- <section class="phpdocumentor-description"><ul>
- <li>QROutputInterface::MARKUP_XXXX where XXXX = HTML, SVG</li>
- <li>QROutputInterface::GDIMAGE_XXX where XXX = PNG, GIF, JPG</li>
- <li>QROutputInterface::STRING_XXXX where XXXX = TEXT, JSON</li>
- <li>QROutputInterface::IMAGICK</li>
- <li>QROutputInterface::EPS</li>
- <li>QROutputInterface::FPDF</li>
- <li>QROutputInterface::CUSTOM</li>
- </ul>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_pngCompression">
- $pngCompression
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">261</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$pngCompression</span>
- = <span class="phpdocumentor-signature__default-value">-1</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\imagepng()">imagepng()</abbr></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_quietzoneSize">
- $quietzoneSize
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">81</span>
- </aside>
- <p class="phpdocumentor-summary">Size of the quiet zone</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$quietzoneSize</span>
- = <span class="phpdocumentor-signature__default-value">4</span></code>
- <section class="phpdocumentor-description"><p>internally clamped to [0 ... $moduleCount / 2], defaults to 4 modules</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
- $readerGrayscale
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">399</span>
- </aside>
- <p class="phpdocumentor-summary">grayscale the image before reading</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$readerGrayscale</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
- $readerIncreaseContrast
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">406</span>
- </aside>
- <p class="phpdocumentor-summary">increase the contrast before reading</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
- $readerUseImagickIfAvailable
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">394</span>
- </aside>
- <p class="phpdocumentor-summary">use Imagick (if available) when reading QR Codes</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_returnResource">
- $returnResource
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_returnResource" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">120</span>
- </aside>
- <p class="phpdocumentor-summary">Return the image resource instead of a render if applicable.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">bool</span>
- <span class="phpdocumentor-signature__name">$returnResource</span>
- = <span class="phpdocumentor-signature__default-value">false</span></code>
- <section class="phpdocumentor-description"><p>This option overrides other output options, such as $cachefile and $imageBase64.</p>
- <p>Supported by the following modules:</p>
- <ul>
- <li>QRGdImage: resource (PHP < 8), GdImage</li>
- <li>QRImagick: Imagick</li>
- <li>QRFpdf: FPDF</li>
- </ul>
- </section>
-
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <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>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_scale">
- $scale
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">231</span>
- </aside>
- <p class="phpdocumentor-summary">pixel size of a QR code module</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$scale</span>
- = <span class="phpdocumentor-signature__default-value">5</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgDefs">
- $svgDefs
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">316</span>
- </aside>
- <p class="phpdocumentor-summary">anything between <defs></p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$svgDefs</span>
- = <span class="phpdocumentor-signature__default-value">''</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgHeight">
- $svgHeight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgHeight" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">345</span>
- </aside>
- <p class="phpdocumentor-summary">optional "height" attribute with the specified value (note that the value is not checked!)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$svgHeight</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgOpacity">
- $svgOpacity
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">309</span>
- </aside>
- <p class="phpdocumentor-summary">SVG opacity</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">float</span>
- <span class="phpdocumentor-signature__name">$svgOpacity</span>
- = <span class="phpdocumentor-signature__default-value">1.0</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgPreserveAspectRatio">
- $svgPreserveAspectRatio
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">331</span>
- </aside>
-
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$svgPreserveAspectRatio</span>
- = <span class="phpdocumentor-signature__default-value">'xMidYMid'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgViewBoxSize">
- $svgViewBoxSize
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">326</span>
- </aside>
- <p class="phpdocumentor-summary">SVG viewBox size. a single integer number which defines width/height of the viewBox attribute.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int|null</span>
- <span class="phpdocumentor-signature__name">$svgViewBoxSize</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>viewBox="0 0 x x"</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</abbr></a></span>
-
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://css-tricks.com/scale-svg/#article-header-id-3"><abbr title="https://css-tricks.com/scale-svg/#article-header-id-3">https://css-tricks.com/scale-svg/#article-header-id-3</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_svgWidth">
- $svgWidth
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgWidth" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">338</span>
- </aside>
- <p class="phpdocumentor-summary">optional "width" attribute with the specified value (note that the value is not checked!)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string|null</span>
- <span class="phpdocumentor-signature__name">$svgWidth</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width</abbr></a></span>
-
-
- </dd>
- </dl>
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_textDark">
- $textDark
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textDark" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">367</span>
- </aside>
- <p class="phpdocumentor-summary">string substitute for dark</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$textDark</span>
- = <span class="phpdocumentor-signature__default-value">'🔴'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_textLight">
- $textLight
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_textLight" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">372</span>
- </aside>
- <p class="phpdocumentor-summary">string substitute for light</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">string</span>
- <span class="phpdocumentor-signature__name">$textLight</span>
- = <span class="phpdocumentor-signature__default-value">'⭕'</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_transparencyColor">
- $transparencyColor
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">251</span>
- </aside>
- <p class="phpdocumentor-summary">Sets a transparency color for when {@see \chillerlan\QRCode\QROptions::$imageTransparent QROptions::$imageTransparent} is set to true.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">mixed|null</span>
- <span class="phpdocumentor-signature__name">$transparencyColor</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
- <section class="phpdocumentor-description"><p>Defaults to <abbr title="\chillerlan\QRCode\QROptions::$bgColor">QROptions::$bgColor</abbr>.</p>
- <ul>
- <li>QRGdImage: [R, G, B], this color is set as transparent in <abbr title="\chillerlan\QRCode\imagecolortransparent()">imagecolortransparent()</abbr>
- </li>
- <li>QRImagick: "color_str", this color is set in <abbr title="\chillerlan\QRCode\Imagick::transparentPaintImage()">Imagick::transparentPaintImage()</abbr>
- </li>
- </ul>
- </section>
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_version">
- $version
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">33</span>
- </aside>
- <p class="phpdocumentor-summary">QR Code version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$version</span>
- = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span></code>
- <section class="phpdocumentor-description"><p>[1 ... 40] or Version::AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_versionMax">
- $versionMax
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">45</span>
- </aside>
- <p class="phpdocumentor-summary">Maximum QR version</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$versionMax</span>
- = <span class="phpdocumentor-signature__default-value">40</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_versionMin">
- $versionMin
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
- <span class="phpdocumentor-element__modifiers">
- </span>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">40</span>
- </aside>
- <p class="phpdocumentor-summary">Minimum QR version</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$versionMin</span>
- = <span class="phpdocumentor-signature__default-value">1</span></code>
- <section class="phpdocumentor-description"><p>if $version = QRCode::VERSION_AUTO</p>
- </section>
- <section class="phpdocumentor-description"></section>
-
- </article>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
- clampLogoSpaceValue()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_clampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">473</span>
- </aside>
- <p class="phpdocumentor-summary">clamp the logo space values between 0 and maximum length (177 modules at version 40)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">int|null</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_circleRadius">
- set_circleRadius()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">513</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set SVG circle radius</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_circleRadius</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$circleRadius</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$circleRadius</span>
- : <span class="phpdocumentor-signature__argument__return-type">float</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_fpdfMeasureUnit">
- set_fpdfMeasureUnit()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_fpdfMeasureUnit" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">453</span>
- </aside>
- <p class="phpdocumentor-summary">sets the FPDF measurement unit</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_fpdfMeasureUnit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$unit</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$unit</span>
- : <span class="phpdocumentor-signature__argument__return-type">string</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-tag-list__heading" id="tags">
- Tags
- <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
- </h5>
- <dl class="phpdocumentor-tag-list">
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceHeight">
- set_logoSpaceHeight()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceHeight" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">492</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set logo space height</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceHeight</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartX">
- set_logoSpaceStartX()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartX" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">499</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set horizontal logo space start</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceStartX</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceStartY">
- set_logoSpaceStartY()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceStartY" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">506</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set vertical logo space start</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceStartY</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_logoSpaceWidth">
- set_logoSpaceWidth()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_logoSpaceWidth" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">485</span>
- </aside>
- <p class="phpdocumentor-summary">clamp/set logo space width</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_logoSpaceWidth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_quietzoneSize">
- set_quietzoneSize()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_quietzoneSize" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">444</span>
- </aside>
- <p class="phpdocumentor-summary">sets/clamps the quiet zone size</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_quietzoneSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$quietzoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$quietzoneSize</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
- set_readerUseImagickIfAvailable()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">466</span>
- </aside>
- <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_readerUseImagickIfAvailable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
- : <span class="phpdocumentor-signature__argument__return-type">bool</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_version">
- set_version()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_version" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">437</span>
- </aside>
- <p class="phpdocumentor-summary">sets/clamps the version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_version</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_versionMax">
- set_versionMax()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMax" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">430</span>
- </aside>
- <p class="phpdocumentor-summary">sets the maximum version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_versionMax</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set_versionMin">
- set_versionMin()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_versionMin" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">423</span>
- </aside>
- <p class="phpdocumentor-summary">sets the minimum version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">set_versionMin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$version</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -protected
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setMinMaxVersion">
- setMinMaxVersion()
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_setMinMaxVersion" class="headerlink"><i class="fas fa-link"></i></a>
- </h4>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/QROptionsTrait.php"><a href="files/src-qroptionstrait.html"><abbr title="src/QROptionsTrait.php">QROptionsTrait.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">412</span>
- </aside>
- <p class="phpdocumentor-summary">clamp min/max version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">protected</span>
- <span class="phpdocumentor-signature__name">setMinMaxVersion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </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 </span><span class="phpdocumentor-signature__argument__name">$versionMax</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
-
- <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
- <dl class="phpdocumentor-argument-list">
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$versionMin</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- <dt class="phpdocumentor-argument-list__entry">
- <span class="phpdocumentor-signature__argument__name">$versionMax</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
- <section class="phpdocumentor-description"></section>
- </dd>
- </dl>
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">void</span>
- —
-
-
- </article>
- </section>
-
- <script type="text/javascript">
- function loadExternalCodeSnippets(line) {
- Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
- var src = pre.getAttribute('data-src').replace( /\\/g, '/');
- var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
- var language = 'php';
- var code = document.createElement('code');
- code.className = 'language-' + language;
- pre.textContent = '';
- pre.setAttribute('data-line', line)
- code.textContent = 'Loading…';
- pre.appendChild(code);
- var xhr = new XMLHttpRequest();
- xhr.open('GET', src, true);
- xhr.onreadystatechange = function () {
- if (xhr.readyState == 4) {
- if (xhr.status < 400 && xhr.responseText) {
- code.textContent = xhr.responseText;
- Prism.highlightElement(code);
- }
- else if (xhr.status >= 400) {
- code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
- }
- else {
- code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
- }
- }
- };
- xhr.send(null);
- });
- }
- var modals = document.querySelectorAll("[data-modal]");
- modals.forEach(function (trigger) {
- trigger.addEventListener("click", function (event) {
- //event.preventDefault();
- const modal = document.getElementById(trigger.dataset.modal);
- modal.classList.add("phpdocumentor-modal__open");
- loadExternalCodeSnippets(trigger.dataset.line)
- const exits = modal.querySelectorAll("[data-exit-button]");
- exits.forEach(function (exit) {
- exit.addEventListener("click", function (event) {
- event.preventDefault();
- modal.classList.remove("phpdocumentor-modal__open");
- });
- });
- });
- });
- </script>
- </article>
- <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
- <section class="phpdocumentor-search-results__dialog">
- <header class="phpdocumentor-search-results__header">
- <h2 class="phpdocumentor-search-results__title">Search results</h2>
- <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
- </header>
- <section class="phpdocumentor-search-results__body">
- <ul class="phpdocumentor-search-results__entries"></ul>
- </section>
- </section>
- </section>
- </div>
- </div>
- <a href="classes/chillerlan-QRCode-QROptionsTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
- </main>
- <script>
- cssVars({});
- </script>
- <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
- </body>
- </html>
|