chillerlan-QRCode-Data-QRMatrix.html 150 KB

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