chillerlan-QRCode-Data-QRMatrix.html 103 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215
  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"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRMatrix
  89. <div class="phpdocumentor-element__package">
  90. in package
  91. <ul class="phpdocumentor-breadcrumbs">
  92. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  93. </ul>
  94. </div>
  95. </h2>
  96. <aside class="phpdocumentor-element-found-in">
  97. <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>
  98. :
  99. <span class="phpdocumentor-element-found-in__line">24</span>
  100. </aside>
  101. <p class="phpdocumentor-summary">Holds a numerical representation of the final QR Code;
  102. maps the ECC coded binary data and applies the mask pattern</p>
  103. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  104. Tags
  105. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  106. </h5>
  107. <dl class="phpdocumentor-tag-list">
  108. <dt class="phpdocumentor-tag-list__entry">
  109. <span class="phpdocumentor-tag__name">see</span>
  110. </dt>
  111. <dd class="phpdocumentor-tag-list__definition">
  112. <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>
  113. </dd>
  114. </dl>
  115. <h3 id="toc">
  116. Table of Contents
  117. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  118. </h3>
  119. <dl class="phpdocumentor-table-of-contents">
  120. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  121. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  122. <span>
  123. &nbsp;= 0b100000000000 </span>
  124. </dt>
  125. <dd></dd>
  126. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  127. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  128. <span>
  129. &nbsp;= 0b10000 </span>
  130. </dt>
  131. <dd></dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  133. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  134. <span>
  135. &nbsp;= 0b1 </span>
  136. </dt>
  137. <dd></dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  139. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  140. <span>
  141. &nbsp;= 0b10 </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  145. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  146. <span>
  147. &nbsp;= 0b100 </span>
  148. </dt>
  149. <dd></dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  151. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  152. <span>
  153. &nbsp;= 0b10000000000 </span>
  154. </dt>
  155. <dd></dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  157. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  158. <span>
  159. &nbsp;= 0b1000000 </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  163. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  164. <span>
  165. &nbsp;= 0b1000000000 </span>
  166. </dt>
  167. <dd></dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  169. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  170. <span>
  171. &nbsp;= 0b0 </span>
  172. </dt>
  173. <dd></dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  175. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  176. <span>
  177. &nbsp;= 0b100000000 </span>
  178. </dt>
  179. <dd></dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  181. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  182. <span>
  183. &nbsp;= 0b1000 </span>
  184. </dt>
  185. <dd></dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  187. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST">M_TEST</a>
  188. <span>
  189. &nbsp;= 0b11111111111 </span>
  190. </dt>
  191. <dd></dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  193. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  194. <span>
  195. &nbsp;= 0b100000 </span>
  196. </dt>
  197. <dd></dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  199. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  200. <span>
  201. &nbsp;= 0b10000000 </span>
  202. </dt>
  203. <dd></dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  205. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  206. <span>
  207. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  208. </dt>
  209. <dd>the current ECC level</dd>
  210. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  211. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  212. <span>
  213. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  214. </dt>
  215. <dd>the used mask pattern, set via QRMatrix::mask()</dd>
  216. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  217. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  218. <span>
  219. &nbsp;: array&lt;string|int, mixed&gt; </span>
  220. </dt>
  221. <dd>the actual matrix data array</dd>
  222. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  223. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  224. <span>
  225. &nbsp;: int </span>
  226. </dt>
  227. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  228. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  229. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  230. <span>
  231. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  232. </dt>
  233. <dd>a Version instance</dd>
  234. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  235. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a>
  236. <span>
  237. &nbsp;: mixed </span>
  238. </dt>
  239. <dd>QRMatrix constructor.</dd>
  240. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  241. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  242. <span>
  243. &nbsp;: bool </span>
  244. </dt>
  245. <dd>Checks whether a module is true (dark) or false (light)</dd>
  246. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  247. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  248. <span>
  249. &nbsp;: bool </span>
  250. </dt>
  251. <dd>Checks whether a module is of the given $M_TYPE</dd>
  252. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  253. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
  254. <span>
  255. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  256. </dt>
  257. <dd>Returns the current ECC level</dd>
  258. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  259. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
  260. <span>
  261. &nbsp;: self </span>
  262. </dt>
  263. <dd>Flips the value of the module</dd>
  264. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  265. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  266. <span>
  267. &nbsp;: int </span>
  268. </dt>
  269. <dd>Returns the value of the module at position [$x, $y]</dd>
  270. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  271. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_init">init()</a>
  272. <span>
  273. &nbsp;: self </span>
  274. </dt>
  275. <dd>shortcut to initialize the matrix</dd>
  276. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  277. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mapData">mapData()</a>
  278. <span>
  279. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  280. </dt>
  281. <dd>Maps the binary $data array from QRData::maskECC() on the matrix,
  282. masking the data using $maskPattern (ISO/IEC 18004:2000 Section 8.8)</dd>
  283. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  284. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  285. <span>
  286. &nbsp;: self </span>
  287. </dt>
  288. <dd>Applies the mask pattern</dd>
  289. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  290. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  291. <span>
  292. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  293. </dt>
  294. <dd>Returns the current mask pattern</dd>
  295. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  296. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  297. <span>
  298. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  299. </dt>
  300. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  301. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  302. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  303. <span>
  304. &nbsp;: self </span>
  305. </dt>
  306. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  307. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  308. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  309. <span>
  310. &nbsp;: self </span>
  311. </dt>
  312. <dd>Draws the 5x5 alignment patterns</dd>
  313. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  314. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  315. <span>
  316. &nbsp;: self </span>
  317. </dt>
  318. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  319. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  320. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  321. <span>
  322. &nbsp;: self </span>
  323. </dt>
  324. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  325. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  326. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  327. <span>
  328. &nbsp;: self </span>
  329. </dt>
  330. <dd>Draws the format info along the finder patterns</dd>
  331. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  332. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  333. <span>
  334. &nbsp;: self </span>
  335. </dt>
  336. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  337. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  338. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
  339. <span>
  340. &nbsp;: self </span>
  341. </dt>
  342. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  343. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  344. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  345. <span>
  346. &nbsp;: self </span>
  347. </dt>
  348. <dd>Draws the separator lines around the finder patterns</dd>
  349. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  350. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  351. <span>
  352. &nbsp;: self </span>
  353. </dt>
  354. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  355. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  356. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  357. <span>
  358. &nbsp;: self </span>
  359. </dt>
  360. <dd>Draws the version information, 2x 3x6 pixel</dd>
  361. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  362. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  363. <span>
  364. &nbsp;: int </span>
  365. </dt>
  366. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  367. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  368. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  369. <span>
  370. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  371. </dt>
  372. <dd>Returns the current version number</dd>
  373. </dl>
  374. <section class="phpdocumentor-constants">
  375. <h3 class="phpdocumentor-elements__header" id="constants">
  376. Constants
  377. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  378. </h3>
  379. <article class="phpdocumentor-element -constant -public ">
  380. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  381. IS_DARK
  382. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  383. </h4>
  384. <aside class="phpdocumentor-element-found-in">
  385. <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>
  386. :
  387. <span class="phpdocumentor-element-found-in__line">53</span>
  388. </aside>
  389. <code class="phpdocumentor-signature phpdocumentor-code ">
  390. <span class="phpdocumentor-signature__visibility">public</span>
  391. <span class="phpdocumentor-signature__type">int</span>
  392. <span class="phpdocumentor-signature__name">IS_DARK</span>
  393. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  394. </code>
  395. </article>
  396. <article class="phpdocumentor-element -constant -public ">
  397. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  398. M_ALIGNMENT
  399. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  400. </h4>
  401. <aside class="phpdocumentor-element-found-in">
  402. <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>
  403. :
  404. <span class="phpdocumentor-element-found-in__line">37</span>
  405. </aside>
  406. <code class="phpdocumentor-signature phpdocumentor-code ">
  407. <span class="phpdocumentor-signature__visibility">public</span>
  408. <span class="phpdocumentor-signature__type">int</span>
  409. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  410. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  411. </code>
  412. </article>
  413. <article class="phpdocumentor-element -constant -public ">
  414. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  415. M_DARKMODULE
  416. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  417. </h4>
  418. <aside class="phpdocumentor-element-found-in">
  419. <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>
  420. :
  421. <span class="phpdocumentor-element-found-in__line">29</span>
  422. </aside>
  423. <code class="phpdocumentor-signature phpdocumentor-code ">
  424. <span class="phpdocumentor-signature__visibility">public</span>
  425. <span class="phpdocumentor-signature__type">int</span>
  426. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  427. = <span class="phpdocumentor-signature__default-value">0b1</span>
  428. </code>
  429. </article>
  430. <article class="phpdocumentor-element -constant -public ">
  431. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  432. M_DATA
  433. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  434. </h4>
  435. <aside class="phpdocumentor-element-found-in">
  436. <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>
  437. :
  438. <span class="phpdocumentor-element-found-in__line">31</span>
  439. </aside>
  440. <code class="phpdocumentor-signature phpdocumentor-code ">
  441. <span class="phpdocumentor-signature__visibility">public</span>
  442. <span class="phpdocumentor-signature__type">int</span>
  443. <span class="phpdocumentor-signature__name">M_DATA</span>
  444. = <span class="phpdocumentor-signature__default-value">0b10</span>
  445. </code>
  446. </article>
  447. <article class="phpdocumentor-element -constant -public ">
  448. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  449. M_FINDER
  450. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  451. </h4>
  452. <aside class="phpdocumentor-element-found-in">
  453. <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>
  454. :
  455. <span class="phpdocumentor-element-found-in__line">33</span>
  456. </aside>
  457. <code class="phpdocumentor-signature phpdocumentor-code ">
  458. <span class="phpdocumentor-signature__visibility">public</span>
  459. <span class="phpdocumentor-signature__type">int</span>
  460. <span class="phpdocumentor-signature__name">M_FINDER</span>
  461. = <span class="phpdocumentor-signature__default-value">0b100</span>
  462. </code>
  463. </article>
  464. <article class="phpdocumentor-element -constant -public ">
  465. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  466. M_FINDER_DOT
  467. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  468. </h4>
  469. <aside class="phpdocumentor-element-found-in">
  470. <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>
  471. :
  472. <span class="phpdocumentor-element-found-in__line">49</span>
  473. </aside>
  474. <code class="phpdocumentor-signature phpdocumentor-code ">
  475. <span class="phpdocumentor-signature__visibility">public</span>
  476. <span class="phpdocumentor-signature__type">int</span>
  477. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  478. = <span class="phpdocumentor-signature__default-value">0b10000000000</span>
  479. </code>
  480. </article>
  481. <article class="phpdocumentor-element -constant -public ">
  482. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  483. M_FORMAT
  484. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  485. </h4>
  486. <aside class="phpdocumentor-element-found-in">
  487. <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>
  488. :
  489. <span class="phpdocumentor-element-found-in__line">41</span>
  490. </aside>
  491. <code class="phpdocumentor-signature phpdocumentor-code ">
  492. <span class="phpdocumentor-signature__visibility">public</span>
  493. <span class="phpdocumentor-signature__type">int</span>
  494. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  495. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  496. </code>
  497. </article>
  498. <article class="phpdocumentor-element -constant -public ">
  499. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  500. M_LOGO
  501. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  502. </h4>
  503. <aside class="phpdocumentor-element-found-in">
  504. <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>
  505. :
  506. <span class="phpdocumentor-element-found-in__line">47</span>
  507. </aside>
  508. <code class="phpdocumentor-signature phpdocumentor-code ">
  509. <span class="phpdocumentor-signature__visibility">public</span>
  510. <span class="phpdocumentor-signature__type">int</span>
  511. <span class="phpdocumentor-signature__name">M_LOGO</span>
  512. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  513. </code>
  514. </article>
  515. <article class="phpdocumentor-element -constant -public ">
  516. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  517. M_NULL
  518. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  519. </h4>
  520. <aside class="phpdocumentor-element-found-in">
  521. <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>
  522. :
  523. <span class="phpdocumentor-element-found-in__line">27</span>
  524. </aside>
  525. <code class="phpdocumentor-signature phpdocumentor-code ">
  526. <span class="phpdocumentor-signature__visibility">public</span>
  527. <span class="phpdocumentor-signature__type">int</span>
  528. <span class="phpdocumentor-signature__name">M_NULL</span>
  529. = <span class="phpdocumentor-signature__default-value">0b0</span>
  530. </code>
  531. </article>
  532. <article class="phpdocumentor-element -constant -public ">
  533. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  534. M_QUIETZONE
  535. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  536. </h4>
  537. <aside class="phpdocumentor-element-found-in">
  538. <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>
  539. :
  540. <span class="phpdocumentor-element-found-in__line">45</span>
  541. </aside>
  542. <code class="phpdocumentor-signature phpdocumentor-code ">
  543. <span class="phpdocumentor-signature__visibility">public</span>
  544. <span class="phpdocumentor-signature__type">int</span>
  545. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  546. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  547. </code>
  548. </article>
  549. <article class="phpdocumentor-element -constant -public ">
  550. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  551. M_SEPARATOR
  552. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  553. </h4>
  554. <aside class="phpdocumentor-element-found-in">
  555. <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>
  556. :
  557. <span class="phpdocumentor-element-found-in__line">35</span>
  558. </aside>
  559. <code class="phpdocumentor-signature phpdocumentor-code ">
  560. <span class="phpdocumentor-signature__visibility">public</span>
  561. <span class="phpdocumentor-signature__type">int</span>
  562. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  563. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  564. </code>
  565. </article>
  566. <article class="phpdocumentor-element -constant -public ">
  567. <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
  568. M_TEST
  569. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" class="headerlink"><i class="fas fa-link"></i></a>
  570. </h4>
  571. <aside class="phpdocumentor-element-found-in">
  572. <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>
  573. :
  574. <span class="phpdocumentor-element-found-in__line">51</span>
  575. </aside>
  576. <code class="phpdocumentor-signature phpdocumentor-code ">
  577. <span class="phpdocumentor-signature__visibility">public</span>
  578. <span class="phpdocumentor-signature__type">int</span>
  579. <span class="phpdocumentor-signature__name">M_TEST</span>
  580. = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
  581. </code>
  582. </article>
  583. <article class="phpdocumentor-element -constant -public ">
  584. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  585. M_TIMING
  586. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  587. </h4>
  588. <aside class="phpdocumentor-element-found-in">
  589. <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>
  590. :
  591. <span class="phpdocumentor-element-found-in__line">39</span>
  592. </aside>
  593. <code class="phpdocumentor-signature phpdocumentor-code ">
  594. <span class="phpdocumentor-signature__visibility">public</span>
  595. <span class="phpdocumentor-signature__type">int</span>
  596. <span class="phpdocumentor-signature__name">M_TIMING</span>
  597. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  598. </code>
  599. </article>
  600. <article class="phpdocumentor-element -constant -public ">
  601. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  602. M_VERSION
  603. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  604. </h4>
  605. <aside class="phpdocumentor-element-found-in">
  606. <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>
  607. :
  608. <span class="phpdocumentor-element-found-in__line">43</span>
  609. </aside>
  610. <code class="phpdocumentor-signature phpdocumentor-code ">
  611. <span class="phpdocumentor-signature__visibility">public</span>
  612. <span class="phpdocumentor-signature__type">int</span>
  613. <span class="phpdocumentor-signature__name">M_VERSION</span>
  614. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  615. </code>
  616. </article>
  617. </section>
  618. <section class="phpdocumentor-properties">
  619. <h3 class="phpdocumentor-elements__header" id="properties">
  620. Properties
  621. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  622. </h3>
  623. <article
  624. class="
  625. phpdocumentor-element
  626. -property
  627. -private
  628. "
  629. >
  630. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  631. $eccLevel
  632. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  633. <span class="phpdocumentor-element__modifiers">
  634. </span>
  635. </h4>
  636. <aside class="phpdocumentor-element-found-in">
  637. <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>
  638. :
  639. <span class="phpdocumentor-element-found-in__line">75</span>
  640. </aside>
  641. <p class="phpdocumentor-summary">the current ECC level</p>
  642. <code class="phpdocumentor-code phpdocumentor-signature ">
  643. <span class="phpdocumentor-signature__visibility">private</span>
  644. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  645. <span class="phpdocumentor-signature__name">$eccLevel</span>
  646. </code>
  647. <section class="phpdocumentor-description"></section>
  648. </article>
  649. <article
  650. class="
  651. phpdocumentor-element
  652. -property
  653. -private
  654. "
  655. >
  656. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  657. $maskPattern
  658. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  659. <span class="phpdocumentor-element__modifiers">
  660. </span>
  661. </h4>
  662. <aside class="phpdocumentor-element-found-in">
  663. <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>
  664. :
  665. <span class="phpdocumentor-element-found-in__line">58</span>
  666. </aside>
  667. <p class="phpdocumentor-summary">the used mask pattern, set via QRMatrix::mask()</p>
  668. <code class="phpdocumentor-code phpdocumentor-signature ">
  669. <span class="phpdocumentor-signature__visibility">private</span>
  670. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  671. <span class="phpdocumentor-signature__name">$maskPattern</span>
  672. = <span class="phpdocumentor-signature__default-value">null</span></code>
  673. <section class="phpdocumentor-description"></section>
  674. </article>
  675. <article
  676. class="
  677. phpdocumentor-element
  678. -property
  679. -private
  680. "
  681. >
  682. <h4 class="phpdocumentor-element__name" id="property_matrix">
  683. $matrix
  684. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  685. <span class="phpdocumentor-element__modifiers">
  686. </span>
  687. </h4>
  688. <aside class="phpdocumentor-element-found-in">
  689. <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>
  690. :
  691. <span class="phpdocumentor-element-found-in__line">70</span>
  692. </aside>
  693. <p class="phpdocumentor-summary">the actual matrix data array</p>
  694. <code class="phpdocumentor-code phpdocumentor-signature ">
  695. <span class="phpdocumentor-signature__visibility">private</span>
  696. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  697. <span class="phpdocumentor-signature__name">$matrix</span>
  698. </code>
  699. </article>
  700. <article
  701. class="
  702. phpdocumentor-element
  703. -property
  704. -private
  705. "
  706. >
  707. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  708. $moduleCount
  709. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  710. <span class="phpdocumentor-element__modifiers">
  711. </span>
  712. </h4>
  713. <aside class="phpdocumentor-element-found-in">
  714. <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>
  715. :
  716. <span class="phpdocumentor-element-found-in__line">63</span>
  717. </aside>
  718. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  719. <code class="phpdocumentor-code phpdocumentor-signature ">
  720. <span class="phpdocumentor-signature__visibility">private</span>
  721. <span class="phpdocumentor-signature__type">int</span>
  722. <span class="phpdocumentor-signature__name">$moduleCount</span>
  723. </code>
  724. <section class="phpdocumentor-description"></section>
  725. </article>
  726. <article
  727. class="
  728. phpdocumentor-element
  729. -property
  730. -private
  731. "
  732. >
  733. <h4 class="phpdocumentor-element__name" id="property_version">
  734. $version
  735. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  736. <span class="phpdocumentor-element__modifiers">
  737. </span>
  738. </h4>
  739. <aside class="phpdocumentor-element-found-in">
  740. <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>
  741. :
  742. <span class="phpdocumentor-element-found-in__line">80</span>
  743. </aside>
  744. <p class="phpdocumentor-summary">a Version instance</p>
  745. <code class="phpdocumentor-code phpdocumentor-signature ">
  746. <span class="phpdocumentor-signature__visibility">private</span>
  747. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  748. <span class="phpdocumentor-signature__name">$version</span>
  749. </code>
  750. <section class="phpdocumentor-description"></section>
  751. </article>
  752. </section>
  753. <section class="phpdocumentor-methods">
  754. <h3 class="phpdocumentor-elements__header" id="methods">
  755. Methods
  756. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  757. </h3>
  758. <article
  759. class="phpdocumentor-element
  760. -method
  761. -public
  762. "
  763. >
  764. <h4 class="phpdocumentor-element__name" id="method___construct">
  765. __construct()
  766. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  767. </h4>
  768. <aside class="phpdocumentor-element-found-in">
  769. <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>
  770. :
  771. <span class="phpdocumentor-element-found-in__line">85</span>
  772. </aside>
  773. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  774. <code class="phpdocumentor-code phpdocumentor-signature ">
  775. <span class="phpdocumentor-signature__visibility">public</span>
  776. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eccLevel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  777. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  778. <dl class="phpdocumentor-argument-list">
  779. <dt class="phpdocumentor-argument-list__entry">
  780. <span class="phpdocumentor-signature__argument__name">$version</span>
  781. : <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>
  782. </dt>
  783. <dd class="phpdocumentor-argument-list__definition">
  784. <section class="phpdocumentor-description"></section>
  785. </dd>
  786. <dt class="phpdocumentor-argument-list__entry">
  787. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  788. : <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>
  789. </dt>
  790. <dd class="phpdocumentor-argument-list__definition">
  791. <section class="phpdocumentor-description"></section>
  792. </dd>
  793. </dl>
  794. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  795. <span class="phpdocumentor-signature__response_type">mixed</span>
  796. &mdash;
  797. </article>
  798. <article
  799. class="phpdocumentor-element
  800. -method
  801. -public
  802. "
  803. >
  804. <h4 class="phpdocumentor-element__name" id="method_check">
  805. check()
  806. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h4>
  808. <aside class="phpdocumentor-element-found-in">
  809. <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>
  810. :
  811. <span class="phpdocumentor-element-found-in__line">204</span>
  812. </aside>
  813. <p class="phpdocumentor-summary">Checks whether a module is true (dark) or false (light)</p>
  814. <code class="phpdocumentor-code phpdocumentor-signature ">
  815. <span class="phpdocumentor-signature__visibility">public</span>
  816. <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>
  817. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; 0x800 === 0x800
  818. false =&gt; $value &amp; 0x800 === 0</p>
  819. </section>
  820. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  821. <dl class="phpdocumentor-argument-list">
  822. <dt class="phpdocumentor-argument-list__entry">
  823. <span class="phpdocumentor-signature__argument__name">$x</span>
  824. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  825. </dt>
  826. <dd class="phpdocumentor-argument-list__definition">
  827. <section class="phpdocumentor-description"></section>
  828. </dd>
  829. <dt class="phpdocumentor-argument-list__entry">
  830. <span class="phpdocumentor-signature__argument__name">$y</span>
  831. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  832. </dt>
  833. <dd class="phpdocumentor-argument-list__definition">
  834. <section class="phpdocumentor-description"></section>
  835. </dd>
  836. </dl>
  837. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  838. <span class="phpdocumentor-signature__response_type">bool</span>
  839. &mdash;
  840. </article>
  841. <article
  842. class="phpdocumentor-element
  843. -method
  844. -public
  845. "
  846. >
  847. <h4 class="phpdocumentor-element__name" id="method_checkType">
  848. checkType()
  849. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  850. </h4>
  851. <aside class="phpdocumentor-element-found-in">
  852. <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>
  853. :
  854. <span class="phpdocumentor-element-found-in__line">194</span>
  855. </aside>
  856. <p class="phpdocumentor-summary">Checks whether a module is of the given $M_TYPE</p>
  857. <code class="phpdocumentor-code phpdocumentor-signature ">
  858. <span class="phpdocumentor-signature__visibility">public</span>
  859. <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>
  860. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  861. </section>
  862. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  863. <dl class="phpdocumentor-argument-list">
  864. <dt class="phpdocumentor-argument-list__entry">
  865. <span class="phpdocumentor-signature__argument__name">$x</span>
  866. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  867. </dt>
  868. <dd class="phpdocumentor-argument-list__definition">
  869. <section class="phpdocumentor-description"></section>
  870. </dd>
  871. <dt class="phpdocumentor-argument-list__entry">
  872. <span class="phpdocumentor-signature__argument__name">$y</span>
  873. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  874. </dt>
  875. <dd class="phpdocumentor-argument-list__definition">
  876. <section class="phpdocumentor-description"></section>
  877. </dd>
  878. <dt class="phpdocumentor-argument-list__entry">
  879. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  880. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  881. </dt>
  882. <dd class="phpdocumentor-argument-list__definition">
  883. <section class="phpdocumentor-description"></section>
  884. </dd>
  885. </dl>
  886. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  887. <span class="phpdocumentor-signature__response_type">bool</span>
  888. &mdash;
  889. </article>
  890. <article
  891. class="phpdocumentor-element
  892. -method
  893. -public
  894. "
  895. >
  896. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  897. eccLevel()
  898. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  899. </h4>
  900. <aside class="phpdocumentor-element-found-in">
  901. <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>
  902. :
  903. <span class="phpdocumentor-element-found-in__line">141</span>
  904. </aside>
  905. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  906. <code class="phpdocumentor-code phpdocumentor-signature ">
  907. <span class="phpdocumentor-signature__visibility">public</span>
  908. <span class="phpdocumentor-signature__name">eccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span></code>
  909. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  910. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  911. &mdash;
  912. </article>
  913. <article
  914. class="phpdocumentor-element
  915. -method
  916. -public
  917. "
  918. >
  919. <h4 class="phpdocumentor-element__name" id="method_flip">
  920. flip()
  921. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  922. </h4>
  923. <aside class="phpdocumentor-element-found-in">
  924. <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>
  925. :
  926. <span class="phpdocumentor-element-found-in__line">183</span>
  927. </aside>
  928. <p class="phpdocumentor-summary">Flips the value of the module</p>
  929. <code class="phpdocumentor-code phpdocumentor-signature ">
  930. <span class="phpdocumentor-signature__visibility">public</span>
  931. <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>
  932. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  933. <dl class="phpdocumentor-argument-list">
  934. <dt class="phpdocumentor-argument-list__entry">
  935. <span class="phpdocumentor-signature__argument__name">$x</span>
  936. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  937. </dt>
  938. <dd class="phpdocumentor-argument-list__definition">
  939. <section class="phpdocumentor-description"></section>
  940. </dd>
  941. <dt class="phpdocumentor-argument-list__entry">
  942. <span class="phpdocumentor-signature__argument__name">$y</span>
  943. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  944. </dt>
  945. <dd class="phpdocumentor-argument-list__definition">
  946. <section class="phpdocumentor-description"></section>
  947. </dd>
  948. </dl>
  949. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  950. <span class="phpdocumentor-signature__response_type">self</span>
  951. &mdash;
  952. </article>
  953. <article
  954. class="phpdocumentor-element
  955. -method
  956. -public
  957. "
  958. >
  959. <h4 class="phpdocumentor-element__name" id="method_get">
  960. get()
  961. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  962. </h4>
  963. <aside class="phpdocumentor-element-found-in">
  964. <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>
  965. :
  966. <span class="phpdocumentor-element-found-in__line">164</span>
  967. </aside>
  968. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y]</p>
  969. <code class="phpdocumentor-code phpdocumentor-signature ">
  970. <span class="phpdocumentor-signature__visibility">public</span>
  971. <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>
  972. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  973. <dl class="phpdocumentor-argument-list">
  974. <dt class="phpdocumentor-argument-list__entry">
  975. <span class="phpdocumentor-signature__argument__name">$x</span>
  976. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  977. </dt>
  978. <dd class="phpdocumentor-argument-list__definition">
  979. <section class="phpdocumentor-description"></section>
  980. </dd>
  981. <dt class="phpdocumentor-argument-list__entry">
  982. <span class="phpdocumentor-signature__argument__name">$y</span>
  983. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  984. </dt>
  985. <dd class="phpdocumentor-argument-list__definition">
  986. <section class="phpdocumentor-description"></section>
  987. </dd>
  988. </dl>
  989. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  990. <span class="phpdocumentor-signature__response_type">int</span>
  991. &mdash;
  992. </article>
  993. <article
  994. class="phpdocumentor-element
  995. -method
  996. -public
  997. "
  998. >
  999. <h4 class="phpdocumentor-element__name" id="method_init">
  1000. init()
  1001. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_init" class="headerlink"><i class="fas fa-link"></i></a>
  1002. </h4>
  1003. <aside class="phpdocumentor-element-found-in">
  1004. <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>
  1005. :
  1006. <span class="phpdocumentor-element-found-in__line">95</span>
  1007. </aside>
  1008. <p class="phpdocumentor-summary">shortcut to initialize the matrix</p>
  1009. <code class="phpdocumentor-code phpdocumentor-signature ">
  1010. <span class="phpdocumentor-signature__visibility">public</span>
  1011. <span class="phpdocumentor-signature__name">init</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$test</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>
  1012. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1013. <dl class="phpdocumentor-argument-list">
  1014. <dt class="phpdocumentor-argument-list__entry">
  1015. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1016. : <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>
  1017. </dt>
  1018. <dd class="phpdocumentor-argument-list__definition">
  1019. <section class="phpdocumentor-description"></section>
  1020. </dd>
  1021. <dt class="phpdocumentor-argument-list__entry">
  1022. <span class="phpdocumentor-signature__argument__name">$test</span>
  1023. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1024. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1025. <dd class="phpdocumentor-argument-list__definition">
  1026. <section class="phpdocumentor-description"></section>
  1027. </dd>
  1028. </dl>
  1029. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1030. <span class="phpdocumentor-signature__response_type">self</span>
  1031. &mdash;
  1032. </article>
  1033. <article
  1034. class="phpdocumentor-element
  1035. -method
  1036. -public
  1037. "
  1038. >
  1039. <h4 class="phpdocumentor-element__name" id="method_mapData">
  1040. mapData()
  1041. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mapData" class="headerlink"><i class="fas fa-link"></i></a>
  1042. </h4>
  1043. <aside class="phpdocumentor-element-found-in">
  1044. <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>
  1045. :
  1046. <span class="phpdocumentor-element-found-in__line">513</span>
  1047. </aside>
  1048. <p class="phpdocumentor-summary">Maps the binary $data array from QRData::maskECC() on the matrix,
  1049. masking the data using $maskPattern (ISO/IEC 18004:2000 Section 8.8)</p>
  1050. <code class="phpdocumentor-code phpdocumentor-signature ">
  1051. <span class="phpdocumentor-signature__visibility">public</span>
  1052. <span class="phpdocumentor-signature__name">mapData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\SplFixedArray">SplFixedArray</abbr>&lt;string|int, int&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span></code>
  1053. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1054. <dl class="phpdocumentor-argument-list">
  1055. <dt class="phpdocumentor-argument-list__entry">
  1056. <span class="phpdocumentor-signature__argument__name">$data</span>
  1057. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\SplFixedArray">SplFixedArray</abbr>&lt;string|int, int&gt;</span>
  1058. </dt>
  1059. <dd class="phpdocumentor-argument-list__definition">
  1060. </dd>
  1061. </dl>
  1062. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1063. Tags
  1064. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1065. </h5>
  1066. <dl class="phpdocumentor-tag-list">
  1067. <dt class="phpdocumentor-tag-list__entry">
  1068. <span class="phpdocumentor-tag__name">see</span>
  1069. </dt>
  1070. <dd class="phpdocumentor-tag-list__definition">
  1071. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Data\QRData::maskECC()">QRData::maskECC()</abbr></span>
  1072. </dd>
  1073. </dl>
  1074. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1075. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1076. &mdash;
  1077. </article>
  1078. <article
  1079. class="phpdocumentor-element
  1080. -method
  1081. -public
  1082. "
  1083. >
  1084. <h4 class="phpdocumentor-element__name" id="method_mask">
  1085. mask()
  1086. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1087. </h4>
  1088. <aside class="phpdocumentor-element-found-in">
  1089. <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>
  1090. :
  1091. <span class="phpdocumentor-element-found-in__line">568</span>
  1092. </aside>
  1093. <p class="phpdocumentor-summary">Applies the mask pattern</p>
  1094. <code class="phpdocumentor-code phpdocumentor-signature ">
  1095. <span class="phpdocumentor-signature__visibility">public</span>
  1096. <span class="phpdocumentor-signature__name">mask</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1097. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1098. </section>
  1099. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1100. <dl class="phpdocumentor-argument-list">
  1101. <dt class="phpdocumentor-argument-list__entry">
  1102. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1103. : <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>
  1104. </dt>
  1105. <dd class="phpdocumentor-argument-list__definition">
  1106. <section class="phpdocumentor-description"></section>
  1107. </dd>
  1108. </dl>
  1109. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1110. <span class="phpdocumentor-signature__response_type">self</span>
  1111. &mdash;
  1112. </article>
  1113. <article
  1114. class="phpdocumentor-element
  1115. -method
  1116. -public
  1117. "
  1118. >
  1119. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1120. maskPattern()
  1121. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1122. </h4>
  1123. <aside class="phpdocumentor-element-found-in">
  1124. <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>
  1125. :
  1126. <span class="phpdocumentor-element-found-in__line">148</span>
  1127. </aside>
  1128. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1129. <code class="phpdocumentor-code phpdocumentor-signature ">
  1130. <span class="phpdocumentor-signature__visibility">public</span>
  1131. <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>
  1132. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1133. <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>
  1134. &mdash;
  1135. </article>
  1136. <article
  1137. class="phpdocumentor-element
  1138. -method
  1139. -public
  1140. "
  1141. >
  1142. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1143. matrix()
  1144. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1145. </h4>
  1146. <aside class="phpdocumentor-element-found-in">
  1147. <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>
  1148. :
  1149. <span class="phpdocumentor-element-found-in__line">112</span>
  1150. </aside>
  1151. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1152. <code class="phpdocumentor-code phpdocumentor-signature ">
  1153. <span class="phpdocumentor-signature__visibility">public</span>
  1154. <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">false</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>
  1155. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1156. <dl class="phpdocumentor-argument-list">
  1157. <dt class="phpdocumentor-argument-list__entry">
  1158. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1159. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1160. = <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
  1161. <dd class="phpdocumentor-argument-list__definition">
  1162. <section class="phpdocumentor-description"></section>
  1163. </dd>
  1164. </dl>
  1165. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1166. <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>
  1167. &mdash;
  1168. </article>
  1169. <article
  1170. class="phpdocumentor-element
  1171. -method
  1172. -public
  1173. "
  1174. >
  1175. <h4 class="phpdocumentor-element__name" id="method_set">
  1176. set()
  1177. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1178. </h4>
  1179. <aside class="phpdocumentor-element-found-in">
  1180. <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>
  1181. :
  1182. <span class="phpdocumentor-element-found-in__line">174</span>
  1183. </aside>
  1184. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1185. <code class="phpdocumentor-code phpdocumentor-signature ">
  1186. <span class="phpdocumentor-signature__visibility">public</span>
  1187. <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>
  1188. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1189. false =&gt; $M_TYPE</p>
  1190. </section>
  1191. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1192. <dl class="phpdocumentor-argument-list">
  1193. <dt class="phpdocumentor-argument-list__entry">
  1194. <span class="phpdocumentor-signature__argument__name">$x</span>
  1195. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1196. </dt>
  1197. <dd class="phpdocumentor-argument-list__definition">
  1198. <section class="phpdocumentor-description"></section>
  1199. </dd>
  1200. <dt class="phpdocumentor-argument-list__entry">
  1201. <span class="phpdocumentor-signature__argument__name">$y</span>
  1202. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1203. </dt>
  1204. <dd class="phpdocumentor-argument-list__definition">
  1205. <section class="phpdocumentor-description"></section>
  1206. </dd>
  1207. <dt class="phpdocumentor-argument-list__entry">
  1208. <span class="phpdocumentor-signature__argument__name">$value</span>
  1209. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1210. </dt>
  1211. <dd class="phpdocumentor-argument-list__definition">
  1212. <section class="phpdocumentor-description"></section>
  1213. </dd>
  1214. <dt class="phpdocumentor-argument-list__entry">
  1215. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1216. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1217. </dt>
  1218. <dd class="phpdocumentor-argument-list__definition">
  1219. <section class="phpdocumentor-description"></section>
  1220. </dd>
  1221. </dl>
  1222. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1223. <span class="phpdocumentor-signature__response_type">self</span>
  1224. &mdash;
  1225. </article>
  1226. <article
  1227. class="phpdocumentor-element
  1228. -method
  1229. -public
  1230. "
  1231. >
  1232. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1233. setAlignmentPattern()
  1234. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1235. </h4>
  1236. <aside class="phpdocumentor-element-found-in">
  1237. <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>
  1238. :
  1239. <span class="phpdocumentor-element-found-in__line">287</span>
  1240. </aside>
  1241. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1242. <code class="phpdocumentor-code phpdocumentor-signature ">
  1243. <span class="phpdocumentor-signature__visibility">public</span>
  1244. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1245. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1246. </section>
  1247. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1248. <span class="phpdocumentor-signature__response_type">self</span>
  1249. &mdash;
  1250. </article>
  1251. <article
  1252. class="phpdocumentor-element
  1253. -method
  1254. -public
  1255. "
  1256. >
  1257. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  1258. setDarkModule()
  1259. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  1260. </h4>
  1261. <aside class="phpdocumentor-element-found-in">
  1262. <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>
  1263. :
  1264. <span class="phpdocumentor-element-found-in__line">211</span>
  1265. </aside>
  1266. <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>
  1267. <code class="phpdocumentor-code phpdocumentor-signature ">
  1268. <span class="phpdocumentor-signature__visibility">public</span>
  1269. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1270. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1271. <span class="phpdocumentor-signature__response_type">self</span>
  1272. &mdash;
  1273. </article>
  1274. <article
  1275. class="phpdocumentor-element
  1276. -method
  1277. -public
  1278. "
  1279. >
  1280. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  1281. setFinderPattern()
  1282. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1283. </h4>
  1284. <aside class="phpdocumentor-element-found-in">
  1285. <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>
  1286. :
  1287. <span class="phpdocumentor-element-found-in__line">222</span>
  1288. </aside>
  1289. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  1290. <code class="phpdocumentor-code phpdocumentor-signature ">
  1291. <span class="phpdocumentor-signature__visibility">public</span>
  1292. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1293. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  1294. </section>
  1295. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1296. <span class="phpdocumentor-signature__response_type">self</span>
  1297. &mdash;
  1298. </article>
  1299. <article
  1300. class="phpdocumentor-element
  1301. -method
  1302. -public
  1303. "
  1304. >
  1305. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  1306. setFormatInfo()
  1307. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  1308. </h4>
  1309. <aside class="phpdocumentor-element-found-in">
  1310. <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>
  1311. :
  1312. <span class="phpdocumentor-element-found-in__line">364</span>
  1313. </aside>
  1314. <p class="phpdocumentor-summary">Draws the format info along the finder patterns</p>
  1315. <code class="phpdocumentor-code phpdocumentor-signature ">
  1316. <span class="phpdocumentor-signature__visibility">public</span>
  1317. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$test</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>
  1318. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  1319. </section>
  1320. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1321. <dl class="phpdocumentor-argument-list">
  1322. <dt class="phpdocumentor-argument-list__entry">
  1323. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1324. : <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>
  1325. </dt>
  1326. <dd class="phpdocumentor-argument-list__definition">
  1327. <section class="phpdocumentor-description"></section>
  1328. </dd>
  1329. <dt class="phpdocumentor-argument-list__entry">
  1330. <span class="phpdocumentor-signature__argument__name">$test</span>
  1331. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1332. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1333. <dd class="phpdocumentor-argument-list__definition">
  1334. <section class="phpdocumentor-description"></section>
  1335. </dd>
  1336. </dl>
  1337. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1338. <span class="phpdocumentor-signature__response_type">self</span>
  1339. &mdash;
  1340. </article>
  1341. <article
  1342. class="phpdocumentor-element
  1343. -method
  1344. -public
  1345. "
  1346. >
  1347. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  1348. setLogoSpace()
  1349. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  1350. </h4>
  1351. <aside class="phpdocumentor-element-found-in">
  1352. <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>
  1353. :
  1354. <span class="phpdocumentor-element-found-in__line">451</span>
  1355. </aside>
  1356. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  1357. <code class="phpdocumentor-code phpdocumentor-signature ">
  1358. <span class="phpdocumentor-signature__visibility">public</span>
  1359. <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 class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </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>
  1360. <section class="phpdocumentor-description"><p>Additionally, the logo space can be positioned within the QR Code - respecting the main functional patterns -
  1361. using $startX and $startY. If either of these are null, the logo space will be centered in that direction.
  1362. ECC level &quot;H&quot; (30%) is required.</p>
  1363. <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
  1364. created images may become unreadable, especially when printed with a chance to receive damage.
  1365. Please test thoroughly before using this feature in production.</p>
  1366. <p>This method should be called from within an output module (after the matrix has been filled with data).
  1367. Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
  1368. </section>
  1369. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1370. <dl class="phpdocumentor-argument-list">
  1371. <dt class="phpdocumentor-argument-list__entry">
  1372. <span class="phpdocumentor-signature__argument__name">$width</span>
  1373. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1374. </dt>
  1375. <dd class="phpdocumentor-argument-list__definition">
  1376. <section class="phpdocumentor-description"></section>
  1377. </dd>
  1378. <dt class="phpdocumentor-argument-list__entry">
  1379. <span class="phpdocumentor-signature__argument__name">$height</span>
  1380. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1381. </dt>
  1382. <dd class="phpdocumentor-argument-list__definition">
  1383. <section class="phpdocumentor-description"></section>
  1384. </dd>
  1385. <dt class="phpdocumentor-argument-list__entry">
  1386. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1387. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1388. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1389. <dd class="phpdocumentor-argument-list__definition">
  1390. <section class="phpdocumentor-description"></section>
  1391. </dd>
  1392. <dt class="phpdocumentor-argument-list__entry">
  1393. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1394. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1395. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1396. <dd class="phpdocumentor-argument-list__definition">
  1397. <section class="phpdocumentor-description"></section>
  1398. </dd>
  1399. </dl>
  1400. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1401. Tags
  1402. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1403. </h5>
  1404. <dl class="phpdocumentor-tag-list">
  1405. <dt class="phpdocumentor-tag-list__entry">
  1406. <span class="phpdocumentor-tag__name">link</span>
  1407. </dt>
  1408. <dd class="phpdocumentor-tag-list__definition">
  1409. <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
  1410. </dd>
  1411. <dt class="phpdocumentor-tag-list__entry">
  1412. <span class="phpdocumentor-tag__name">throws</span>
  1413. </dt>
  1414. <dd class="phpdocumentor-tag-list__definition">
  1415. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1416. </dd>
  1417. </dl>
  1418. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1419. <span class="phpdocumentor-signature__response_type">self</span>
  1420. &mdash;
  1421. </article>
  1422. <article
  1423. class="phpdocumentor-element
  1424. -method
  1425. -public
  1426. "
  1427. >
  1428. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  1429. setQuietZone()
  1430. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  1431. </h4>
  1432. <aside class="phpdocumentor-element-found-in">
  1433. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1434. :
  1435. <span class="phpdocumentor-element-found-in__line">404</span>
  1436. </aside>
  1437. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  1438. <code class="phpdocumentor-code phpdocumentor-signature ">
  1439. <span class="phpdocumentor-signature__visibility">public</span>
  1440. <span class="phpdocumentor-signature__name">setQuietZone</span><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">$size</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1441. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</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">$size</span>
  1447. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1448. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1449. <dd class="phpdocumentor-argument-list__definition">
  1450. <section class="phpdocumentor-description"></section>
  1451. </dd>
  1452. </dl>
  1453. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1454. Tags
  1455. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1456. </h5>
  1457. <dl class="phpdocumentor-tag-list">
  1458. <dt class="phpdocumentor-tag-list__entry">
  1459. <span class="phpdocumentor-tag__name">throws</span>
  1460. </dt>
  1461. <dd class="phpdocumentor-tag-list__definition">
  1462. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1463. </dd>
  1464. </dl>
  1465. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1466. <span class="phpdocumentor-signature__response_type">self</span>
  1467. &mdash;
  1468. </article>
  1469. <article
  1470. class="phpdocumentor-element
  1471. -method
  1472. -public
  1473. "
  1474. >
  1475. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  1476. setSeparators()
  1477. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  1478. </h4>
  1479. <aside class="phpdocumentor-element-found-in">
  1480. <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>
  1481. :
  1482. <span class="phpdocumentor-element-found-in__line">257</span>
  1483. </aside>
  1484. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  1485. <code class="phpdocumentor-code phpdocumentor-signature ">
  1486. <span class="phpdocumentor-signature__visibility">public</span>
  1487. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1488. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  1489. </section>
  1490. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1491. <span class="phpdocumentor-signature__response_type">self</span>
  1492. &mdash;
  1493. </article>
  1494. <article
  1495. class="phpdocumentor-element
  1496. -method
  1497. -public
  1498. "
  1499. >
  1500. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  1501. setTimingPattern()
  1502. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1503. </h4>
  1504. <aside class="phpdocumentor-element-found-in">
  1505. <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>
  1506. :
  1507. <span class="phpdocumentor-element-found-in__line">318</span>
  1508. </aside>
  1509. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  1510. <code class="phpdocumentor-code phpdocumentor-signature ">
  1511. <span class="phpdocumentor-signature__visibility">public</span>
  1512. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1513. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  1514. </section>
  1515. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1516. <span class="phpdocumentor-signature__response_type">self</span>
  1517. &mdash;
  1518. </article>
  1519. <article
  1520. class="phpdocumentor-element
  1521. -method
  1522. -public
  1523. "
  1524. >
  1525. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  1526. setVersionNumber()
  1527. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1528. </h4>
  1529. <aside class="phpdocumentor-element-found-in">
  1530. <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>
  1531. :
  1532. <span class="phpdocumentor-element-found-in__line">340</span>
  1533. </aside>
  1534. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  1535. <code class="phpdocumentor-code phpdocumentor-signature ">
  1536. <span class="phpdocumentor-signature__visibility">public</span>
  1537. <span class="phpdocumentor-signature__name">setVersionNumber</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">$test</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>
  1538. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  1539. </section>
  1540. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1541. <dl class="phpdocumentor-argument-list">
  1542. <dt class="phpdocumentor-argument-list__entry">
  1543. <span class="phpdocumentor-signature__argument__name">$test</span>
  1544. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1545. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1546. <dd class="phpdocumentor-argument-list__definition">
  1547. <section class="phpdocumentor-description"></section>
  1548. </dd>
  1549. </dl>
  1550. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1551. <span class="phpdocumentor-signature__response_type">self</span>
  1552. &mdash;
  1553. </article>
  1554. <article
  1555. class="phpdocumentor-element
  1556. -method
  1557. -public
  1558. "
  1559. >
  1560. <h4 class="phpdocumentor-element__name" id="method_size">
  1561. size()
  1562. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  1563. </h4>
  1564. <aside class="phpdocumentor-element-found-in">
  1565. <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>
  1566. :
  1567. <span class="phpdocumentor-element-found-in__line">157</span>
  1568. </aside>
  1569. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1570. <code class="phpdocumentor-code phpdocumentor-signature ">
  1571. <span class="phpdocumentor-signature__visibility">public</span>
  1572. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1573. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1574. </section>
  1575. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1576. <span class="phpdocumentor-signature__response_type">int</span>
  1577. &mdash;
  1578. </article>
  1579. <article
  1580. class="phpdocumentor-element
  1581. -method
  1582. -public
  1583. "
  1584. >
  1585. <h4 class="phpdocumentor-element__name" id="method_version">
  1586. version()
  1587. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  1588. </h4>
  1589. <aside class="phpdocumentor-element-found-in">
  1590. <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>
  1591. :
  1592. <span class="phpdocumentor-element-found-in__line">134</span>
  1593. </aside>
  1594. <p class="phpdocumentor-summary">Returns the current version number</p>
  1595. <code class="phpdocumentor-code phpdocumentor-signature ">
  1596. <span class="phpdocumentor-signature__visibility">public</span>
  1597. <span class="phpdocumentor-signature__name">version</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span></code>
  1598. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1599. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  1600. &mdash;
  1601. </article>
  1602. </section>
  1603. <script type="text/javascript">
  1604. function loadExternalCodeSnippets(line) {
  1605. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1606. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1607. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1608. var language = 'php';
  1609. var code = document.createElement('code');
  1610. code.className = 'language-' + language;
  1611. pre.textContent = '';
  1612. pre.setAttribute('data-line', line)
  1613. code.textContent = 'Loading…';
  1614. pre.appendChild(code);
  1615. var xhr = new XMLHttpRequest();
  1616. xhr.open('GET', src, true);
  1617. xhr.onreadystatechange = function () {
  1618. if (xhr.readyState == 4) {
  1619. if (xhr.status < 400 && xhr.responseText) {
  1620. code.textContent = xhr.responseText;
  1621. Prism.highlightElement(code);
  1622. }
  1623. else if (xhr.status >= 400) {
  1624. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1625. }
  1626. else {
  1627. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1628. }
  1629. }
  1630. };
  1631. xhr.send(null);
  1632. });
  1633. }
  1634. var modals = document.querySelectorAll("[data-modal]");
  1635. modals.forEach(function (trigger) {
  1636. trigger.addEventListener("click", function (event) {
  1637. //event.preventDefault();
  1638. const modal = document.getElementById(trigger.dataset.modal);
  1639. modal.classList.add("phpdocumentor-modal__open");
  1640. loadExternalCodeSnippets(trigger.dataset.line)
  1641. const exits = modal.querySelectorAll("[data-exit-button]");
  1642. exits.forEach(function (exit) {
  1643. exit.addEventListener("click", function (event) {
  1644. event.preventDefault();
  1645. modal.classList.remove("phpdocumentor-modal__open");
  1646. });
  1647. });
  1648. });
  1649. });
  1650. </script>
  1651. </article>
  1652. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1653. <section class="phpdocumentor-search-results__dialog">
  1654. <header class="phpdocumentor-search-results__header">
  1655. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1656. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1657. </header>
  1658. <section class="phpdocumentor-search-results__body">
  1659. <ul class="phpdocumentor-search-results__entries"></ul>
  1660. </section>
  1661. </section>
  1662. </section>
  1663. </div>
  1664. </div>
  1665. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1666. </main>
  1667. <script>
  1668. cssVars({});
  1669. </script>
  1670. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1671. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1672. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1673. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1674. </body>
  1675. </html>