chillerlan-QRCode-Data-QRMatrix.html 150 KB

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