chillerlan-QRCode-Data-QRMatrix.html 107 KB

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