chillerlan-QRCode-Data-QRMatrix.html 106 KB

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