chillerlan-QRCode-Data-QRMatrix.html 145 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRMatrix
  93. <div class="phpdocumentor-element__package">
  94. in package
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">22</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Holds an array representation of the final QR Code that contains numerical values for later output modifications;
  106. maps the ECC coded binary data and applies the mask pattern</p>
  107. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  108. Tags
  109. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  110. </h5>
  111. <dl class="phpdocumentor-tag-list">
  112. <dt class="phpdocumentor-tag-list__entry">
  113. <span class="phpdocumentor-tag__name">see</span>
  114. </dt>
  115. <dd class="phpdocumentor-tag-list__definition">
  116. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/format-version-information"><abbr title="http://www.thonky.com/qr-code-tutorial/format-version-information">http://www.thonky.com/qr-code-tutorial/format-version-information</abbr></a></span>
  117. </dd>
  118. </dl>
  119. <h3 id="toc">
  120. Table of Contents
  121. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  122. </h3>
  123. <dl class="phpdocumentor-table-of-contents">
  124. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  125. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  126. <span>
  127. &nbsp;= 0b100000000000 </span>
  128. </dt>
  129. <dd></dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  131. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  132. <span>
  133. &nbsp;= 0b10000 </span>
  134. </dt>
  135. <dd></dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  137. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a>
  138. <span>
  139. &nbsp;= 0b100000010000 </span>
  140. </dt>
  141. <dd></dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  143. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  144. <span>
  145. &nbsp;= 0b100000000001 </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  149. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  150. <span>
  151. &nbsp;= 0b10 </span>
  152. </dt>
  153. <dd></dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  155. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a>
  156. <span>
  157. &nbsp;= 0b100000000010 </span>
  158. </dt>
  159. <dd></dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  161. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  162. <span>
  163. &nbsp;= 0b100 </span>
  164. </dt>
  165. <dd></dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  167. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a>
  168. <span>
  169. &nbsp;= 0b100000000100 </span>
  170. </dt>
  171. <dd></dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  173. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  174. <span>
  175. &nbsp;= 0b110000000000 </span>
  176. </dt>
  177. <dd></dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  179. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  180. <span>
  181. &nbsp;= 0b1000000 </span>
  182. </dt>
  183. <dd></dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  185. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a>
  186. <span>
  187. &nbsp;= 0b100001000000 </span>
  188. </dt>
  189. <dd></dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  191. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  192. <span>
  193. &nbsp;= 0b1000000000 </span>
  194. </dt>
  195. <dd></dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  197. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  198. <span>
  199. &nbsp;= 0b0 </span>
  200. </dt>
  201. <dd></dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  203. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  204. <span>
  205. &nbsp;= 0b100000000 </span>
  206. </dt>
  207. <dd></dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  209. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  210. <span>
  211. &nbsp;= 0b1000 </span>
  212. </dt>
  213. <dd></dd>
  214. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  215. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST">M_TEST</a>
  216. <span>
  217. &nbsp;= 0b11111111111 </span>
  218. </dt>
  219. <dd></dd>
  220. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  221. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK">M_TEST_DARK</a>
  222. <span>
  223. &nbsp;= 0b111111111111 </span>
  224. </dt>
  225. <dd></dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  227. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  228. <span>
  229. &nbsp;= 0b100000 </span>
  230. </dt>
  231. <dd></dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  233. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a>
  234. <span>
  235. &nbsp;= 0b100000100000 </span>
  236. </dt>
  237. <dd></dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  239. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  240. <span>
  241. &nbsp;= 0b10000000 </span>
  242. </dt>
  243. <dd></dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  245. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a>
  246. <span>
  247. &nbsp;= 0b100010000000 </span>
  248. </dt>
  249. <dd></dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  251. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a>
  252. <span>
  253. &nbsp;= [0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]] </span>
  254. </dt>
  255. <dd>Map of flag =&gt; coord</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  257. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  258. <span>
  259. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  260. </dt>
  261. <dd>the current ECC level - always set in QRMatrix, may be null in BitMatrix</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  263. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  264. <span>
  265. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  266. </dt>
  267. <dd>the mask pattern that was used in the most recent operation, set via:</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  269. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  270. <span>
  271. &nbsp;: array&lt;string|int, mixed&gt; </span>
  272. </dt>
  273. <dd>the actual matrix data array</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  275. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  276. <span>
  277. &nbsp;: int </span>
  278. </dt>
  279. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  281. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  282. <span>
  283. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  284. </dt>
  285. <dd>the matrix version - always set in QRMatrix, may be null in BitMatrix</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  287. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct">__construct()</a>
  288. <span>
  289. &nbsp;: mixed </span>
  290. </dt>
  291. <dd>QRMatrix constructor.</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  293. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  294. <span>
  295. &nbsp;: bool </span>
  296. </dt>
  297. <dd>Checks whether the module at ($x, $y) is true (dark) or false (light)</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  299. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a>
  300. <span>
  301. &nbsp;: int </span>
  302. </dt>
  303. <dd>Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</dd>
  304. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  305. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  306. <span>
  307. &nbsp;: bool </span>
  308. </dt>
  309. <dd>Checks whether the module at ($x, $y) is of the given $M_TYPE</dd>
  310. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  311. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a>
  312. <span>
  313. &nbsp;: bool </span>
  314. </dt>
  315. <dd>checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  316. returns true if a match is found, otherwise false.</dd>
  317. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  318. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel">eccLevel()</a>
  319. <span>
  320. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  321. </dt>
  322. <dd></dd>
  323. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  324. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  325. <span>
  326. &nbsp;: int </span>
  327. </dt>
  328. <dd>Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</dd>
  329. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  330. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a>
  331. <span>
  332. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  333. </dt>
  334. <dd>Returns the current ECC level</dd>
  335. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  336. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a>
  337. <span>
  338. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  339. </dt>
  340. <dd>Returns the current mask pattern</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  342. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a>
  343. <span>
  344. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  345. </dt>
  346. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  348. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a>
  349. <span>
  350. &nbsp;: int </span>
  351. </dt>
  352. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  354. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a>
  355. <span>
  356. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  357. </dt>
  358. <dd>Returns the current version number</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  360. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
  361. <span>
  362. &nbsp;: self </span>
  363. </dt>
  364. <dd>shortcut to initialize the functional patterns</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  366. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  367. <span>
  368. &nbsp;: self </span>
  369. </dt>
  370. <dd>Applies/reverses the mask pattern</dd>
  371. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  372. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern">maskPattern()</a>
  373. <span>
  374. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  375. </dt>
  376. <dd></dd>
  377. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  378. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix">matrix()</a>
  379. <span>
  380. &nbsp;: array&lt;string|int, mixed&gt; </span>
  381. </dt>
  382. <dd></dd>
  383. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  384. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  385. <span>
  386. &nbsp;: self </span>
  387. </dt>
  388. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  389. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  390. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  391. <span>
  392. &nbsp;: self </span>
  393. </dt>
  394. <dd>Draws the 5x5 alignment patterns</dd>
  395. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  396. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a>
  397. <span>
  398. &nbsp;: self </span>
  399. </dt>
  400. <dd>Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</dd>
  401. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  402. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  403. <span>
  404. &nbsp;: self </span>
  405. </dt>
  406. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  407. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  408. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  409. <span>
  410. &nbsp;: self </span>
  411. </dt>
  412. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  413. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  414. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  415. <span>
  416. &nbsp;: self </span>
  417. </dt>
  418. <dd>Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</dd>
  419. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  420. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  421. <span>
  422. &nbsp;: self </span>
  423. </dt>
  424. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  425. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  426. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone">setQuietZone()</a>
  427. <span>
  428. &nbsp;: self </span>
  429. </dt>
  430. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  431. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  432. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  433. <span>
  434. &nbsp;: self </span>
  435. </dt>
  436. <dd>Draws the separator lines around the finder patterns</dd>
  437. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  438. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  439. <span>
  440. &nbsp;: self </span>
  441. </dt>
  442. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  443. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  444. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  445. <span>
  446. &nbsp;: self </span>
  447. </dt>
  448. <dd>Draws the version information, 2x 3x6 pixel</dd>
  449. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  450. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size">size()</a>
  451. <span>
  452. &nbsp;: int </span>
  453. </dt>
  454. <dd></dd>
  455. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  456. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version">version()</a>
  457. <span>
  458. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  459. </dt>
  460. <dd></dd>
  461. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  462. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  463. <span>
  464. &nbsp;: self </span>
  465. </dt>
  466. <dd>Maps the interleaved binary $data on the matrix</dd>
  467. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  468. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a>
  469. <span>
  470. &nbsp;: array&lt;string|int, mixed&gt; </span>
  471. </dt>
  472. <dd>Creates a 2-dimensional array (square) of the given $size</dd>
  473. </dl>
  474. <section class="phpdocumentor-constants">
  475. <h3 class="phpdocumentor-elements__header" id="constants">
  476. Constants
  477. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  478. </h3>
  479. <article class="phpdocumentor-element -constant -public ">
  480. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  481. IS_DARK
  482. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  483. </h4>
  484. <aside class="phpdocumentor-element-found-in">
  485. <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>
  486. :
  487. <span class="phpdocumentor-element-found-in__line">25</span>
  488. </aside>
  489. <code class="phpdocumentor-signature phpdocumentor-code ">
  490. <span class="phpdocumentor-signature__visibility">public</span>
  491. <span class="phpdocumentor-signature__type">int</span>
  492. <span class="phpdocumentor-signature__name">IS_DARK</span>
  493. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  494. </code>
  495. </article>
  496. <article class="phpdocumentor-element -constant -public ">
  497. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  498. M_ALIGNMENT
  499. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  500. </h4>
  501. <aside class="phpdocumentor-element-found-in">
  502. <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>
  503. :
  504. <span class="phpdocumentor-element-found-in__line">41</span>
  505. </aside>
  506. <code class="phpdocumentor-signature phpdocumentor-code ">
  507. <span class="phpdocumentor-signature__visibility">public</span>
  508. <span class="phpdocumentor-signature__type">int</span>
  509. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  510. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  511. </code>
  512. </article>
  513. <article class="phpdocumentor-element -constant -public ">
  514. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT_DARK">
  515. M_ALIGNMENT_DARK
  516. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h4>
  518. <aside class="phpdocumentor-element-found-in">
  519. <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>
  520. :
  521. <span class="phpdocumentor-element-found-in__line">43</span>
  522. </aside>
  523. <code class="phpdocumentor-signature phpdocumentor-code ">
  524. <span class="phpdocumentor-signature__visibility">public</span>
  525. <span class="phpdocumentor-signature__type">int</span>
  526. <span class="phpdocumentor-signature__name">M_ALIGNMENT_DARK</span>
  527. = <span class="phpdocumentor-signature__default-value">0b100000010000</span>
  528. </code>
  529. </article>
  530. <article class="phpdocumentor-element -constant -public ">
  531. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  532. M_DARKMODULE
  533. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  534. </h4>
  535. <aside class="phpdocumentor-element-found-in">
  536. <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>
  537. :
  538. <span class="phpdocumentor-element-found-in__line">29</span>
  539. </aside>
  540. <code class="phpdocumentor-signature phpdocumentor-code ">
  541. <span class="phpdocumentor-signature__visibility">public</span>
  542. <span class="phpdocumentor-signature__type">int</span>
  543. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  544. = <span class="phpdocumentor-signature__default-value">0b100000000001</span>
  545. </code>
  546. </article>
  547. <article class="phpdocumentor-element -constant -public ">
  548. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  549. M_DATA
  550. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  551. </h4>
  552. <aside class="phpdocumentor-element-found-in">
  553. <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>
  554. :
  555. <span class="phpdocumentor-element-found-in__line">31</span>
  556. </aside>
  557. <code class="phpdocumentor-signature phpdocumentor-code ">
  558. <span class="phpdocumentor-signature__visibility">public</span>
  559. <span class="phpdocumentor-signature__type">int</span>
  560. <span class="phpdocumentor-signature__name">M_DATA</span>
  561. = <span class="phpdocumentor-signature__default-value">0b10</span>
  562. </code>
  563. </article>
  564. <article class="phpdocumentor-element -constant -public ">
  565. <h4 class="phpdocumentor-element__name" id="constant_M_DATA_DARK">
  566. M_DATA_DARK
  567. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  568. </h4>
  569. <aside class="phpdocumentor-element-found-in">
  570. <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>
  571. :
  572. <span class="phpdocumentor-element-found-in__line">33</span>
  573. </aside>
  574. <code class="phpdocumentor-signature phpdocumentor-code ">
  575. <span class="phpdocumentor-signature__visibility">public</span>
  576. <span class="phpdocumentor-signature__type">int</span>
  577. <span class="phpdocumentor-signature__name">M_DATA_DARK</span>
  578. = <span class="phpdocumentor-signature__default-value">0b100000000010</span>
  579. </code>
  580. </article>
  581. <article class="phpdocumentor-element -constant -public ">
  582. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  583. M_FINDER
  584. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  585. </h4>
  586. <aside class="phpdocumentor-element-found-in">
  587. <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>
  588. :
  589. <span class="phpdocumentor-element-found-in__line">35</span>
  590. </aside>
  591. <code class="phpdocumentor-signature phpdocumentor-code ">
  592. <span class="phpdocumentor-signature__visibility">public</span>
  593. <span class="phpdocumentor-signature__type">int</span>
  594. <span class="phpdocumentor-signature__name">M_FINDER</span>
  595. = <span class="phpdocumentor-signature__default-value">0b100</span>
  596. </code>
  597. </article>
  598. <article class="phpdocumentor-element -constant -public ">
  599. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DARK">
  600. M_FINDER_DARK
  601. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  602. </h4>
  603. <aside class="phpdocumentor-element-found-in">
  604. <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>
  605. :
  606. <span class="phpdocumentor-element-found-in__line">37</span>
  607. </aside>
  608. <code class="phpdocumentor-signature phpdocumentor-code ">
  609. <span class="phpdocumentor-signature__visibility">public</span>
  610. <span class="phpdocumentor-signature__type">int</span>
  611. <span class="phpdocumentor-signature__name">M_FINDER_DARK</span>
  612. = <span class="phpdocumentor-signature__default-value">0b100000000100</span>
  613. </code>
  614. </article>
  615. <article class="phpdocumentor-element -constant -public ">
  616. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  617. M_FINDER_DOT
  618. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  619. </h4>
  620. <aside class="phpdocumentor-element-found-in">
  621. <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>
  622. :
  623. <span class="phpdocumentor-element-found-in__line">61</span>
  624. </aside>
  625. <code class="phpdocumentor-signature phpdocumentor-code ">
  626. <span class="phpdocumentor-signature__visibility">public</span>
  627. <span class="phpdocumentor-signature__type">int</span>
  628. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  629. = <span class="phpdocumentor-signature__default-value">0b110000000000</span>
  630. </code>
  631. </article>
  632. <article class="phpdocumentor-element -constant -public ">
  633. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  634. M_FORMAT
  635. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  636. </h4>
  637. <aside class="phpdocumentor-element-found-in">
  638. <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>
  639. :
  640. <span class="phpdocumentor-element-found-in__line">49</span>
  641. </aside>
  642. <code class="phpdocumentor-signature phpdocumentor-code ">
  643. <span class="phpdocumentor-signature__visibility">public</span>
  644. <span class="phpdocumentor-signature__type">int</span>
  645. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  646. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  647. </code>
  648. </article>
  649. <article class="phpdocumentor-element -constant -public ">
  650. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT_DARK">
  651. M_FORMAT_DARK
  652. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  653. </h4>
  654. <aside class="phpdocumentor-element-found-in">
  655. <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>
  656. :
  657. <span class="phpdocumentor-element-found-in__line">51</span>
  658. </aside>
  659. <code class="phpdocumentor-signature phpdocumentor-code ">
  660. <span class="phpdocumentor-signature__visibility">public</span>
  661. <span class="phpdocumentor-signature__type">int</span>
  662. <span class="phpdocumentor-signature__name">M_FORMAT_DARK</span>
  663. = <span class="phpdocumentor-signature__default-value">0b100001000000</span>
  664. </code>
  665. </article>
  666. <article class="phpdocumentor-element -constant -public ">
  667. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  668. M_LOGO
  669. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h4>
  671. <aside class="phpdocumentor-element-found-in">
  672. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  673. :
  674. <span class="phpdocumentor-element-found-in__line">59</span>
  675. </aside>
  676. <code class="phpdocumentor-signature phpdocumentor-code ">
  677. <span class="phpdocumentor-signature__visibility">public</span>
  678. <span class="phpdocumentor-signature__type">int</span>
  679. <span class="phpdocumentor-signature__name">M_LOGO</span>
  680. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  681. </code>
  682. </article>
  683. <article class="phpdocumentor-element -constant -public ">
  684. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  685. M_NULL
  686. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  687. </h4>
  688. <aside class="phpdocumentor-element-found-in">
  689. <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>
  690. :
  691. <span class="phpdocumentor-element-found-in__line">27</span>
  692. </aside>
  693. <code class="phpdocumentor-signature phpdocumentor-code ">
  694. <span class="phpdocumentor-signature__visibility">public</span>
  695. <span class="phpdocumentor-signature__type">int</span>
  696. <span class="phpdocumentor-signature__name">M_NULL</span>
  697. = <span class="phpdocumentor-signature__default-value">0b0</span>
  698. </code>
  699. </article>
  700. <article class="phpdocumentor-element -constant -public ">
  701. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  702. M_QUIETZONE
  703. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  704. </h4>
  705. <aside class="phpdocumentor-element-found-in">
  706. <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>
  707. :
  708. <span class="phpdocumentor-element-found-in__line">57</span>
  709. </aside>
  710. <code class="phpdocumentor-signature phpdocumentor-code ">
  711. <span class="phpdocumentor-signature__visibility">public</span>
  712. <span class="phpdocumentor-signature__type">int</span>
  713. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  714. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  715. </code>
  716. </article>
  717. <article class="phpdocumentor-element -constant -public ">
  718. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  719. M_SEPARATOR
  720. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  721. </h4>
  722. <aside class="phpdocumentor-element-found-in">
  723. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  724. :
  725. <span class="phpdocumentor-element-found-in__line">39</span>
  726. </aside>
  727. <code class="phpdocumentor-signature phpdocumentor-code ">
  728. <span class="phpdocumentor-signature__visibility">public</span>
  729. <span class="phpdocumentor-signature__type">int</span>
  730. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  731. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  732. </code>
  733. </article>
  734. <article class="phpdocumentor-element -constant -public ">
  735. <h4 class="phpdocumentor-element__name" id="constant_M_TEST">
  736. M_TEST
  737. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST" class="headerlink"><i class="fas fa-link"></i></a>
  738. </h4>
  739. <aside class="phpdocumentor-element-found-in">
  740. <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>
  741. :
  742. <span class="phpdocumentor-element-found-in__line">63</span>
  743. </aside>
  744. <code class="phpdocumentor-signature phpdocumentor-code ">
  745. <span class="phpdocumentor-signature__visibility">public</span>
  746. <span class="phpdocumentor-signature__type">int</span>
  747. <span class="phpdocumentor-signature__name">M_TEST</span>
  748. = <span class="phpdocumentor-signature__default-value">0b11111111111</span>
  749. </code>
  750. </article>
  751. <article class="phpdocumentor-element -constant -public ">
  752. <h4 class="phpdocumentor-element__name" id="constant_M_TEST_DARK">
  753. M_TEST_DARK
  754. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TEST_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  755. </h4>
  756. <aside class="phpdocumentor-element-found-in">
  757. <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>
  758. :
  759. <span class="phpdocumentor-element-found-in__line">65</span>
  760. </aside>
  761. <code class="phpdocumentor-signature phpdocumentor-code ">
  762. <span class="phpdocumentor-signature__visibility">public</span>
  763. <span class="phpdocumentor-signature__type">int</span>
  764. <span class="phpdocumentor-signature__name">M_TEST_DARK</span>
  765. = <span class="phpdocumentor-signature__default-value">0b111111111111</span>
  766. </code>
  767. </article>
  768. <article class="phpdocumentor-element -constant -public ">
  769. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  770. M_TIMING
  771. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  772. </h4>
  773. <aside class="phpdocumentor-element-found-in">
  774. <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>
  775. :
  776. <span class="phpdocumentor-element-found-in__line">45</span>
  777. </aside>
  778. <code class="phpdocumentor-signature phpdocumentor-code ">
  779. <span class="phpdocumentor-signature__visibility">public</span>
  780. <span class="phpdocumentor-signature__type">int</span>
  781. <span class="phpdocumentor-signature__name">M_TIMING</span>
  782. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  783. </code>
  784. </article>
  785. <article class="phpdocumentor-element -constant -public ">
  786. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING_DARK">
  787. M_TIMING_DARK
  788. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  789. </h4>
  790. <aside class="phpdocumentor-element-found-in">
  791. <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>
  792. :
  793. <span class="phpdocumentor-element-found-in__line">47</span>
  794. </aside>
  795. <code class="phpdocumentor-signature phpdocumentor-code ">
  796. <span class="phpdocumentor-signature__visibility">public</span>
  797. <span class="phpdocumentor-signature__type">int</span>
  798. <span class="phpdocumentor-signature__name">M_TIMING_DARK</span>
  799. = <span class="phpdocumentor-signature__default-value">0b100000100000</span>
  800. </code>
  801. </article>
  802. <article class="phpdocumentor-element -constant -public ">
  803. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  804. M_VERSION
  805. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  806. </h4>
  807. <aside class="phpdocumentor-element-found-in">
  808. <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>
  809. :
  810. <span class="phpdocumentor-element-found-in__line">53</span>
  811. </aside>
  812. <code class="phpdocumentor-signature phpdocumentor-code ">
  813. <span class="phpdocumentor-signature__visibility">public</span>
  814. <span class="phpdocumentor-signature__type">int</span>
  815. <span class="phpdocumentor-signature__name">M_VERSION</span>
  816. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  817. </code>
  818. </article>
  819. <article class="phpdocumentor-element -constant -public ">
  820. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION_DARK">
  821. M_VERSION_DARK
  822. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  823. </h4>
  824. <aside class="phpdocumentor-element-found-in">
  825. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  826. :
  827. <span class="phpdocumentor-element-found-in__line">55</span>
  828. </aside>
  829. <code class="phpdocumentor-signature phpdocumentor-code ">
  830. <span class="phpdocumentor-signature__visibility">public</span>
  831. <span class="phpdocumentor-signature__type">int</span>
  832. <span class="phpdocumentor-signature__name">M_VERSION_DARK</span>
  833. = <span class="phpdocumentor-signature__default-value">0b100010000000</span>
  834. </code>
  835. </article>
  836. <article class="phpdocumentor-element -constant -protected ">
  837. <h4 class="phpdocumentor-element__name" id="constant_neighbours">
  838. neighbours
  839. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours" class="headerlink"><i class="fas fa-link"></i></a>
  840. </h4>
  841. <aside class="phpdocumentor-element-found-in">
  842. <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>
  843. :
  844. <span class="phpdocumentor-element-found-in__line">74</span>
  845. </aside>
  846. <p class="phpdocumentor-summary">Map of flag =&gt; coord</p>
  847. <code class="phpdocumentor-signature phpdocumentor-code ">
  848. <span class="phpdocumentor-signature__visibility">protected</span>
  849. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  850. <span class="phpdocumentor-signature__name">neighbours</span>
  851. = <span class="phpdocumentor-signature__default-value">[0b1 =&gt; [-1, -1], 0b10 =&gt; [0, -1], 0b100 =&gt; [1, -1], 0b1000 =&gt; [1, 0], 0b10000 =&gt; [1, 1], 0b100000 =&gt; [0, 1], 0b1000000 =&gt; [-1, 1], 0b10000000 =&gt; [-1, 0]]</span>
  852. </code>
  853. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  854. Tags
  855. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  856. </h5>
  857. <dl class="phpdocumentor-tag-list">
  858. <dt class="phpdocumentor-tag-list__entry">
  859. <span class="phpdocumentor-tag__name">see</span>
  860. </dt>
  861. <dd class="phpdocumentor-tag-list__definition">
  862. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours"><abbr title="\chillerlan\QRCode\Data\QRMatrix::checkNeighbours()">QRMatrix::checkNeighbours()</abbr></a></span>
  863. </dd>
  864. </dl>
  865. </article>
  866. </section>
  867. <section class="phpdocumentor-properties">
  868. <h3 class="phpdocumentor-elements__header" id="properties">
  869. Properties
  870. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  871. </h3>
  872. <article
  873. class="
  874. phpdocumentor-element
  875. -property
  876. -protected
  877. "
  878. >
  879. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  880. $eccLevel
  881. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  882. <span class="phpdocumentor-element__modifiers">
  883. </span>
  884. </h4>
  885. <aside class="phpdocumentor-element-found-in">
  886. <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>
  887. :
  888. <span class="phpdocumentor-element-found-in__line">93</span>
  889. </aside>
  890. <p class="phpdocumentor-summary">the current ECC level - always set in QRMatrix, may be null in BitMatrix</p>
  891. <code class="phpdocumentor-code phpdocumentor-signature ">
  892. <span class="phpdocumentor-signature__visibility">protected</span>
  893. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  894. <span class="phpdocumentor-signature__name">$eccLevel</span>
  895. = <span class="phpdocumentor-signature__default-value">null</span></code>
  896. <section class="phpdocumentor-description"></section>
  897. </article>
  898. <article
  899. class="
  900. phpdocumentor-element
  901. -property
  902. -protected
  903. "
  904. >
  905. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  906. $maskPattern
  907. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  908. <span class="phpdocumentor-element__modifiers">
  909. </span>
  910. </h4>
  911. <aside class="phpdocumentor-element-found-in">
  912. <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>
  913. :
  914. <span class="phpdocumentor-element-found-in__line">102</span>
  915. </aside>
  916. <p class="phpdocumentor-summary">the mask pattern that was used in the most recent operation, set via:</p>
  917. <code class="phpdocumentor-code phpdocumentor-signature ">
  918. <span class="phpdocumentor-signature__visibility">protected</span>
  919. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  920. <span class="phpdocumentor-signature__name">$maskPattern</span>
  921. = <span class="phpdocumentor-signature__default-value">null</span></code>
  922. <section class="phpdocumentor-description"><ul>
  923. <li>QRMatrix::setFormatInfo()</li>
  924. <li>QRMatrix::mask()</li>
  925. <li>BitMatrix::readFormatInformation()</li>
  926. </ul>
  927. </section>
  928. <section class="phpdocumentor-description"></section>
  929. </article>
  930. <article
  931. class="
  932. phpdocumentor-element
  933. -property
  934. -protected
  935. "
  936. >
  937. <h4 class="phpdocumentor-element__name" id="property_matrix">
  938. $matrix
  939. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  940. <span class="phpdocumentor-element__modifiers">
  941. </span>
  942. </h4>
  943. <aside class="phpdocumentor-element-found-in">
  944. <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>
  945. :
  946. <span class="phpdocumentor-element-found-in__line">114</span>
  947. </aside>
  948. <p class="phpdocumentor-summary">the actual matrix data array</p>
  949. <code class="phpdocumentor-code phpdocumentor-signature ">
  950. <span class="phpdocumentor-signature__visibility">protected</span>
  951. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  952. <span class="phpdocumentor-signature__name">$matrix</span>
  953. </code>
  954. </article>
  955. <article
  956. class="
  957. phpdocumentor-element
  958. -property
  959. -protected
  960. "
  961. >
  962. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  963. $moduleCount
  964. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  965. <span class="phpdocumentor-element__modifiers">
  966. </span>
  967. </h4>
  968. <aside class="phpdocumentor-element-found-in">
  969. <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>
  970. :
  971. <span class="phpdocumentor-element-found-in__line">107</span>
  972. </aside>
  973. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  974. <code class="phpdocumentor-code phpdocumentor-signature ">
  975. <span class="phpdocumentor-signature__visibility">protected</span>
  976. <span class="phpdocumentor-signature__type">int</span>
  977. <span class="phpdocumentor-signature__name">$moduleCount</span>
  978. </code>
  979. <section class="phpdocumentor-description"></section>
  980. </article>
  981. <article
  982. class="
  983. phpdocumentor-element
  984. -property
  985. -protected
  986. "
  987. >
  988. <h4 class="phpdocumentor-element__name" id="property_version">
  989. $version
  990. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  991. <span class="phpdocumentor-element__modifiers">
  992. </span>
  993. </h4>
  994. <aside class="phpdocumentor-element-found-in">
  995. <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>
  996. :
  997. <span class="phpdocumentor-element-found-in__line">88</span>
  998. </aside>
  999. <p class="phpdocumentor-summary">the matrix version - always set in QRMatrix, may be null in BitMatrix</p>
  1000. <code class="phpdocumentor-code phpdocumentor-signature ">
  1001. <span class="phpdocumentor-signature__visibility">protected</span>
  1002. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1003. <span class="phpdocumentor-signature__name">$version</span>
  1004. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1005. <section class="phpdocumentor-description"></section>
  1006. </article>
  1007. </section>
  1008. <section class="phpdocumentor-methods">
  1009. <h3 class="phpdocumentor-elements__header" id="methods">
  1010. Methods
  1011. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1012. </h3>
  1013. <article
  1014. class="phpdocumentor-element
  1015. -method
  1016. -public
  1017. "
  1018. >
  1019. <h4 class="phpdocumentor-element__name" id="method___construct">
  1020. __construct()
  1021. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1022. </h4>
  1023. <aside class="phpdocumentor-element-found-in">
  1024. <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>
  1025. :
  1026. <span class="phpdocumentor-element-found-in__line">119</span>
  1027. </aside>
  1028. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  1029. <code class="phpdocumentor-code phpdocumentor-signature ">
  1030. <span class="phpdocumentor-signature__visibility">public</span>
  1031. <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>
  1032. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1033. <dl class="phpdocumentor-argument-list">
  1034. <dt class="phpdocumentor-argument-list__entry">
  1035. <span class="phpdocumentor-signature__argument__name">$version</span>
  1036. : <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>
  1037. </dt>
  1038. <dd class="phpdocumentor-argument-list__definition">
  1039. <section class="phpdocumentor-description"></section>
  1040. </dd>
  1041. <dt class="phpdocumentor-argument-list__entry">
  1042. <span class="phpdocumentor-signature__argument__name">$eccLevel</span>
  1043. : <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>
  1044. </dt>
  1045. <dd class="phpdocumentor-argument-list__definition">
  1046. <section class="phpdocumentor-description"></section>
  1047. </dd>
  1048. </dl>
  1049. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1050. <span class="phpdocumentor-signature__response_type">mixed</span>
  1051. &mdash;
  1052. </article>
  1053. <article
  1054. class="phpdocumentor-element
  1055. -method
  1056. -public
  1057. "
  1058. >
  1059. <h4 class="phpdocumentor-element__name" id="method_check">
  1060. check()
  1061. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  1062. </h4>
  1063. <aside class="phpdocumentor-element-found-in">
  1064. <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>
  1065. :
  1066. <span class="phpdocumentor-element-found-in__line">318</span>
  1067. </aside>
  1068. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is true (dark) or false (light)</p>
  1069. <code class="phpdocumentor-code phpdocumentor-signature ">
  1070. <span class="phpdocumentor-signature__visibility">public</span>
  1071. <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>
  1072. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1073. <dl class="phpdocumentor-argument-list">
  1074. <dt class="phpdocumentor-argument-list__entry">
  1075. <span class="phpdocumentor-signature__argument__name">$x</span>
  1076. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1077. </dt>
  1078. <dd class="phpdocumentor-argument-list__definition">
  1079. <section class="phpdocumentor-description"></section>
  1080. </dd>
  1081. <dt class="phpdocumentor-argument-list__entry">
  1082. <span class="phpdocumentor-signature__argument__name">$y</span>
  1083. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1084. </dt>
  1085. <dd class="phpdocumentor-argument-list__definition">
  1086. <section class="phpdocumentor-description"></section>
  1087. </dd>
  1088. </dl>
  1089. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1090. <span class="phpdocumentor-signature__response_type">bool</span>
  1091. &mdash;
  1092. </article>
  1093. <article
  1094. class="phpdocumentor-element
  1095. -method
  1096. -public
  1097. "
  1098. >
  1099. <h4 class="phpdocumentor-element__name" id="method_checkNeighbours">
  1100. checkNeighbours()
  1101. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1102. </h4>
  1103. <aside class="phpdocumentor-element-found-in">
  1104. <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>
  1105. :
  1106. <span class="phpdocumentor-element-found-in__line">332</span>
  1107. </aside>
  1108. <p class="phpdocumentor-summary">Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</p>
  1109. <code class="phpdocumentor-code phpdocumentor-signature ">
  1110. <span class="phpdocumentor-signature__visibility">public</span>
  1111. <span class="phpdocumentor-signature__name">checkNeighbours</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>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</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">int</span></code>
  1112. <section class="phpdocumentor-description"><p>The 8 flags of the bitmask represent the status of each of the neighbouring fields,
  1113. starting with the lowest bit for top left, going clockwise:</p>
  1114. <p>1 2 3
  1115. 8 # 4
  1116. 7 6 5</p>
  1117. </section>
  1118. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1119. <dl class="phpdocumentor-argument-list">
  1120. <dt class="phpdocumentor-argument-list__entry">
  1121. <span class="phpdocumentor-signature__argument__name">$x</span>
  1122. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1123. </dt>
  1124. <dd class="phpdocumentor-argument-list__definition">
  1125. <section class="phpdocumentor-description"></section>
  1126. </dd>
  1127. <dt class="phpdocumentor-argument-list__entry">
  1128. <span class="phpdocumentor-signature__argument__name">$y</span>
  1129. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1130. </dt>
  1131. <dd class="phpdocumentor-argument-list__definition">
  1132. <section class="phpdocumentor-description"></section>
  1133. </dd>
  1134. <dt class="phpdocumentor-argument-list__entry">
  1135. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1136. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1137. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1138. <dd class="phpdocumentor-argument-list__definition">
  1139. <section class="phpdocumentor-description"></section>
  1140. </dd>
  1141. </dl>
  1142. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1143. <span class="phpdocumentor-signature__response_type">int</span>
  1144. &mdash;
  1145. </article>
  1146. <article
  1147. class="phpdocumentor-element
  1148. -method
  1149. -public
  1150. "
  1151. >
  1152. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1153. checkType()
  1154. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1155. </h4>
  1156. <aside class="phpdocumentor-element-found-in">
  1157. <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>
  1158. :
  1159. <span class="phpdocumentor-element-found-in__line">290</span>
  1160. </aside>
  1161. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is of the given $M_TYPE</p>
  1162. <code class="phpdocumentor-code phpdocumentor-signature ">
  1163. <span class="phpdocumentor-signature__visibility">public</span>
  1164. <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>
  1165. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1166. </section>
  1167. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1168. <dl class="phpdocumentor-argument-list">
  1169. <dt class="phpdocumentor-argument-list__entry">
  1170. <span class="phpdocumentor-signature__argument__name">$x</span>
  1171. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1172. </dt>
  1173. <dd class="phpdocumentor-argument-list__definition">
  1174. <section class="phpdocumentor-description"></section>
  1175. </dd>
  1176. <dt class="phpdocumentor-argument-list__entry">
  1177. <span class="phpdocumentor-signature__argument__name">$y</span>
  1178. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1179. </dt>
  1180. <dd class="phpdocumentor-argument-list__definition">
  1181. <section class="phpdocumentor-description"></section>
  1182. </dd>
  1183. <dt class="phpdocumentor-argument-list__entry">
  1184. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1185. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1186. </dt>
  1187. <dd class="phpdocumentor-argument-list__definition">
  1188. <section class="phpdocumentor-description"></section>
  1189. </dd>
  1190. </dl>
  1191. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1192. <span class="phpdocumentor-signature__response_type">bool</span>
  1193. &mdash;
  1194. </article>
  1195. <article
  1196. class="phpdocumentor-element
  1197. -method
  1198. -public
  1199. "
  1200. >
  1201. <h4 class="phpdocumentor-element__name" id="method_checkTypeIn">
  1202. checkTypeIn()
  1203. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" class="headerlink"><i class="fas fa-link"></i></a>
  1204. </h4>
  1205. <aside class="phpdocumentor-element-found-in">
  1206. <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>
  1207. :
  1208. <span class="phpdocumentor-element-found-in__line">304</span>
  1209. </aside>
  1210. <p class="phpdocumentor-summary">checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  1211. returns true if a match is found, otherwise false.</p>
  1212. <code class="phpdocumentor-code phpdocumentor-signature ">
  1213. <span class="phpdocumentor-signature__visibility">public</span>
  1214. <span class="phpdocumentor-signature__name">checkTypeIn</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>
  1215. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1216. <dl class="phpdocumentor-argument-list">
  1217. <dt class="phpdocumentor-argument-list__entry">
  1218. <span class="phpdocumentor-signature__argument__name">$x</span>
  1219. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1220. </dt>
  1221. <dd class="phpdocumentor-argument-list__definition">
  1222. <section class="phpdocumentor-description"></section>
  1223. </dd>
  1224. <dt class="phpdocumentor-argument-list__entry">
  1225. <span class="phpdocumentor-signature__argument__name">$y</span>
  1226. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1227. </dt>
  1228. <dd class="phpdocumentor-argument-list__definition">
  1229. <section class="phpdocumentor-description"></section>
  1230. </dd>
  1231. <dt class="phpdocumentor-argument-list__entry">
  1232. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1233. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1234. </dt>
  1235. <dd class="phpdocumentor-argument-list__definition">
  1236. <section class="phpdocumentor-description"></section>
  1237. </dd>
  1238. </dl>
  1239. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1240. <span class="phpdocumentor-signature__response_type">bool</span>
  1241. &mdash;
  1242. </article>
  1243. <article
  1244. class="phpdocumentor-element
  1245. -method
  1246. -public
  1247. -deprecated "
  1248. >
  1249. <h4 class="phpdocumentor-element__name" id="method_eccLevel">
  1250. eccLevel()
  1251. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1252. </h4>
  1253. <aside class="phpdocumentor-element-found-in">
  1254. <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>
  1255. :
  1256. <span class="phpdocumentor-element-found-in__line">206</span>
  1257. </aside>
  1258. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1259. <span class="phpdocumentor-signature__visibility">public</span>
  1260. <span class="phpdocumentor-signature__name">eccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span></code>
  1261. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1262. Tags
  1263. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1264. </h5>
  1265. <dl class="phpdocumentor-tag-list">
  1266. <dt class="phpdocumentor-tag-list__entry">
  1267. <span class="phpdocumentor-tag__name">deprecated</span>
  1268. </dt>
  1269. <dd class="phpdocumentor-tag-list__definition">
  1270. <span class="phpdocumentor-tag-link">5.0.0</span>
  1271. <section class="phpdocumentor-description"><p>use QRMatrix::getEccLevel() instead</p>
  1272. </section>
  1273. </dd>
  1274. <dt class="phpdocumentor-tag-list__entry">
  1275. <span class="phpdocumentor-tag__name">see</span>
  1276. </dt>
  1277. <dd class="phpdocumentor-tag-list__definition">
  1278. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getEccLevel()">QRMatrix::getEccLevel()</abbr></a></span>
  1279. </dd>
  1280. <dt class="phpdocumentor-tag-list__entry">
  1281. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1282. </dt>
  1283. <dd class="phpdocumentor-tag-list__definition">
  1284. </dd>
  1285. </dl>
  1286. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1287. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1288. &mdash;
  1289. </article>
  1290. <article
  1291. class="phpdocumentor-element
  1292. -method
  1293. -public
  1294. "
  1295. >
  1296. <h4 class="phpdocumentor-element__name" id="method_get">
  1297. get()
  1298. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1299. </h4>
  1300. <aside class="phpdocumentor-element-found-in">
  1301. <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>
  1302. :
  1303. <span class="phpdocumentor-element-found-in__line">247</span>
  1304. </aside>
  1305. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</p>
  1306. <code class="phpdocumentor-code phpdocumentor-signature ">
  1307. <span class="phpdocumentor-signature__visibility">public</span>
  1308. <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>
  1309. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1310. <dl class="phpdocumentor-argument-list">
  1311. <dt class="phpdocumentor-argument-list__entry">
  1312. <span class="phpdocumentor-signature__argument__name">$x</span>
  1313. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1314. </dt>
  1315. <dd class="phpdocumentor-argument-list__definition">
  1316. <section class="phpdocumentor-description"></section>
  1317. </dd>
  1318. <dt class="phpdocumentor-argument-list__entry">
  1319. <span class="phpdocumentor-signature__argument__name">$y</span>
  1320. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1321. </dt>
  1322. <dd class="phpdocumentor-argument-list__definition">
  1323. <section class="phpdocumentor-description"></section>
  1324. </dd>
  1325. </dl>
  1326. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1327. <span class="phpdocumentor-signature__response_type">int</span>
  1328. &mdash;
  1329. </article>
  1330. <article
  1331. class="phpdocumentor-element
  1332. -method
  1333. -public
  1334. "
  1335. >
  1336. <h4 class="phpdocumentor-element__name" id="method_getEccLevel">
  1337. getEccLevel()
  1338. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1339. </h4>
  1340. <aside class="phpdocumentor-element-found-in">
  1341. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1342. :
  1343. <span class="phpdocumentor-element-found-in__line">197</span>
  1344. </aside>
  1345. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1346. <code class="phpdocumentor-code phpdocumentor-signature ">
  1347. <span class="phpdocumentor-signature__visibility">public</span>
  1348. <span class="phpdocumentor-signature__name">getEccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span></code>
  1349. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1350. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1351. &mdash;
  1352. </article>
  1353. <article
  1354. class="phpdocumentor-element
  1355. -method
  1356. -public
  1357. "
  1358. >
  1359. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  1360. getMaskPattern()
  1361. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1362. </h4>
  1363. <aside class="phpdocumentor-element-found-in">
  1364. <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>
  1365. :
  1366. <span class="phpdocumentor-element-found-in__line">213</span>
  1367. </aside>
  1368. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1369. <code class="phpdocumentor-code phpdocumentor-signature ">
  1370. <span class="phpdocumentor-signature__visibility">public</span>
  1371. <span class="phpdocumentor-signature__name">getMaskPattern</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>
  1372. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1373. <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>
  1374. &mdash;
  1375. </article>
  1376. <article
  1377. class="phpdocumentor-element
  1378. -method
  1379. -public
  1380. "
  1381. >
  1382. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1383. getMatrix()
  1384. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix" 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">153</span>
  1390. </aside>
  1391. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1392. <code class="phpdocumentor-code phpdocumentor-signature ">
  1393. <span class="phpdocumentor-signature__visibility">public</span>
  1394. <span class="phpdocumentor-signature__name">getMatrix</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">null</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>
  1395. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1396. <dl class="phpdocumentor-argument-list">
  1397. <dt class="phpdocumentor-argument-list__entry">
  1398. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1399. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1400. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1401. <dd class="phpdocumentor-argument-list__definition">
  1402. <section class="phpdocumentor-description"></section>
  1403. </dd>
  1404. </dl>
  1405. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1406. <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>
  1407. &mdash;
  1408. </article>
  1409. <article
  1410. class="phpdocumentor-element
  1411. -method
  1412. -public
  1413. "
  1414. >
  1415. <h4 class="phpdocumentor-element__name" id="method_getSize">
  1416. getSize()
  1417. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize" class="headerlink"><i class="fas fa-link"></i></a>
  1418. </h4>
  1419. <aside class="phpdocumentor-element-found-in">
  1420. <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>
  1421. :
  1422. <span class="phpdocumentor-element-found-in__line">231</span>
  1423. </aside>
  1424. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1425. <code class="phpdocumentor-code phpdocumentor-signature ">
  1426. <span class="phpdocumentor-signature__visibility">public</span>
  1427. <span class="phpdocumentor-signature__name">getSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1428. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1429. </section>
  1430. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1431. <span class="phpdocumentor-signature__response_type">int</span>
  1432. &mdash;
  1433. </article>
  1434. <article
  1435. class="phpdocumentor-element
  1436. -method
  1437. -public
  1438. "
  1439. >
  1440. <h4 class="phpdocumentor-element__name" id="method_getVersion">
  1441. getVersion()
  1442. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
  1443. </h4>
  1444. <aside class="phpdocumentor-element-found-in">
  1445. <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>
  1446. :
  1447. <span class="phpdocumentor-element-found-in__line">181</span>
  1448. </aside>
  1449. <p class="phpdocumentor-summary">Returns the current version number</p>
  1450. <code class="phpdocumentor-code phpdocumentor-signature ">
  1451. <span class="phpdocumentor-signature__visibility">public</span>
  1452. <span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  1453. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1454. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1455. &mdash;
  1456. </article>
  1457. <article
  1458. class="phpdocumentor-element
  1459. -method
  1460. -public
  1461. "
  1462. >
  1463. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1464. initFunctionalPatterns()
  1465. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1466. </h4>
  1467. <aside class="phpdocumentor-element-found-in">
  1468. <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>
  1469. :
  1470. <span class="phpdocumentor-element-found-in__line">136</span>
  1471. </aside>
  1472. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1473. <code class="phpdocumentor-code phpdocumentor-signature ">
  1474. <span class="phpdocumentor-signature__visibility">public</span>
  1475. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1476. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1477. <span class="phpdocumentor-signature__response_type">self</span>
  1478. &mdash;
  1479. </article>
  1480. <article
  1481. class="phpdocumentor-element
  1482. -method
  1483. -public
  1484. "
  1485. >
  1486. <h4 class="phpdocumentor-element__name" id="method_mask">
  1487. mask()
  1488. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1489. </h4>
  1490. <aside class="phpdocumentor-element-found-in">
  1491. <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>
  1492. :
  1493. <span class="phpdocumentor-element-found-in__line">703</span>
  1494. </aside>
  1495. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1496. <code class="phpdocumentor-code phpdocumentor-signature ">
  1497. <span class="phpdocumentor-signature__visibility">public</span>
  1498. <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>
  1499. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1500. </section>
  1501. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1502. <dl class="phpdocumentor-argument-list">
  1503. <dt class="phpdocumentor-argument-list__entry">
  1504. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1505. : <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>
  1506. </dt>
  1507. <dd class="phpdocumentor-argument-list__definition">
  1508. <section class="phpdocumentor-description"></section>
  1509. </dd>
  1510. </dl>
  1511. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1512. <span class="phpdocumentor-signature__response_type">self</span>
  1513. &mdash;
  1514. </article>
  1515. <article
  1516. class="phpdocumentor-element
  1517. -method
  1518. -public
  1519. -deprecated "
  1520. >
  1521. <h4 class="phpdocumentor-element__name" id="method_maskPattern">
  1522. maskPattern()
  1523. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1524. </h4>
  1525. <aside class="phpdocumentor-element-found-in">
  1526. <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>
  1527. :
  1528. <span class="phpdocumentor-element-found-in__line">222</span>
  1529. </aside>
  1530. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1531. <span class="phpdocumentor-signature__visibility">public</span>
  1532. <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>
  1533. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1534. Tags
  1535. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1536. </h5>
  1537. <dl class="phpdocumentor-tag-list">
  1538. <dt class="phpdocumentor-tag-list__entry">
  1539. <span class="phpdocumentor-tag__name">deprecated</span>
  1540. </dt>
  1541. <dd class="phpdocumentor-tag-list__definition">
  1542. <span class="phpdocumentor-tag-link">5.0.0</span>
  1543. <section class="phpdocumentor-description"><p>use QRMatrix::getMaskPattern() instead</p>
  1544. </section>
  1545. </dd>
  1546. <dt class="phpdocumentor-tag-list__entry">
  1547. <span class="phpdocumentor-tag__name">see</span>
  1548. </dt>
  1549. <dd class="phpdocumentor-tag-list__definition">
  1550. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMaskPattern()">QRMatrix::getMaskPattern()</abbr></a></span>
  1551. </dd>
  1552. <dt class="phpdocumentor-tag-list__entry">
  1553. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1554. </dt>
  1555. <dd class="phpdocumentor-tag-list__definition">
  1556. </dd>
  1557. </dl>
  1558. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1559. <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>
  1560. &mdash;
  1561. </article>
  1562. <article
  1563. class="phpdocumentor-element
  1564. -method
  1565. -public
  1566. -deprecated "
  1567. >
  1568. <h4 class="phpdocumentor-element__name" id="method_matrix">
  1569. matrix()
  1570. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1571. </h4>
  1572. <aside class="phpdocumentor-element-found-in">
  1573. <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>
  1574. :
  1575. <span class="phpdocumentor-element-found-in__line">174</span>
  1576. </aside>
  1577. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1578. <span class="phpdocumentor-signature__visibility">public</span>
  1579. <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">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1580. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1581. <dl class="phpdocumentor-argument-list">
  1582. <dt class="phpdocumentor-argument-list__entry">
  1583. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1584. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1585. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1586. <dd class="phpdocumentor-argument-list__definition">
  1587. <section class="phpdocumentor-description"></section>
  1588. </dd>
  1589. </dl>
  1590. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1591. Tags
  1592. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1593. </h5>
  1594. <dl class="phpdocumentor-tag-list">
  1595. <dt class="phpdocumentor-tag-list__entry">
  1596. <span class="phpdocumentor-tag__name">deprecated</span>
  1597. </dt>
  1598. <dd class="phpdocumentor-tag-list__definition">
  1599. <span class="phpdocumentor-tag-link">5.0.0</span>
  1600. <section class="phpdocumentor-description"><p>use QRMatrix::getMatrix() instead</p>
  1601. </section>
  1602. </dd>
  1603. <dt class="phpdocumentor-tag-list__entry">
  1604. <span class="phpdocumentor-tag__name">see</span>
  1605. </dt>
  1606. <dd class="phpdocumentor-tag-list__definition">
  1607. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getMatrix()">QRMatrix::getMatrix()</abbr></a></span>
  1608. </dd>
  1609. <dt class="phpdocumentor-tag-list__entry">
  1610. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1611. </dt>
  1612. <dd class="phpdocumentor-tag-list__definition">
  1613. </dd>
  1614. </dl>
  1615. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1616. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1617. &mdash;
  1618. </article>
  1619. <article
  1620. class="phpdocumentor-element
  1621. -method
  1622. -public
  1623. "
  1624. >
  1625. <h4 class="phpdocumentor-element__name" id="method_set">
  1626. set()
  1627. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  1628. </h4>
  1629. <aside class="phpdocumentor-element-found-in">
  1630. <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>
  1631. :
  1632. <span class="phpdocumentor-element-found-in__line">262</span>
  1633. </aside>
  1634. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  1635. <code class="phpdocumentor-code phpdocumentor-signature ">
  1636. <span class="phpdocumentor-signature__visibility">public</span>
  1637. <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>
  1638. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  1639. false =&gt; $M_TYPE</p>
  1640. </section>
  1641. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1642. <dl class="phpdocumentor-argument-list">
  1643. <dt class="phpdocumentor-argument-list__entry">
  1644. <span class="phpdocumentor-signature__argument__name">$x</span>
  1645. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1646. </dt>
  1647. <dd class="phpdocumentor-argument-list__definition">
  1648. <section class="phpdocumentor-description"></section>
  1649. </dd>
  1650. <dt class="phpdocumentor-argument-list__entry">
  1651. <span class="phpdocumentor-signature__argument__name">$y</span>
  1652. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1653. </dt>
  1654. <dd class="phpdocumentor-argument-list__definition">
  1655. <section class="phpdocumentor-description"></section>
  1656. </dd>
  1657. <dt class="phpdocumentor-argument-list__entry">
  1658. <span class="phpdocumentor-signature__argument__name">$value</span>
  1659. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1660. </dt>
  1661. <dd class="phpdocumentor-argument-list__definition">
  1662. <section class="phpdocumentor-description"></section>
  1663. </dd>
  1664. <dt class="phpdocumentor-argument-list__entry">
  1665. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1666. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1667. </dt>
  1668. <dd class="phpdocumentor-argument-list__definition">
  1669. <section class="phpdocumentor-description"></section>
  1670. </dd>
  1671. </dl>
  1672. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1673. <span class="phpdocumentor-signature__response_type">self</span>
  1674. &mdash;
  1675. </article>
  1676. <article
  1677. class="phpdocumentor-element
  1678. -method
  1679. -public
  1680. "
  1681. >
  1682. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  1683. setAlignmentPattern()
  1684. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1685. </h4>
  1686. <aside class="phpdocumentor-element-found-in">
  1687. <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>
  1688. :
  1689. <span class="phpdocumentor-element-found-in__line">424</span>
  1690. </aside>
  1691. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  1692. <code class="phpdocumentor-code phpdocumentor-signature ">
  1693. <span class="phpdocumentor-signature__visibility">public</span>
  1694. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1695. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  1696. </section>
  1697. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1698. <span class="phpdocumentor-signature__response_type">self</span>
  1699. &mdash;
  1700. </article>
  1701. <article
  1702. class="phpdocumentor-element
  1703. -method
  1704. -public
  1705. "
  1706. >
  1707. <h4 class="phpdocumentor-element__name" id="method_setArea">
  1708. setArea()
  1709. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea" class="headerlink"><i class="fas fa-link"></i></a>
  1710. </h4>
  1711. <aside class="phpdocumentor-element-found-in">
  1712. <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>
  1713. :
  1714. <span class="phpdocumentor-element-found-in__line">274</span>
  1715. </aside>
  1716. <p class="phpdocumentor-summary">Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</p>
  1717. <code class="phpdocumentor-code phpdocumentor-signature ">
  1718. <span class="phpdocumentor-signature__visibility">public</span>
  1719. <span class="phpdocumentor-signature__name">setArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startX</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">$startY</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">$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 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>
  1720. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1721. <dl class="phpdocumentor-argument-list">
  1722. <dt class="phpdocumentor-argument-list__entry">
  1723. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1724. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1725. </dt>
  1726. <dd class="phpdocumentor-argument-list__definition">
  1727. <section class="phpdocumentor-description"></section>
  1728. </dd>
  1729. <dt class="phpdocumentor-argument-list__entry">
  1730. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1731. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1732. </dt>
  1733. <dd class="phpdocumentor-argument-list__definition">
  1734. <section class="phpdocumentor-description"></section>
  1735. </dd>
  1736. <dt class="phpdocumentor-argument-list__entry">
  1737. <span class="phpdocumentor-signature__argument__name">$width</span>
  1738. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1739. </dt>
  1740. <dd class="phpdocumentor-argument-list__definition">
  1741. <section class="phpdocumentor-description"></section>
  1742. </dd>
  1743. <dt class="phpdocumentor-argument-list__entry">
  1744. <span class="phpdocumentor-signature__argument__name">$height</span>
  1745. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1746. </dt>
  1747. <dd class="phpdocumentor-argument-list__definition">
  1748. <section class="phpdocumentor-description"></section>
  1749. </dd>
  1750. <dt class="phpdocumentor-argument-list__entry">
  1751. <span class="phpdocumentor-signature__argument__name">$value</span>
  1752. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1753. </dt>
  1754. <dd class="phpdocumentor-argument-list__definition">
  1755. <section class="phpdocumentor-description"></section>
  1756. </dd>
  1757. <dt class="phpdocumentor-argument-list__entry">
  1758. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1759. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1760. </dt>
  1761. <dd class="phpdocumentor-argument-list__definition">
  1762. <section class="phpdocumentor-description"></section>
  1763. </dd>
  1764. </dl>
  1765. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1766. <span class="phpdocumentor-signature__response_type">self</span>
  1767. &mdash;
  1768. </article>
  1769. <article
  1770. class="phpdocumentor-element
  1771. -method
  1772. -public
  1773. "
  1774. >
  1775. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  1776. setDarkModule()
  1777. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  1778. </h4>
  1779. <aside class="phpdocumentor-element-found-in">
  1780. <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>
  1781. :
  1782. <span class="phpdocumentor-element-found-in__line">359</span>
  1783. </aside>
  1784. <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>
  1785. <code class="phpdocumentor-code phpdocumentor-signature ">
  1786. <span class="phpdocumentor-signature__visibility">public</span>
  1787. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1788. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  1789. </section>
  1790. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1791. <span class="phpdocumentor-signature__response_type">self</span>
  1792. &mdash;
  1793. </article>
  1794. <article
  1795. class="phpdocumentor-element
  1796. -method
  1797. -public
  1798. "
  1799. >
  1800. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  1801. setFinderPattern()
  1802. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1803. </h4>
  1804. <aside class="phpdocumentor-element-found-in">
  1805. <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>
  1806. :
  1807. <span class="phpdocumentor-element-found-in__line">370</span>
  1808. </aside>
  1809. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  1810. <code class="phpdocumentor-code phpdocumentor-signature ">
  1811. <span class="phpdocumentor-signature__visibility">public</span>
  1812. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1813. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  1814. </section>
  1815. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1816. <span class="phpdocumentor-signature__response_type">self</span>
  1817. &mdash;
  1818. </article>
  1819. <article
  1820. class="phpdocumentor-element
  1821. -method
  1822. -public
  1823. "
  1824. >
  1825. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  1826. setFormatInfo()
  1827. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  1828. </h4>
  1829. <aside class="phpdocumentor-element-found-in">
  1830. <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>
  1831. :
  1832. <span class="phpdocumentor-element-found-in__line">499</span>
  1833. </aside>
  1834. <p class="phpdocumentor-summary">Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</p>
  1835. <code class="phpdocumentor-code phpdocumentor-signature ">
  1836. <span class="phpdocumentor-signature__visibility">public</span>
  1837. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1838. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  1839. </section>
  1840. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1841. <dl class="phpdocumentor-argument-list">
  1842. <dt class="phpdocumentor-argument-list__entry">
  1843. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1844. : <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>
  1845. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1846. <dd class="phpdocumentor-argument-list__definition">
  1847. <section class="phpdocumentor-description"></section>
  1848. </dd>
  1849. </dl>
  1850. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1851. <span class="phpdocumentor-signature__response_type">self</span>
  1852. &mdash;
  1853. </article>
  1854. <article
  1855. class="phpdocumentor-element
  1856. -method
  1857. -public
  1858. "
  1859. >
  1860. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  1861. setLogoSpace()
  1862. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  1863. </h4>
  1864. <aside class="phpdocumentor-element-found-in">
  1865. <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>
  1866. :
  1867. <span class="phpdocumentor-element-found-in__line">587</span>
  1868. </aside>
  1869. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  1870. <code class="phpdocumentor-code phpdocumentor-signature ">
  1871. <span class="phpdocumentor-signature__visibility">public</span>
  1872. <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>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</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">$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>
  1873. <section class="phpdocumentor-description"><p>If no $height is given, the space will be assumed a square of $width.</p>
  1874. <p>Additionally, the logo space can be positioned within the QR Code - respecting the main functional patterns -
  1875. using $startX and $startY. If either of these are null, the logo space will be centered in that direction.
  1876. ECC level &quot;H&quot; (30%) is required.</p>
  1877. <p>The coordinates of $startX and $startY do not include the quiet zone:
  1878. [0, 0] is always the top left module of the top left finder pattern, negative values go into the quiet zone top and left.</p>
  1879. <p>Please note that adding a logo space minimizes the error correction capacity of the QR Code and
  1880. created images may become unreadable, especially when printed with a chance to receive damage.
  1881. Please test thoroughly before using this feature in production.</p>
  1882. <p>This method should be called from within an output module (after the matrix has been filled with data).
  1883. Note that there is no restiction on how many times this method could be called on the same matrix instance.</p>
  1884. </section>
  1885. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1886. <dl class="phpdocumentor-argument-list">
  1887. <dt class="phpdocumentor-argument-list__entry">
  1888. <span class="phpdocumentor-signature__argument__name">$width</span>
  1889. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1890. </dt>
  1891. <dd class="phpdocumentor-argument-list__definition">
  1892. <section class="phpdocumentor-description"></section>
  1893. </dd>
  1894. <dt class="phpdocumentor-argument-list__entry">
  1895. <span class="phpdocumentor-signature__argument__name">$height</span>
  1896. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1897. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1898. <dd class="phpdocumentor-argument-list__definition">
  1899. <section class="phpdocumentor-description"></section>
  1900. </dd>
  1901. <dt class="phpdocumentor-argument-list__entry">
  1902. <span class="phpdocumentor-signature__argument__name">$startX</span>
  1903. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1904. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1905. <dd class="phpdocumentor-argument-list__definition">
  1906. <section class="phpdocumentor-description"></section>
  1907. </dd>
  1908. <dt class="phpdocumentor-argument-list__entry">
  1909. <span class="phpdocumentor-signature__argument__name">$startY</span>
  1910. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1911. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1912. <dd class="phpdocumentor-argument-list__definition">
  1913. <section class="phpdocumentor-description"></section>
  1914. </dd>
  1915. </dl>
  1916. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1917. Tags
  1918. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1919. </h5>
  1920. <dl class="phpdocumentor-tag-list">
  1921. <dt class="phpdocumentor-tag-list__entry">
  1922. <span class="phpdocumentor-tag__name">link</span>
  1923. </dt>
  1924. <dd class="phpdocumentor-tag-list__definition">
  1925. <a class="phpdocumentor-tag-link" href="https://github.com/chillerlan/php-qrcode/issues/52"> https://github.com/chillerlan/php-qrcode/issues/52 </a>
  1926. </dd>
  1927. <dt class="phpdocumentor-tag-list__entry">
  1928. <span class="phpdocumentor-tag__name">throws</span>
  1929. </dt>
  1930. <dd class="phpdocumentor-tag-list__definition">
  1931. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1932. </dd>
  1933. </dl>
  1934. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1935. <span class="phpdocumentor-signature__response_type">self</span>
  1936. &mdash;
  1937. </article>
  1938. <article
  1939. class="phpdocumentor-element
  1940. -method
  1941. -public
  1942. "
  1943. >
  1944. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  1945. setQuietZone()
  1946. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  1947. </h4>
  1948. <aside class="phpdocumentor-element-found-in">
  1949. <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>
  1950. :
  1951. <span class="phpdocumentor-element-found-in__line">541</span>
  1952. </aside>
  1953. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  1954. <code class="phpdocumentor-code phpdocumentor-signature ">
  1955. <span class="phpdocumentor-signature__visibility">public</span>
  1956. <span class="phpdocumentor-signature__name">setQuietZone</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$quietZoneSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1957. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.7</p>
  1958. </section>
  1959. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1960. <dl class="phpdocumentor-argument-list">
  1961. <dt class="phpdocumentor-argument-list__entry">
  1962. <span class="phpdocumentor-signature__argument__name">$quietZoneSize</span>
  1963. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1964. </dt>
  1965. <dd class="phpdocumentor-argument-list__definition">
  1966. <section class="phpdocumentor-description"></section>
  1967. </dd>
  1968. </dl>
  1969. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1970. Tags
  1971. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1972. </h5>
  1973. <dl class="phpdocumentor-tag-list">
  1974. <dt class="phpdocumentor-tag-list__entry">
  1975. <span class="phpdocumentor-tag__name">throws</span>
  1976. </dt>
  1977. <dd class="phpdocumentor-tag-list__definition">
  1978. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1979. </dd>
  1980. </dl>
  1981. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1982. <span class="phpdocumentor-signature__response_type">self</span>
  1983. &mdash;
  1984. </article>
  1985. <article
  1986. class="phpdocumentor-element
  1987. -method
  1988. -public
  1989. "
  1990. >
  1991. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  1992. setSeparators()
  1993. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  1994. </h4>
  1995. <aside class="phpdocumentor-element-found-in">
  1996. <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>
  1997. :
  1998. <span class="phpdocumentor-element-found-in__line">394</span>
  1999. </aside>
  2000. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  2001. <code class="phpdocumentor-code phpdocumentor-signature ">
  2002. <span class="phpdocumentor-signature__visibility">public</span>
  2003. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2004. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  2005. </section>
  2006. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2007. <span class="phpdocumentor-signature__response_type">self</span>
  2008. &mdash;
  2009. </article>
  2010. <article
  2011. class="phpdocumentor-element
  2012. -method
  2013. -public
  2014. "
  2015. >
  2016. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  2017. setTimingPattern()
  2018. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2019. </h4>
  2020. <aside class="phpdocumentor-element-found-in">
  2021. <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>
  2022. :
  2023. <span class="phpdocumentor-element-found-in__line">453</span>
  2024. </aside>
  2025. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  2026. <code class="phpdocumentor-code phpdocumentor-signature ">
  2027. <span class="phpdocumentor-signature__visibility">public</span>
  2028. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2029. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  2030. </section>
  2031. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2032. <span class="phpdocumentor-signature__response_type">self</span>
  2033. &mdash;
  2034. </article>
  2035. <article
  2036. class="phpdocumentor-element
  2037. -method
  2038. -public
  2039. "
  2040. >
  2041. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  2042. setVersionNumber()
  2043. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  2044. </h4>
  2045. <aside class="phpdocumentor-element-found-in">
  2046. <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>
  2047. :
  2048. <span class="phpdocumentor-element-found-in__line">475</span>
  2049. </aside>
  2050. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  2051. <code class="phpdocumentor-code phpdocumentor-signature ">
  2052. <span class="phpdocumentor-signature__visibility">public</span>
  2053. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2054. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  2055. </section>
  2056. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2057. <span class="phpdocumentor-signature__response_type">self</span>
  2058. &mdash;
  2059. </article>
  2060. <article
  2061. class="phpdocumentor-element
  2062. -method
  2063. -public
  2064. -deprecated "
  2065. >
  2066. <h4 class="phpdocumentor-element__name" id="method_size">
  2067. size()
  2068. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size" class="headerlink"><i class="fas fa-link"></i></a>
  2069. </h4>
  2070. <aside class="phpdocumentor-element-found-in">
  2071. <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>
  2072. :
  2073. <span class="phpdocumentor-element-found-in__line">240</span>
  2074. </aside>
  2075. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2076. <span class="phpdocumentor-signature__visibility">public</span>
  2077. <span class="phpdocumentor-signature__name">size</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  2078. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2079. Tags
  2080. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2081. </h5>
  2082. <dl class="phpdocumentor-tag-list">
  2083. <dt class="phpdocumentor-tag-list__entry">
  2084. <span class="phpdocumentor-tag__name">deprecated</span>
  2085. </dt>
  2086. <dd class="phpdocumentor-tag-list__definition">
  2087. <span class="phpdocumentor-tag-link">5.0.0</span>
  2088. <section class="phpdocumentor-description"><p>use QRMatrix::getSize() instead</p>
  2089. </section>
  2090. </dd>
  2091. <dt class="phpdocumentor-tag-list__entry">
  2092. <span class="phpdocumentor-tag__name">see</span>
  2093. </dt>
  2094. <dd class="phpdocumentor-tag-list__definition">
  2095. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  2096. </dd>
  2097. <dt class="phpdocumentor-tag-list__entry">
  2098. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2099. </dt>
  2100. <dd class="phpdocumentor-tag-list__definition">
  2101. </dd>
  2102. </dl>
  2103. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2104. <span class="phpdocumentor-signature__response_type">int</span>
  2105. &mdash;
  2106. </article>
  2107. <article
  2108. class="phpdocumentor-element
  2109. -method
  2110. -public
  2111. -deprecated "
  2112. >
  2113. <h4 class="phpdocumentor-element__name" id="method_version">
  2114. version()
  2115. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_version" class="headerlink"><i class="fas fa-link"></i></a>
  2116. </h4>
  2117. <aside class="phpdocumentor-element-found-in">
  2118. <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>
  2119. :
  2120. <span class="phpdocumentor-element-found-in__line">190</span>
  2121. </aside>
  2122. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  2123. <span class="phpdocumentor-signature__visibility">public</span>
  2124. <span class="phpdocumentor-signature__name">version</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  2125. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2126. Tags
  2127. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2128. </h5>
  2129. <dl class="phpdocumentor-tag-list">
  2130. <dt class="phpdocumentor-tag-list__entry">
  2131. <span class="phpdocumentor-tag__name">deprecated</span>
  2132. </dt>
  2133. <dd class="phpdocumentor-tag-list__definition">
  2134. <span class="phpdocumentor-tag-link">5.0.0</span>
  2135. <section class="phpdocumentor-description"><p>use QRMatrix::getVersion() instead</p>
  2136. </section>
  2137. </dd>
  2138. <dt class="phpdocumentor-tag-list__entry">
  2139. <span class="phpdocumentor-tag__name">see</span>
  2140. </dt>
  2141. <dd class="phpdocumentor-tag-list__definition">
  2142. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getVersion()">QRMatrix::getVersion()</abbr></a></span>
  2143. </dd>
  2144. <dt class="phpdocumentor-tag-list__entry">
  2145. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2146. </dt>
  2147. <dd class="phpdocumentor-tag-list__definition">
  2148. </dd>
  2149. </dl>
  2150. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2151. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  2152. &mdash;
  2153. </article>
  2154. <article
  2155. class="phpdocumentor-element
  2156. -method
  2157. -public
  2158. "
  2159. >
  2160. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  2161. writeCodewords()
  2162. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  2163. </h4>
  2164. <aside class="phpdocumentor-element-found-in">
  2165. <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>
  2166. :
  2167. <span class="phpdocumentor-element-found-in__line">656</span>
  2168. </aside>
  2169. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  2170. <code class="phpdocumentor-code phpdocumentor-signature ">
  2171. <span class="phpdocumentor-signature__visibility">public</span>
  2172. <span class="phpdocumentor-signature__name">writeCodewords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  2173. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2174. <dl class="phpdocumentor-argument-list">
  2175. <dt class="phpdocumentor-argument-list__entry">
  2176. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  2177. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  2178. </dt>
  2179. <dd class="phpdocumentor-argument-list__definition">
  2180. <section class="phpdocumentor-description"></section>
  2181. </dd>
  2182. </dl>
  2183. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2184. <span class="phpdocumentor-signature__response_type">self</span>
  2185. &mdash;
  2186. </article>
  2187. <article
  2188. class="phpdocumentor-element
  2189. -method
  2190. -protected
  2191. "
  2192. >
  2193. <h4 class="phpdocumentor-element__name" id="method_createMatrix">
  2194. createMatrix()
  2195. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  2196. </h4>
  2197. <aside class="phpdocumentor-element-found-in">
  2198. <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>
  2199. :
  2200. <span class="phpdocumentor-element-found-in__line">129</span>
  2201. </aside>
  2202. <p class="phpdocumentor-summary">Creates a 2-dimensional array (square) of the given $size</p>
  2203. <code class="phpdocumentor-code phpdocumentor-signature ">
  2204. <span class="phpdocumentor-signature__visibility">protected</span>
  2205. <span class="phpdocumentor-signature__name">createMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</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">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  2206. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2207. <dl class="phpdocumentor-argument-list">
  2208. <dt class="phpdocumentor-argument-list__entry">
  2209. <span class="phpdocumentor-signature__argument__name">$size</span>
  2210. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2211. </dt>
  2212. <dd class="phpdocumentor-argument-list__definition">
  2213. <section class="phpdocumentor-description"></section>
  2214. </dd>
  2215. <dt class="phpdocumentor-argument-list__entry">
  2216. <span class="phpdocumentor-signature__argument__name">$value</span>
  2217. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2218. </dt>
  2219. <dd class="phpdocumentor-argument-list__definition">
  2220. <section class="phpdocumentor-description"></section>
  2221. </dd>
  2222. </dl>
  2223. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2224. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  2225. &mdash;
  2226. </article>
  2227. </section>
  2228. <script type="text/javascript">
  2229. function loadExternalCodeSnippets(line) {
  2230. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2231. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  2232. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  2233. var language = 'php';
  2234. var code = document.createElement('code');
  2235. code.className = 'language-' + language;
  2236. pre.textContent = '';
  2237. pre.setAttribute('data-line', line)
  2238. code.textContent = 'Loading…';
  2239. pre.appendChild(code);
  2240. var xhr = new XMLHttpRequest();
  2241. xhr.open('GET', src, true);
  2242. xhr.onreadystatechange = function () {
  2243. if (xhr.readyState == 4) {
  2244. if (xhr.status < 400 && xhr.responseText) {
  2245. code.textContent = xhr.responseText;
  2246. Prism.highlightElement(code);
  2247. }
  2248. else if (xhr.status >= 400) {
  2249. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2250. }
  2251. else {
  2252. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  2253. }
  2254. }
  2255. };
  2256. xhr.send(null);
  2257. });
  2258. }
  2259. var modals = document.querySelectorAll("[data-modal]");
  2260. modals.forEach(function (trigger) {
  2261. trigger.addEventListener("click", function (event) {
  2262. //event.preventDefault();
  2263. const modal = document.getElementById(trigger.dataset.modal);
  2264. modal.classList.add("phpdocumentor-modal__open");
  2265. loadExternalCodeSnippets(trigger.dataset.line)
  2266. const exits = modal.querySelectorAll("[data-exit-button]");
  2267. exits.forEach(function (exit) {
  2268. exit.addEventListener("click", function (event) {
  2269. event.preventDefault();
  2270. modal.classList.remove("phpdocumentor-modal__open");
  2271. });
  2272. });
  2273. });
  2274. });
  2275. </script>
  2276. </article>
  2277. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2278. <section class="phpdocumentor-search-results__dialog">
  2279. <header class="phpdocumentor-search-results__header">
  2280. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2281. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2282. </header>
  2283. <section class="phpdocumentor-search-results__body">
  2284. <ul class="phpdocumentor-search-results__entries"></ul>
  2285. </section>
  2286. </section>
  2287. </section>
  2288. </div>
  2289. </div>
  2290. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2291. </main>
  2292. <script>
  2293. cssVars({});
  2294. </script>
  2295. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2296. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2297. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2298. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2299. </body>
  2300. </html>