chillerlan-QRCode-Data-QRMatrix.html 153 KB

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