chillerlan-QRCode-Data-QRMatrix.html 103 KB

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