chillerlan-QRCode-Decoder-BitMatrix.html 145 KB

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