chillerlan-QRCode-Data-QRMatrix.html 154 KB

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