chillerlan-QRCode-Data-QRMatrix.html 102 KB

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