chillerlan-QRCode-Data-QRMatrix.html 148 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRMatrix
  93. <div class="phpdocumentor-element__package">
  94. in package
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <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>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">22</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Holds an array representation of the final QR Code that contains numerical values for later output modifications;
  106. maps the ECC coded binary data and applies the mask pattern</p>
  107. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  108. Tags
  109. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  110. </h5>
  111. <dl class="phpdocumentor-tag-list">
  112. <dt class="phpdocumentor-tag-list__entry">
  113. <span class="phpdocumentor-tag__name">see</span>
  114. </dt>
  115. <dd class="phpdocumentor-tag-list__definition">
  116. <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>
  117. </dd>
  118. </dl>
  119. <h3 id="toc">
  120. Table of Contents
  121. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  122. </h3>
  123. <dl class="phpdocumentor-table-of-contents">
  124. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  125. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  126. <span>
  127. &nbsp;= 0b100000000000 </span>
  128. </dt>
  129. <dd></dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  131. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  132. <span>
  133. &nbsp;= 0b10000 </span>
  134. </dt>
  135. <dd></dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  137. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a>
  138. <span>
  139. &nbsp;= 0b100000010000 </span>
  140. </dt>
  141. <dd></dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  143. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  144. <span>
  145. &nbsp;= 0b100000000001 </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  149. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  150. <span>
  151. &nbsp;= 0b10 </span>
  152. </dt>
  153. <dd></dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  155. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a>
  156. <span>
  157. &nbsp;= 0b100000000010 </span>
  158. </dt>
  159. <dd></dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  161. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  162. <span>
  163. &nbsp;= 0b100 </span>
  164. </dt>
  165. <dd></dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  167. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a>
  168. <span>
  169. &nbsp;= 0b100000000100 </span>
  170. </dt>
  171. <dd></dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  173. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  174. <span>
  175. &nbsp;= 0b110000000000 </span>
  176. </dt>
  177. <dd></dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  179. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  180. <span>
  181. &nbsp;= 0b1000000 </span>
  182. </dt>
  183. <dd></dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  185. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a>
  186. <span>
  187. &nbsp;= 0b100001000000 </span>
  188. </dt>
  189. <dd></dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  191. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  192. <span>
  193. &nbsp;= 0b1000000000 </span>
  194. </dt>
  195. <dd></dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  197. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  198. <span>
  199. &nbsp;= 0b0 </span>
  200. </dt>
  201. <dd></dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  203. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  204. <span>
  205. &nbsp;= 0b100000000 </span>
  206. </dt>
  207. <dd></dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  209. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  210. <span>
  211. &nbsp;= 0b1000 </span>
  212. </dt>
  213. <dd></dd>
  214. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  215. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST">M_TEST</a>
  216. <span>
  217. &nbsp;= 0b11111111111 </span>
  218. </dt>
  219. <dd></dd>
  220. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  221. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK">M_TEST_DARK</a>
  222. <span>
  223. &nbsp;= 0b111111111111 </span>
  224. </dt>
  225. <dd></dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  227. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  228. <span>
  229. &nbsp;= 0b100000 </span>
  230. </dt>
  231. <dd></dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  233. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a>
  234. <span>
  235. &nbsp;= 0b100000100000 </span>
  236. </dt>
  237. <dd></dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  239. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  240. <span>
  241. &nbsp;= 0b10000000 </span>
  242. </dt>
  243. <dd></dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  245. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a>
  246. <span>
  247. &nbsp;= 0b100010000000 </span>
  248. </dt>
  249. <dd></dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  251. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a>
  252. <span>
  253. &nbsp;= [0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]] </span>
  254. </dt>
  255. <dd>Map of flag =&gt; coord</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  257. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  258. <span>
  259. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  260. </dt>
  261. <dd>the current ECC level - always set in QRMatrix, may be null in BitMatrix</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  263. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  264. <span>
  265. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  266. </dt>
  267. <dd>the mask pattern that was used in the most recent operation, set via:</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  269. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  270. <span>
  271. &nbsp;: array&lt;string|int, mixed&gt; </span>
  272. </dt>
  273. <dd>the actual matrix data array</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  275. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  276. <span>
  277. &nbsp;: int </span>
  278. </dt>
  279. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  281. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  282. <span>
  283. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  284. </dt>
  285. <dd>the matrix version - always set in QRMatrix, may be null in BitMatrix</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  287. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a>
  288. <span>
  289. &nbsp;: mixed </span>
  290. </dt>
  291. <dd>QRMatrix constructor.</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  293. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  294. <span>
  295. &nbsp;: bool </span>
  296. </dt>
  297. <dd>Checks whether the module at ($x, $y) is true (dark) or false (light)</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  299. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a>
  300. <span>
  301. &nbsp;: int </span>
  302. </dt>
  303. <dd>Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</dd>
  304. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  305. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  306. <span>
  307. &nbsp;: bool </span>
  308. </dt>
  309. <dd>Checks whether the module at ($x, $y) is of the given $M_TYPE</dd>
  310. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  311. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a>
  312. <span>
  313. &nbsp;: bool </span>
  314. </dt>
  315. <dd>checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  316. returns true if a match is found, otherwise false.</dd>
  317. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  318. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
  319. <span>
  320. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  321. </dt>
  322. <dd></dd>
  323. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  324. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
  325. <span>
  326. &nbsp;: self </span>
  327. </dt>
  328. <dd>Flips the value of the module at ($x, $y)</dd>
  329. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  330. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  331. <span>
  332. &nbsp;: int </span>
  333. </dt>
  334. <dd>Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</dd>
  335. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  336. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a>
  337. <span>
  338. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  339. </dt>
  340. <dd>Returns the current ECC level</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  342. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a>
  343. <span>
  344. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  345. </dt>
  346. <dd>Returns the current mask pattern</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  348. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a>
  349. <span>
  350. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  351. </dt>
  352. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  354. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a>
  355. <span>
  356. &nbsp;: int </span>
  357. </dt>
  358. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  360. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a>
  361. <span>
  362. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  363. </dt>
  364. <dd>Returns the current version number</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  366. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
  367. <span>
  368. &nbsp;: self </span>
  369. </dt>
  370. <dd>shortcut to initialize the functional patterns</dd>
  371. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  372. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  373. <span>
  374. &nbsp;: self </span>
  375. </dt>
  376. <dd>Applies/reverses the mask pattern</dd>
  377. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  378. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  379. <span>
  380. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  381. </dt>
  382. <dd></dd>
  383. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  384. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  385. <span>
  386. &nbsp;: array&lt;string|int, mixed&gt; </span>
  387. </dt>
  388. <dd></dd>
  389. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  390. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  391. <span>
  392. &nbsp;: self </span>
  393. </dt>
  394. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  395. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  396. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  397. <span>
  398. &nbsp;: self </span>
  399. </dt>
  400. <dd>Draws the 5x5 alignment patterns</dd>
  401. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  402. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a>
  403. <span>
  404. &nbsp;: self </span>
  405. </dt>
  406. <dd>Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</dd>
  407. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  408. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  409. <span>
  410. &nbsp;: self </span>
  411. </dt>
  412. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  413. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  414. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  415. <span>
  416. &nbsp;: self </span>
  417. </dt>
  418. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  419. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  420. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  421. <span>
  422. &nbsp;: self </span>
  423. </dt>
  424. <dd>Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</dd>
  425. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  426. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  427. <span>
  428. &nbsp;: self </span>
  429. </dt>
  430. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  431. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  432. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
  433. <span>
  434. &nbsp;: self </span>
  435. </dt>
  436. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  437. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  438. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  439. <span>
  440. &nbsp;: self </span>
  441. </dt>
  442. <dd>Draws the separator lines around the finder patterns</dd>
  443. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  444. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  445. <span>
  446. &nbsp;: self </span>
  447. </dt>
  448. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  449. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  450. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  451. <span>
  452. &nbsp;: self </span>
  453. </dt>
  454. <dd>Draws the version information, 2x 3x6 pixel</dd>
  455. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  456. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  457. <span>
  458. &nbsp;: int </span>
  459. </dt>
  460. <dd></dd>
  461. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  462. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  463. <span>
  464. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  465. </dt>
  466. <dd></dd>
  467. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  468. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  469. <span>
  470. &nbsp;: self </span>
  471. </dt>
  472. <dd>Maps the interleaved binary $data on the matrix</dd>
  473. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  474. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a>
  475. <span>
  476. &nbsp;: array&lt;string|int, mixed&gt; </span>
  477. </dt>
  478. <dd>Creates a 2-dimensional array (square) of the given $size</dd>
  479. </dl>
  480. <section class="phpdocumentor-constants">
  481. <h3 class="phpdocumentor-elements__header" id="constants">
  482. Constants
  483. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  484. </h3>
  485. <article class="phpdocumentor-element -constant -public ">
  486. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  487. IS_DARK
  488. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  489. </h4>
  490. <aside class="phpdocumentor-element-found-in">
  491. <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>
  492. :
  493. <span class="phpdocumentor-element-found-in__line">25</span>
  494. </aside>
  495. <code class="phpdocumentor-signature phpdocumentor-code ">
  496. <span class="phpdocumentor-signature__visibility">public</span>
  497. <span class="phpdocumentor-signature__type">int</span>
  498. <span class="phpdocumentor-signature__name">IS_DARK</span>
  499. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  500. </code>
  501. </article>
  502. <article class="phpdocumentor-element -constant -public ">
  503. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  504. M_ALIGNMENT
  505. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  506. </h4>
  507. <aside class="phpdocumentor-element-found-in">
  508. <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>
  509. :
  510. <span class="phpdocumentor-element-found-in__line">41</span>
  511. </aside>
  512. <code class="phpdocumentor-signature phpdocumentor-code ">
  513. <span class="phpdocumentor-signature__visibility">public</span>
  514. <span class="phpdocumentor-signature__type">int</span>
  515. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  516. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  517. </code>
  518. </article>
  519. <article class="phpdocumentor-element -constant -public ">
  520. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT_DARK">
  521. M_ALIGNMENT_DARK
  522. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  523. </h4>
  524. <aside class="phpdocumentor-element-found-in">
  525. <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>
  526. :
  527. <span class="phpdocumentor-element-found-in__line">43</span>
  528. </aside>
  529. <code class="phpdocumentor-signature phpdocumentor-code ">
  530. <span class="phpdocumentor-signature__visibility">public</span>
  531. <span class="phpdocumentor-signature__type">int</span>
  532. <span class="phpdocumentor-signature__name">M_ALIGNMENT_DARK</span>
  533. = <span class="phpdocumentor-signature__default-value">0b100000010000</span>
  534. </code>
  535. </article>
  536. <article class="phpdocumentor-element -constant -public ">
  537. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  538. M_DARKMODULE
  539. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  540. </h4>
  541. <aside class="phpdocumentor-element-found-in">
  542. <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>
  543. :
  544. <span class="phpdocumentor-element-found-in__line">29</span>
  545. </aside>
  546. <code class="phpdocumentor-signature phpdocumentor-code ">
  547. <span class="phpdocumentor-signature__visibility">public</span>
  548. <span class="phpdocumentor-signature__type">int</span>
  549. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  550. = <span class="phpdocumentor-signature__default-value">0b100000000001</span>
  551. </code>
  552. </article>
  553. <article class="phpdocumentor-element -constant -public ">
  554. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  555. M_DATA
  556. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  557. </h4>
  558. <aside class="phpdocumentor-element-found-in">
  559. <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>
  560. :
  561. <span class="phpdocumentor-element-found-in__line">31</span>
  562. </aside>
  563. <code class="phpdocumentor-signature phpdocumentor-code ">
  564. <span class="phpdocumentor-signature__visibility">public</span>
  565. <span class="phpdocumentor-signature__type">int</span>
  566. <span class="phpdocumentor-signature__name">M_DATA</span>
  567. = <span class="phpdocumentor-signature__default-value">0b10</span>
  568. </code>
  569. </article>
  570. <article class="phpdocumentor-element -constant -public ">
  571. <h4 class="phpdocumentor-element__name" id="constant_M_DATA_DARK">
  572. M_DATA_DARK
  573. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  574. </h4>
  575. <aside class="phpdocumentor-element-found-in">
  576. <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>
  577. :
  578. <span class="phpdocumentor-element-found-in__line">33</span>
  579. </aside>
  580. <code class="phpdocumentor-signature phpdocumentor-code ">
  581. <span class="phpdocumentor-signature__visibility">public</span>
  582. <span class="phpdocumentor-signature__type">int</span>
  583. <span class="phpdocumentor-signature__name">M_DATA_DARK</span>
  584. = <span class="phpdocumentor-signature__default-value">0b100000000010</span>
  585. </code>
  586. </article>
  587. <article class="phpdocumentor-element -constant -public ">
  588. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  589. M_FINDER
  590. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  591. </h4>
  592. <aside class="phpdocumentor-element-found-in">
  593. <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>
  594. :
  595. <span class="phpdocumentor-element-found-in__line">35</span>
  596. </aside>
  597. <code class="phpdocumentor-signature phpdocumentor-code ">
  598. <span class="phpdocumentor-signature__visibility">public</span>
  599. <span class="phpdocumentor-signature__type">int</span>
  600. <span class="phpdocumentor-signature__name">M_FINDER</span>
  601. = <span class="phpdocumentor-signature__default-value">0b100</span>
  602. </code>
  603. </article>
  604. <article class="phpdocumentor-element -constant -public ">
  605. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DARK">
  606. M_FINDER_DARK
  607. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  608. </h4>
  609. <aside class="phpdocumentor-element-found-in">
  610. <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>
  611. :
  612. <span class="phpdocumentor-element-found-in__line">37</span>
  613. </aside>
  614. <code class="phpdocumentor-signature phpdocumentor-code ">
  615. <span class="phpdocumentor-signature__visibility">public</span>
  616. <span class="phpdocumentor-signature__type">int</span>
  617. <span class="phpdocumentor-signature__name">M_FINDER_DARK</span>
  618. = <span class="phpdocumentor-signature__default-value">0b100000000100</span>
  619. </code>
  620. </article>
  621. <article class="phpdocumentor-element -constant -public ">
  622. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  623. M_FINDER_DOT
  624. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h4>
  626. <aside class="phpdocumentor-element-found-in">
  627. <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>
  628. :
  629. <span class="phpdocumentor-element-found-in__line">61</span>
  630. </aside>
  631. <code class="phpdocumentor-signature phpdocumentor-code ">
  632. <span class="phpdocumentor-signature__visibility">public</span>
  633. <span class="phpdocumentor-signature__type">int</span>
  634. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  635. = <span class="phpdocumentor-signature__default-value">0b110000000000</span>
  636. </code>
  637. </article>
  638. <article class="phpdocumentor-element -constant -public ">
  639. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  640. M_FORMAT
  641. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  642. </h4>
  643. <aside class="phpdocumentor-element-found-in">
  644. <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>
  645. :
  646. <span class="phpdocumentor-element-found-in__line">49</span>
  647. </aside>
  648. <code class="phpdocumentor-signature phpdocumentor-code ">
  649. <span class="phpdocumentor-signature__visibility">public</span>
  650. <span class="phpdocumentor-signature__type">int</span>
  651. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  652. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  653. </code>
  654. </article>
  655. <article class="phpdocumentor-element -constant -public ">
  656. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT_DARK">
  657. M_FORMAT_DARK
  658. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  659. </h4>
  660. <aside class="phpdocumentor-element-found-in">
  661. <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>
  662. :
  663. <span class="phpdocumentor-element-found-in__line">51</span>
  664. </aside>
  665. <code class="phpdocumentor-signature phpdocumentor-code ">
  666. <span class="phpdocumentor-signature__visibility">public</span>
  667. <span class="phpdocumentor-signature__type">int</span>
  668. <span class="phpdocumentor-signature__name">M_FORMAT_DARK</span>
  669. = <span class="phpdocumentor-signature__default-value">0b100001000000</span>
  670. </code>
  671. </article>
  672. <article class="phpdocumentor-element -constant -public ">
  673. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  674. M_LOGO
  675. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  676. </h4>
  677. <aside class="phpdocumentor-element-found-in">
  678. <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>
  679. :
  680. <span class="phpdocumentor-element-found-in__line">59</span>
  681. </aside>
  682. <code class="phpdocumentor-signature phpdocumentor-code ">
  683. <span class="phpdocumentor-signature__visibility">public</span>
  684. <span class="phpdocumentor-signature__type">int</span>
  685. <span class="phpdocumentor-signature__name">M_LOGO</span>
  686. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  687. </code>
  688. </article>
  689. <article class="phpdocumentor-element -constant -public ">
  690. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  691. M_NULL
  692. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  693. </h4>
  694. <aside class="phpdocumentor-element-found-in">
  695. <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>
  696. :
  697. <span class="phpdocumentor-element-found-in__line">27</span>
  698. </aside>
  699. <code class="phpdocumentor-signature phpdocumentor-code ">
  700. <span class="phpdocumentor-signature__visibility">public</span>
  701. <span class="phpdocumentor-signature__type">int</span>
  702. <span class="phpdocumentor-signature__name">M_NULL</span>
  703. = <span class="phpdocumentor-signature__default-value">0b0</span>
  704. </code>
  705. </article>
  706. <article class="phpdocumentor-element -constant -public ">
  707. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  708. M_QUIETZONE
  709. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  710. </h4>
  711. <aside class="phpdocumentor-element-found-in">
  712. <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>
  713. :
  714. <span class="phpdocumentor-element-found-in__line">57</span>
  715. </aside>
  716. <code class="phpdocumentor-signature phpdocumentor-code ">
  717. <span class="phpdocumentor-signature__visibility">public</span>
  718. <span class="phpdocumentor-signature__type">int</span>
  719. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  720. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  721. </code>
  722. </article>
  723. <article class="phpdocumentor-element -constant -public ">
  724. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  725. M_SEPARATOR
  726. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  727. </h4>
  728. <aside class="phpdocumentor-element-found-in">
  729. <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>
  730. :
  731. <span class="phpdocumentor-element-found-in__line">39</span>
  732. </aside>
  733. <code class="phpdocumentor-signature phpdocumentor-code ">
  734. <span class="phpdocumentor-signature__visibility">public</span>
  735. <span class="phpdocumentor-signature__type">int</span>
  736. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  737. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  738. </code>
  739. </article>
  740. <article class="phpdocumentor-element -constant -public ">
  741. <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
  742. M_TEST
  743. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" class="headerlink"><i class="fas fa-link"></i></a>
  744. </h4>
  745. <aside class="phpdocumentor-element-found-in">
  746. <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>
  747. :
  748. <span class="phpdocumentor-element-found-in__line">63</span>
  749. </aside>
  750. <code class="phpdocumentor-signature phpdocumentor-code ">
  751. <span class="phpdocumentor-signature__visibility">public</span>
  752. <span class="phpdocumentor-signature__type">int</span>
  753. <span class="phpdocumentor-signature__name">M_TEST</span>
  754. = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
  755. </code>
  756. </article>
  757. <article class="phpdocumentor-element -constant -public ">
  758. <h4 class="phpdocumentor-element__name" id="constant_M_TEST_DARK">
  759. M_TEST_DARK
  760. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  761. </h4>
  762. <aside class="phpdocumentor-element-found-in">
  763. <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>
  764. :
  765. <span class="phpdocumentor-element-found-in__line">65</span>
  766. </aside>
  767. <code class="phpdocumentor-signature phpdocumentor-code ">
  768. <span class="phpdocumentor-signature__visibility">public</span>
  769. <span class="phpdocumentor-signature__type">int</span>
  770. <span class="phpdocumentor-signature__name">M_TEST_DARK</span>
  771. = <span class="phpdocumentor-signature__default-value">0b111111111111</span>
  772. </code>
  773. </article>
  774. <article class="phpdocumentor-element -constant -public ">
  775. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  776. M_TIMING
  777. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  778. </h4>
  779. <aside class="phpdocumentor-element-found-in">
  780. <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>
  781. :
  782. <span class="phpdocumentor-element-found-in__line">45</span>
  783. </aside>
  784. <code class="phpdocumentor-signature phpdocumentor-code ">
  785. <span class="phpdocumentor-signature__visibility">public</span>
  786. <span class="phpdocumentor-signature__type">int</span>
  787. <span class="phpdocumentor-signature__name">M_TIMING</span>
  788. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  789. </code>
  790. </article>
  791. <article class="phpdocumentor-element -constant -public ">
  792. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING_DARK">
  793. M_TIMING_DARK
  794. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  795. </h4>
  796. <aside class="phpdocumentor-element-found-in">
  797. <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>
  798. :
  799. <span class="phpdocumentor-element-found-in__line">47</span>
  800. </aside>
  801. <code class="phpdocumentor-signature phpdocumentor-code ">
  802. <span class="phpdocumentor-signature__visibility">public</span>
  803. <span class="phpdocumentor-signature__type">int</span>
  804. <span class="phpdocumentor-signature__name">M_TIMING_DARK</span>
  805. = <span class="phpdocumentor-signature__default-value">0b100000100000</span>
  806. </code>
  807. </article>
  808. <article class="phpdocumentor-element -constant -public ">
  809. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  810. M_VERSION
  811. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  812. </h4>
  813. <aside class="phpdocumentor-element-found-in">
  814. <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>
  815. :
  816. <span class="phpdocumentor-element-found-in__line">53</span>
  817. </aside>
  818. <code class="phpdocumentor-signature phpdocumentor-code ">
  819. <span class="phpdocumentor-signature__visibility">public</span>
  820. <span class="phpdocumentor-signature__type">int</span>
  821. <span class="phpdocumentor-signature__name">M_VERSION</span>
  822. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  823. </code>
  824. </article>
  825. <article class="phpdocumentor-element -constant -public ">
  826. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION_DARK">
  827. M_VERSION_DARK
  828. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  829. </h4>
  830. <aside class="phpdocumentor-element-found-in">
  831. <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>
  832. :
  833. <span class="phpdocumentor-element-found-in__line">55</span>
  834. </aside>
  835. <code class="phpdocumentor-signature phpdocumentor-code ">
  836. <span class="phpdocumentor-signature__visibility">public</span>
  837. <span class="phpdocumentor-signature__type">int</span>
  838. <span class="phpdocumentor-signature__name">M_VERSION_DARK</span>
  839. = <span class="phpdocumentor-signature__default-value">0b100010000000</span>
  840. </code>
  841. </article>
  842. <article class="phpdocumentor-element -constant -protected ">
  843. <h4 class="phpdocumentor-element__name" id="constant_neighbours">
  844. neighbours
  845. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours" class="headerlink"><i class="fas fa-link"></i></a>
  846. </h4>
  847. <aside class="phpdocumentor-element-found-in">
  848. <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>
  849. :
  850. <span class="phpdocumentor-element-found-in__line">74</span>
  851. </aside>
  852. <p class="phpdocumentor-summary">Map of flag =&gt; coord</p>
  853. <code class="phpdocumentor-signature phpdocumentor-code ">
  854. <span class="phpdocumentor-signature__visibility">protected</span>
  855. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  856. <span class="phpdocumentor-signature__name">neighbours</span>
  857. = <span class="phpdocumentor-signature__default-value">[0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]]</span>
  858. </code>
  859. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  860. Tags
  861. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  862. </h5>
  863. <dl class="phpdocumentor-tag-list">
  864. <dt class="phpdocumentor-tag-list__entry">
  865. <span class="phpdocumentor-tag__name">see</span>
  866. </dt>
  867. <dd class="phpdocumentor-tag-list__definition">
  868. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours"><abbr title="\chillerlan\QRCode\Data\QRMatrix::checkNeighbours()">QRMatrix::checkNeighbours()</abbr></a></span>
  869. </dd>
  870. </dl>
  871. </article>
  872. </section>
  873. <section class="phpdocumentor-properties">
  874. <h3 class="phpdocumentor-elements__header" id="properties">
  875. Properties
  876. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  877. </h3>
  878. <article
  879. class="
  880. phpdocumentor-element
  881. -property
  882. -protected
  883. "
  884. >
  885. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  886. $eccLevel
  887. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  888. <span class="phpdocumentor-element__modifiers">
  889. </span>
  890. </h4>
  891. <aside class="phpdocumentor-element-found-in">
  892. <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>
  893. :
  894. <span class="phpdocumentor-element-found-in__line">93</span>
  895. </aside>
  896. <p class="phpdocumentor-summary">the current ECC level - always set in QRMatrix, may be null in BitMatrix</p>
  897. <code class="phpdocumentor-code phpdocumentor-signature ">
  898. <span class="phpdocumentor-signature__visibility">protected</span>
  899. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  900. <span class="phpdocumentor-signature__name">$eccLevel</span>
  901. = <span class="phpdocumentor-signature__default-value">null</span></code>
  902. <section class="phpdocumentor-description"></section>
  903. </article>
  904. <article
  905. class="
  906. phpdocumentor-element
  907. -property
  908. -protected
  909. "
  910. >
  911. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  912. $maskPattern
  913. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  914. <span class="phpdocumentor-element__modifiers">
  915. </span>
  916. </h4>
  917. <aside class="phpdocumentor-element-found-in">
  918. <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>
  919. :
  920. <span class="phpdocumentor-element-found-in__line">102</span>
  921. </aside>
  922. <p class="phpdocumentor-summary">the mask pattern that was used in the most recent operation, set via:</p>
  923. <code class="phpdocumentor-code phpdocumentor-signature ">
  924. <span class="phpdocumentor-signature__visibility">protected</span>
  925. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  926. <span class="phpdocumentor-signature__name">$maskPattern</span>
  927. = <span class="phpdocumentor-signature__default-value">null</span></code>
  928. <section class="phpdocumentor-description"><ul>
  929. <li>QRMatrix::setFormatInfo()</li>
  930. <li>QRMatrix::mask()</li>
  931. <li>BitMatrix::readFormatInformation()</li>
  932. </ul>
  933. </section>
  934. <section class="phpdocumentor-description"></section>
  935. </article>
  936. <article
  937. class="
  938. phpdocumentor-element
  939. -property
  940. -protected
  941. "
  942. >
  943. <h4 class="phpdocumentor-element__name" id="property_matrix">
  944. $matrix
  945. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  946. <span class="phpdocumentor-element__modifiers">
  947. </span>
  948. </h4>
  949. <aside class="phpdocumentor-element-found-in">
  950. <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>
  951. :
  952. <span class="phpdocumentor-element-found-in__line">114</span>
  953. </aside>
  954. <p class="phpdocumentor-summary">the actual matrix data array</p>
  955. <code class="phpdocumentor-code phpdocumentor-signature ">
  956. <span class="phpdocumentor-signature__visibility">protected</span>
  957. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  958. <span class="phpdocumentor-signature__name">$matrix</span>
  959. </code>
  960. </article>
  961. <article
  962. class="
  963. phpdocumentor-element
  964. -property
  965. -protected
  966. "
  967. >
  968. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  969. $moduleCount
  970. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  971. <span class="phpdocumentor-element__modifiers">
  972. </span>
  973. </h4>
  974. <aside class="phpdocumentor-element-found-in">
  975. <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>
  976. :
  977. <span class="phpdocumentor-element-found-in__line">107</span>
  978. </aside>
  979. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  980. <code class="phpdocumentor-code phpdocumentor-signature ">
  981. <span class="phpdocumentor-signature__visibility">protected</span>
  982. <span class="phpdocumentor-signature__type">int</span>
  983. <span class="phpdocumentor-signature__name">$moduleCount</span>
  984. </code>
  985. <section class="phpdocumentor-description"></section>
  986. </article>
  987. <article
  988. class="
  989. phpdocumentor-element
  990. -property
  991. -protected
  992. "
  993. >
  994. <h4 class="phpdocumentor-element__name" id="property_version">
  995. $version
  996. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  997. <span class="phpdocumentor-element__modifiers">
  998. </span>
  999. </h4>
  1000. <aside class="phpdocumentor-element-found-in">
  1001. <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>
  1002. :
  1003. <span class="phpdocumentor-element-found-in__line">88</span>
  1004. </aside>
  1005. <p class="phpdocumentor-summary">the matrix version - always set in QRMatrix, may be null in BitMatrix</p>
  1006. <code class="phpdocumentor-code phpdocumentor-signature ">
  1007. <span class="phpdocumentor-signature__visibility">protected</span>
  1008. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1009. <span class="phpdocumentor-signature__name">$version</span>
  1010. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1011. <section class="phpdocumentor-description"></section>
  1012. </article>
  1013. </section>
  1014. <section class="phpdocumentor-methods">
  1015. <h3 class="phpdocumentor-elements__header" id="methods">
  1016. Methods
  1017. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1018. </h3>
  1019. <article
  1020. class="phpdocumentor-element
  1021. -method
  1022. -public
  1023. "
  1024. >
  1025. <h4 class="phpdocumentor-element__name" id="method___construct">
  1026. __construct()
  1027. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1028. </h4>
  1029. <aside class="phpdocumentor-element-found-in">
  1030. <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>
  1031. :
  1032. <span class="phpdocumentor-element-found-in__line">119</span>
  1033. </aside>
  1034. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  1035. <code class="phpdocumentor-code phpdocumentor-signature ">
  1036. <span class="phpdocumentor-signature__visibility">public</span>
  1037. <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>&nbsp;</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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1038. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1039. <dl class="phpdocumentor-argument-list">
  1040. <dt class="phpdocumentor-argument-list__entry">
  1041. <span class="phpdocumentor-signature__argument__name">$version</span>
  1042. : <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>
  1043. </dt>
  1044. <dd class="phpdocumentor-argument-list__definition">
  1045. <section class="phpdocumentor-description"></section>
  1046. </dd>
  1047. <dt class="phpdocumentor-argument-list__entry">
  1048. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1049. : <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>
  1050. </dt>
  1051. <dd class="phpdocumentor-argument-list__definition">
  1052. <section class="phpdocumentor-description"></section>
  1053. </dd>
  1054. </dl>
  1055. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1056. <span class="phpdocumentor-signature__response_type">mixed</span>
  1057. &mdash;
  1058. </article>
  1059. <article
  1060. class="phpdocumentor-element
  1061. -method
  1062. -public
  1063. "
  1064. >
  1065. <h4 class="phpdocumentor-element__name" id="method_check">
  1066. check()
  1067. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  1068. </h4>
  1069. <aside class="phpdocumentor-element-found-in">
  1070. <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>
  1071. :
  1072. <span class="phpdocumentor-element-found-in__line">330</span>
  1073. </aside>
  1074. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is true (dark) or false (light)</p>
  1075. <code class="phpdocumentor-code phpdocumentor-signature ">
  1076. <span class="phpdocumentor-signature__visibility">public</span>
  1077. <span class="phpdocumentor-signature__name">check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1078. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1079. <dl class="phpdocumentor-argument-list">
  1080. <dt class="phpdocumentor-argument-list__entry">
  1081. <span class="phpdocumentor-signature__argument__name">$x</span>
  1082. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1083. </dt>
  1084. <dd class="phpdocumentor-argument-list__definition">
  1085. <section class="phpdocumentor-description"></section>
  1086. </dd>
  1087. <dt class="phpdocumentor-argument-list__entry">
  1088. <span class="phpdocumentor-signature__argument__name">$y</span>
  1089. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1090. </dt>
  1091. <dd class="phpdocumentor-argument-list__definition">
  1092. <section class="phpdocumentor-description"></section>
  1093. </dd>
  1094. </dl>
  1095. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1096. <span class="phpdocumentor-signature__response_type">bool</span>
  1097. &mdash;
  1098. </article>
  1099. <article
  1100. class="phpdocumentor-element
  1101. -method
  1102. -public
  1103. "
  1104. >
  1105. <h4 class="phpdocumentor-element__name" id="method_checkNeighbours">
  1106. checkNeighbours()
  1107. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1108. </h4>
  1109. <aside class="phpdocumentor-element-found-in">
  1110. <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>
  1111. :
  1112. <span class="phpdocumentor-element-found-in__line">344</span>
  1113. </aside>
  1114. <p class="phpdocumentor-summary">Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</p>
  1115. <code class="phpdocumentor-code phpdocumentor-signature ">
  1116. <span class="phpdocumentor-signature__visibility">public</span>
  1117. <span class="phpdocumentor-signature__name">checkNeighbours</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</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">int</span></code>
  1118. <section class="phpdocumentor-description"><p>The 8 flags of the bitmask represent the status of each of the neighbouring fields,
  1119. starting with the lowest bit for top left, going clockwise:</p>
  1120. <p>1 2 3
  1121. 8 # 4
  1122. 7 6 5</p>
  1123. </section>
  1124. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1125. <dl class="phpdocumentor-argument-list">
  1126. <dt class="phpdocumentor-argument-list__entry">
  1127. <span class="phpdocumentor-signature__argument__name">$x</span>
  1128. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1129. </dt>
  1130. <dd class="phpdocumentor-argument-list__definition">
  1131. <section class="phpdocumentor-description"></section>
  1132. </dd>
  1133. <dt class="phpdocumentor-argument-list__entry">
  1134. <span class="phpdocumentor-signature__argument__name">$y</span>
  1135. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1136. </dt>
  1137. <dd class="phpdocumentor-argument-list__definition">
  1138. <section class="phpdocumentor-description"></section>
  1139. </dd>
  1140. <dt class="phpdocumentor-argument-list__entry">
  1141. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1142. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1143. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1144. <dd class="phpdocumentor-argument-list__definition">
  1145. <section class="phpdocumentor-description"></section>
  1146. </dd>
  1147. </dl>
  1148. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1149. <span class="phpdocumentor-signature__response_type">int</span>
  1150. &mdash;
  1151. </article>
  1152. <article
  1153. class="phpdocumentor-element
  1154. -method
  1155. -public
  1156. "
  1157. >
  1158. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1159. checkType()
  1160. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1161. </h4>
  1162. <aside class="phpdocumentor-element-found-in">
  1163. <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>
  1164. :
  1165. <span class="phpdocumentor-element-found-in__line">302</span>
  1166. </aside>
  1167. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is of the given $M_TYPE</p>
  1168. <code class="phpdocumentor-code phpdocumentor-signature ">
  1169. <span class="phpdocumentor-signature__visibility">public</span>
  1170. <span class="phpdocumentor-signature__name">checkType</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1171. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1172. </section>
  1173. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1174. <dl class="phpdocumentor-argument-list">
  1175. <dt class="phpdocumentor-argument-list__entry">
  1176. <span class="phpdocumentor-signature__argument__name">$x</span>
  1177. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1178. </dt>
  1179. <dd class="phpdocumentor-argument-list__definition">
  1180. <section class="phpdocumentor-description"></section>
  1181. </dd>
  1182. <dt class="phpdocumentor-argument-list__entry">
  1183. <span class="phpdocumentor-signature__argument__name">$y</span>
  1184. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1185. </dt>
  1186. <dd class="phpdocumentor-argument-list__definition">
  1187. <section class="phpdocumentor-description"></section>
  1188. </dd>
  1189. <dt class="phpdocumentor-argument-list__entry">
  1190. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1191. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1192. </dt>
  1193. <dd class="phpdocumentor-argument-list__definition">
  1194. <section class="phpdocumentor-description"></section>
  1195. </dd>
  1196. </dl>
  1197. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1198. <span class="phpdocumentor-signature__response_type">bool</span>
  1199. &mdash;
  1200. </article>
  1201. <article
  1202. class="phpdocumentor-element
  1203. -method
  1204. -public
  1205. "
  1206. >
  1207. <h4 class="phpdocumentor-element__name" id="method_checkTypeIn">
  1208. checkTypeIn()
  1209. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" class="headerlink"><i class="fas fa-link"></i></a>
  1210. </h4>
  1211. <aside class="phpdocumentor-element-found-in">
  1212. <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>
  1213. :
  1214. <span class="phpdocumentor-element-found-in__line">316</span>
  1215. </aside>
  1216. <p class="phpdocumentor-summary">checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  1217. returns true if a match is found, otherwise false.</p>
  1218. <code class="phpdocumentor-code phpdocumentor-signature ">
  1219. <span class="phpdocumentor-signature__visibility">public</span>
  1220. <span class="phpdocumentor-signature__name">checkTypeIn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</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&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPES</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1221. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1222. <dl class="phpdocumentor-argument-list">
  1223. <dt class="phpdocumentor-argument-list__entry">
  1224. <span class="phpdocumentor-signature__argument__name">$x</span>
  1225. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1226. </dt>
  1227. <dd class="phpdocumentor-argument-list__definition">
  1228. <section class="phpdocumentor-description"></section>
  1229. </dd>
  1230. <dt class="phpdocumentor-argument-list__entry">
  1231. <span class="phpdocumentor-signature__argument__name">$y</span>
  1232. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1233. </dt>
  1234. <dd class="phpdocumentor-argument-list__definition">
  1235. <section class="phpdocumentor-description"></section>
  1236. </dd>
  1237. <dt class="phpdocumentor-argument-list__entry">
  1238. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1239. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1240. </dt>
  1241. <dd class="phpdocumentor-argument-list__definition">
  1242. <section class="phpdocumentor-description"></section>
  1243. </dd>
  1244. </dl>
  1245. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1246. <span class="phpdocumentor-signature__response_type">bool</span>
  1247. &mdash;
  1248. </article>
  1249. <article
  1250. class="phpdocumentor-element
  1251. -method
  1252. -public
  1253. -deprecated "
  1254. >
  1255. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  1256. eccLevel()
  1257. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1258. </h4>
  1259. <aside class="phpdocumentor-element-found-in">
  1260. <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>
  1261. :
  1262. <span class="phpdocumentor-element-found-in__line">206</span>
  1263. </aside>
  1264. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1265. <span class="phpdocumentor-signature__visibility">public</span>
  1266. <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>|null</span></code>
  1267. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1268. Tags
  1269. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1270. </h5>
  1271. <dl class="phpdocumentor-tag-list">
  1272. <dt class="phpdocumentor-tag-list__entry">
  1273. <span class="phpdocumentor-tag__name">deprecated</span>
  1274. </dt>
  1275. <dd class="phpdocumentor-tag-list__definition">
  1276. <span class="phpdocumentor-tag-link">5.0.0</span>
  1277. <section class="phpdocumentor-description"><p>use QRMatrix::getEccLevel() instead</p>
  1278. </section>
  1279. </dd>
  1280. <dt class="phpdocumentor-tag-list__entry">
  1281. <span class="phpdocumentor-tag__name">see</span>
  1282. </dt>
  1283. <dd class="phpdocumentor-tag-list__definition">
  1284. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getEccLevel()">QRMatrix::getEccLevel()</abbr></a></span>
  1285. </dd>
  1286. <dt class="phpdocumentor-tag-list__entry">
  1287. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1288. </dt>
  1289. <dd class="phpdocumentor-tag-list__definition">
  1290. </dd>
  1291. </dl>
  1292. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1293. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1294. &mdash;
  1295. </article>
  1296. <article
  1297. class="phpdocumentor-element
  1298. -method
  1299. -public
  1300. "
  1301. >
  1302. <h4 class="phpdocumentor-element__name" id="method_flip">
  1303. flip()
  1304. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  1305. </h4>
  1306. <aside class="phpdocumentor-element-found-in">
  1307. <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>
  1308. :
  1309. <span class="phpdocumentor-element-found-in__line">288</span>
  1310. </aside>
  1311. <p class="phpdocumentor-summary">Flips the value of the module at ($x, $y)</p>
  1312. <code class="phpdocumentor-code phpdocumentor-signature ">
  1313. <span class="phpdocumentor-signature__visibility">public</span>
  1314. <span class="phpdocumentor-signature__name">flip</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1315. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1316. <dl class="phpdocumentor-argument-list">
  1317. <dt class="phpdocumentor-argument-list__entry">
  1318. <span class="phpdocumentor-signature__argument__name">$x</span>
  1319. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1320. </dt>
  1321. <dd class="phpdocumentor-argument-list__definition">
  1322. <section class="phpdocumentor-description"></section>
  1323. </dd>
  1324. <dt class="phpdocumentor-argument-list__entry">
  1325. <span class="phpdocumentor-signature__argument__name">$y</span>
  1326. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1327. </dt>
  1328. <dd class="phpdocumentor-argument-list__definition">
  1329. <section class="phpdocumentor-description"></section>
  1330. </dd>
  1331. </dl>
  1332. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1333. <span class="phpdocumentor-signature__response_type">self</span>
  1334. &mdash;
  1335. </article>
  1336. <article
  1337. class="phpdocumentor-element
  1338. -method
  1339. -public
  1340. "
  1341. >
  1342. <h4 class="phpdocumentor-element__name" id="method_get">
  1343. get()
  1344. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1345. </h4>
  1346. <aside class="phpdocumentor-element-found-in">
  1347. <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>
  1348. :
  1349. <span class="phpdocumentor-element-found-in__line">247</span>
  1350. </aside>
  1351. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</p>
  1352. <code class="phpdocumentor-code phpdocumentor-signature ">
  1353. <span class="phpdocumentor-signature__visibility">public</span>
  1354. <span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1355. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1356. <dl class="phpdocumentor-argument-list">
  1357. <dt class="phpdocumentor-argument-list__entry">
  1358. <span class="phpdocumentor-signature__argument__name">$x</span>
  1359. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1360. </dt>
  1361. <dd class="phpdocumentor-argument-list__definition">
  1362. <section class="phpdocumentor-description"></section>
  1363. </dd>
  1364. <dt class="phpdocumentor-argument-list__entry">
  1365. <span class="phpdocumentor-signature__argument__name">$y</span>
  1366. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1367. </dt>
  1368. <dd class="phpdocumentor-argument-list__definition">
  1369. <section class="phpdocumentor-description"></section>
  1370. </dd>
  1371. </dl>
  1372. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1373. <span class="phpdocumentor-signature__response_type">int</span>
  1374. &mdash;
  1375. </article>
  1376. <article
  1377. class="phpdocumentor-element
  1378. -method
  1379. -public
  1380. "
  1381. >
  1382. <h4 class="phpdocumentor-element__name" id="method_getEccLevel">
  1383. getEccLevel()
  1384. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1385. </h4>
  1386. <aside class="phpdocumentor-element-found-in">
  1387. <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>
  1388. :
  1389. <span class="phpdocumentor-element-found-in__line">197</span>
  1390. </aside>
  1391. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1392. <code class="phpdocumentor-code phpdocumentor-signature ">
  1393. <span class="phpdocumentor-signature__visibility">public</span>
  1394. <span class="phpdocumentor-signature__name">getEccLevel</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>|null</span></code>
  1395. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1396. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1397. &mdash;
  1398. </article>
  1399. <article
  1400. class="phpdocumentor-element
  1401. -method
  1402. -public
  1403. "
  1404. >
  1405. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  1406. getMaskPattern()
  1407. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1408. </h4>
  1409. <aside class="phpdocumentor-element-found-in">
  1410. <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>
  1411. :
  1412. <span class="phpdocumentor-element-found-in__line">213</span>
  1413. </aside>
  1414. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1415. <code class="phpdocumentor-code phpdocumentor-signature ">
  1416. <span class="phpdocumentor-signature__visibility">public</span>
  1417. <span class="phpdocumentor-signature__name">getMaskPattern</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>
  1418. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1419. <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>
  1420. &mdash;
  1421. </article>
  1422. <article
  1423. class="phpdocumentor-element
  1424. -method
  1425. -public
  1426. "
  1427. >
  1428. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1429. getMatrix()
  1430. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1431. </h4>
  1432. <aside class="phpdocumentor-element-found-in">
  1433. <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>
  1434. :
  1435. <span class="phpdocumentor-element-found-in__line">153</span>
  1436. </aside>
  1437. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1438. <code class="phpdocumentor-code phpdocumentor-signature ">
  1439. <span class="phpdocumentor-signature__visibility">public</span>
  1440. <span class="phpdocumentor-signature__name">getMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$boolean</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">array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span></code>
  1441. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1442. <dl class="phpdocumentor-argument-list">
  1443. <dt class="phpdocumentor-argument-list__entry">
  1444. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1445. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1446. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1447. <dd class="phpdocumentor-argument-list__definition">
  1448. <section class="phpdocumentor-description"></section>
  1449. </dd>
  1450. </dl>
  1451. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1452. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
  1453. &mdash;
  1454. </article>
  1455. <article
  1456. class="phpdocumentor-element
  1457. -method
  1458. -public
  1459. "
  1460. >
  1461. <h4 class="phpdocumentor-element__name" id="method_getSize">
  1462. getSize()
  1463. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize" class="headerlink"><i class="fas fa-link"></i></a>
  1464. </h4>
  1465. <aside class="phpdocumentor-element-found-in">
  1466. <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>
  1467. :
  1468. <span class="phpdocumentor-element-found-in__line">231</span>
  1469. </aside>
  1470. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1471. <code class="phpdocumentor-code phpdocumentor-signature ">
  1472. <span class="phpdocumentor-signature__visibility">public</span>
  1473. <span class="phpdocumentor-signature__name">getSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1474. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1475. </section>
  1476. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1477. <span class="phpdocumentor-signature__response_type">int</span>
  1478. &mdash;
  1479. </article>
  1480. <article
  1481. class="phpdocumentor-element
  1482. -method
  1483. -public
  1484. "
  1485. >
  1486. <h4 class="phpdocumentor-element__name" id="method_getVersion">
  1487. getVersion()
  1488. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
  1489. </h4>
  1490. <aside class="phpdocumentor-element-found-in">
  1491. <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>
  1492. :
  1493. <span class="phpdocumentor-element-found-in__line">181</span>
  1494. </aside>
  1495. <p class="phpdocumentor-summary">Returns the current version number</p>
  1496. <code class="phpdocumentor-code phpdocumentor-signature ">
  1497. <span class="phpdocumentor-signature__visibility">public</span>
  1498. <span class="phpdocumentor-signature__name">getVersion</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>|null</span></code>
  1499. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1500. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1501. &mdash;
  1502. </article>
  1503. <article
  1504. class="phpdocumentor-element
  1505. -method
  1506. -public
  1507. "
  1508. >
  1509. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1510. initFunctionalPatterns()
  1511. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1512. </h4>
  1513. <aside class="phpdocumentor-element-found-in">
  1514. <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>
  1515. :
  1516. <span class="phpdocumentor-element-found-in__line">136</span>
  1517. </aside>
  1518. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1519. <code class="phpdocumentor-code phpdocumentor-signature ">
  1520. <span class="phpdocumentor-signature__visibility">public</span>
  1521. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1522. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1523. <span class="phpdocumentor-signature__response_type">self</span>
  1524. &mdash;
  1525. </article>
  1526. <article
  1527. class="phpdocumentor-element
  1528. -method
  1529. -public
  1530. "
  1531. >
  1532. <h4 class="phpdocumentor-element__name" id="method_mask">
  1533. mask()
  1534. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1535. </h4>
  1536. <aside class="phpdocumentor-element-found-in">
  1537. <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>
  1538. :
  1539. <span class="phpdocumentor-element-found-in__line">715</span>
  1540. </aside>
  1541. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1542. <code class="phpdocumentor-code phpdocumentor-signature ">
  1543. <span class="phpdocumentor-signature__visibility">public</span>
  1544. <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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1545. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1546. </section>
  1547. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1548. <dl class="phpdocumentor-argument-list">
  1549. <dt class="phpdocumentor-argument-list__entry">
  1550. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1551. : <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>
  1552. </dt>
  1553. <dd class="phpdocumentor-argument-list__definition">
  1554. <section class="phpdocumentor-description"></section>
  1555. </dd>
  1556. </dl>
  1557. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1558. <span class="phpdocumentor-signature__response_type">self</span>
  1559. &mdash;
  1560. </article>
  1561. <article
  1562. class="phpdocumentor-element
  1563. -method
  1564. -public
  1565. -deprecated "
  1566. >
  1567. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1568. maskPattern()
  1569. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1570. </h4>
  1571. <aside class="phpdocumentor-element-found-in">
  1572. <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>
  1573. :
  1574. <span class="phpdocumentor-element-found-in__line">222</span>
  1575. </aside>
  1576. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1577. <span class="phpdocumentor-signature__visibility">public</span>
  1578. <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>
  1579. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1580. Tags
  1581. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1582. </h5>
  1583. <dl class="phpdocumentor-tag-list">
  1584. <dt class="phpdocumentor-tag-list__entry">
  1585. <span class="phpdocumentor-tag__name">deprecated</span>
  1586. </dt>
  1587. <dd class="phpdocumentor-tag-list__definition">
  1588. <span class="phpdocumentor-tag-link">5.0.0</span>
  1589. <section class="phpdocumentor-description"><p>use QRMatrix::getMaskPattern() instead</p>
  1590. </section>
  1591. </dd>
  1592. <dt class="phpdocumentor-tag-list__entry">
  1593. <span class="phpdocumentor-tag__name">see</span>
  1594. </dt>
  1595. <dd class="phpdocumentor-tag-list__definition">
  1596. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMaskPattern()">QRMatrix::getMaskPattern()</abbr></a></span>
  1597. </dd>
  1598. <dt class="phpdocumentor-tag-list__entry">
  1599. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1600. </dt>
  1601. <dd class="phpdocumentor-tag-list__definition">
  1602. </dd>
  1603. </dl>
  1604. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1605. <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>
  1606. &mdash;
  1607. </article>
  1608. <article
  1609. class="phpdocumentor-element
  1610. -method
  1611. -public
  1612. -deprecated "
  1613. >
  1614. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1615. matrix()
  1616. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1617. </h4>
  1618. <aside class="phpdocumentor-element-found-in">
  1619. <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>
  1620. :
  1621. <span class="phpdocumentor-element-found-in__line">174</span>
  1622. </aside>
  1623. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1624. <span class="phpdocumentor-signature__visibility">public</span>
  1625. <span class="phpdocumentor-signature__name">matrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$boolean</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">array&lt;string|int, mixed&gt;</span></code>
  1626. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1627. <dl class="phpdocumentor-argument-list">
  1628. <dt class="phpdocumentor-argument-list__entry">
  1629. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1630. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1631. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1632. <dd class="phpdocumentor-argument-list__definition">
  1633. <section class="phpdocumentor-description"></section>
  1634. </dd>
  1635. </dl>
  1636. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1637. Tags
  1638. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1639. </h5>
  1640. <dl class="phpdocumentor-tag-list">
  1641. <dt class="phpdocumentor-tag-list__entry">
  1642. <span class="phpdocumentor-tag__name">deprecated</span>
  1643. </dt>
  1644. <dd class="phpdocumentor-tag-list__definition">
  1645. <span class="phpdocumentor-tag-link">5.0.0</span>
  1646. <section class="phpdocumentor-description"><p>use QRMatrix::getMatrix() instead</p>
  1647. </section>
  1648. </dd>
  1649. <dt class="phpdocumentor-tag-list__entry">
  1650. <span class="phpdocumentor-tag__name">see</span>
  1651. </dt>
  1652. <dd class="phpdocumentor-tag-list__definition">
  1653. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMatrix()">QRMatrix::getMatrix()</abbr></a></span>
  1654. </dd>
  1655. <dt class="phpdocumentor-tag-list__entry">
  1656. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1657. </dt>
  1658. <dd class="phpdocumentor-tag-list__definition">
  1659. </dd>
  1660. </dl>
  1661. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1662. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1663. &mdash;
  1664. </article>
  1665. <article
  1666. class="phpdocumentor-element
  1667. -method
  1668. -public
  1669. "
  1670. >
  1671. <h4 class="phpdocumentor-element__name" id="method_set">
  1672. set()
  1673. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1674. </h4>
  1675. <aside class="phpdocumentor-element-found-in">
  1676. <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>
  1677. :
  1678. <span class="phpdocumentor-element-found-in__line">262</span>
  1679. </aside>
  1680. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1681. <code class="phpdocumentor-code phpdocumentor-signature ">
  1682. <span class="phpdocumentor-signature__visibility">public</span>
  1683. <span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</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&nbsp;</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&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1684. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1685. false =&gt; $M_TYPE</p>
  1686. </section>
  1687. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1688. <dl class="phpdocumentor-argument-list">
  1689. <dt class="phpdocumentor-argument-list__entry">
  1690. <span class="phpdocumentor-signature__argument__name">$x</span>
  1691. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1692. </dt>
  1693. <dd class="phpdocumentor-argument-list__definition">
  1694. <section class="phpdocumentor-description"></section>
  1695. </dd>
  1696. <dt class="phpdocumentor-argument-list__entry">
  1697. <span class="phpdocumentor-signature__argument__name">$y</span>
  1698. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1699. </dt>
  1700. <dd class="phpdocumentor-argument-list__definition">
  1701. <section class="phpdocumentor-description"></section>
  1702. </dd>
  1703. <dt class="phpdocumentor-argument-list__entry">
  1704. <span class="phpdocumentor-signature__argument__name">$value</span>
  1705. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1706. </dt>
  1707. <dd class="phpdocumentor-argument-list__definition">
  1708. <section class="phpdocumentor-description"></section>
  1709. </dd>
  1710. <dt class="phpdocumentor-argument-list__entry">
  1711. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1712. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1713. </dt>
  1714. <dd class="phpdocumentor-argument-list__definition">
  1715. <section class="phpdocumentor-description"></section>
  1716. </dd>
  1717. </dl>
  1718. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1719. <span class="phpdocumentor-signature__response_type">self</span>
  1720. &mdash;
  1721. </article>
  1722. <article
  1723. class="phpdocumentor-element
  1724. -method
  1725. -public
  1726. "
  1727. >
  1728. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1729. setAlignmentPattern()
  1730. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1731. </h4>
  1732. <aside class="phpdocumentor-element-found-in">
  1733. <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>
  1734. :
  1735. <span class="phpdocumentor-element-found-in__line">436</span>
  1736. </aside>
  1737. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1738. <code class="phpdocumentor-code phpdocumentor-signature ">
  1739. <span class="phpdocumentor-signature__visibility">public</span>
  1740. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1741. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1742. </section>
  1743. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1744. <span class="phpdocumentor-signature__response_type">self</span>
  1745. &mdash;
  1746. </article>
  1747. <article
  1748. class="phpdocumentor-element
  1749. -method
  1750. -public
  1751. "
  1752. >
  1753. <h4 class="phpdocumentor-element__name" id="method_setArea">
  1754. setArea()
  1755. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea" class="headerlink"><i class="fas fa-link"></i></a>
  1756. </h4>
  1757. <aside class="phpdocumentor-element-found-in">
  1758. <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>
  1759. :
  1760. <span class="phpdocumentor-element-found-in__line">274</span>
  1761. </aside>
  1762. <p class="phpdocumentor-summary">Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</p>
  1763. <code class="phpdocumentor-code phpdocumentor-signature ">
  1764. <span class="phpdocumentor-signature__visibility">public</span>
  1765. <span class="phpdocumentor-signature__name">setArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startY</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1766. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1767. <dl class="phpdocumentor-argument-list">
  1768. <dt class="phpdocumentor-argument-list__entry">
  1769. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1770. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1771. </dt>
  1772. <dd class="phpdocumentor-argument-list__definition">
  1773. <section class="phpdocumentor-description"></section>
  1774. </dd>
  1775. <dt class="phpdocumentor-argument-list__entry">
  1776. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1777. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1778. </dt>
  1779. <dd class="phpdocumentor-argument-list__definition">
  1780. <section class="phpdocumentor-description"></section>
  1781. </dd>
  1782. <dt class="phpdocumentor-argument-list__entry">
  1783. <span class="phpdocumentor-signature__argument__name">$width</span>
  1784. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1785. </dt>
  1786. <dd class="phpdocumentor-argument-list__definition">
  1787. <section class="phpdocumentor-description"></section>
  1788. </dd>
  1789. <dt class="phpdocumentor-argument-list__entry">
  1790. <span class="phpdocumentor-signature__argument__name">$height</span>
  1791. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1792. </dt>
  1793. <dd class="phpdocumentor-argument-list__definition">
  1794. <section class="phpdocumentor-description"></section>
  1795. </dd>
  1796. <dt class="phpdocumentor-argument-list__entry">
  1797. <span class="phpdocumentor-signature__argument__name">$value</span>
  1798. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1799. </dt>
  1800. <dd class="phpdocumentor-argument-list__definition">
  1801. <section class="phpdocumentor-description"></section>
  1802. </dd>
  1803. <dt class="phpdocumentor-argument-list__entry">
  1804. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1805. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1806. </dt>
  1807. <dd class="phpdocumentor-argument-list__definition">
  1808. <section class="phpdocumentor-description"></section>
  1809. </dd>
  1810. </dl>
  1811. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1812. <span class="phpdocumentor-signature__response_type">self</span>
  1813. &mdash;
  1814. </article>
  1815. <article
  1816. class="phpdocumentor-element
  1817. -method
  1818. -public
  1819. "
  1820. >
  1821. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  1822. setDarkModule()
  1823. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  1824. </h4>
  1825. <aside class="phpdocumentor-element-found-in">
  1826. <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>
  1827. :
  1828. <span class="phpdocumentor-element-found-in__line">371</span>
  1829. </aside>
  1830. <p class="phpdocumentor-summary">Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</p>
  1831. <code class="phpdocumentor-code phpdocumentor-signature ">
  1832. <span class="phpdocumentor-signature__visibility">public</span>
  1833. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1834. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  1835. </section>
  1836. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1837. <span class="phpdocumentor-signature__response_type">self</span>
  1838. &mdash;
  1839. </article>
  1840. <article
  1841. class="phpdocumentor-element
  1842. -method
  1843. -public
  1844. "
  1845. >
  1846. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  1847. setFinderPattern()
  1848. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1849. </h4>
  1850. <aside class="phpdocumentor-element-found-in">
  1851. <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>
  1852. :
  1853. <span class="phpdocumentor-element-found-in__line">382</span>
  1854. </aside>
  1855. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  1856. <code class="phpdocumentor-code phpdocumentor-signature ">
  1857. <span class="phpdocumentor-signature__visibility">public</span>
  1858. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1859. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  1860. </section>
  1861. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1862. <span class="phpdocumentor-signature__response_type">self</span>
  1863. &mdash;
  1864. </article>
  1865. <article
  1866. class="phpdocumentor-element
  1867. -method
  1868. -public
  1869. "
  1870. >
  1871. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  1872. setFormatInfo()
  1873. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  1874. </h4>
  1875. <aside class="phpdocumentor-element-found-in">
  1876. <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>
  1877. :
  1878. <span class="phpdocumentor-element-found-in__line">511</span>
  1879. </aside>
  1880. <p class="phpdocumentor-summary">Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</p>
  1881. <code class="phpdocumentor-code phpdocumentor-signature ">
  1882. <span class="phpdocumentor-signature__visibility">public</span>
  1883. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</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>
  1884. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  1885. </section>
  1886. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1887. <dl class="phpdocumentor-argument-list">
  1888. <dt class="phpdocumentor-argument-list__entry">
  1889. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1890. : <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>
  1891. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1892. <dd class="phpdocumentor-argument-list__definition">
  1893. <section class="phpdocumentor-description"></section>
  1894. </dd>
  1895. </dl>
  1896. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1897. <span class="phpdocumentor-signature__response_type">self</span>
  1898. &mdash;
  1899. </article>
  1900. <article
  1901. class="phpdocumentor-element
  1902. -method
  1903. -public
  1904. "
  1905. >
  1906. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  1907. setLogoSpace()
  1908. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  1909. </h4>
  1910. <aside class="phpdocumentor-element-found-in">
  1911. <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>
  1912. :
  1913. <span class="phpdocumentor-element-found-in__line">599</span>
  1914. </aside>
  1915. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  1916. <code class="phpdocumentor-code phpdocumentor-signature ">
  1917. <span class="phpdocumentor-signature__visibility">public</span>
  1918. <span class="phpdocumentor-signature__name">setLogoSpace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</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&nbsp;</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&nbsp;</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>
  1919. <section class="phpdocumentor-description"><p>If no $height is given, the space will be assumed a square of $width.</p>
  1920. <p>Additionally, the logo space can be positioned within the QR Code - respecting the main functional patterns -
  1921. using $startX and $startY. If either of these are null, the logo space will be centered in that direction.
  1922. ECC level &quot;H&quot; (30%) is required.</p>
  1923. <p>The coordinates of $startX and $startY do not include the quiet zone:
  1924. [0, 0] is always the top left module of the top left finder pattern, negative values go into the quiet zone top and left.</p>
  1925. <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
  1926. created images may become unreadable, especially when printed with a chance to receive damage.
  1927. Please test thoroughly before using this feature in production.</p>
  1928. <p>This method should be called from within an output module (after the matrix has been filled with data).
  1929. Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
  1930. </section>
  1931. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1932. <dl class="phpdocumentor-argument-list">
  1933. <dt class="phpdocumentor-argument-list__entry">
  1934. <span class="phpdocumentor-signature__argument__name">$width</span>
  1935. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1936. </dt>
  1937. <dd class="phpdocumentor-argument-list__definition">
  1938. <section class="phpdocumentor-description"></section>
  1939. </dd>
  1940. <dt class="phpdocumentor-argument-list__entry">
  1941. <span class="phpdocumentor-signature__argument__name">$height</span>
  1942. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1943. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1944. <dd class="phpdocumentor-argument-list__definition">
  1945. <section class="phpdocumentor-description"></section>
  1946. </dd>
  1947. <dt class="phpdocumentor-argument-list__entry">
  1948. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1949. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1950. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1951. <dd class="phpdocumentor-argument-list__definition">
  1952. <section class="phpdocumentor-description"></section>
  1953. </dd>
  1954. <dt class="phpdocumentor-argument-list__entry">
  1955. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1956. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1957. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1958. <dd class="phpdocumentor-argument-list__definition">
  1959. <section class="phpdocumentor-description"></section>
  1960. </dd>
  1961. </dl>
  1962. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1963. Tags
  1964. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1965. </h5>
  1966. <dl class="phpdocumentor-tag-list">
  1967. <dt class="phpdocumentor-tag-list__entry">
  1968. <span class="phpdocumentor-tag__name">link</span>
  1969. </dt>
  1970. <dd class="phpdocumentor-tag-list__definition">
  1971. <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
  1972. </dd>
  1973. <dt class="phpdocumentor-tag-list__entry">
  1974. <span class="phpdocumentor-tag__name">throws</span>
  1975. </dt>
  1976. <dd class="phpdocumentor-tag-list__definition">
  1977. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1978. </dd>
  1979. </dl>
  1980. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1981. <span class="phpdocumentor-signature__response_type">self</span>
  1982. &mdash;
  1983. </article>
  1984. <article
  1985. class="phpdocumentor-element
  1986. -method
  1987. -public
  1988. "
  1989. >
  1990. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  1991. setQuietZone()
  1992. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  1993. </h4>
  1994. <aside class="phpdocumentor-element-found-in">
  1995. <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>
  1996. :
  1997. <span class="phpdocumentor-element-found-in__line">553</span>
  1998. </aside>
  1999. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  2000. <code class="phpdocumentor-code phpdocumentor-signature ">
  2001. <span class="phpdocumentor-signature__visibility">public</span>
  2002. <span class="phpdocumentor-signature__name">setQuietZone</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$quietZoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2003. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</p>
  2004. </section>
  2005. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2006. <dl class="phpdocumentor-argument-list">
  2007. <dt class="phpdocumentor-argument-list__entry">
  2008. <span class="phpdocumentor-signature__argument__name">$quietZoneSize</span>
  2009. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2010. </dt>
  2011. <dd class="phpdocumentor-argument-list__definition">
  2012. <section class="phpdocumentor-description"></section>
  2013. </dd>
  2014. </dl>
  2015. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2016. Tags
  2017. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2018. </h5>
  2019. <dl class="phpdocumentor-tag-list">
  2020. <dt class="phpdocumentor-tag-list__entry">
  2021. <span class="phpdocumentor-tag__name">throws</span>
  2022. </dt>
  2023. <dd class="phpdocumentor-tag-list__definition">
  2024. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  2025. </dd>
  2026. </dl>
  2027. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2028. <span class="phpdocumentor-signature__response_type">self</span>
  2029. &mdash;
  2030. </article>
  2031. <article
  2032. class="phpdocumentor-element
  2033. -method
  2034. -public
  2035. "
  2036. >
  2037. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  2038. setSeparators()
  2039. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  2040. </h4>
  2041. <aside class="phpdocumentor-element-found-in">
  2042. <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>
  2043. :
  2044. <span class="phpdocumentor-element-found-in__line">406</span>
  2045. </aside>
  2046. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  2047. <code class="phpdocumentor-code phpdocumentor-signature ">
  2048. <span class="phpdocumentor-signature__visibility">public</span>
  2049. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2050. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  2051. </section>
  2052. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2053. <span class="phpdocumentor-signature__response_type">self</span>
  2054. &mdash;
  2055. </article>
  2056. <article
  2057. class="phpdocumentor-element
  2058. -method
  2059. -public
  2060. "
  2061. >
  2062. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  2063. setTimingPattern()
  2064. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2065. </h4>
  2066. <aside class="phpdocumentor-element-found-in">
  2067. <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>
  2068. :
  2069. <span class="phpdocumentor-element-found-in__line">465</span>
  2070. </aside>
  2071. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  2072. <code class="phpdocumentor-code phpdocumentor-signature ">
  2073. <span class="phpdocumentor-signature__visibility">public</span>
  2074. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2075. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  2076. </section>
  2077. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2078. <span class="phpdocumentor-signature__response_type">self</span>
  2079. &mdash;
  2080. </article>
  2081. <article
  2082. class="phpdocumentor-element
  2083. -method
  2084. -public
  2085. "
  2086. >
  2087. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  2088. setVersionNumber()
  2089. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  2090. </h4>
  2091. <aside class="phpdocumentor-element-found-in">
  2092. <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>
  2093. :
  2094. <span class="phpdocumentor-element-found-in__line">487</span>
  2095. </aside>
  2096. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  2097. <code class="phpdocumentor-code phpdocumentor-signature ">
  2098. <span class="phpdocumentor-signature__visibility">public</span>
  2099. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2100. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  2101. </section>
  2102. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2103. <span class="phpdocumentor-signature__response_type">self</span>
  2104. &mdash;
  2105. </article>
  2106. <article
  2107. class="phpdocumentor-element
  2108. -method
  2109. -public
  2110. -deprecated "
  2111. >
  2112. <h4 class="phpdocumentor-element__name" id="method_size">
  2113. size()
  2114. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  2115. </h4>
  2116. <aside class="phpdocumentor-element-found-in">
  2117. <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>
  2118. :
  2119. <span class="phpdocumentor-element-found-in__line">240</span>
  2120. </aside>
  2121. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2122. <span class="phpdocumentor-signature__visibility">public</span>
  2123. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2124. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2125. Tags
  2126. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2127. </h5>
  2128. <dl class="phpdocumentor-tag-list">
  2129. <dt class="phpdocumentor-tag-list__entry">
  2130. <span class="phpdocumentor-tag__name">deprecated</span>
  2131. </dt>
  2132. <dd class="phpdocumentor-tag-list__definition">
  2133. <span class="phpdocumentor-tag-link">5.0.0</span>
  2134. <section class="phpdocumentor-description"><p>use QRMatrix::getSize() instead</p>
  2135. </section>
  2136. </dd>
  2137. <dt class="phpdocumentor-tag-list__entry">
  2138. <span class="phpdocumentor-tag__name">see</span>
  2139. </dt>
  2140. <dd class="phpdocumentor-tag-list__definition">
  2141. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  2142. </dd>
  2143. <dt class="phpdocumentor-tag-list__entry">
  2144. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2145. </dt>
  2146. <dd class="phpdocumentor-tag-list__definition">
  2147. </dd>
  2148. </dl>
  2149. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2150. <span class="phpdocumentor-signature__response_type">int</span>
  2151. &mdash;
  2152. </article>
  2153. <article
  2154. class="phpdocumentor-element
  2155. -method
  2156. -public
  2157. -deprecated "
  2158. >
  2159. <h4 class="phpdocumentor-element__name" id="method_version">
  2160. version()
  2161. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  2162. </h4>
  2163. <aside class="phpdocumentor-element-found-in">
  2164. <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>
  2165. :
  2166. <span class="phpdocumentor-element-found-in__line">190</span>
  2167. </aside>
  2168. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2169. <span class="phpdocumentor-signature__visibility">public</span>
  2170. <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>|null</span></code>
  2171. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2172. Tags
  2173. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2174. </h5>
  2175. <dl class="phpdocumentor-tag-list">
  2176. <dt class="phpdocumentor-tag-list__entry">
  2177. <span class="phpdocumentor-tag__name">deprecated</span>
  2178. </dt>
  2179. <dd class="phpdocumentor-tag-list__definition">
  2180. <span class="phpdocumentor-tag-link">5.0.0</span>
  2181. <section class="phpdocumentor-description"><p>use QRMatrix::getVersion() instead</p>
  2182. </section>
  2183. </dd>
  2184. <dt class="phpdocumentor-tag-list__entry">
  2185. <span class="phpdocumentor-tag__name">see</span>
  2186. </dt>
  2187. <dd class="phpdocumentor-tag-list__definition">
  2188. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getVersion()">QRMatrix::getVersion()</abbr></a></span>
  2189. </dd>
  2190. <dt class="phpdocumentor-tag-list__entry">
  2191. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2192. </dt>
  2193. <dd class="phpdocumentor-tag-list__definition">
  2194. </dd>
  2195. </dl>
  2196. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2197. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  2198. &mdash;
  2199. </article>
  2200. <article
  2201. class="phpdocumentor-element
  2202. -method
  2203. -public
  2204. "
  2205. >
  2206. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  2207. writeCodewords()
  2208. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  2209. </h4>
  2210. <aside class="phpdocumentor-element-found-in">
  2211. <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>
  2212. :
  2213. <span class="phpdocumentor-element-found-in__line">668</span>
  2214. </aside>
  2215. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  2216. <code class="phpdocumentor-code phpdocumentor-signature ">
  2217. <span class="phpdocumentor-signature__visibility">public</span>
  2218. <span class="phpdocumentor-signature__name">writeCodewords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2219. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2220. <dl class="phpdocumentor-argument-list">
  2221. <dt class="phpdocumentor-argument-list__entry">
  2222. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  2223. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  2224. </dt>
  2225. <dd class="phpdocumentor-argument-list__definition">
  2226. <section class="phpdocumentor-description"></section>
  2227. </dd>
  2228. </dl>
  2229. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2230. <span class="phpdocumentor-signature__response_type">self</span>
  2231. &mdash;
  2232. </article>
  2233. <article
  2234. class="phpdocumentor-element
  2235. -method
  2236. -protected
  2237. "
  2238. >
  2239. <h4 class="phpdocumentor-element__name" id="method_createMatrix">
  2240. createMatrix()
  2241. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  2242. </h4>
  2243. <aside class="phpdocumentor-element-found-in">
  2244. <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>
  2245. :
  2246. <span class="phpdocumentor-element-found-in__line">129</span>
  2247. </aside>
  2248. <p class="phpdocumentor-summary">Creates a 2-dimensional array (square) of the given $size</p>
  2249. <code class="phpdocumentor-code phpdocumentor-signature ">
  2250. <span class="phpdocumentor-signature__visibility">protected</span>
  2251. <span class="phpdocumentor-signature__name">createMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  2252. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2253. <dl class="phpdocumentor-argument-list">
  2254. <dt class="phpdocumentor-argument-list__entry">
  2255. <span class="phpdocumentor-signature__argument__name">$size</span>
  2256. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2257. </dt>
  2258. <dd class="phpdocumentor-argument-list__definition">
  2259. <section class="phpdocumentor-description"></section>
  2260. </dd>
  2261. <dt class="phpdocumentor-argument-list__entry">
  2262. <span class="phpdocumentor-signature__argument__name">$value</span>
  2263. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2264. </dt>
  2265. <dd class="phpdocumentor-argument-list__definition">
  2266. <section class="phpdocumentor-description"></section>
  2267. </dd>
  2268. </dl>
  2269. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2270. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  2271. &mdash;
  2272. </article>
  2273. </section>
  2274. <script type="text/javascript">
  2275. function loadExternalCodeSnippets(line) {
  2276. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2277. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  2278. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  2279. var language = 'php';
  2280. var code = document.createElement('code');
  2281. code.className = 'language-' + language;
  2282. pre.textContent = '';
  2283. pre.setAttribute('data-line', line)
  2284. code.textContent = 'Loading…';
  2285. pre.appendChild(code);
  2286. var xhr = new XMLHttpRequest();
  2287. xhr.open('GET', src, true);
  2288. xhr.onreadystatechange = function () {
  2289. if (xhr.readyState == 4) {
  2290. if (xhr.status < 400 && xhr.responseText) {
  2291. code.textContent = xhr.responseText;
  2292. Prism.highlightElement(code);
  2293. }
  2294. else if (xhr.status >= 400) {
  2295. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2296. }
  2297. else {
  2298. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  2299. }
  2300. }
  2301. };
  2302. xhr.send(null);
  2303. });
  2304. }
  2305. var modals = document.querySelectorAll("[data-modal]");
  2306. modals.forEach(function (trigger) {
  2307. trigger.addEventListener("click", function (event) {
  2308. //event.preventDefault();
  2309. const modal = document.getElementById(trigger.dataset.modal);
  2310. modal.classList.add("phpdocumentor-modal__open");
  2311. loadExternalCodeSnippets(trigger.dataset.line)
  2312. const exits = modal.querySelectorAll("[data-exit-button]");
  2313. exits.forEach(function (exit) {
  2314. exit.addEventListener("click", function (event) {
  2315. event.preventDefault();
  2316. modal.classList.remove("phpdocumentor-modal__open");
  2317. });
  2318. });
  2319. });
  2320. });
  2321. </script>
  2322. </article>
  2323. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2324. <section class="phpdocumentor-search-results__dialog">
  2325. <header class="phpdocumentor-search-results__header">
  2326. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2327. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2328. </header>
  2329. <section class="phpdocumentor-search-results__body">
  2330. <ul class="phpdocumentor-search-results__entries"></ul>
  2331. </section>
  2332. </section>
  2333. </section>
  2334. </div>
  2335. </div>
  2336. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2337. </main>
  2338. <script>
  2339. cssVars({});
  2340. </script>
  2341. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2342. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2343. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2344. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2345. </body>
  2346. </html>