chillerlan-QRCode-Data-QRMatrix.html 122 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641
  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;= self::M_ALIGNMENT | self::IS_DARK </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;= 0b1 | self::IS_DARK </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;= self::M_DATA | self::IS_DARK </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;= self::M_FINDER | self::IS_DARK </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;= 0b10000000000 | self::IS_DARK </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;= self::M_FORMAT | self::IS_DARK </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;= self::M_TEST | self::IS_DARK </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;= self::M_TIMING | self::IS_DARK </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;= self::M_VERSION | self::IS_DARK </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</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 used mask pattern, set via QRMatrix::mask()</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>a Version instance</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>Returns the current ECC level</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_initFunctionalPatterns">initFunctionalPatterns()</a>
  337. <span>
  338. &nbsp;: self </span>
  339. </dt>
  340. <dd>shortcut to initialize the functional patterns</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  342. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  343. <span>
  344. &nbsp;: self </span>
  345. </dt>
  346. <dd>Applies/reverses the mask pattern</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  348. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  349. <span>
  350. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  351. </dt>
  352. <dd>Returns the current mask pattern</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  354. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  355. <span>
  356. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  357. </dt>
  358. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  360. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  361. <span>
  362. &nbsp;: self </span>
  363. </dt>
  364. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  366. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  367. <span>
  368. &nbsp;: self </span>
  369. </dt>
  370. <dd>Draws the 5x5 alignment patterns</dd>
  371. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  372. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  373. <span>
  374. &nbsp;: self </span>
  375. </dt>
  376. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  377. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  378. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  379. <span>
  380. &nbsp;: self </span>
  381. </dt>
  382. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  383. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  384. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  385. <span>
  386. &nbsp;: self </span>
  387. </dt>
  388. <dd>Draws the format info along the finder patterns</dd>
  389. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  390. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  391. <span>
  392. &nbsp;: self </span>
  393. </dt>
  394. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  395. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  396. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
  397. <span>
  398. &nbsp;: self </span>
  399. </dt>
  400. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  401. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  402. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  403. <span>
  404. &nbsp;: self </span>
  405. </dt>
  406. <dd>Draws the separator lines around the finder patterns</dd>
  407. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  408. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  409. <span>
  410. &nbsp;: self </span>
  411. </dt>
  412. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  413. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  414. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  415. <span>
  416. &nbsp;: self </span>
  417. </dt>
  418. <dd>Draws the version information, 2x 3x6 pixel</dd>
  419. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  420. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  421. <span>
  422. &nbsp;: int </span>
  423. </dt>
  424. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  425. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  426. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  427. <span>
  428. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  429. </dt>
  430. <dd>Returns the current version number</dd>
  431. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  432. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  433. <span>
  434. &nbsp;: self </span>
  435. </dt>
  436. <dd>Maps the interleaved binary $data on the matrix</dd>
  437. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  438. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a>
  439. <span>
  440. &nbsp;: array&lt;string|int, mixed&gt; </span>
  441. </dt>
  442. <dd>Creates a 2-dimensional array (square) of the given $size</dd>
  443. </dl>
  444. <section class="phpdocumentor-constants">
  445. <h3 class="phpdocumentor-elements__header" id="constants">
  446. Constants
  447. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  448. </h3>
  449. <article class="phpdocumentor-element -constant -public ">
  450. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  451. IS_DARK
  452. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  453. </h4>
  454. <aside class="phpdocumentor-element-found-in">
  455. <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>
  456. :
  457. <span class="phpdocumentor-element-found-in__line">25</span>
  458. </aside>
  459. <code class="phpdocumentor-signature phpdocumentor-code ">
  460. <span class="phpdocumentor-signature__visibility">public</span>
  461. <span class="phpdocumentor-signature__type">int</span>
  462. <span class="phpdocumentor-signature__name">IS_DARK</span>
  463. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  464. </code>
  465. </article>
  466. <article class="phpdocumentor-element -constant -public ">
  467. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  468. M_ALIGNMENT
  469. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  470. </h4>
  471. <aside class="phpdocumentor-element-found-in">
  472. <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>
  473. :
  474. <span class="phpdocumentor-element-found-in__line">41</span>
  475. </aside>
  476. <code class="phpdocumentor-signature phpdocumentor-code ">
  477. <span class="phpdocumentor-signature__visibility">public</span>
  478. <span class="phpdocumentor-signature__type">int</span>
  479. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  480. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  481. </code>
  482. </article>
  483. <article class="phpdocumentor-element -constant -public ">
  484. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT_DARK">
  485. M_ALIGNMENT_DARK
  486. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  487. </h4>
  488. <aside class="phpdocumentor-element-found-in">
  489. <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>
  490. :
  491. <span class="phpdocumentor-element-found-in__line">43</span>
  492. </aside>
  493. <code class="phpdocumentor-signature phpdocumentor-code ">
  494. <span class="phpdocumentor-signature__visibility">public</span>
  495. <span class="phpdocumentor-signature__type">int</span>
  496. <span class="phpdocumentor-signature__name">M_ALIGNMENT_DARK</span>
  497. = <span class="phpdocumentor-signature__default-value">self::M_ALIGNMENT | self::IS_DARK</span>
  498. </code>
  499. </article>
  500. <article class="phpdocumentor-element -constant -public ">
  501. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  502. M_DARKMODULE
  503. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  504. </h4>
  505. <aside class="phpdocumentor-element-found-in">
  506. <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>
  507. :
  508. <span class="phpdocumentor-element-found-in__line">29</span>
  509. </aside>
  510. <code class="phpdocumentor-signature phpdocumentor-code ">
  511. <span class="phpdocumentor-signature__visibility">public</span>
  512. <span class="phpdocumentor-signature__type">int</span>
  513. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  514. = <span class="phpdocumentor-signature__default-value">0b1 | self::IS_DARK</span>
  515. </code>
  516. </article>
  517. <article class="phpdocumentor-element -constant -public ">
  518. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  519. M_DATA
  520. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  521. </h4>
  522. <aside class="phpdocumentor-element-found-in">
  523. <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>
  524. :
  525. <span class="phpdocumentor-element-found-in__line">31</span>
  526. </aside>
  527. <code class="phpdocumentor-signature phpdocumentor-code ">
  528. <span class="phpdocumentor-signature__visibility">public</span>
  529. <span class="phpdocumentor-signature__type">int</span>
  530. <span class="phpdocumentor-signature__name">M_DATA</span>
  531. = <span class="phpdocumentor-signature__default-value">0b10</span>
  532. </code>
  533. </article>
  534. <article class="phpdocumentor-element -constant -public ">
  535. <h4 class="phpdocumentor-element__name" id="constant_M_DATA_DARK">
  536. M_DATA_DARK
  537. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  538. </h4>
  539. <aside class="phpdocumentor-element-found-in">
  540. <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>
  541. :
  542. <span class="phpdocumentor-element-found-in__line">33</span>
  543. </aside>
  544. <code class="phpdocumentor-signature phpdocumentor-code ">
  545. <span class="phpdocumentor-signature__visibility">public</span>
  546. <span class="phpdocumentor-signature__type">int</span>
  547. <span class="phpdocumentor-signature__name">M_DATA_DARK</span>
  548. = <span class="phpdocumentor-signature__default-value">self::M_DATA | self::IS_DARK</span>
  549. </code>
  550. </article>
  551. <article class="phpdocumentor-element -constant -public ">
  552. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  553. M_FINDER
  554. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  555. </h4>
  556. <aside class="phpdocumentor-element-found-in">
  557. <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>
  558. :
  559. <span class="phpdocumentor-element-found-in__line">35</span>
  560. </aside>
  561. <code class="phpdocumentor-signature phpdocumentor-code ">
  562. <span class="phpdocumentor-signature__visibility">public</span>
  563. <span class="phpdocumentor-signature__type">int</span>
  564. <span class="phpdocumentor-signature__name">M_FINDER</span>
  565. = <span class="phpdocumentor-signature__default-value">0b100</span>
  566. </code>
  567. </article>
  568. <article class="phpdocumentor-element -constant -public ">
  569. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DARK">
  570. M_FINDER_DARK
  571. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  572. </h4>
  573. <aside class="phpdocumentor-element-found-in">
  574. <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>
  575. :
  576. <span class="phpdocumentor-element-found-in__line">37</span>
  577. </aside>
  578. <code class="phpdocumentor-signature phpdocumentor-code ">
  579. <span class="phpdocumentor-signature__visibility">public</span>
  580. <span class="phpdocumentor-signature__type">int</span>
  581. <span class="phpdocumentor-signature__name">M_FINDER_DARK</span>
  582. = <span class="phpdocumentor-signature__default-value">self::M_FINDER | self::IS_DARK</span>
  583. </code>
  584. </article>
  585. <article class="phpdocumentor-element -constant -public ">
  586. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  587. M_FINDER_DOT
  588. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  589. </h4>
  590. <aside class="phpdocumentor-element-found-in">
  591. <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>
  592. :
  593. <span class="phpdocumentor-element-found-in__line">61</span>
  594. </aside>
  595. <code class="phpdocumentor-signature phpdocumentor-code ">
  596. <span class="phpdocumentor-signature__visibility">public</span>
  597. <span class="phpdocumentor-signature__type">int</span>
  598. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  599. = <span class="phpdocumentor-signature__default-value">0b10000000000 | self::IS_DARK</span>
  600. </code>
  601. </article>
  602. <article class="phpdocumentor-element -constant -public ">
  603. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  604. M_FORMAT
  605. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  606. </h4>
  607. <aside class="phpdocumentor-element-found-in">
  608. <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>
  609. :
  610. <span class="phpdocumentor-element-found-in__line">49</span>
  611. </aside>
  612. <code class="phpdocumentor-signature phpdocumentor-code ">
  613. <span class="phpdocumentor-signature__visibility">public</span>
  614. <span class="phpdocumentor-signature__type">int</span>
  615. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  616. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  617. </code>
  618. </article>
  619. <article class="phpdocumentor-element -constant -public ">
  620. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT_DARK">
  621. M_FORMAT_DARK
  622. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  623. </h4>
  624. <aside class="phpdocumentor-element-found-in">
  625. <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>
  626. :
  627. <span class="phpdocumentor-element-found-in__line">51</span>
  628. </aside>
  629. <code class="phpdocumentor-signature phpdocumentor-code ">
  630. <span class="phpdocumentor-signature__visibility">public</span>
  631. <span class="phpdocumentor-signature__type">int</span>
  632. <span class="phpdocumentor-signature__name">M_FORMAT_DARK</span>
  633. = <span class="phpdocumentor-signature__default-value">self::M_FORMAT | self::IS_DARK</span>
  634. </code>
  635. </article>
  636. <article class="phpdocumentor-element -constant -public ">
  637. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  638. M_LOGO
  639. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  640. </h4>
  641. <aside class="phpdocumentor-element-found-in">
  642. <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>
  643. :
  644. <span class="phpdocumentor-element-found-in__line">59</span>
  645. </aside>
  646. <code class="phpdocumentor-signature phpdocumentor-code ">
  647. <span class="phpdocumentor-signature__visibility">public</span>
  648. <span class="phpdocumentor-signature__type">int</span>
  649. <span class="phpdocumentor-signature__name">M_LOGO</span>
  650. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  651. </code>
  652. </article>
  653. <article class="phpdocumentor-element -constant -public ">
  654. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  655. M_NULL
  656. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  657. </h4>
  658. <aside class="phpdocumentor-element-found-in">
  659. <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>
  660. :
  661. <span class="phpdocumentor-element-found-in__line">27</span>
  662. </aside>
  663. <code class="phpdocumentor-signature phpdocumentor-code ">
  664. <span class="phpdocumentor-signature__visibility">public</span>
  665. <span class="phpdocumentor-signature__type">int</span>
  666. <span class="phpdocumentor-signature__name">M_NULL</span>
  667. = <span class="phpdocumentor-signature__default-value">0b0</span>
  668. </code>
  669. </article>
  670. <article class="phpdocumentor-element -constant -public ">
  671. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  672. M_QUIETZONE
  673. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  674. </h4>
  675. <aside class="phpdocumentor-element-found-in">
  676. <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>
  677. :
  678. <span class="phpdocumentor-element-found-in__line">57</span>
  679. </aside>
  680. <code class="phpdocumentor-signature phpdocumentor-code ">
  681. <span class="phpdocumentor-signature__visibility">public</span>
  682. <span class="phpdocumentor-signature__type">int</span>
  683. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  684. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  685. </code>
  686. </article>
  687. <article class="phpdocumentor-element -constant -public ">
  688. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  689. M_SEPARATOR
  690. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  691. </h4>
  692. <aside class="phpdocumentor-element-found-in">
  693. <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>
  694. :
  695. <span class="phpdocumentor-element-found-in__line">39</span>
  696. </aside>
  697. <code class="phpdocumentor-signature phpdocumentor-code ">
  698. <span class="phpdocumentor-signature__visibility">public</span>
  699. <span class="phpdocumentor-signature__type">int</span>
  700. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  701. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  702. </code>
  703. </article>
  704. <article class="phpdocumentor-element -constant -public ">
  705. <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
  706. M_TEST
  707. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" class="headerlink"><i class="fas fa-link"></i></a>
  708. </h4>
  709. <aside class="phpdocumentor-element-found-in">
  710. <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>
  711. :
  712. <span class="phpdocumentor-element-found-in__line">63</span>
  713. </aside>
  714. <code class="phpdocumentor-signature phpdocumentor-code ">
  715. <span class="phpdocumentor-signature__visibility">public</span>
  716. <span class="phpdocumentor-signature__type">int</span>
  717. <span class="phpdocumentor-signature__name">M_TEST</span>
  718. = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
  719. </code>
  720. </article>
  721. <article class="phpdocumentor-element -constant -public ">
  722. <h4 class="phpdocumentor-element__name" id="constant_M_TEST_DARK">
  723. M_TEST_DARK
  724. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  725. </h4>
  726. <aside class="phpdocumentor-element-found-in">
  727. <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>
  728. :
  729. <span class="phpdocumentor-element-found-in__line">65</span>
  730. </aside>
  731. <code class="phpdocumentor-signature phpdocumentor-code ">
  732. <span class="phpdocumentor-signature__visibility">public</span>
  733. <span class="phpdocumentor-signature__type">int</span>
  734. <span class="phpdocumentor-signature__name">M_TEST_DARK</span>
  735. = <span class="phpdocumentor-signature__default-value">self::M_TEST | self::IS_DARK</span>
  736. </code>
  737. </article>
  738. <article class="phpdocumentor-element -constant -public ">
  739. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  740. M_TIMING
  741. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  742. </h4>
  743. <aside class="phpdocumentor-element-found-in">
  744. <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>
  745. :
  746. <span class="phpdocumentor-element-found-in__line">45</span>
  747. </aside>
  748. <code class="phpdocumentor-signature phpdocumentor-code ">
  749. <span class="phpdocumentor-signature__visibility">public</span>
  750. <span class="phpdocumentor-signature__type">int</span>
  751. <span class="phpdocumentor-signature__name">M_TIMING</span>
  752. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  753. </code>
  754. </article>
  755. <article class="phpdocumentor-element -constant -public ">
  756. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING_DARK">
  757. M_TIMING_DARK
  758. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  759. </h4>
  760. <aside class="phpdocumentor-element-found-in">
  761. <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>
  762. :
  763. <span class="phpdocumentor-element-found-in__line">47</span>
  764. </aside>
  765. <code class="phpdocumentor-signature phpdocumentor-code ">
  766. <span class="phpdocumentor-signature__visibility">public</span>
  767. <span class="phpdocumentor-signature__type">int</span>
  768. <span class="phpdocumentor-signature__name">M_TIMING_DARK</span>
  769. = <span class="phpdocumentor-signature__default-value">self::M_TIMING | self::IS_DARK</span>
  770. </code>
  771. </article>
  772. <article class="phpdocumentor-element -constant -public ">
  773. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  774. M_VERSION
  775. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  776. </h4>
  777. <aside class="phpdocumentor-element-found-in">
  778. <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>
  779. :
  780. <span class="phpdocumentor-element-found-in__line">53</span>
  781. </aside>
  782. <code class="phpdocumentor-signature phpdocumentor-code ">
  783. <span class="phpdocumentor-signature__visibility">public</span>
  784. <span class="phpdocumentor-signature__type">int</span>
  785. <span class="phpdocumentor-signature__name">M_VERSION</span>
  786. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  787. </code>
  788. </article>
  789. <article class="phpdocumentor-element -constant -public ">
  790. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION_DARK">
  791. M_VERSION_DARK
  792. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  793. </h4>
  794. <aside class="phpdocumentor-element-found-in">
  795. <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>
  796. :
  797. <span class="phpdocumentor-element-found-in__line">55</span>
  798. </aside>
  799. <code class="phpdocumentor-signature phpdocumentor-code ">
  800. <span class="phpdocumentor-signature__visibility">public</span>
  801. <span class="phpdocumentor-signature__type">int</span>
  802. <span class="phpdocumentor-signature__name">M_VERSION_DARK</span>
  803. = <span class="phpdocumentor-signature__default-value">self::M_VERSION | self::IS_DARK</span>
  804. </code>
  805. </article>
  806. <article class="phpdocumentor-element -constant -protected ">
  807. <h4 class="phpdocumentor-element__name" id="constant_neighbours">
  808. neighbours
  809. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours" class="headerlink"><i class="fas fa-link"></i></a>
  810. </h4>
  811. <aside class="phpdocumentor-element-found-in">
  812. <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>
  813. :
  814. <span class="phpdocumentor-element-found-in__line">74</span>
  815. </aside>
  816. <p class="phpdocumentor-summary">Map of flag =&gt; coord</p>
  817. <code class="phpdocumentor-signature phpdocumentor-code ">
  818. <span class="phpdocumentor-signature__visibility">protected</span>
  819. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  820. <span class="phpdocumentor-signature__name">neighbours</span>
  821. = <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>
  822. </code>
  823. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  824. Tags
  825. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  826. </h5>
  827. <dl class="phpdocumentor-tag-list">
  828. <dt class="phpdocumentor-tag-list__entry">
  829. <span class="phpdocumentor-tag__name">see</span>
  830. </dt>
  831. <dd class="phpdocumentor-tag-list__definition">
  832. <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>
  833. </dd>
  834. </dl>
  835. </article>
  836. </section>
  837. <section class="phpdocumentor-properties">
  838. <h3 class="phpdocumentor-elements__header" id="properties">
  839. Properties
  840. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  841. </h3>
  842. <article
  843. class="
  844. phpdocumentor-element
  845. -property
  846. -protected
  847. "
  848. >
  849. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  850. $eccLevel
  851. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  852. <span class="phpdocumentor-element__modifiers">
  853. </span>
  854. </h4>
  855. <aside class="phpdocumentor-element-found-in">
  856. <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>
  857. :
  858. <span class="phpdocumentor-element-found-in__line">93</span>
  859. </aside>
  860. <p class="phpdocumentor-summary">the current ECC level</p>
  861. <code class="phpdocumentor-code phpdocumentor-signature ">
  862. <span class="phpdocumentor-signature__visibility">protected</span>
  863. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  864. <span class="phpdocumentor-signature__name">$eccLevel</span>
  865. = <span class="phpdocumentor-signature__default-value">null</span></code>
  866. <section class="phpdocumentor-description"></section>
  867. </article>
  868. <article
  869. class="
  870. phpdocumentor-element
  871. -property
  872. -protected
  873. "
  874. >
  875. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  876. $maskPattern
  877. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  878. <span class="phpdocumentor-element__modifiers">
  879. </span>
  880. </h4>
  881. <aside class="phpdocumentor-element-found-in">
  882. <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>
  883. :
  884. <span class="phpdocumentor-element-found-in__line">88</span>
  885. </aside>
  886. <p class="phpdocumentor-summary">the used mask pattern, set via QRMatrix::mask()</p>
  887. <code class="phpdocumentor-code phpdocumentor-signature ">
  888. <span class="phpdocumentor-signature__visibility">protected</span>
  889. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  890. <span class="phpdocumentor-signature__name">$maskPattern</span>
  891. = <span class="phpdocumentor-signature__default-value">null</span></code>
  892. <section class="phpdocumentor-description"></section>
  893. </article>
  894. <article
  895. class="
  896. phpdocumentor-element
  897. -property
  898. -protected
  899. "
  900. >
  901. <h4 class="phpdocumentor-element__name" id="property_matrix">
  902. $matrix
  903. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  904. <span class="phpdocumentor-element__modifiers">
  905. </span>
  906. </h4>
  907. <aside class="phpdocumentor-element-found-in">
  908. <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>
  909. :
  910. <span class="phpdocumentor-element-found-in__line">110</span>
  911. </aside>
  912. <p class="phpdocumentor-summary">the actual matrix data array</p>
  913. <code class="phpdocumentor-code phpdocumentor-signature ">
  914. <span class="phpdocumentor-signature__visibility">protected</span>
  915. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  916. <span class="phpdocumentor-signature__name">$matrix</span>
  917. </code>
  918. </article>
  919. <article
  920. class="
  921. phpdocumentor-element
  922. -property
  923. -protected
  924. "
  925. >
  926. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  927. $moduleCount
  928. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  929. <span class="phpdocumentor-element__modifiers">
  930. </span>
  931. </h4>
  932. <aside class="phpdocumentor-element-found-in">
  933. <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>
  934. :
  935. <span class="phpdocumentor-element-found-in__line">103</span>
  936. </aside>
  937. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  938. <code class="phpdocumentor-code phpdocumentor-signature ">
  939. <span class="phpdocumentor-signature__visibility">protected</span>
  940. <span class="phpdocumentor-signature__type">int</span>
  941. <span class="phpdocumentor-signature__name">$moduleCount</span>
  942. </code>
  943. <section class="phpdocumentor-description"></section>
  944. </article>
  945. <article
  946. class="
  947. phpdocumentor-element
  948. -property
  949. -protected
  950. "
  951. >
  952. <h4 class="phpdocumentor-element__name" id="property_version">
  953. $version
  954. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  955. <span class="phpdocumentor-element__modifiers">
  956. </span>
  957. </h4>
  958. <aside class="phpdocumentor-element-found-in">
  959. <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>
  960. :
  961. <span class="phpdocumentor-element-found-in__line">98</span>
  962. </aside>
  963. <p class="phpdocumentor-summary">a Version instance</p>
  964. <code class="phpdocumentor-code phpdocumentor-signature ">
  965. <span class="phpdocumentor-signature__visibility">protected</span>
  966. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  967. <span class="phpdocumentor-signature__name">$version</span>
  968. = <span class="phpdocumentor-signature__default-value">null</span></code>
  969. <section class="phpdocumentor-description"></section>
  970. </article>
  971. </section>
  972. <section class="phpdocumentor-methods">
  973. <h3 class="phpdocumentor-elements__header" id="methods">
  974. Methods
  975. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  976. </h3>
  977. <article
  978. class="phpdocumentor-element
  979. -method
  980. -public
  981. "
  982. >
  983. <h4 class="phpdocumentor-element__name" id="method___construct">
  984. __construct()
  985. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  986. </h4>
  987. <aside class="phpdocumentor-element-found-in">
  988. <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>
  989. :
  990. <span class="phpdocumentor-element-found-in__line">115</span>
  991. </aside>
  992. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  993. <code class="phpdocumentor-code phpdocumentor-signature ">
  994. <span class="phpdocumentor-signature__visibility">public</span>
  995. <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 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><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  996. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  997. <dl class="phpdocumentor-argument-list">
  998. <dt class="phpdocumentor-argument-list__entry">
  999. <span class="phpdocumentor-signature__argument__name">$version</span>
  1000. : <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>
  1001. </dt>
  1002. <dd class="phpdocumentor-argument-list__definition">
  1003. <section class="phpdocumentor-description"></section>
  1004. </dd>
  1005. <dt class="phpdocumentor-argument-list__entry">
  1006. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1007. : <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>
  1008. </dt>
  1009. <dd class="phpdocumentor-argument-list__definition">
  1010. <section class="phpdocumentor-description"></section>
  1011. </dd>
  1012. <dt class="phpdocumentor-argument-list__entry">
  1013. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1014. : <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>
  1015. </dt>
  1016. <dd class="phpdocumentor-argument-list__definition">
  1017. <section class="phpdocumentor-description"></section>
  1018. </dd>
  1019. </dl>
  1020. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1021. <span class="phpdocumentor-signature__response_type">mixed</span>
  1022. &mdash;
  1023. </article>
  1024. <article
  1025. class="phpdocumentor-element
  1026. -method
  1027. -public
  1028. "
  1029. >
  1030. <h4 class="phpdocumentor-element__name" id="method_check">
  1031. check()
  1032. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  1033. </h4>
  1034. <aside class="phpdocumentor-element-found-in">
  1035. <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>
  1036. :
  1037. <span class="phpdocumentor-element-found-in__line">270</span>
  1038. </aside>
  1039. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is true (dark) or false (light)</p>
  1040. <code class="phpdocumentor-code phpdocumentor-signature ">
  1041. <span class="phpdocumentor-signature__visibility">public</span>
  1042. <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>
  1043. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1044. <dl class="phpdocumentor-argument-list">
  1045. <dt class="phpdocumentor-argument-list__entry">
  1046. <span class="phpdocumentor-signature__argument__name">$x</span>
  1047. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1048. </dt>
  1049. <dd class="phpdocumentor-argument-list__definition">
  1050. <section class="phpdocumentor-description"></section>
  1051. </dd>
  1052. <dt class="phpdocumentor-argument-list__entry">
  1053. <span class="phpdocumentor-signature__argument__name">$y</span>
  1054. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1055. </dt>
  1056. <dd class="phpdocumentor-argument-list__definition">
  1057. <section class="phpdocumentor-description"></section>
  1058. </dd>
  1059. </dl>
  1060. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1061. <span class="phpdocumentor-signature__response_type">bool</span>
  1062. &mdash;
  1063. </article>
  1064. <article
  1065. class="phpdocumentor-element
  1066. -method
  1067. -public
  1068. "
  1069. >
  1070. <h4 class="phpdocumentor-element__name" id="method_checkNeighbours">
  1071. checkNeighbours()
  1072. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1073. </h4>
  1074. <aside class="phpdocumentor-element-found-in">
  1075. <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>
  1076. :
  1077. <span class="phpdocumentor-element-found-in__line">284</span>
  1078. </aside>
  1079. <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>
  1080. <code class="phpdocumentor-code phpdocumentor-signature ">
  1081. <span class="phpdocumentor-signature__visibility">public</span>
  1082. <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_VALUE</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>
  1083. <section class="phpdocumentor-description"><p>The 8 flags of the bitmask represent the status of each of the neighbouring fields,
  1084. starting with the lowest bit for top left, going clockwise:</p>
  1085. <p>1 2 3
  1086. 8 # 4
  1087. 7 6 5</p>
  1088. </section>
  1089. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1090. <dl class="phpdocumentor-argument-list">
  1091. <dt class="phpdocumentor-argument-list__entry">
  1092. <span class="phpdocumentor-signature__argument__name">$x</span>
  1093. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1094. </dt>
  1095. <dd class="phpdocumentor-argument-list__definition">
  1096. <section class="phpdocumentor-description"></section>
  1097. </dd>
  1098. <dt class="phpdocumentor-argument-list__entry">
  1099. <span class="phpdocumentor-signature__argument__name">$y</span>
  1100. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1101. </dt>
  1102. <dd class="phpdocumentor-argument-list__definition">
  1103. <section class="phpdocumentor-description"></section>
  1104. </dd>
  1105. <dt class="phpdocumentor-argument-list__entry">
  1106. <span class="phpdocumentor-signature__argument__name">$M_TYPE_VALUE</span>
  1107. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1108. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1109. <dd class="phpdocumentor-argument-list__definition">
  1110. <section class="phpdocumentor-description"></section>
  1111. </dd>
  1112. </dl>
  1113. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1114. <span class="phpdocumentor-signature__response_type">int</span>
  1115. &mdash;
  1116. </article>
  1117. <article
  1118. class="phpdocumentor-element
  1119. -method
  1120. -public
  1121. "
  1122. >
  1123. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1124. checkType()
  1125. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1126. </h4>
  1127. <aside class="phpdocumentor-element-found-in">
  1128. <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>
  1129. :
  1130. <span class="phpdocumentor-element-found-in__line">243</span>
  1131. </aside>
  1132. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is of the given $M_TYPE</p>
  1133. <code class="phpdocumentor-code phpdocumentor-signature ">
  1134. <span class="phpdocumentor-signature__visibility">public</span>
  1135. <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>
  1136. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1137. </section>
  1138. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1139. <dl class="phpdocumentor-argument-list">
  1140. <dt class="phpdocumentor-argument-list__entry">
  1141. <span class="phpdocumentor-signature__argument__name">$x</span>
  1142. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1143. </dt>
  1144. <dd class="phpdocumentor-argument-list__definition">
  1145. <section class="phpdocumentor-description"></section>
  1146. </dd>
  1147. <dt class="phpdocumentor-argument-list__entry">
  1148. <span class="phpdocumentor-signature__argument__name">$y</span>
  1149. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1150. </dt>
  1151. <dd class="phpdocumentor-argument-list__definition">
  1152. <section class="phpdocumentor-description"></section>
  1153. </dd>
  1154. <dt class="phpdocumentor-argument-list__entry">
  1155. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1156. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1157. </dt>
  1158. <dd class="phpdocumentor-argument-list__definition">
  1159. <section class="phpdocumentor-description"></section>
  1160. </dd>
  1161. </dl>
  1162. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1163. <span class="phpdocumentor-signature__response_type">bool</span>
  1164. &mdash;
  1165. </article>
  1166. <article
  1167. class="phpdocumentor-element
  1168. -method
  1169. -public
  1170. "
  1171. >
  1172. <h4 class="phpdocumentor-element__name" id="method_checkTypeIn">
  1173. checkTypeIn()
  1174. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" class="headerlink"><i class="fas fa-link"></i></a>
  1175. </h4>
  1176. <aside class="phpdocumentor-element-found-in">
  1177. <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>
  1178. :
  1179. <span class="phpdocumentor-element-found-in__line">256</span>
  1180. </aside>
  1181. <p class="phpdocumentor-summary">checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  1182. returns true if a match is found, otherwise false.</p>
  1183. <code class="phpdocumentor-code phpdocumentor-signature ">
  1184. <span class="phpdocumentor-signature__visibility">public</span>
  1185. <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>
  1186. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1187. <dl class="phpdocumentor-argument-list">
  1188. <dt class="phpdocumentor-argument-list__entry">
  1189. <span class="phpdocumentor-signature__argument__name">$x</span>
  1190. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1191. </dt>
  1192. <dd class="phpdocumentor-argument-list__definition">
  1193. <section class="phpdocumentor-description"></section>
  1194. </dd>
  1195. <dt class="phpdocumentor-argument-list__entry">
  1196. <span class="phpdocumentor-signature__argument__name">$y</span>
  1197. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1198. </dt>
  1199. <dd class="phpdocumentor-argument-list__definition">
  1200. <section class="phpdocumentor-description"></section>
  1201. </dd>
  1202. <dt class="phpdocumentor-argument-list__entry">
  1203. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1204. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1205. </dt>
  1206. <dd class="phpdocumentor-argument-list__definition">
  1207. <section class="phpdocumentor-description"></section>
  1208. </dd>
  1209. </dl>
  1210. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1211. <span class="phpdocumentor-signature__response_type">bool</span>
  1212. &mdash;
  1213. </article>
  1214. <article
  1215. class="phpdocumentor-element
  1216. -method
  1217. -public
  1218. "
  1219. >
  1220. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  1221. eccLevel()
  1222. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1223. </h4>
  1224. <aside class="phpdocumentor-element-found-in">
  1225. <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>
  1226. :
  1227. <span class="phpdocumentor-element-found-in__line">179</span>
  1228. </aside>
  1229. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1230. <code class="phpdocumentor-code phpdocumentor-signature ">
  1231. <span class="phpdocumentor-signature__visibility">public</span>
  1232. <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>
  1233. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1234. <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>
  1235. &mdash;
  1236. </article>
  1237. <article
  1238. class="phpdocumentor-element
  1239. -method
  1240. -public
  1241. "
  1242. >
  1243. <h4 class="phpdocumentor-element__name" id="method_flip">
  1244. flip()
  1245. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  1246. </h4>
  1247. <aside class="phpdocumentor-element-found-in">
  1248. <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>
  1249. :
  1250. <span class="phpdocumentor-element-found-in__line">229</span>
  1251. </aside>
  1252. <p class="phpdocumentor-summary">Flips the value of the module at ($x, $y)</p>
  1253. <code class="phpdocumentor-code phpdocumentor-signature ">
  1254. <span class="phpdocumentor-signature__visibility">public</span>
  1255. <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>
  1256. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1257. <dl class="phpdocumentor-argument-list">
  1258. <dt class="phpdocumentor-argument-list__entry">
  1259. <span class="phpdocumentor-signature__argument__name">$x</span>
  1260. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1261. </dt>
  1262. <dd class="phpdocumentor-argument-list__definition">
  1263. <section class="phpdocumentor-description"></section>
  1264. </dd>
  1265. <dt class="phpdocumentor-argument-list__entry">
  1266. <span class="phpdocumentor-signature__argument__name">$y</span>
  1267. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1268. </dt>
  1269. <dd class="phpdocumentor-argument-list__definition">
  1270. <section class="phpdocumentor-description"></section>
  1271. </dd>
  1272. </dl>
  1273. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1274. <span class="phpdocumentor-signature__response_type">self</span>
  1275. &mdash;
  1276. </article>
  1277. <article
  1278. class="phpdocumentor-element
  1279. -method
  1280. -public
  1281. "
  1282. >
  1283. <h4 class="phpdocumentor-element__name" id="method_get">
  1284. get()
  1285. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1286. </h4>
  1287. <aside class="phpdocumentor-element-found-in">
  1288. <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>
  1289. :
  1290. <span class="phpdocumentor-element-found-in__line">202</span>
  1291. </aside>
  1292. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</p>
  1293. <code class="phpdocumentor-code phpdocumentor-signature ">
  1294. <span class="phpdocumentor-signature__visibility">public</span>
  1295. <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>
  1296. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1297. <dl class="phpdocumentor-argument-list">
  1298. <dt class="phpdocumentor-argument-list__entry">
  1299. <span class="phpdocumentor-signature__argument__name">$x</span>
  1300. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1301. </dt>
  1302. <dd class="phpdocumentor-argument-list__definition">
  1303. <section class="phpdocumentor-description"></section>
  1304. </dd>
  1305. <dt class="phpdocumentor-argument-list__entry">
  1306. <span class="phpdocumentor-signature__argument__name">$y</span>
  1307. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1308. </dt>
  1309. <dd class="phpdocumentor-argument-list__definition">
  1310. <section class="phpdocumentor-description"></section>
  1311. </dd>
  1312. </dl>
  1313. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1314. <span class="phpdocumentor-signature__response_type">int</span>
  1315. &mdash;
  1316. </article>
  1317. <article
  1318. class="phpdocumentor-element
  1319. -method
  1320. -public
  1321. "
  1322. >
  1323. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1324. initFunctionalPatterns()
  1325. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1326. </h4>
  1327. <aside class="phpdocumentor-element-found-in">
  1328. <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>
  1329. :
  1330. <span class="phpdocumentor-element-found-in__line">133</span>
  1331. </aside>
  1332. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1333. <code class="phpdocumentor-code phpdocumentor-signature ">
  1334. <span class="phpdocumentor-signature__visibility">public</span>
  1335. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1336. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1337. <span class="phpdocumentor-signature__response_type">self</span>
  1338. &mdash;
  1339. </article>
  1340. <article
  1341. class="phpdocumentor-element
  1342. -method
  1343. -public
  1344. "
  1345. >
  1346. <h4 class="phpdocumentor-element__name" id="method_mask">
  1347. mask()
  1348. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1349. </h4>
  1350. <aside class="phpdocumentor-element-found-in">
  1351. <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>
  1352. :
  1353. <span class="phpdocumentor-element-found-in__line">661</span>
  1354. </aside>
  1355. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1356. <code class="phpdocumentor-code phpdocumentor-signature ">
  1357. <span class="phpdocumentor-signature__visibility">public</span>
  1358. <span class="phpdocumentor-signature__name">mask</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1359. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1360. </section>
  1361. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1362. <span class="phpdocumentor-signature__response_type">self</span>
  1363. &mdash;
  1364. </article>
  1365. <article
  1366. class="phpdocumentor-element
  1367. -method
  1368. -public
  1369. "
  1370. >
  1371. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1372. maskPattern()
  1373. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1374. </h4>
  1375. <aside class="phpdocumentor-element-found-in">
  1376. <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>
  1377. :
  1378. <span class="phpdocumentor-element-found-in__line">186</span>
  1379. </aside>
  1380. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1381. <code class="phpdocumentor-code phpdocumentor-signature ">
  1382. <span class="phpdocumentor-signature__visibility">public</span>
  1383. <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>
  1384. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1385. <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>
  1386. &mdash;
  1387. </article>
  1388. <article
  1389. class="phpdocumentor-element
  1390. -method
  1391. -public
  1392. "
  1393. >
  1394. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1395. matrix()
  1396. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1397. </h4>
  1398. <aside class="phpdocumentor-element-found-in">
  1399. <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>
  1400. :
  1401. <span class="phpdocumentor-element-found-in__line">150</span>
  1402. </aside>
  1403. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1404. <code class="phpdocumentor-code phpdocumentor-signature ">
  1405. <span class="phpdocumentor-signature__visibility">public</span>
  1406. <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, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span></code>
  1407. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1408. <dl class="phpdocumentor-argument-list">
  1409. <dt class="phpdocumentor-argument-list__entry">
  1410. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1411. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1412. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1413. <dd class="phpdocumentor-argument-list__definition">
  1414. <section class="phpdocumentor-description"></section>
  1415. </dd>
  1416. </dl>
  1417. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1418. <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>
  1419. &mdash;
  1420. </article>
  1421. <article
  1422. class="phpdocumentor-element
  1423. -method
  1424. -public
  1425. "
  1426. >
  1427. <h4 class="phpdocumentor-element__name" id="method_set">
  1428. set()
  1429. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1430. </h4>
  1431. <aside class="phpdocumentor-element-found-in">
  1432. <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>
  1433. :
  1434. <span class="phpdocumentor-element-found-in__line">217</span>
  1435. </aside>
  1436. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1437. <code class="phpdocumentor-code phpdocumentor-signature ">
  1438. <span class="phpdocumentor-signature__visibility">public</span>
  1439. <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>
  1440. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1441. false =&gt; $M_TYPE</p>
  1442. </section>
  1443. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1444. <dl class="phpdocumentor-argument-list">
  1445. <dt class="phpdocumentor-argument-list__entry">
  1446. <span class="phpdocumentor-signature__argument__name">$x</span>
  1447. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1448. </dt>
  1449. <dd class="phpdocumentor-argument-list__definition">
  1450. <section class="phpdocumentor-description"></section>
  1451. </dd>
  1452. <dt class="phpdocumentor-argument-list__entry">
  1453. <span class="phpdocumentor-signature__argument__name">$y</span>
  1454. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1455. </dt>
  1456. <dd class="phpdocumentor-argument-list__definition">
  1457. <section class="phpdocumentor-description"></section>
  1458. </dd>
  1459. <dt class="phpdocumentor-argument-list__entry">
  1460. <span class="phpdocumentor-signature__argument__name">$value</span>
  1461. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1462. </dt>
  1463. <dd class="phpdocumentor-argument-list__definition">
  1464. <section class="phpdocumentor-description"></section>
  1465. </dd>
  1466. <dt class="phpdocumentor-argument-list__entry">
  1467. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1468. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1469. </dt>
  1470. <dd class="phpdocumentor-argument-list__definition">
  1471. <section class="phpdocumentor-description"></section>
  1472. </dd>
  1473. </dl>
  1474. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1475. <span class="phpdocumentor-signature__response_type">self</span>
  1476. &mdash;
  1477. </article>
  1478. <article
  1479. class="phpdocumentor-element
  1480. -method
  1481. -public
  1482. "
  1483. >
  1484. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1485. setAlignmentPattern()
  1486. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1487. </h4>
  1488. <aside class="phpdocumentor-element-found-in">
  1489. <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>
  1490. :
  1491. <span class="phpdocumentor-element-found-in__line">387</span>
  1492. </aside>
  1493. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1494. <code class="phpdocumentor-code phpdocumentor-signature ">
  1495. <span class="phpdocumentor-signature__visibility">public</span>
  1496. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1497. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1498. </section>
  1499. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1500. <span class="phpdocumentor-signature__response_type">self</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_setDarkModule">
  1510. setDarkModule()
  1511. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" 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">311</span>
  1517. </aside>
  1518. <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>
  1519. <code class="phpdocumentor-code phpdocumentor-signature ">
  1520. <span class="phpdocumentor-signature__visibility">public</span>
  1521. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1522. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  1523. </section>
  1524. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1525. <span class="phpdocumentor-signature__response_type">self</span>
  1526. &mdash;
  1527. </article>
  1528. <article
  1529. class="phpdocumentor-element
  1530. -method
  1531. -public
  1532. "
  1533. >
  1534. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  1535. setFinderPattern()
  1536. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1537. </h4>
  1538. <aside class="phpdocumentor-element-found-in">
  1539. <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>
  1540. :
  1541. <span class="phpdocumentor-element-found-in__line">322</span>
  1542. </aside>
  1543. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  1544. <code class="phpdocumentor-code phpdocumentor-signature ">
  1545. <span class="phpdocumentor-signature__visibility">public</span>
  1546. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1547. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  1548. </section>
  1549. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1550. <span class="phpdocumentor-signature__response_type">self</span>
  1551. &mdash;
  1552. </article>
  1553. <article
  1554. class="phpdocumentor-element
  1555. -method
  1556. -public
  1557. "
  1558. >
  1559. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  1560. setFormatInfo()
  1561. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  1562. </h4>
  1563. <aside class="phpdocumentor-element-found-in">
  1564. <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>
  1565. :
  1566. <span class="phpdocumentor-element-found-in__line">464</span>
  1567. </aside>
  1568. <p class="phpdocumentor-summary">Draws the format info along the finder patterns</p>
  1569. <code class="phpdocumentor-code phpdocumentor-signature ">
  1570. <span class="phpdocumentor-signature__visibility">public</span>
  1571. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1572. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  1573. </section>
  1574. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1575. <span class="phpdocumentor-signature__response_type">self</span>
  1576. &mdash;
  1577. </article>
  1578. <article
  1579. class="phpdocumentor-element
  1580. -method
  1581. -public
  1582. "
  1583. >
  1584. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  1585. setLogoSpace()
  1586. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  1587. </h4>
  1588. <aside class="phpdocumentor-element-found-in">
  1589. <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>
  1590. :
  1591. <span class="phpdocumentor-element-found-in__line">545</span>
  1592. </aside>
  1593. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  1594. <code class="phpdocumentor-code phpdocumentor-signature ">
  1595. <span class="phpdocumentor-signature__visibility">public</span>
  1596. <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>
  1597. <section class="phpdocumentor-description"><p>If no $height is given, the space will be assumed a square of $width.</p>
  1598. <p>Additionally, the logo space can be positioned within the QR Code - respecting the main functional patterns -
  1599. using $startX and $startY. If either of these are null, the logo space will be centered in that direction.
  1600. ECC level &quot;H&quot; (30%) is required.</p>
  1601. <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
  1602. created images may become unreadable, especially when printed with a chance to receive damage.
  1603. Please test thoroughly before using this feature in production.</p>
  1604. <p>This method should be called from within an output module (after the matrix has been filled with data).
  1605. Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
  1606. </section>
  1607. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1608. <dl class="phpdocumentor-argument-list">
  1609. <dt class="phpdocumentor-argument-list__entry">
  1610. <span class="phpdocumentor-signature__argument__name">$width</span>
  1611. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1612. </dt>
  1613. <dd class="phpdocumentor-argument-list__definition">
  1614. <section class="phpdocumentor-description"></section>
  1615. </dd>
  1616. <dt class="phpdocumentor-argument-list__entry">
  1617. <span class="phpdocumentor-signature__argument__name">$height</span>
  1618. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1619. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1620. <dd class="phpdocumentor-argument-list__definition">
  1621. <section class="phpdocumentor-description"></section>
  1622. </dd>
  1623. <dt class="phpdocumentor-argument-list__entry">
  1624. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1625. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1626. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1627. <dd class="phpdocumentor-argument-list__definition">
  1628. <section class="phpdocumentor-description"></section>
  1629. </dd>
  1630. <dt class="phpdocumentor-argument-list__entry">
  1631. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1632. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1633. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1634. <dd class="phpdocumentor-argument-list__definition">
  1635. <section class="phpdocumentor-description"></section>
  1636. </dd>
  1637. </dl>
  1638. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1639. Tags
  1640. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1641. </h5>
  1642. <dl class="phpdocumentor-tag-list">
  1643. <dt class="phpdocumentor-tag-list__entry">
  1644. <span class="phpdocumentor-tag__name">link</span>
  1645. </dt>
  1646. <dd class="phpdocumentor-tag-list__definition">
  1647. <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
  1648. </dd>
  1649. <dt class="phpdocumentor-tag-list__entry">
  1650. <span class="phpdocumentor-tag__name">throws</span>
  1651. </dt>
  1652. <dd class="phpdocumentor-tag-list__definition">
  1653. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1654. </dd>
  1655. </dl>
  1656. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1657. <span class="phpdocumentor-signature__response_type">self</span>
  1658. &mdash;
  1659. </article>
  1660. <article
  1661. class="phpdocumentor-element
  1662. -method
  1663. -public
  1664. "
  1665. >
  1666. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  1667. setQuietZone()
  1668. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  1669. </h4>
  1670. <aside class="phpdocumentor-element-found-in">
  1671. <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>
  1672. :
  1673. <span class="phpdocumentor-element-found-in__line">502</span>
  1674. </aside>
  1675. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  1676. <code class="phpdocumentor-code phpdocumentor-signature ">
  1677. <span class="phpdocumentor-signature__visibility">public</span>
  1678. <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>
  1679. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</p>
  1680. </section>
  1681. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1682. <dl class="phpdocumentor-argument-list">
  1683. <dt class="phpdocumentor-argument-list__entry">
  1684. <span class="phpdocumentor-signature__argument__name">$quietZoneSize</span>
  1685. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1686. </dt>
  1687. <dd class="phpdocumentor-argument-list__definition">
  1688. <section class="phpdocumentor-description"></section>
  1689. </dd>
  1690. </dl>
  1691. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1692. Tags
  1693. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1694. </h5>
  1695. <dl class="phpdocumentor-tag-list">
  1696. <dt class="phpdocumentor-tag-list__entry">
  1697. <span class="phpdocumentor-tag__name">throws</span>
  1698. </dt>
  1699. <dd class="phpdocumentor-tag-list__definition">
  1700. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1701. </dd>
  1702. </dl>
  1703. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1704. <span class="phpdocumentor-signature__response_type">self</span>
  1705. &mdash;
  1706. </article>
  1707. <article
  1708. class="phpdocumentor-element
  1709. -method
  1710. -public
  1711. "
  1712. >
  1713. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  1714. setSeparators()
  1715. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  1716. </h4>
  1717. <aside class="phpdocumentor-element-found-in">
  1718. <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>
  1719. :
  1720. <span class="phpdocumentor-element-found-in__line">357</span>
  1721. </aside>
  1722. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  1723. <code class="phpdocumentor-code phpdocumentor-signature ">
  1724. <span class="phpdocumentor-signature__visibility">public</span>
  1725. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1726. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  1727. </section>
  1728. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1729. <span class="phpdocumentor-signature__response_type">self</span>
  1730. &mdash;
  1731. </article>
  1732. <article
  1733. class="phpdocumentor-element
  1734. -method
  1735. -public
  1736. "
  1737. >
  1738. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  1739. setTimingPattern()
  1740. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1741. </h4>
  1742. <aside class="phpdocumentor-element-found-in">
  1743. <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>
  1744. :
  1745. <span class="phpdocumentor-element-found-in__line">418</span>
  1746. </aside>
  1747. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  1748. <code class="phpdocumentor-code phpdocumentor-signature ">
  1749. <span class="phpdocumentor-signature__visibility">public</span>
  1750. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1751. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  1752. </section>
  1753. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1754. <span class="phpdocumentor-signature__response_type">self</span>
  1755. &mdash;
  1756. </article>
  1757. <article
  1758. class="phpdocumentor-element
  1759. -method
  1760. -public
  1761. "
  1762. >
  1763. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  1764. setVersionNumber()
  1765. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1766. </h4>
  1767. <aside class="phpdocumentor-element-found-in">
  1768. <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>
  1769. :
  1770. <span class="phpdocumentor-element-found-in__line">440</span>
  1771. </aside>
  1772. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  1773. <code class="phpdocumentor-code phpdocumentor-signature ">
  1774. <span class="phpdocumentor-signature__visibility">public</span>
  1775. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1776. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  1777. </section>
  1778. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1779. <span class="phpdocumentor-signature__response_type">self</span>
  1780. &mdash;
  1781. </article>
  1782. <article
  1783. class="phpdocumentor-element
  1784. -method
  1785. -public
  1786. "
  1787. >
  1788. <h4 class="phpdocumentor-element__name" id="method_size">
  1789. size()
  1790. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  1791. </h4>
  1792. <aside class="phpdocumentor-element-found-in">
  1793. <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>
  1794. :
  1795. <span class="phpdocumentor-element-found-in__line">195</span>
  1796. </aside>
  1797. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1798. <code class="phpdocumentor-code phpdocumentor-signature ">
  1799. <span class="phpdocumentor-signature__visibility">public</span>
  1800. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1801. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1802. </section>
  1803. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1804. <span class="phpdocumentor-signature__response_type">int</span>
  1805. &mdash;
  1806. </article>
  1807. <article
  1808. class="phpdocumentor-element
  1809. -method
  1810. -public
  1811. "
  1812. >
  1813. <h4 class="phpdocumentor-element__name" id="method_version">
  1814. version()
  1815. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  1816. </h4>
  1817. <aside class="phpdocumentor-element-found-in">
  1818. <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>
  1819. :
  1820. <span class="phpdocumentor-element-found-in__line">172</span>
  1821. </aside>
  1822. <p class="phpdocumentor-summary">Returns the current version number</p>
  1823. <code class="phpdocumentor-code phpdocumentor-signature ">
  1824. <span class="phpdocumentor-signature__visibility">public</span>
  1825. <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>
  1826. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1827. <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>
  1828. &mdash;
  1829. </article>
  1830. <article
  1831. class="phpdocumentor-element
  1832. -method
  1833. -public
  1834. "
  1835. >
  1836. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  1837. writeCodewords()
  1838. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  1839. </h4>
  1840. <aside class="phpdocumentor-element-found-in">
  1841. <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>
  1842. :
  1843. <span class="phpdocumentor-element-found-in__line">614</span>
  1844. </aside>
  1845. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  1846. <code class="phpdocumentor-code phpdocumentor-signature ">
  1847. <span class="phpdocumentor-signature__visibility">public</span>
  1848. <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>
  1849. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1850. <dl class="phpdocumentor-argument-list">
  1851. <dt class="phpdocumentor-argument-list__entry">
  1852. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  1853. : <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>
  1854. </dt>
  1855. <dd class="phpdocumentor-argument-list__definition">
  1856. <section class="phpdocumentor-description"></section>
  1857. </dd>
  1858. </dl>
  1859. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1860. <span class="phpdocumentor-signature__response_type">self</span>
  1861. &mdash;
  1862. </article>
  1863. <article
  1864. class="phpdocumentor-element
  1865. -method
  1866. -protected
  1867. "
  1868. >
  1869. <h4 class="phpdocumentor-element__name" id="method_createMatrix">
  1870. createMatrix()
  1871. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1872. </h4>
  1873. <aside class="phpdocumentor-element-found-in">
  1874. <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>
  1875. :
  1876. <span class="phpdocumentor-element-found-in__line">126</span>
  1877. </aside>
  1878. <p class="phpdocumentor-summary">Creates a 2-dimensional array (square) of the given $size</p>
  1879. <code class="phpdocumentor-code phpdocumentor-signature ">
  1880. <span class="phpdocumentor-signature__visibility">protected</span>
  1881. <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>
  1882. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1883. <dl class="phpdocumentor-argument-list">
  1884. <dt class="phpdocumentor-argument-list__entry">
  1885. <span class="phpdocumentor-signature__argument__name">$size</span>
  1886. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1887. </dt>
  1888. <dd class="phpdocumentor-argument-list__definition">
  1889. <section class="phpdocumentor-description"></section>
  1890. </dd>
  1891. <dt class="phpdocumentor-argument-list__entry">
  1892. <span class="phpdocumentor-signature__argument__name">$value</span>
  1893. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1894. </dt>
  1895. <dd class="phpdocumentor-argument-list__definition">
  1896. <section class="phpdocumentor-description"></section>
  1897. </dd>
  1898. </dl>
  1899. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1900. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1901. &mdash;
  1902. </article>
  1903. </section>
  1904. <script type="text/javascript">
  1905. function loadExternalCodeSnippets(line) {
  1906. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1907. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1908. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1909. var language = 'php';
  1910. var code = document.createElement('code');
  1911. code.className = 'language-' + language;
  1912. pre.textContent = '';
  1913. pre.setAttribute('data-line', line)
  1914. code.textContent = 'Loading…';
  1915. pre.appendChild(code);
  1916. var xhr = new XMLHttpRequest();
  1917. xhr.open('GET', src, true);
  1918. xhr.onreadystatechange = function () {
  1919. if (xhr.readyState == 4) {
  1920. if (xhr.status < 400 && xhr.responseText) {
  1921. code.textContent = xhr.responseText;
  1922. Prism.highlightElement(code);
  1923. }
  1924. else if (xhr.status >= 400) {
  1925. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1926. }
  1927. else {
  1928. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1929. }
  1930. }
  1931. };
  1932. xhr.send(null);
  1933. });
  1934. }
  1935. var modals = document.querySelectorAll("[data-modal]");
  1936. modals.forEach(function (trigger) {
  1937. trigger.addEventListener("click", function (event) {
  1938. //event.preventDefault();
  1939. const modal = document.getElementById(trigger.dataset.modal);
  1940. modal.classList.add("phpdocumentor-modal__open");
  1941. loadExternalCodeSnippets(trigger.dataset.line)
  1942. const exits = modal.querySelectorAll("[data-exit-button]");
  1943. exits.forEach(function (exit) {
  1944. exit.addEventListener("click", function (event) {
  1945. event.preventDefault();
  1946. modal.classList.remove("phpdocumentor-modal__open");
  1947. });
  1948. });
  1949. });
  1950. });
  1951. </script>
  1952. </article>
  1953. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1954. <section class="phpdocumentor-search-results__dialog">
  1955. <header class="phpdocumentor-search-results__header">
  1956. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1957. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1958. </header>
  1959. <section class="phpdocumentor-search-results__body">
  1960. <ul class="phpdocumentor-search-results__entries"></ul>
  1961. </section>
  1962. </section>
  1963. </section>
  1964. </div>
  1965. </div>
  1966. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1967. </main>
  1968. <script>
  1969. cssVars({});
  1970. </script>
  1971. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1972. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1973. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1974. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1975. </body>
  1976. </html>