| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302 |
- <!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>
- <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
- </ul>
- <article class="phpdocumentor-element -class">
- <h2 class="phpdocumentor-content__title">
- QRMatrix
-
- <div class="phpdocumentor-element__package">
- in package
- <ul class="phpdocumentor-breadcrumbs">
- <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
- </ul>
- </div>
-
-
- </h2>
- <aside class="phpdocumentor-element-found-in">
- <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">24</span>
- </aside>
- <p class="phpdocumentor-summary">Holds a numerical representation of the final QR Code;
- maps the ECC coded binary data and applies the mask pattern</p>
- <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="http://www.thonky.com/qr-code-tutorial/format-version-information"><abbr title="http://www.thonky.com/qr-code-tutorial/format-version-information">http://www.thonky.com/qr-code-tutorial/format-version-information</abbr></a></span>
-
-
- </dd>
- </dl>
- <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 -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
- <span>
- = 0b100000000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
- <span>
- = 0b10000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
- <span>
- = 0b1 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
- <span>
- = 0b10 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
- <span>
- = 0b100 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
- <span>
- = 0b10000000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
- <span>
- = 0b1000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
- <span>
- = 0b1000000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
- <span>
- = 0b0 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
- <span>
- = 0b100000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
- <span>
- = 0b1000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST">M_TEST</a>
- <span>
- = 0b11111111111 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
- <span>
- = 0b100000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -constant -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
- <span>
- = 0b10000000 </span>
- </dt>
- <dd></dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
- </dt>
- <dd>the current ECC level</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
- </dt>
- <dd>the used mask pattern, set via QRMatrix::mask()</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
- <span>
- : array<string|int, mixed> </span>
- </dt>
- <dd>the actual matrix data array</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
- <span>
- : int </span>
- </dt>
- <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -property -private">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
- </dt>
- <dd>a Version instance</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a>
- <span>
- : mixed </span>
- </dt>
- <dd>QRMatrix constructor.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
- <span>
- : bool </span>
- </dt>
- <dd>Checks whether a module is true (dark) or false (light)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
- <span>
- : bool </span>
- </dt>
- <dd>Checks whether a module is of the given $M_TYPE</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypes">checkTypes()</a>
- <span>
- : bool </span>
- </dt>
- <dd>checks whether a module matches one of the given $M_TYPES</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
- </dt>
- <dd>Returns the current ECC level</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
- <span>
- : self </span>
- </dt>
- <dd>Flips the value of the module</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
- <span>
- : int </span>
- </dt>
- <dd>Returns the value of the module at position [$x, $y]</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFormatInfo">initFormatInfo()</a>
- <span>
- : self </span>
- </dt>
- <dd>shortcut to set format and version info</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
- <span>
- : self </span>
- </dt>
- <dd>shortcut to initialize the functional patterns</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mapData">mapData()</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
- </dt>
- <dd>Maps the binary $data array from QRData::maskECC() on the matrix,
- masking the data using $maskPattern (ISO/IEC 18004:2000 Section 8.8)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
- <span>
- : self </span>
- </dt>
- <dd>Applies the mask pattern</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
- </dt>
- <dd>Returns the current mask pattern</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
- <span>
- : array<string|int, array<string|int, int>>|array<string|int, array<string|int, bool>> </span>
- </dt>
- <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
- <span>
- : self </span>
- </dt>
- <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the 5x5 alignment patterns</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
- <span>
- : self </span>
- </dt>
- <dd>Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the format info along the finder patterns</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
- <span>
- : self </span>
- </dt>
- <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the "quiet zone" of $size around the matrix</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the separator lines around the finder patterns</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
- <span>
- : self </span>
- </dt>
- <dd>Draws the version information, 2x 3x6 pixel</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
- <span>
- : int </span>
- </dt>
- <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
- <dt class="phpdocumentor-table-of-contents__entry -method -public">
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
- <span>
- : <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
- </dt>
- <dd>Returns the current version number</dd>
- </dl>
-
- <section class="phpdocumentor-constants">
- <h3 class="phpdocumentor-elements__header" id="constants">
- Constants
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
- IS_DARK
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">53</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">IS_DARK</span>
- = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
- M_ALIGNMENT
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">37</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
- = <span class="phpdocumentor-signature__default-value">0b10000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
- M_DARKMODULE
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">29</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
- = <span class="phpdocumentor-signature__default-value">0b1</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
- M_DATA
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">31</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_DATA</span>
- = <span class="phpdocumentor-signature__default-value">0b10</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
- M_FINDER
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">33</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_FINDER</span>
- = <span class="phpdocumentor-signature__default-value">0b100</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
- M_FINDER_DOT
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">49</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
- = <span class="phpdocumentor-signature__default-value">0b10000000000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
- M_FORMAT
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">41</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_FORMAT</span>
- = <span class="phpdocumentor-signature__default-value">0b1000000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
- M_LOGO
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">47</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_LOGO</span>
- = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
- M_NULL
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">27</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_NULL</span>
- = <span class="phpdocumentor-signature__default-value">0b0</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
- M_QUIETZONE
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">45</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
- = <span class="phpdocumentor-signature__default-value">0b100000000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
- M_SEPARATOR
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">35</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
- = <span class="phpdocumentor-signature__default-value">0b1000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
- M_TEST
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">51</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_TEST</span>
- = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
- M_TIMING
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">39</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_TIMING</span>
- = <span class="phpdocumentor-signature__default-value">0b100000</span>
- </code>
-
-
-
- </article>
- <article class="phpdocumentor-element -constant -public ">
- <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
- M_VERSION
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">43</span>
- </aside>
-
- <code class="phpdocumentor-signature phpdocumentor-code ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">M_VERSION</span>
- = <span class="phpdocumentor-signature__default-value">0b10000000</span>
- </code>
-
-
-
- </article>
- </section>
-
- <section class="phpdocumentor-properties">
- <h3 class="phpdocumentor-elements__header" id="properties">
- Properties
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_eccLevel">
- $eccLevel
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">75</span>
- </aside>
- <p class="phpdocumentor-summary">the current ECC level</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
- <span class="phpdocumentor-signature__name">$eccLevel</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_maskPattern">
- $maskPattern
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">58</span>
- </aside>
- <p class="phpdocumentor-summary">the used mask pattern, set via QRMatrix::mask()</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
- <span class="phpdocumentor-signature__name">$maskPattern</span>
- = <span class="phpdocumentor-signature__default-value">null</span></code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_matrix">
- $matrix
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">70</span>
- </aside>
- <p class="phpdocumentor-summary">the actual matrix data array</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
- <span class="phpdocumentor-signature__name">$matrix</span>
- </code>
-
-
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_moduleCount">
- $moduleCount
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">63</span>
- </aside>
- <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type">int</span>
- <span class="phpdocumentor-signature__name">$moduleCount</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- <article
- class="
- phpdocumentor-element
- -property
- -private
- "
- >
- <h4 class="phpdocumentor-element__name" id="property_version">
- $version
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">80</span>
- </aside>
- <p class="phpdocumentor-summary">a Version instance</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">private</span>
- <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
- <span class="phpdocumentor-signature__name">$version</span>
- </code>
-
- <section class="phpdocumentor-description"></section>
-
- </article>
- </section>
- <section class="phpdocumentor-methods">
- <h3 class="phpdocumentor-elements__header" id="methods">
- Methods
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
- </h3>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method___construct">
- __construct()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">85</span>
- </aside>
- <p class="phpdocumentor-summary">QRMatrix constructor.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></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">$eccLevel</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></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">mixed</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_check">
- check()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">226</span>
- </aside>
- <p class="phpdocumentor-summary">Checks whether a module is true (dark) or false (light)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
- <section class="phpdocumentor-description"><p>true => $value & 0x800 === 0x800
- false => $value & 0x800 === 0</p>
- </section>
- <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">$x</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">$y</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">bool</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_checkType">
- checkType()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">202</span>
- </aside>
- <p class="phpdocumentor-summary">Checks whether a module is of the given $M_TYPE</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">checkType</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
- <section class="phpdocumentor-description"><p>true => $value & $M_TYPE === $M_TYPE</p>
- </section>
- <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">$x</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">$y</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">$M_TYPE</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">bool</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_checkTypes">
- checkTypes()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypes" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">209</span>
- </aside>
- <p class="phpdocumentor-summary">checks whether a module matches one of the given $M_TYPES</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">checkTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$M_TYPES</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$x</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">$y</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">$M_TYPES</span>
- : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></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">bool</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_eccLevel">
- eccLevel()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">149</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the current ECC level</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">eccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span></code>
-
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_flip">
- flip()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">191</span>
- </aside>
- <p class="phpdocumentor-summary">Flips the value of the module</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">flip</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</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">$x</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">$y</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">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_get">
- get()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">172</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y]</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$x</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">$y</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">int</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_initFormatInfo">
- initFormatInfo()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFormatInfo" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">108</span>
- </aside>
- <p class="phpdocumentor-summary">shortcut to set format and version info</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">initFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</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">$maskPattern</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></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">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
- initFunctionalPatterns()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">95</span>
- </aside>
- <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
-
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_mapData">
- mapData()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mapData" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">545</span>
- </aside>
- <p class="phpdocumentor-summary">Maps the binary $data array from QRData::maskECC() on the matrix,
- masking the data using $maskPattern (ISO/IEC 18004:2000 Section 8.8)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">mapData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\SplFixedArray">SplFixedArray</abbr><string|int, int> </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></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">$data</span>
- : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\SplFixedArray">SplFixedArray</abbr><string|int, int></span>
- </dt>
- <dd class="phpdocumentor-argument-list__definition">
-
- </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">see</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Data\QRData::maskECC()">QRData::maskECC()</abbr></span>
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_mask">
- mask()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">602</span>
- </aside>
- <p class="phpdocumentor-summary">Applies the mask pattern</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">mask</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
- </section>
- <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">$maskPattern</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></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">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_maskPattern">
- maskPattern()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">156</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the current mask pattern</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">maskPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span></code>
-
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_matrix">
- matrix()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">120</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">matrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$boolean</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, array<string|int, int>>|array<string|int, array<string|int, bool>></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">$boolean</span>
- : <span class="phpdocumentor-signature__argument__return-type">bool</span>
- = <span class="phpdocumentor-signature__argument__default-value">false</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">array<string|int, array<string|int, int>>|array<string|int, array<string|int, bool>></span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_set">
- set()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">182</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>true => $M_TYPE | 0x800
- false => $M_TYPE</p>
- </section>
- <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">$x</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">$y</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">$value</span>
- : <span class="phpdocumentor-signature__argument__return-type">bool</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">$M_TYPE</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">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
- setAlignmentPattern()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">311</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
- setDarkModule()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">235</span>
- </aside>
- <p class="phpdocumentor-summary">Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
- setFinderPattern()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">246</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
- setFormatInfo()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">388</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the format info along the finder patterns</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
- </section>
- <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">$maskPattern</span>
- : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></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">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
- setLogoSpace()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">473</span>
- </aside>
- <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setLogoSpace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$startX</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$startY</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>Additionally, the logo space can be positioned within the QR Code - respecting the main functional patterns -
- using $startX and $startY. If either of these are null, the logo space will be centered in that direction.
- ECC level "H" (30%) is required.</p>
- <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
- created images may become unreadable, especially when printed with a chance to receive damage.
- Please test thoroughly before using this feature in production.</p>
- <p>This method should be called from within an output module (after the matrix has been filled with data).
- Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
- </section>
- <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">$width</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">$height</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">$startX</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- = <span class="phpdocumentor-signature__argument__default-value">null</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">$startY</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- = <span class="phpdocumentor-signature__argument__default-value">null</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">link</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
-
- </dd>
- <dt class="phpdocumentor-tag-list__entry">
- <span class="phpdocumentor-tag__name">throws</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
- setQuietZone()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">426</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the "quiet zone" of $size around the matrix</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setQuietZone</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$size</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</p>
- </section>
- <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">$size</span>
- : <span class="phpdocumentor-signature__argument__return-type">int</span>
- = <span class="phpdocumentor-signature__argument__default-value">null</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">throws</span>
- </dt>
- <dd class="phpdocumentor-tag-list__definition">
- <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
-
-
- </dd>
- </dl>
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setSeparators">
- setSeparators()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">281</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
- setTimingPattern()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">342</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
- setVersionNumber()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">364</span>
- </aside>
- <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
- <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">self</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_size">
- size()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">165</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
- <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
- </section>
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type">int</span>
- —
-
-
- </article>
- <article
- class="phpdocumentor-element
- -method
- -public
- "
- >
- <h4 class="phpdocumentor-element__name" id="method_version">
- version()
- <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
- :
- <span class="phpdocumentor-element-found-in__line">142</span>
- </aside>
- <p class="phpdocumentor-summary">Returns the current version number</p>
- <code class="phpdocumentor-code phpdocumentor-signature ">
- <span class="phpdocumentor-signature__visibility">public</span>
- <span class="phpdocumentor-signature__name">version</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span></code>
-
-
-
- <h5 class="phpdocumentor-return-value__heading">Return values</h5>
- <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></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-Data-QRMatrix.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>
|