chillerlan-QRCode-Decoder-BitMatrix.html 144 KB

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