chillerlan-QRCode-Data-QRMatrix.html 103 KB

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