chillerlan-QRCode-Decoder-BitMatrix.html 191 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. BitMatrix
  119. <span class="phpdocumentor-element__extends">
  120. extends <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>
  121. </span>
  122. <div class="phpdocumentor-element__package">
  123. in package
  124. <ul class="phpdocumentor-breadcrumbs">
  125. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  126. </ul>
  127. </div>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  131. </div>
  132. <aside class="phpdocumentor-element-found-in">
  133. <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>
  134. :
  135. <span class="phpdocumentor-element-found-in__line">22</span>
  136. </aside>
  137. <p class="phpdocumentor-summary">Extended QRMatrix to map read data from the Binarizer</p>
  138. <h3 id="toc">
  139. Table of Contents
  140. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  141. </h3>
  142. <h4 id="toc-constants">
  143. Constants
  144. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  145. </h4>
  146. <dl class="phpdocumentor-table-of-contents">
  147. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  148. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a>
  149. <span>
  150. &nbsp;= 0b100000000000 </span>
  151. </dt>
  152. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  153. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a>
  154. <span>
  155. &nbsp;= 0b10000 </span>
  156. </dt>
  157. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  158. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a>
  159. <span>
  160. &nbsp;= 0b100000010000 </span>
  161. </dt>
  162. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  163. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a>
  164. <span>
  165. &nbsp;= 0b100000000001 </span>
  166. </dt>
  167. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  168. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT">M_DARKMODULE_LIGHT</a>
  169. <span>
  170. &nbsp;= 0b1 </span>
  171. </dt>
  172. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  173. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a>
  174. <span>
  175. &nbsp;= 0b10 </span>
  176. </dt>
  177. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  178. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a>
  179. <span>
  180. &nbsp;= 0b100000000010 </span>
  181. </dt>
  182. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  183. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a>
  184. <span>
  185. &nbsp;= 0b100 </span>
  186. </dt>
  187. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  188. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a>
  189. <span>
  190. &nbsp;= 0b100000000100 </span>
  191. </dt>
  192. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  193. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a>
  194. <span>
  195. &nbsp;= 0b110000000000 </span>
  196. </dt>
  197. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  198. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT">M_FINDER_DOT_LIGHT</a>
  199. <span>
  200. &nbsp;= 0b10000000000 </span>
  201. </dt>
  202. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  203. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a>
  204. <span>
  205. &nbsp;= 0b1000000 </span>
  206. </dt>
  207. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  208. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a>
  209. <span>
  210. &nbsp;= 0b100001000000 </span>
  211. </dt>
  212. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  213. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a>
  214. <span>
  215. &nbsp;= 0b1000000000 </span>
  216. </dt>
  217. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  218. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK">M_LOGO_DARK</a>
  219. <span>
  220. &nbsp;= 0b101000000000 </span>
  221. </dt>
  222. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  223. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a>
  224. <span>
  225. &nbsp;= 0b0 </span>
  226. </dt>
  227. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  228. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a>
  229. <span>
  230. &nbsp;= 0b100000000 </span>
  231. </dt>
  232. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  233. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK">M_QUIETZONE_DARK</a>
  234. <span>
  235. &nbsp;= 0b100100000000 </span>
  236. </dt>
  237. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  238. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a>
  239. <span>
  240. &nbsp;= 0b1000 </span>
  241. </dt>
  242. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  243. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK">M_SEPARATOR_DARK</a>
  244. <span>
  245. &nbsp;= 0b100000001000 </span>
  246. </dt>
  247. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  248. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a>
  249. <span>
  250. &nbsp;= 0b100000 </span>
  251. </dt>
  252. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  253. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a>
  254. <span>
  255. &nbsp;= 0b100000100000 </span>
  256. </dt>
  257. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  258. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a>
  259. <span>
  260. &nbsp;= 0b10000000 </span>
  261. </dt>
  262. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  263. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a>
  264. <span>
  265. &nbsp;= 0b100010000000 </span>
  266. </dt>
  267. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  268. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a>
  269. <span>
  270. &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>
  271. </dt>
  272. <dd>Map of flag =&gt; coord</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  274. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_DECODE_LOOKUP">DECODE_LOOKUP</a>
  275. <span>
  276. &nbsp;= [
  277. 0x5412,
  278. // 0101010000010010
  279. 0x5125,
  280. // 0101000100100101
  281. 0x5e7c,
  282. // 0101111001111100
  283. 0x5b4b,
  284. // 0101101101001011
  285. 0x45f9,
  286. // 0100010111111001
  287. 0x40ce,
  288. // 0100000011001110
  289. 0x4f97,
  290. // 0100111110010111
  291. 0x4aa0,
  292. // 0100101010100000
  293. 0x77c4,
  294. // 0111011111000100
  295. 0x72f3,
  296. // 0111001011110011
  297. 0x7daa,
  298. // 0111110110101010
  299. 0x789d,
  300. // 0111100010011101
  301. 0x662f,
  302. // 0110011000101111
  303. 0x6318,
  304. // 0110001100011000
  305. 0x6c41,
  306. // 0110110001000001
  307. 0x6976,
  308. // 0110100101110110
  309. 0x1689,
  310. // 0001011010001001
  311. 0x13be,
  312. // 0001001110111110
  313. 0x1ce7,
  314. // 0001110011100111
  315. 0x19d0,
  316. // 0001100111010000
  317. 0x762,
  318. // 0000011101100010
  319. 0x255,
  320. // 0000001001010101
  321. 0xd0c,
  322. // 0000110100001100
  323. 0x83b,
  324. // 0000100000111011
  325. 0x355f,
  326. // 0011010101011111
  327. 0x3068,
  328. // 0011000001101000
  329. 0x3f31,
  330. // 0011111100110001
  331. 0x3a06,
  332. // 0011101000000110
  333. 0x24b4,
  334. // 0010010010110100
  335. 0x2183,
  336. // 0010000110000011
  337. 0x2eda,
  338. // 0010111011011010
  339. 0x2bed,
  340. ] </span>
  341. </dt>
  342. <dd>See ISO 18004:2006, Annex C, Table C.1</dd>
  343. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  344. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_FORMAT_INFO_MASK_QR">FORMAT_INFO_MASK_QR</a>
  345. <span>
  346. &nbsp;= 0x5412 </span>
  347. </dt>
  348. </dl>
  349. <h4 id="toc-properties">
  350. Properties
  351. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  352. </h4>
  353. <dl class="phpdocumentor-table-of-contents">
  354. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  355. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</a>
  356. <span>
  357. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  358. </dt>
  359. <dd>the current ECC level - always set in QRMatrix, may be null in BitMatrix</dd>
  360. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  361. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</a>
  362. <span>
  363. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  364. </dt>
  365. <dd>the mask pattern that was used in the most recent operation, set via:</dd>
  366. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  367. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</a>
  368. <span>
  369. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  370. </dt>
  371. <dd>the actual matrix data array</dd>
  372. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  373. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</a>
  374. <span>
  375. &nbsp;: int </span>
  376. </dt>
  377. <dd>the size (side length) of the matrix, including quiet zone (if created)</dd>
  378. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  379. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</a>
  380. <span>
  381. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  382. </dt>
  383. <dd>the matrix version - always set in QRMatrix, may be null in BitMatrix</dd>
  384. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  385. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror">$mirror</a>
  386. <span>
  387. &nbsp;: bool </span>
  388. </dt>
  389. <dd>This flag has effect only on the copyVersionBit() method.</dd>
  390. </dl>
  391. <h4 id="toc-methods">
  392. Methods
  393. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  394. </h4>
  395. <dl class="phpdocumentor-table-of-contents">
  396. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  397. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct">__construct()</a>
  398. <span>
  399. &nbsp;: mixed </span>
  400. </dt>
  401. <dd>QRMatrix constructor.</dd>
  402. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  403. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a>
  404. <span>
  405. &nbsp;: bool </span>
  406. </dt>
  407. <dd>Checks whether the module at ($x, $y) is true (dark) or false (light)</dd>
  408. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  409. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a>
  410. <span>
  411. &nbsp;: int </span>
  412. </dt>
  413. <dd>Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</dd>
  414. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  415. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a>
  416. <span>
  417. &nbsp;: bool </span>
  418. </dt>
  419. <dd>Checks whether the module at ($x, $y) is of the given $M_TYPE</dd>
  420. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  421. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a>
  422. <span>
  423. &nbsp;: bool </span>
  424. </dt>
  425. <dd>Checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  426. returns true if a match is found, otherwise false.</dd>
  427. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  428. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a>
  429. <span>
  430. &nbsp;: static </span>
  431. </dt>
  432. <dd>Flips the value of the module at ($x, $y)</dd>
  433. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  434. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a>
  435. <span>
  436. &nbsp;: int </span>
  437. </dt>
  438. <dd>Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</dd>
  439. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  440. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a>
  441. <span>
  442. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null </span>
  443. </dt>
  444. <dd>Returns the current ECC level</dd>
  445. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  446. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a>
  447. <span>
  448. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null </span>
  449. </dt>
  450. <dd>Returns the current mask pattern</dd>
  451. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  452. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a>
  453. <span>
  454. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt; </span>
  455. </dt>
  456. <dd>Returns the data matrix, returns a pure boolean representation if $boolean is set to true</dd>
  457. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  458. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a>
  459. <span>
  460. &nbsp;: int </span>
  461. </dt>
  462. <dd>Returns the absoulute size of the matrix, including quiet zone (after setting it).</dd>
  463. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  464. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a>
  465. <span>
  466. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  467. </dt>
  468. <dd>Returns the current version number</dd>
  469. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  470. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a>
  471. <span>
  472. &nbsp;: static </span>
  473. </dt>
  474. <dd>shortcut to initialize the functional patterns</dd>
  475. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  476. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert">invert()</a>
  477. <span>
  478. &nbsp;: static </span>
  479. </dt>
  480. <dd>Inverts the values of the whole matrix</dd>
  481. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  482. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_isDark">isDark()</a>
  483. <span>
  484. &nbsp;: bool </span>
  485. </dt>
  486. <dd>Checks whether the given $M_TYPE is a dark value</dd>
  487. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  488. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a>
  489. <span>
  490. &nbsp;: static </span>
  491. </dt>
  492. <dd>Applies/reverses the mask pattern</dd>
  493. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  494. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirrorDiagonal">mirrorDiagonal()</a>
  495. <span>
  496. &nbsp;: static </span>
  497. </dt>
  498. <dd>Mirror the bit matrix diagonally in order to attempt a second reading.</dd>
  499. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  500. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords">readCodewords()</a>
  501. <span>
  502. &nbsp;: array&lt;string|int, mixed&gt; </span>
  503. </dt>
  504. <dd>Reads the bits in the BitMatrix representing the finder pattern in the
  505. correct order in order to reconstruct the codewords bytes contained within the
  506. QR Code. Throws if the exact number of bytes expected is not read.</dd>
  507. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  508. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_resetVersionInfo">resetVersionInfo()</a>
  509. <span>
  510. &nbsp;: static </span>
  511. </dt>
  512. <dd>Resets the current version info in order to attempt another reading</dd>
  513. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  514. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90">rotate90()</a>
  515. <span>
  516. &nbsp;: static </span>
  517. </dt>
  518. <dd>Rotates the matrix by 90 degrees clock wise</dd>
  519. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  520. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a>
  521. <span>
  522. &nbsp;: static </span>
  523. </dt>
  524. <dd>Sets the $M_TYPE value for the module at position [$x, $y]</dd>
  525. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  526. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a>
  527. <span>
  528. &nbsp;: static </span>
  529. </dt>
  530. <dd>Draws the 5x5 alignment patterns</dd>
  531. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  532. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a>
  533. <span>
  534. &nbsp;: static </span>
  535. </dt>
  536. <dd>Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</dd>
  537. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  538. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a>
  539. <span>
  540. &nbsp;: static </span>
  541. </dt>
  542. <dd>Sets the &quot;dark module&quot;, that is always on the same position 1x1px away from the bottom left finder</dd>
  543. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  544. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a>
  545. <span>
  546. &nbsp;: static </span>
  547. </dt>
  548. <dd>Draws the 7x7 finder patterns in the corners top left/right and bottom left</dd>
  549. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  550. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a>
  551. <span>
  552. &nbsp;: static </span>
  553. </dt>
  554. <dd>Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</dd>
  555. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  556. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace">setLogoSpace()</a>
  557. <span>
  558. &nbsp;: static </span>
  559. </dt>
  560. <dd>Clears a space of $width * $height in order to add a logo or text.</dd>
  561. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  562. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone">setQuietZone()</a>
  563. <span>
  564. &nbsp;: static </span>
  565. </dt>
  566. <dd>Draws the &quot;quiet zone&quot; of $size around the matrix</dd>
  567. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  568. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a>
  569. <span>
  570. &nbsp;: static </span>
  571. </dt>
  572. <dd>Draws the separator lines around the finder patterns</dd>
  573. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  574. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a>
  575. <span>
  576. &nbsp;: static </span>
  577. </dt>
  578. <dd>Draws the timing pattern (h/v checkered line between the finder patterns)</dd>
  579. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  580. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a>
  581. <span>
  582. &nbsp;: static </span>
  583. </dt>
  584. <dd>Draws the version information, 2x 3x6 pixel</dd>
  585. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  586. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a>
  587. <span>
  588. &nbsp;: static </span>
  589. </dt>
  590. <dd>Maps the interleaved binary $data on the matrix</dd>
  591. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  592. <a class="" href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a>
  593. <span>
  594. &nbsp;: array&lt;string|int, mixed&gt; </span>
  595. </dt>
  596. <dd>Creates a 2-dimensional array (square) of the given $size</dd>
  597. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  598. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyVersionBit">copyVersionBit()</a>
  599. <span>
  600. &nbsp;: int </span>
  601. </dt>
  602. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  603. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation">decodeVersionInformation()</a>
  604. <span>
  605. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  606. </dt>
  607. <dd>Decodes the version information from the given bit sequence, returns null if no valid match is found.</dd>
  608. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  609. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation">doDecodeFormatInformation()</a>
  610. <span>
  611. &nbsp;: int|null </span>
  612. </dt>
  613. <dd>Returns information about the format it specifies, or null if it doesn&#039;t seem to match any known pattern</dd>
  614. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  615. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering">numBitsDiffering()</a>
  616. <span>
  617. &nbsp;: int </span>
  618. </dt>
  619. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  620. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation">readFormatInformation()</a>
  621. <span>
  622. &nbsp;: static </span>
  623. </dt>
  624. <dd>Reads format information from one of its two locations within the QR Code.</dd>
  625. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  626. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion">readVersion()</a>
  627. <span>
  628. &nbsp;: static </span>
  629. </dt>
  630. <dd>Reads version information from one of its two locations within the QR Code.</dd>
  631. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  632. <a class="" href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift">uRShift()</a>
  633. <span>
  634. &nbsp;: int </span>
  635. </dt>
  636. </dl>
  637. <section class="phpdocumentor-constants">
  638. <h3 class="phpdocumentor-elements__header" id="constants">
  639. Constants
  640. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  641. </h3>
  642. <article class="phpdocumentor-element -constant -public ">
  643. <h4 class="phpdocumentor-element__name" id="constant_IS_DARK">
  644. IS_DARK
  645. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  646. </h4>
  647. <aside class="phpdocumentor-element-found-in">
  648. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  649. :
  650. <span class="phpdocumentor-element-found-in__line">29</span>
  651. </aside>
  652. <code class="phpdocumentor-signature phpdocumentor-code ">
  653. <span class="phpdocumentor-signature__visibility">public</span>
  654. <span class="phpdocumentor-signature__type">int</span>
  655. <span class="phpdocumentor-signature__name">IS_DARK</span>
  656. = <span class="phpdocumentor-signature__default-value">0b100000000000</span>
  657. </code>
  658. </article>
  659. <article class="phpdocumentor-element -constant -public ">
  660. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT">
  661. M_ALIGNMENT
  662. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT" class="headerlink"><i class="fas fa-link"></i></a>
  663. </h4>
  664. <aside class="phpdocumentor-element-found-in">
  665. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  666. :
  667. <span class="phpdocumentor-element-found-in__line">48</span>
  668. </aside>
  669. <code class="phpdocumentor-signature phpdocumentor-code ">
  670. <span class="phpdocumentor-signature__visibility">public</span>
  671. <span class="phpdocumentor-signature__type">int</span>
  672. <span class="phpdocumentor-signature__name">M_ALIGNMENT</span>
  673. = <span class="phpdocumentor-signature__default-value">0b10000</span>
  674. </code>
  675. </article>
  676. <article class="phpdocumentor-element -constant -public ">
  677. <h4 class="phpdocumentor-element__name" id="constant_M_ALIGNMENT_DARK">
  678. M_ALIGNMENT_DARK
  679. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  680. </h4>
  681. <aside class="phpdocumentor-element-found-in">
  682. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  683. :
  684. <span class="phpdocumentor-element-found-in__line">69</span>
  685. </aside>
  686. <code class="phpdocumentor-signature phpdocumentor-code ">
  687. <span class="phpdocumentor-signature__visibility">public</span>
  688. <span class="phpdocumentor-signature__type">int</span>
  689. <span class="phpdocumentor-signature__name">M_ALIGNMENT_DARK</span>
  690. = <span class="phpdocumentor-signature__default-value">0b100000010000</span>
  691. </code>
  692. </article>
  693. <article class="phpdocumentor-element -constant -public ">
  694. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE">
  695. M_DARKMODULE
  696. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE" class="headerlink"><i class="fas fa-link"></i></a>
  697. </h4>
  698. <aside class="phpdocumentor-element-found-in">
  699. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  700. :
  701. <span class="phpdocumentor-element-found-in__line">63</span>
  702. </aside>
  703. <code class="phpdocumentor-signature phpdocumentor-code ">
  704. <span class="phpdocumentor-signature__visibility">public</span>
  705. <span class="phpdocumentor-signature__type">int</span>
  706. <span class="phpdocumentor-signature__name">M_DARKMODULE</span>
  707. = <span class="phpdocumentor-signature__default-value">0b100000000001</span>
  708. </code>
  709. </article>
  710. <article class="phpdocumentor-element -constant -public ">
  711. <h4 class="phpdocumentor-element__name" id="constant_M_DARKMODULE_LIGHT">
  712. M_DARKMODULE_LIGHT
  713. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT" class="headerlink"><i class="fas fa-link"></i></a>
  714. </h4>
  715. <aside class="phpdocumentor-element-found-in">
  716. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  717. :
  718. <span class="phpdocumentor-element-found-in__line">84</span>
  719. </aside>
  720. <code class="phpdocumentor-signature phpdocumentor-code ">
  721. <span class="phpdocumentor-signature__visibility">public</span>
  722. <span class="phpdocumentor-signature__type">int</span>
  723. <span class="phpdocumentor-signature__name">M_DARKMODULE_LIGHT</span>
  724. = <span class="phpdocumentor-signature__default-value">0b1</span>
  725. </code>
  726. </article>
  727. <article class="phpdocumentor-element -constant -public ">
  728. <h4 class="phpdocumentor-element__name" id="constant_M_DATA">
  729. M_DATA
  730. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA" class="headerlink"><i class="fas fa-link"></i></a>
  731. </h4>
  732. <aside class="phpdocumentor-element-found-in">
  733. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  734. :
  735. <span class="phpdocumentor-element-found-in__line">42</span>
  736. </aside>
  737. <code class="phpdocumentor-signature phpdocumentor-code ">
  738. <span class="phpdocumentor-signature__visibility">public</span>
  739. <span class="phpdocumentor-signature__type">int</span>
  740. <span class="phpdocumentor-signature__name">M_DATA</span>
  741. = <span class="phpdocumentor-signature__default-value">0b10</span>
  742. </code>
  743. </article>
  744. <article class="phpdocumentor-element -constant -public ">
  745. <h4 class="phpdocumentor-element__name" id="constant_M_DATA_DARK">
  746. M_DATA_DARK
  747. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  748. </h4>
  749. <aside class="phpdocumentor-element-found-in">
  750. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  751. :
  752. <span class="phpdocumentor-element-found-in__line">65</span>
  753. </aside>
  754. <code class="phpdocumentor-signature phpdocumentor-code ">
  755. <span class="phpdocumentor-signature__visibility">public</span>
  756. <span class="phpdocumentor-signature__type">int</span>
  757. <span class="phpdocumentor-signature__name">M_DATA_DARK</span>
  758. = <span class="phpdocumentor-signature__default-value">0b100000000010</span>
  759. </code>
  760. </article>
  761. <article class="phpdocumentor-element -constant -public ">
  762. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER">
  763. M_FINDER
  764. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER" class="headerlink"><i class="fas fa-link"></i></a>
  765. </h4>
  766. <aside class="phpdocumentor-element-found-in">
  767. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  768. :
  769. <span class="phpdocumentor-element-found-in__line">44</span>
  770. </aside>
  771. <code class="phpdocumentor-signature phpdocumentor-code ">
  772. <span class="phpdocumentor-signature__visibility">public</span>
  773. <span class="phpdocumentor-signature__type">int</span>
  774. <span class="phpdocumentor-signature__name">M_FINDER</span>
  775. = <span class="phpdocumentor-signature__default-value">0b100</span>
  776. </code>
  777. </article>
  778. <article class="phpdocumentor-element -constant -public ">
  779. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DARK">
  780. M_FINDER_DARK
  781. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  782. </h4>
  783. <aside class="phpdocumentor-element-found-in">
  784. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  785. :
  786. <span class="phpdocumentor-element-found-in__line">67</span>
  787. </aside>
  788. <code class="phpdocumentor-signature phpdocumentor-code ">
  789. <span class="phpdocumentor-signature__visibility">public</span>
  790. <span class="phpdocumentor-signature__type">int</span>
  791. <span class="phpdocumentor-signature__name">M_FINDER_DARK</span>
  792. = <span class="phpdocumentor-signature__default-value">0b100000000100</span>
  793. </code>
  794. </article>
  795. <article class="phpdocumentor-element -constant -public ">
  796. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT">
  797. M_FINDER_DOT
  798. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT" class="headerlink"><i class="fas fa-link"></i></a>
  799. </h4>
  800. <aside class="phpdocumentor-element-found-in">
  801. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  802. :
  803. <span class="phpdocumentor-element-found-in__line">77</span>
  804. </aside>
  805. <code class="phpdocumentor-signature phpdocumentor-code ">
  806. <span class="phpdocumentor-signature__visibility">public</span>
  807. <span class="phpdocumentor-signature__type">int</span>
  808. <span class="phpdocumentor-signature__name">M_FINDER_DOT</span>
  809. = <span class="phpdocumentor-signature__default-value">0b110000000000</span>
  810. </code>
  811. </article>
  812. <article class="phpdocumentor-element -constant -public ">
  813. <h4 class="phpdocumentor-element__name" id="constant_M_FINDER_DOT_LIGHT">
  814. M_FINDER_DOT_LIGHT
  815. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT" class="headerlink"><i class="fas fa-link"></i></a>
  816. </h4>
  817. <aside class="phpdocumentor-element-found-in">
  818. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  819. :
  820. <span class="phpdocumentor-element-found-in__line">86</span>
  821. </aside>
  822. <code class="phpdocumentor-signature phpdocumentor-code ">
  823. <span class="phpdocumentor-signature__visibility">public</span>
  824. <span class="phpdocumentor-signature__type">int</span>
  825. <span class="phpdocumentor-signature__name">M_FINDER_DOT_LIGHT</span>
  826. = <span class="phpdocumentor-signature__default-value">0b10000000000</span>
  827. </code>
  828. </article>
  829. <article class="phpdocumentor-element -constant -public ">
  830. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT">
  831. M_FORMAT
  832. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT" class="headerlink"><i class="fas fa-link"></i></a>
  833. </h4>
  834. <aside class="phpdocumentor-element-found-in">
  835. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  836. :
  837. <span class="phpdocumentor-element-found-in__line">52</span>
  838. </aside>
  839. <code class="phpdocumentor-signature phpdocumentor-code ">
  840. <span class="phpdocumentor-signature__visibility">public</span>
  841. <span class="phpdocumentor-signature__type">int</span>
  842. <span class="phpdocumentor-signature__name">M_FORMAT</span>
  843. = <span class="phpdocumentor-signature__default-value">0b1000000</span>
  844. </code>
  845. </article>
  846. <article class="phpdocumentor-element -constant -public ">
  847. <h4 class="phpdocumentor-element__name" id="constant_M_FORMAT_DARK">
  848. M_FORMAT_DARK
  849. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  850. </h4>
  851. <aside class="phpdocumentor-element-found-in">
  852. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  853. :
  854. <span class="phpdocumentor-element-found-in__line">73</span>
  855. </aside>
  856. <code class="phpdocumentor-signature phpdocumentor-code ">
  857. <span class="phpdocumentor-signature__visibility">public</span>
  858. <span class="phpdocumentor-signature__type">int</span>
  859. <span class="phpdocumentor-signature__name">M_FORMAT_DARK</span>
  860. = <span class="phpdocumentor-signature__default-value">0b100001000000</span>
  861. </code>
  862. </article>
  863. <article class="phpdocumentor-element -constant -public ">
  864. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO">
  865. M_LOGO
  866. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO" class="headerlink"><i class="fas fa-link"></i></a>
  867. </h4>
  868. <aside class="phpdocumentor-element-found-in">
  869. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  870. :
  871. <span class="phpdocumentor-element-found-in__line">33</span>
  872. </aside>
  873. <code class="phpdocumentor-signature phpdocumentor-code ">
  874. <span class="phpdocumentor-signature__visibility">public</span>
  875. <span class="phpdocumentor-signature__type">int</span>
  876. <span class="phpdocumentor-signature__name">M_LOGO</span>
  877. = <span class="phpdocumentor-signature__default-value">0b1000000000</span>
  878. </code>
  879. </article>
  880. <article class="phpdocumentor-element -constant -public ">
  881. <h4 class="phpdocumentor-element__name" id="constant_M_LOGO_DARK">
  882. M_LOGO_DARK
  883. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  884. </h4>
  885. <aside class="phpdocumentor-element-found-in">
  886. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  887. :
  888. <span class="phpdocumentor-element-found-in__line">35</span>
  889. </aside>
  890. <code class="phpdocumentor-signature phpdocumentor-code ">
  891. <span class="phpdocumentor-signature__visibility">public</span>
  892. <span class="phpdocumentor-signature__type">int</span>
  893. <span class="phpdocumentor-signature__name">M_LOGO_DARK</span>
  894. = <span class="phpdocumentor-signature__default-value">0b101000000000</span>
  895. </code>
  896. </article>
  897. <article class="phpdocumentor-element -constant -public ">
  898. <h4 class="phpdocumentor-element__name" id="constant_M_NULL">
  899. M_NULL
  900. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL" class="headerlink"><i class="fas fa-link"></i></a>
  901. </h4>
  902. <aside class="phpdocumentor-element-found-in">
  903. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  904. :
  905. <span class="phpdocumentor-element-found-in__line">31</span>
  906. </aside>
  907. <code class="phpdocumentor-signature phpdocumentor-code ">
  908. <span class="phpdocumentor-signature__visibility">public</span>
  909. <span class="phpdocumentor-signature__type">int</span>
  910. <span class="phpdocumentor-signature__name">M_NULL</span>
  911. = <span class="phpdocumentor-signature__default-value">0b0</span>
  912. </code>
  913. </article>
  914. <article class="phpdocumentor-element -constant -public ">
  915. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE">
  916. M_QUIETZONE
  917. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE" class="headerlink"><i class="fas fa-link"></i></a>
  918. </h4>
  919. <aside class="phpdocumentor-element-found-in">
  920. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  921. :
  922. <span class="phpdocumentor-element-found-in__line">56</span>
  923. </aside>
  924. <code class="phpdocumentor-signature phpdocumentor-code ">
  925. <span class="phpdocumentor-signature__visibility">public</span>
  926. <span class="phpdocumentor-signature__type">int</span>
  927. <span class="phpdocumentor-signature__name">M_QUIETZONE</span>
  928. = <span class="phpdocumentor-signature__default-value">0b100000000</span>
  929. </code>
  930. </article>
  931. <article class="phpdocumentor-element -constant -public ">
  932. <h4 class="phpdocumentor-element__name" id="constant_M_QUIETZONE_DARK">
  933. M_QUIETZONE_DARK
  934. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  935. </h4>
  936. <aside class="phpdocumentor-element-found-in">
  937. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  938. :
  939. <span class="phpdocumentor-element-found-in__line">90</span>
  940. </aside>
  941. <code class="phpdocumentor-signature phpdocumentor-code ">
  942. <span class="phpdocumentor-signature__visibility">public</span>
  943. <span class="phpdocumentor-signature__type">int</span>
  944. <span class="phpdocumentor-signature__name">M_QUIETZONE_DARK</span>
  945. = <span class="phpdocumentor-signature__default-value">0b100100000000</span>
  946. </code>
  947. </article>
  948. <article class="phpdocumentor-element -constant -public ">
  949. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR">
  950. M_SEPARATOR
  951. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR" class="headerlink"><i class="fas fa-link"></i></a>
  952. </h4>
  953. <aside class="phpdocumentor-element-found-in">
  954. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  955. :
  956. <span class="phpdocumentor-element-found-in__line">46</span>
  957. </aside>
  958. <code class="phpdocumentor-signature phpdocumentor-code ">
  959. <span class="phpdocumentor-signature__visibility">public</span>
  960. <span class="phpdocumentor-signature__type">int</span>
  961. <span class="phpdocumentor-signature__name">M_SEPARATOR</span>
  962. = <span class="phpdocumentor-signature__default-value">0b1000</span>
  963. </code>
  964. </article>
  965. <article class="phpdocumentor-element -constant -public ">
  966. <h4 class="phpdocumentor-element__name" id="constant_M_SEPARATOR_DARK">
  967. M_SEPARATOR_DARK
  968. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  969. </h4>
  970. <aside class="phpdocumentor-element-found-in">
  971. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  972. :
  973. <span class="phpdocumentor-element-found-in__line">88</span>
  974. </aside>
  975. <code class="phpdocumentor-signature phpdocumentor-code ">
  976. <span class="phpdocumentor-signature__visibility">public</span>
  977. <span class="phpdocumentor-signature__type">int</span>
  978. <span class="phpdocumentor-signature__name">M_SEPARATOR_DARK</span>
  979. = <span class="phpdocumentor-signature__default-value">0b100000001000</span>
  980. </code>
  981. </article>
  982. <article class="phpdocumentor-element -constant -public ">
  983. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING">
  984. M_TIMING
  985. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING" class="headerlink"><i class="fas fa-link"></i></a>
  986. </h4>
  987. <aside class="phpdocumentor-element-found-in">
  988. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  989. :
  990. <span class="phpdocumentor-element-found-in__line">50</span>
  991. </aside>
  992. <code class="phpdocumentor-signature phpdocumentor-code ">
  993. <span class="phpdocumentor-signature__visibility">public</span>
  994. <span class="phpdocumentor-signature__type">int</span>
  995. <span class="phpdocumentor-signature__name">M_TIMING</span>
  996. = <span class="phpdocumentor-signature__default-value">0b100000</span>
  997. </code>
  998. </article>
  999. <article class="phpdocumentor-element -constant -public ">
  1000. <h4 class="phpdocumentor-element__name" id="constant_M_TIMING_DARK">
  1001. M_TIMING_DARK
  1002. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  1003. </h4>
  1004. <aside class="phpdocumentor-element-found-in">
  1005. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1006. :
  1007. <span class="phpdocumentor-element-found-in__line">71</span>
  1008. </aside>
  1009. <code class="phpdocumentor-signature phpdocumentor-code ">
  1010. <span class="phpdocumentor-signature__visibility">public</span>
  1011. <span class="phpdocumentor-signature__type">int</span>
  1012. <span class="phpdocumentor-signature__name">M_TIMING_DARK</span>
  1013. = <span class="phpdocumentor-signature__default-value">0b100000100000</span>
  1014. </code>
  1015. </article>
  1016. <article class="phpdocumentor-element -constant -public ">
  1017. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION">
  1018. M_VERSION
  1019. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
  1020. </h4>
  1021. <aside class="phpdocumentor-element-found-in">
  1022. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1023. :
  1024. <span class="phpdocumentor-element-found-in__line">54</span>
  1025. </aside>
  1026. <code class="phpdocumentor-signature phpdocumentor-code ">
  1027. <span class="phpdocumentor-signature__visibility">public</span>
  1028. <span class="phpdocumentor-signature__type">int</span>
  1029. <span class="phpdocumentor-signature__name">M_VERSION</span>
  1030. = <span class="phpdocumentor-signature__default-value">0b10000000</span>
  1031. </code>
  1032. </article>
  1033. <article class="phpdocumentor-element -constant -public ">
  1034. <h4 class="phpdocumentor-element__name" id="constant_M_VERSION_DARK">
  1035. M_VERSION_DARK
  1036. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK" class="headerlink"><i class="fas fa-link"></i></a>
  1037. </h4>
  1038. <aside class="phpdocumentor-element-found-in">
  1039. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1040. :
  1041. <span class="phpdocumentor-element-found-in__line">75</span>
  1042. </aside>
  1043. <code class="phpdocumentor-signature phpdocumentor-code ">
  1044. <span class="phpdocumentor-signature__visibility">public</span>
  1045. <span class="phpdocumentor-signature__type">int</span>
  1046. <span class="phpdocumentor-signature__name">M_VERSION_DARK</span>
  1047. = <span class="phpdocumentor-signature__default-value">0b100010000000</span>
  1048. </code>
  1049. </article>
  1050. <article class="phpdocumentor-element -constant -protected ">
  1051. <h4 class="phpdocumentor-element__name" id="constant_neighbours">
  1052. neighbours
  1053. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1054. </h4>
  1055. <aside class="phpdocumentor-element-found-in">
  1056. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1057. :
  1058. <span class="phpdocumentor-element-found-in__line">99</span>
  1059. </aside>
  1060. <p class="phpdocumentor-summary">Map of flag =&gt; coord</p>
  1061. <code class="phpdocumentor-signature phpdocumentor-code ">
  1062. <span class="phpdocumentor-signature__visibility">protected</span>
  1063. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1064. <span class="phpdocumentor-signature__name">neighbours</span>
  1065. = <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>
  1066. </code>
  1067. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1068. Tags
  1069. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1070. </h5>
  1071. <dl class="phpdocumentor-tag-list">
  1072. <dt class="phpdocumentor-tag-list__entry">
  1073. <span class="phpdocumentor-tag__name">see</span>
  1074. </dt>
  1075. <dd class="phpdocumentor-tag-list__definition">
  1076. <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>
  1077. </dd>
  1078. </dl>
  1079. </article>
  1080. <article class="phpdocumentor-element -constant -private ">
  1081. <h4 class="phpdocumentor-element__name" id="constant_DECODE_LOOKUP">
  1082. DECODE_LOOKUP
  1083. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_DECODE_LOOKUP" class="headerlink"><i class="fas fa-link"></i></a>
  1084. </h4>
  1085. <aside class="phpdocumentor-element-found-in">
  1086. <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>
  1087. :
  1088. <span class="phpdocumentor-element-found-in__line">29</span>
  1089. </aside>
  1090. <p class="phpdocumentor-summary">See ISO 18004:2006, Annex C, Table C.1</p>
  1091. <code class="phpdocumentor-signature phpdocumentor-code ">
  1092. <span class="phpdocumentor-signature__visibility">private</span>
  1093. <span class="phpdocumentor-signature__type">mixed</span>
  1094. <span class="phpdocumentor-signature__name">DECODE_LOOKUP</span>
  1095. = <span class="phpdocumentor-signature__default-value">[
  1096. 0x5412,
  1097. // 0101010000010010
  1098. 0x5125,
  1099. // 0101000100100101
  1100. 0x5e7c,
  1101. // 0101111001111100
  1102. 0x5b4b,
  1103. // 0101101101001011
  1104. 0x45f9,
  1105. // 0100010111111001
  1106. 0x40ce,
  1107. // 0100000011001110
  1108. 0x4f97,
  1109. // 0100111110010111
  1110. 0x4aa0,
  1111. // 0100101010100000
  1112. 0x77c4,
  1113. // 0111011111000100
  1114. 0x72f3,
  1115. // 0111001011110011
  1116. 0x7daa,
  1117. // 0111110110101010
  1118. 0x789d,
  1119. // 0111100010011101
  1120. 0x662f,
  1121. // 0110011000101111
  1122. 0x6318,
  1123. // 0110001100011000
  1124. 0x6c41,
  1125. // 0110110001000001
  1126. 0x6976,
  1127. // 0110100101110110
  1128. 0x1689,
  1129. // 0001011010001001
  1130. 0x13be,
  1131. // 0001001110111110
  1132. 0x1ce7,
  1133. // 0001110011100111
  1134. 0x19d0,
  1135. // 0001100111010000
  1136. 0x762,
  1137. // 0000011101100010
  1138. 0x255,
  1139. // 0000001001010101
  1140. 0xd0c,
  1141. // 0000110100001100
  1142. 0x83b,
  1143. // 0000100000111011
  1144. 0x355f,
  1145. // 0011010101011111
  1146. 0x3068,
  1147. // 0011000001101000
  1148. 0x3f31,
  1149. // 0011111100110001
  1150. 0x3a06,
  1151. // 0011101000000110
  1152. 0x24b4,
  1153. // 0010010010110100
  1154. 0x2183,
  1155. // 0010000110000011
  1156. 0x2eda,
  1157. // 0010111011011010
  1158. 0x2bed,
  1159. ]</span>
  1160. </code>
  1161. <section class="phpdocumentor-description"><p>[data bits, sequence after masking]</p>
  1162. </section>
  1163. </article>
  1164. <article class="phpdocumentor-element -constant -private ">
  1165. <h4 class="phpdocumentor-element__name" id="constant_FORMAT_INFO_MASK_QR">
  1166. FORMAT_INFO_MASK_QR
  1167. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_FORMAT_INFO_MASK_QR" class="headerlink"><i class="fas fa-link"></i></a>
  1168. </h4>
  1169. <aside class="phpdocumentor-element-found-in">
  1170. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  1171. :
  1172. <span class="phpdocumentor-element-found-in__line">64</span>
  1173. </aside>
  1174. <code class="phpdocumentor-signature phpdocumentor-code ">
  1175. <span class="phpdocumentor-signature__visibility">private</span>
  1176. <span class="phpdocumentor-signature__type">mixed</span>
  1177. <span class="phpdocumentor-signature__name">FORMAT_INFO_MASK_QR</span>
  1178. = <span class="phpdocumentor-signature__default-value">0x5412</span>
  1179. </code>
  1180. </article>
  1181. </section>
  1182. <section class="phpdocumentor-properties">
  1183. <h3 class="phpdocumentor-elements__header" id="properties">
  1184. Properties
  1185. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  1186. </h3>
  1187. <article
  1188. class="
  1189. phpdocumentor-element
  1190. -property
  1191. -protected
  1192. "
  1193. >
  1194. <h4 class="phpdocumentor-element__name" id="property_eccLevel">
  1195. $eccLevel
  1196. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1197. <span class="phpdocumentor-element__modifiers">
  1198. </span>
  1199. </h4>
  1200. <aside class="phpdocumentor-element-found-in">
  1201. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1202. :
  1203. <span class="phpdocumentor-element-found-in__line">118</span>
  1204. </aside>
  1205. <p class="phpdocumentor-summary">the current ECC level - always set in QRMatrix, may be null in BitMatrix</p>
  1206. <code class="phpdocumentor-code phpdocumentor-signature ">
  1207. <span class="phpdocumentor-signature__visibility">protected</span>
  1208. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span>
  1209. <span class="phpdocumentor-signature__name">$eccLevel</span>
  1210. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1211. </article>
  1212. <article
  1213. class="
  1214. phpdocumentor-element
  1215. -property
  1216. -protected
  1217. "
  1218. >
  1219. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  1220. $maskPattern
  1221. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1222. <span class="phpdocumentor-element__modifiers">
  1223. </span>
  1224. </h4>
  1225. <aside class="phpdocumentor-element-found-in">
  1226. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1227. :
  1228. <span class="phpdocumentor-element-found-in__line">127</span>
  1229. </aside>
  1230. <p class="phpdocumentor-summary">the mask pattern that was used in the most recent operation, set via:</p>
  1231. <code class="phpdocumentor-code phpdocumentor-signature ">
  1232. <span class="phpdocumentor-signature__visibility">protected</span>
  1233. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  1234. <span class="phpdocumentor-signature__name">$maskPattern</span>
  1235. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1236. <section class="phpdocumentor-description"><ul>
  1237. <li>QRMatrix::setFormatInfo()</li>
  1238. <li>QRMatrix::mask()</li>
  1239. <li>BitMatrix::readFormatInformation()</li>
  1240. </ul>
  1241. </section>
  1242. </article>
  1243. <article
  1244. class="
  1245. phpdocumentor-element
  1246. -property
  1247. -protected
  1248. "
  1249. >
  1250. <h4 class="phpdocumentor-element__name" id="property_matrix">
  1251. $matrix
  1252. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  1253. <span class="phpdocumentor-element__modifiers">
  1254. </span>
  1255. </h4>
  1256. <aside class="phpdocumentor-element-found-in">
  1257. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1258. :
  1259. <span class="phpdocumentor-element-found-in__line">139</span>
  1260. </aside>
  1261. <p class="phpdocumentor-summary">the actual matrix data array</p>
  1262. <code class="phpdocumentor-code phpdocumentor-signature ">
  1263. <span class="phpdocumentor-signature__visibility">protected</span>
  1264. <span class="phpdocumentor-signature__type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  1265. <span class="phpdocumentor-signature__name">$matrix</span>
  1266. </code>
  1267. </article>
  1268. <article
  1269. class="
  1270. phpdocumentor-element
  1271. -property
  1272. -protected
  1273. "
  1274. >
  1275. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  1276. $moduleCount
  1277. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  1278. <span class="phpdocumentor-element__modifiers">
  1279. </span>
  1280. </h4>
  1281. <aside class="phpdocumentor-element-found-in">
  1282. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1283. :
  1284. <span class="phpdocumentor-element-found-in__line">132</span>
  1285. </aside>
  1286. <p class="phpdocumentor-summary">the size (side length) of the matrix, including quiet zone (if created)</p>
  1287. <code class="phpdocumentor-code phpdocumentor-signature ">
  1288. <span class="phpdocumentor-signature__visibility">protected</span>
  1289. <span class="phpdocumentor-signature__type">int</span>
  1290. <span class="phpdocumentor-signature__name">$moduleCount</span>
  1291. </code>
  1292. </article>
  1293. <article
  1294. class="
  1295. phpdocumentor-element
  1296. -property
  1297. -protected
  1298. "
  1299. >
  1300. <h4 class="phpdocumentor-element__name" id="property_version">
  1301. $version
  1302. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  1303. <span class="phpdocumentor-element__modifiers">
  1304. </span>
  1305. </h4>
  1306. <aside class="phpdocumentor-element-found-in">
  1307. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1308. :
  1309. <span class="phpdocumentor-element-found-in__line">113</span>
  1310. </aside>
  1311. <p class="phpdocumentor-summary">the matrix version - always set in QRMatrix, may be null in BitMatrix</p>
  1312. <code class="phpdocumentor-code phpdocumentor-signature ">
  1313. <span class="phpdocumentor-signature__visibility">protected</span>
  1314. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  1315. <span class="phpdocumentor-signature__name">$version</span>
  1316. = <span class="phpdocumentor-signature__default-value">null</span></code>
  1317. </article>
  1318. <article
  1319. class="
  1320. phpdocumentor-element
  1321. -property
  1322. -private
  1323. "
  1324. >
  1325. <h4 class="phpdocumentor-element__name" id="property_mirror">
  1326. $mirror
  1327. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror" class="headerlink"><i class="fas fa-link"></i></a>
  1328. <span class="phpdocumentor-element__modifiers">
  1329. </span>
  1330. </h4>
  1331. <aside class="phpdocumentor-element-found-in">
  1332. <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>
  1333. :
  1334. <span class="phpdocumentor-element-found-in__line">70</span>
  1335. </aside>
  1336. <p class="phpdocumentor-summary">This flag has effect only on the copyVersionBit() method.</p>
  1337. <code class="phpdocumentor-code phpdocumentor-signature ">
  1338. <span class="phpdocumentor-signature__visibility">private</span>
  1339. <span class="phpdocumentor-signature__type">bool</span>
  1340. <span class="phpdocumentor-signature__name">$mirror</span>
  1341. = <span class="phpdocumentor-signature__default-value">false</span></code>
  1342. <section class="phpdocumentor-description"><p>Before proceeding with readCodewords() the resetInfo() method should be called.</p>
  1343. </section>
  1344. </article>
  1345. </section>
  1346. <section class="phpdocumentor-methods">
  1347. <h3 class="phpdocumentor-elements__header" id="methods">
  1348. Methods
  1349. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1350. </h3>
  1351. <article
  1352. class="phpdocumentor-element
  1353. -method
  1354. -public
  1355. "
  1356. >
  1357. <h4 class="phpdocumentor-element__name" id="method___construct">
  1358. __construct()
  1359. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1360. </h4>
  1361. <aside class="phpdocumentor-element-found-in">
  1362. <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>
  1363. :
  1364. <span class="phpdocumentor-element-found-in__line">75</span>
  1365. </aside>
  1366. <p class="phpdocumentor-summary">QRMatrix constructor.</p>
  1367. <code class="phpdocumentor-code phpdocumentor-signature ">
  1368. <span class="phpdocumentor-signature__visibility">public</span>
  1369. <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>
  1370. <div class="phpdocumentor-label-line">
  1371. </div>
  1372. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1373. <dl class="phpdocumentor-argument-list">
  1374. <dt class="phpdocumentor-argument-list__entry">
  1375. <span class="phpdocumentor-signature__argument__name">$dimension</span>
  1376. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1377. </dt>
  1378. <dd class="phpdocumentor-argument-list__definition">
  1379. </dd>
  1380. </dl>
  1381. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1382. Tags
  1383. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1384. </h5>
  1385. <dl class="phpdocumentor-tag-list">
  1386. <dt class="phpdocumentor-tag-list__entry">
  1387. <span class="phpdocumentor-tag__name">noinspection</span>
  1388. </dt>
  1389. <dd class="phpdocumentor-tag-list__definition">
  1390. <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
  1391. </section>
  1392. </dd>
  1393. </dl>
  1394. </article>
  1395. <article
  1396. class="phpdocumentor-element
  1397. -method
  1398. -public
  1399. "
  1400. >
  1401. <h4 class="phpdocumentor-element__name" id="method_check">
  1402. check()
  1403. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check" class="headerlink"><i class="fas fa-link"></i></a>
  1404. </h4>
  1405. <aside class="phpdocumentor-element-found-in">
  1406. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1407. :
  1408. <span class="phpdocumentor-element-found-in__line">319</span>
  1409. </aside>
  1410. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is true (dark) or false (light)</p>
  1411. <code class="phpdocumentor-code phpdocumentor-signature ">
  1412. <span class="phpdocumentor-signature__visibility">public</span>
  1413. <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>
  1414. <div class="phpdocumentor-label-line">
  1415. </div>
  1416. <section class="phpdocumentor-description"><p>Also, returns false if the given coordinates are out of range.</p>
  1417. </section>
  1418. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1419. <dl class="phpdocumentor-argument-list">
  1420. <dt class="phpdocumentor-argument-list__entry">
  1421. <span class="phpdocumentor-signature__argument__name">$x</span>
  1422. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1423. </dt>
  1424. <dd class="phpdocumentor-argument-list__definition">
  1425. </dd>
  1426. <dt class="phpdocumentor-argument-list__entry">
  1427. <span class="phpdocumentor-signature__argument__name">$y</span>
  1428. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1429. </dt>
  1430. <dd class="phpdocumentor-argument-list__definition">
  1431. </dd>
  1432. </dl>
  1433. <section>
  1434. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1435. <span class="phpdocumentor-signature__response_type">bool</span>
  1436. </section>
  1437. </article>
  1438. <article
  1439. class="phpdocumentor-element
  1440. -method
  1441. -public
  1442. "
  1443. >
  1444. <h4 class="phpdocumentor-element__name" id="method_checkNeighbours">
  1445. checkNeighbours()
  1446. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours" class="headerlink"><i class="fas fa-link"></i></a>
  1447. </h4>
  1448. <aside class="phpdocumentor-element-found-in">
  1449. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1450. :
  1451. <span class="phpdocumentor-element-found-in__line">345</span>
  1452. </aside>
  1453. <p class="phpdocumentor-summary">Checks the status of the neighbouring modules for the module at ($x, $y) and returns a bitmask with the results.</p>
  1454. <code class="phpdocumentor-code phpdocumentor-signature ">
  1455. <span class="phpdocumentor-signature__visibility">public</span>
  1456. <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|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1457. <div class="phpdocumentor-label-line">
  1458. </div>
  1459. <section class="phpdocumentor-description"><p>The 8 flags of the bitmask represent the status of each of the neighbouring fields,
  1460. starting with the lowest bit for top left, going clockwise:</p>
  1461. <p>0 1 2
  1462. 7 # 3
  1463. 6 5 4</p>
  1464. </section>
  1465. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1466. <dl class="phpdocumentor-argument-list">
  1467. <dt class="phpdocumentor-argument-list__entry">
  1468. <span class="phpdocumentor-signature__argument__name">$x</span>
  1469. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1470. </dt>
  1471. <dd class="phpdocumentor-argument-list__definition">
  1472. </dd>
  1473. <dt class="phpdocumentor-argument-list__entry">
  1474. <span class="phpdocumentor-signature__argument__name">$y</span>
  1475. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1476. </dt>
  1477. <dd class="phpdocumentor-argument-list__definition">
  1478. </dd>
  1479. <dt class="phpdocumentor-argument-list__entry">
  1480. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1481. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  1482. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1483. <dd class="phpdocumentor-argument-list__definition">
  1484. </dd>
  1485. </dl>
  1486. <section>
  1487. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1488. <span class="phpdocumentor-signature__response_type">int</span>
  1489. </section>
  1490. </article>
  1491. <article
  1492. class="phpdocumentor-element
  1493. -method
  1494. -public
  1495. "
  1496. >
  1497. <h4 class="phpdocumentor-element__name" id="method_checkType">
  1498. checkType()
  1499. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType" class="headerlink"><i class="fas fa-link"></i></a>
  1500. </h4>
  1501. <aside class="phpdocumentor-element-found-in">
  1502. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1503. :
  1504. <span class="phpdocumentor-element-found-in__line">290</span>
  1505. </aside>
  1506. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is of the given $M_TYPE</p>
  1507. <code class="phpdocumentor-code phpdocumentor-signature ">
  1508. <span class="phpdocumentor-signature__visibility">public</span>
  1509. <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>
  1510. <div class="phpdocumentor-label-line">
  1511. </div>
  1512. <section class="phpdocumentor-description"><p>true =&gt; $value &amp; $M_TYPE === $M_TYPE</p>
  1513. <p>Also, returns false if the given coordinates are out of range.</p>
  1514. </section>
  1515. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1516. <dl class="phpdocumentor-argument-list">
  1517. <dt class="phpdocumentor-argument-list__entry">
  1518. <span class="phpdocumentor-signature__argument__name">$x</span>
  1519. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1520. </dt>
  1521. <dd class="phpdocumentor-argument-list__definition">
  1522. </dd>
  1523. <dt class="phpdocumentor-argument-list__entry">
  1524. <span class="phpdocumentor-signature__argument__name">$y</span>
  1525. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1526. </dt>
  1527. <dd class="phpdocumentor-argument-list__definition">
  1528. </dd>
  1529. <dt class="phpdocumentor-argument-list__entry">
  1530. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1531. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1532. </dt>
  1533. <dd class="phpdocumentor-argument-list__definition">
  1534. </dd>
  1535. </dl>
  1536. <section>
  1537. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1538. <span class="phpdocumentor-signature__response_type">bool</span>
  1539. </section>
  1540. </article>
  1541. <article
  1542. class="phpdocumentor-element
  1543. -method
  1544. -public
  1545. "
  1546. >
  1547. <h4 class="phpdocumentor-element__name" id="method_checkTypeIn">
  1548. checkTypeIn()
  1549. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn" class="headerlink"><i class="fas fa-link"></i></a>
  1550. </h4>
  1551. <aside class="phpdocumentor-element-found-in">
  1552. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1553. :
  1554. <span class="phpdocumentor-element-found-in__line">303</span>
  1555. </aside>
  1556. <p class="phpdocumentor-summary">Checks whether the module at ($x, $y) is in the given array of $M_TYPES,
  1557. returns true if a match is found, otherwise false.</p>
  1558. <code class="phpdocumentor-code phpdocumentor-signature ">
  1559. <span class="phpdocumentor-signature__visibility">public</span>
  1560. <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>
  1561. <div class="phpdocumentor-label-line">
  1562. </div>
  1563. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1564. <dl class="phpdocumentor-argument-list">
  1565. <dt class="phpdocumentor-argument-list__entry">
  1566. <span class="phpdocumentor-signature__argument__name">$x</span>
  1567. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1568. </dt>
  1569. <dd class="phpdocumentor-argument-list__definition">
  1570. </dd>
  1571. <dt class="phpdocumentor-argument-list__entry">
  1572. <span class="phpdocumentor-signature__argument__name">$y</span>
  1573. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1574. </dt>
  1575. <dd class="phpdocumentor-argument-list__definition">
  1576. </dd>
  1577. <dt class="phpdocumentor-argument-list__entry">
  1578. <span class="phpdocumentor-signature__argument__name">$M_TYPES</span>
  1579. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1580. </dt>
  1581. <dd class="phpdocumentor-argument-list__definition">
  1582. </dd>
  1583. </dl>
  1584. <section>
  1585. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1586. <span class="phpdocumentor-signature__response_type">bool</span>
  1587. </section>
  1588. </article>
  1589. <article
  1590. class="phpdocumentor-element
  1591. -method
  1592. -public
  1593. "
  1594. >
  1595. <h4 class="phpdocumentor-element__name" id="method_flip">
  1596. flip()
  1597. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  1598. </h4>
  1599. <aside class="phpdocumentor-element-found-in">
  1600. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1601. :
  1602. <span class="phpdocumentor-element-found-in__line">274</span>
  1603. </aside>
  1604. <p class="phpdocumentor-summary">Flips the value of the module at ($x, $y)</p>
  1605. <code class="phpdocumentor-code phpdocumentor-signature ">
  1606. <span class="phpdocumentor-signature__visibility">public</span>
  1607. <span class="phpdocumentor-signature__name">flip</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1608. <div class="phpdocumentor-label-line">
  1609. </div>
  1610. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1611. <dl class="phpdocumentor-argument-list">
  1612. <dt class="phpdocumentor-argument-list__entry">
  1613. <span class="phpdocumentor-signature__argument__name">$x</span>
  1614. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1615. </dt>
  1616. <dd class="phpdocumentor-argument-list__definition">
  1617. </dd>
  1618. <dt class="phpdocumentor-argument-list__entry">
  1619. <span class="phpdocumentor-signature__argument__name">$y</span>
  1620. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1621. </dt>
  1622. <dd class="phpdocumentor-argument-list__definition">
  1623. </dd>
  1624. </dl>
  1625. <section>
  1626. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1627. <span class="phpdocumentor-signature__response_type">static</span>
  1628. </section>
  1629. </article>
  1630. <article
  1631. class="phpdocumentor-element
  1632. -method
  1633. -public
  1634. "
  1635. >
  1636. <h4 class="phpdocumentor-element__name" id="method_get">
  1637. get()
  1638. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  1639. </h4>
  1640. <aside class="phpdocumentor-element-found-in">
  1641. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1642. :
  1643. <span class="phpdocumentor-element-found-in__line">226</span>
  1644. </aside>
  1645. <p class="phpdocumentor-summary">Returns the value of the module at position [$x, $y] or -1 if the coordinate is outside the matrix</p>
  1646. <code class="phpdocumentor-code phpdocumentor-signature ">
  1647. <span class="phpdocumentor-signature__visibility">public</span>
  1648. <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>
  1649. <div class="phpdocumentor-label-line">
  1650. </div>
  1651. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1652. <dl class="phpdocumentor-argument-list">
  1653. <dt class="phpdocumentor-argument-list__entry">
  1654. <span class="phpdocumentor-signature__argument__name">$x</span>
  1655. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1656. </dt>
  1657. <dd class="phpdocumentor-argument-list__definition">
  1658. </dd>
  1659. <dt class="phpdocumentor-argument-list__entry">
  1660. <span class="phpdocumentor-signature__argument__name">$y</span>
  1661. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1662. </dt>
  1663. <dd class="phpdocumentor-argument-list__definition">
  1664. </dd>
  1665. </dl>
  1666. <section>
  1667. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1668. <span class="phpdocumentor-signature__response_type">int</span>
  1669. </section>
  1670. </article>
  1671. <article
  1672. class="phpdocumentor-element
  1673. -method
  1674. -public
  1675. "
  1676. >
  1677. <h4 class="phpdocumentor-element__name" id="method_getEccLevel">
  1678. getEccLevel()
  1679. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel" class="headerlink"><i class="fas fa-link"></i></a>
  1680. </h4>
  1681. <aside class="phpdocumentor-element-found-in">
  1682. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1683. :
  1684. <span class="phpdocumentor-element-found-in__line">203</span>
  1685. </aside>
  1686. <p class="phpdocumentor-summary">Returns the current ECC level</p>
  1687. <code class="phpdocumentor-code phpdocumentor-signature ">
  1688. <span class="phpdocumentor-signature__visibility">public</span>
  1689. <span class="phpdocumentor-signature__name">getEccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a>|null</span></code>
  1690. <div class="phpdocumentor-label-line">
  1691. </div>
  1692. <section>
  1693. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1694. <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>
  1695. </section>
  1696. </article>
  1697. <article
  1698. class="phpdocumentor-element
  1699. -method
  1700. -public
  1701. "
  1702. >
  1703. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  1704. getMaskPattern()
  1705. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  1706. </h4>
  1707. <aside class="phpdocumentor-element-found-in">
  1708. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1709. :
  1710. <span class="phpdocumentor-element-found-in__line">210</span>
  1711. </aside>
  1712. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  1713. <code class="phpdocumentor-code phpdocumentor-signature ">
  1714. <span class="phpdocumentor-signature__visibility">public</span>
  1715. <span class="phpdocumentor-signature__name">getMaskPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span></code>
  1716. <div class="phpdocumentor-label-line">
  1717. </div>
  1718. <section>
  1719. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1720. <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>
  1721. </section>
  1722. </article>
  1723. <article
  1724. class="phpdocumentor-element
  1725. -method
  1726. -public
  1727. "
  1728. >
  1729. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1730. getMatrix()
  1731. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1732. </h4>
  1733. <aside class="phpdocumentor-element-found-in">
  1734. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1735. :
  1736. <span class="phpdocumentor-element-found-in__line">178</span>
  1737. </aside>
  1738. <p class="phpdocumentor-summary">Returns the data matrix, returns a pure boolean representation if $boolean is set to true</p>
  1739. <code class="phpdocumentor-code phpdocumentor-signature ">
  1740. <span class="phpdocumentor-signature__visibility">public</span>
  1741. <span class="phpdocumentor-signature__name">getMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$boolean</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;|array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span></code>
  1742. <div class="phpdocumentor-label-line">
  1743. </div>
  1744. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1745. <dl class="phpdocumentor-argument-list">
  1746. <dt class="phpdocumentor-argument-list__entry">
  1747. <span class="phpdocumentor-signature__argument__name">$boolean</span>
  1748. : <span class="phpdocumentor-signature__argument__return-type">bool|null</span>
  1749. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1750. <dd class="phpdocumentor-argument-list__definition">
  1751. </dd>
  1752. </dl>
  1753. <section>
  1754. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1755. <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>
  1756. </section>
  1757. </article>
  1758. <article
  1759. class="phpdocumentor-element
  1760. -method
  1761. -public
  1762. "
  1763. >
  1764. <h4 class="phpdocumentor-element__name" id="method_getSize">
  1765. getSize()
  1766. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize" class="headerlink"><i class="fas fa-link"></i></a>
  1767. </h4>
  1768. <aside class="phpdocumentor-element-found-in">
  1769. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1770. :
  1771. <span class="phpdocumentor-element-found-in__line">219</span>
  1772. </aside>
  1773. <p class="phpdocumentor-summary">Returns the absoulute size of the matrix, including quiet zone (after setting it).</p>
  1774. <code class="phpdocumentor-code phpdocumentor-signature ">
  1775. <span class="phpdocumentor-signature__visibility">public</span>
  1776. <span class="phpdocumentor-signature__name">getSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1777. <div class="phpdocumentor-label-line">
  1778. </div>
  1779. <section class="phpdocumentor-description"><p>size = version * 4 + 17 [ + 2 * quietzone size]</p>
  1780. </section>
  1781. <section>
  1782. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1783. <span class="phpdocumentor-signature__response_type">int</span>
  1784. </section>
  1785. </article>
  1786. <article
  1787. class="phpdocumentor-element
  1788. -method
  1789. -public
  1790. "
  1791. >
  1792. <h4 class="phpdocumentor-element__name" id="method_getVersion">
  1793. getVersion()
  1794. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
  1795. </h4>
  1796. <aside class="phpdocumentor-element-found-in">
  1797. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1798. :
  1799. <span class="phpdocumentor-element-found-in__line">196</span>
  1800. </aside>
  1801. <p class="phpdocumentor-summary">Returns the current version number</p>
  1802. <code class="phpdocumentor-code phpdocumentor-signature ">
  1803. <span class="phpdocumentor-signature__visibility">public</span>
  1804. <span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  1805. <div class="phpdocumentor-label-line">
  1806. </div>
  1807. <section>
  1808. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1809. <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>
  1810. </section>
  1811. </article>
  1812. <article
  1813. class="phpdocumentor-element
  1814. -method
  1815. -public
  1816. "
  1817. >
  1818. <h4 class="phpdocumentor-element__name" id="method_initFunctionalPatterns">
  1819. initFunctionalPatterns()
  1820. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns" class="headerlink"><i class="fas fa-link"></i></a>
  1821. </h4>
  1822. <aside class="phpdocumentor-element-found-in">
  1823. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1824. :
  1825. <span class="phpdocumentor-element-found-in__line">161</span>
  1826. </aside>
  1827. <p class="phpdocumentor-summary">shortcut to initialize the functional patterns</p>
  1828. <code class="phpdocumentor-code phpdocumentor-signature ">
  1829. <span class="phpdocumentor-signature__visibility">public</span>
  1830. <span class="phpdocumentor-signature__name">initFunctionalPatterns</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1831. <div class="phpdocumentor-label-line">
  1832. </div>
  1833. <section>
  1834. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1835. <span class="phpdocumentor-signature__response_type">static</span>
  1836. </section>
  1837. </article>
  1838. <article
  1839. class="phpdocumentor-element
  1840. -method
  1841. -public
  1842. "
  1843. >
  1844. <h4 class="phpdocumentor-element__name" id="method_invert">
  1845. invert()
  1846. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert" class="headerlink"><i class="fas fa-link"></i></a>
  1847. </h4>
  1848. <aside class="phpdocumentor-element-found-in">
  1849. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1850. :
  1851. <span class="phpdocumentor-element-found-in__line">597</span>
  1852. </aside>
  1853. <p class="phpdocumentor-summary">Inverts the values of the whole matrix</p>
  1854. <code class="phpdocumentor-code phpdocumentor-signature ">
  1855. <span class="phpdocumentor-signature__visibility">public</span>
  1856. <span class="phpdocumentor-signature__name">invert</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1857. <div class="phpdocumentor-label-line">
  1858. </div>
  1859. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2015 Section 6.2 - Reflectance reversal</p>
  1860. </section>
  1861. <section>
  1862. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1863. <span class="phpdocumentor-signature__response_type">static</span>
  1864. </section>
  1865. </article>
  1866. <article
  1867. class="phpdocumentor-element
  1868. -method
  1869. -public
  1870. "
  1871. >
  1872. <h4 class="phpdocumentor-element__name" id="method_isDark">
  1873. isDark()
  1874. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_isDark" class="headerlink"><i class="fas fa-link"></i></a>
  1875. </h4>
  1876. <aside class="phpdocumentor-element-found-in">
  1877. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1878. :
  1879. <span class="phpdocumentor-element-found-in__line">331</span>
  1880. </aside>
  1881. <p class="phpdocumentor-summary">Checks whether the given $M_TYPE is a dark value</p>
  1882. <code class="phpdocumentor-code phpdocumentor-signature ">
  1883. <span class="phpdocumentor-signature__visibility">public</span>
  1884. <span class="phpdocumentor-signature__name">isDark</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1885. <div class="phpdocumentor-label-line">
  1886. </div>
  1887. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1888. <dl class="phpdocumentor-argument-list">
  1889. <dt class="phpdocumentor-argument-list__entry">
  1890. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1891. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1892. </dt>
  1893. <dd class="phpdocumentor-argument-list__definition">
  1894. </dd>
  1895. </dl>
  1896. <section>
  1897. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1898. <span class="phpdocumentor-signature__response_type">bool</span>
  1899. </section>
  1900. </article>
  1901. <article
  1902. class="phpdocumentor-element
  1903. -method
  1904. -public
  1905. "
  1906. >
  1907. <h4 class="phpdocumentor-element__name" id="method_mask">
  1908. mask()
  1909. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask" class="headerlink"><i class="fas fa-link"></i></a>
  1910. </h4>
  1911. <aside class="phpdocumentor-element-found-in">
  1912. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  1913. :
  1914. <span class="phpdocumentor-element-found-in__line">751</span>
  1915. </aside>
  1916. <p class="phpdocumentor-summary">Applies/reverses the mask pattern</p>
  1917. <code class="phpdocumentor-code phpdocumentor-signature ">
  1918. <span class="phpdocumentor-signature__visibility">public</span>
  1919. <span class="phpdocumentor-signature__name">mask</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1920. <div class="phpdocumentor-label-line">
  1921. </div>
  1922. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.8.1</p>
  1923. </section>
  1924. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1925. <dl class="phpdocumentor-argument-list">
  1926. <dt class="phpdocumentor-argument-list__entry">
  1927. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  1928. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  1929. </dt>
  1930. <dd class="phpdocumentor-argument-list__definition">
  1931. </dd>
  1932. </dl>
  1933. <section>
  1934. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1935. <span class="phpdocumentor-signature__response_type">static</span>
  1936. </section>
  1937. </article>
  1938. <article
  1939. class="phpdocumentor-element
  1940. -method
  1941. -public
  1942. "
  1943. >
  1944. <h4 class="phpdocumentor-element__name" id="method_mirrorDiagonal">
  1945. mirrorDiagonal()
  1946. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirrorDiagonal" class="headerlink"><i class="fas fa-link"></i></a>
  1947. </h4>
  1948. <aside class="phpdocumentor-element-found-in">
  1949. <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>
  1950. :
  1951. <span class="phpdocumentor-element-found-in__line">94</span>
  1952. </aside>
  1953. <p class="phpdocumentor-summary">Mirror the bit matrix diagonally in order to attempt a second reading.</p>
  1954. <code class="phpdocumentor-code phpdocumentor-signature ">
  1955. <span class="phpdocumentor-signature__visibility">public</span>
  1956. <span class="phpdocumentor-signature__name">mirrorDiagonal</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1957. <div class="phpdocumentor-label-line">
  1958. </div>
  1959. <section>
  1960. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1961. <span class="phpdocumentor-signature__response_type">static</span>
  1962. </section>
  1963. </article>
  1964. <article
  1965. class="phpdocumentor-element
  1966. -method
  1967. -public
  1968. "
  1969. >
  1970. <h4 class="phpdocumentor-element__name" id="method_readCodewords">
  1971. readCodewords()
  1972. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  1973. </h4>
  1974. <aside class="phpdocumentor-element-found-in">
  1975. <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>
  1976. :
  1977. <span class="phpdocumentor-element-found-in__line">110</span>
  1978. </aside>
  1979. <p class="phpdocumentor-summary">Reads the bits in the BitMatrix representing the finder pattern in the
  1980. correct order in order to reconstruct the codewords bytes contained within the
  1981. QR Code. Throws if the exact number of bytes expected is not read.</p>
  1982. <code class="phpdocumentor-code phpdocumentor-signature ">
  1983. <span class="phpdocumentor-signature__visibility">public</span>
  1984. <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>
  1985. <div class="phpdocumentor-label-line">
  1986. </div>
  1987. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1988. Tags
  1989. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1990. </h5>
  1991. <dl class="phpdocumentor-tag-list">
  1992. <dt class="phpdocumentor-tag-list__entry">
  1993. <span class="phpdocumentor-tag__name">throws</span>
  1994. </dt>
  1995. <dd class="phpdocumentor-tag-list__definition">
  1996. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  1997. </dd>
  1998. </dl>
  1999. <section>
  2000. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2001. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  2002. </section>
  2003. </article>
  2004. <article
  2005. class="phpdocumentor-element
  2006. -method
  2007. -public
  2008. "
  2009. >
  2010. <h4 class="phpdocumentor-element__name" id="method_resetVersionInfo">
  2011. resetVersionInfo()
  2012. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_resetVersionInfo" class="headerlink"><i class="fas fa-link"></i></a>
  2013. </h4>
  2014. <aside class="phpdocumentor-element-found-in">
  2015. <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>
  2016. :
  2017. <span class="phpdocumentor-element-found-in__line">83</span>
  2018. </aside>
  2019. <p class="phpdocumentor-summary">Resets the current version info in order to attempt another reading</p>
  2020. <code class="phpdocumentor-code phpdocumentor-signature ">
  2021. <span class="phpdocumentor-signature__visibility">public</span>
  2022. <span class="phpdocumentor-signature__name">resetVersionInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2023. <div class="phpdocumentor-label-line">
  2024. </div>
  2025. <section>
  2026. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2027. <span class="phpdocumentor-signature__response_type">static</span>
  2028. </section>
  2029. </article>
  2030. <article
  2031. class="phpdocumentor-element
  2032. -method
  2033. -public
  2034. "
  2035. >
  2036. <h4 class="phpdocumentor-element__name" id="method_rotate90">
  2037. rotate90()
  2038. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90" class="headerlink"><i class="fas fa-link"></i></a>
  2039. </h4>
  2040. <aside class="phpdocumentor-element-found-in">
  2041. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2042. :
  2043. <span class="phpdocumentor-element-found-in__line">585</span>
  2044. </aside>
  2045. <p class="phpdocumentor-summary">Rotates the matrix by 90 degrees clock wise</p>
  2046. <code class="phpdocumentor-code phpdocumentor-signature ">
  2047. <span class="phpdocumentor-signature__visibility">public</span>
  2048. <span class="phpdocumentor-signature__name">rotate90</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2049. <div class="phpdocumentor-label-line">
  2050. </div>
  2051. <section>
  2052. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2053. <span class="phpdocumentor-signature__response_type">static</span>
  2054. </section>
  2055. </article>
  2056. <article
  2057. class="phpdocumentor-element
  2058. -method
  2059. -public
  2060. "
  2061. >
  2062. <h4 class="phpdocumentor-element__name" id="method_set">
  2063. set()
  2064. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  2065. </h4>
  2066. <aside class="phpdocumentor-element-found-in">
  2067. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2068. :
  2069. <span class="phpdocumentor-element-found-in__line">241</span>
  2070. </aside>
  2071. <p class="phpdocumentor-summary">Sets the $M_TYPE value for the module at position [$x, $y]</p>
  2072. <code class="phpdocumentor-code phpdocumentor-signature ">
  2073. <span class="phpdocumentor-signature__visibility">public</span>
  2074. <span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2075. <div class="phpdocumentor-label-line">
  2076. </div>
  2077. <section class="phpdocumentor-description"><p>true =&gt; $M_TYPE | 0x800
  2078. false =&gt; $M_TYPE</p>
  2079. </section>
  2080. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2081. <dl class="phpdocumentor-argument-list">
  2082. <dt class="phpdocumentor-argument-list__entry">
  2083. <span class="phpdocumentor-signature__argument__name">$x</span>
  2084. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2085. </dt>
  2086. <dd class="phpdocumentor-argument-list__definition">
  2087. </dd>
  2088. <dt class="phpdocumentor-argument-list__entry">
  2089. <span class="phpdocumentor-signature__argument__name">$y</span>
  2090. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2091. </dt>
  2092. <dd class="phpdocumentor-argument-list__definition">
  2093. </dd>
  2094. <dt class="phpdocumentor-argument-list__entry">
  2095. <span class="phpdocumentor-signature__argument__name">$value</span>
  2096. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2097. </dt>
  2098. <dd class="phpdocumentor-argument-list__definition">
  2099. </dd>
  2100. <dt class="phpdocumentor-argument-list__entry">
  2101. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  2102. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2103. </dt>
  2104. <dd class="phpdocumentor-argument-list__definition">
  2105. </dd>
  2106. </dl>
  2107. <section>
  2108. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2109. <span class="phpdocumentor-signature__response_type">static</span>
  2110. </section>
  2111. </article>
  2112. <article
  2113. class="phpdocumentor-element
  2114. -method
  2115. -public
  2116. "
  2117. >
  2118. <h4 class="phpdocumentor-element__name" id="method_setAlignmentPattern">
  2119. setAlignmentPattern()
  2120. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2121. </h4>
  2122. <aside class="phpdocumentor-element-found-in">
  2123. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2124. :
  2125. <span class="phpdocumentor-element-found-in__line">435</span>
  2126. </aside>
  2127. <p class="phpdocumentor-summary">Draws the 5x5 alignment patterns</p>
  2128. <code class="phpdocumentor-code phpdocumentor-signature ">
  2129. <span class="phpdocumentor-signature__visibility">public</span>
  2130. <span class="phpdocumentor-signature__name">setAlignmentPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2131. <div class="phpdocumentor-label-line">
  2132. </div>
  2133. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.5</p>
  2134. </section>
  2135. <section>
  2136. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2137. <span class="phpdocumentor-signature__response_type">static</span>
  2138. </section>
  2139. </article>
  2140. <article
  2141. class="phpdocumentor-element
  2142. -method
  2143. -public
  2144. "
  2145. >
  2146. <h4 class="phpdocumentor-element__name" id="method_setArea">
  2147. setArea()
  2148. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea" 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/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2152. :
  2153. <span class="phpdocumentor-element-found-in__line">260</span>
  2154. </aside>
  2155. <p class="phpdocumentor-summary">Fills an area of $width * $height, from the given starting point [$startX, $startY] (top left) with $value for $M_TYPE.</p>
  2156. <code class="phpdocumentor-code phpdocumentor-signature ">
  2157. <span class="phpdocumentor-signature__visibility">public</span>
  2158. <span class="phpdocumentor-signature__name">setArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startY</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2159. <div class="phpdocumentor-label-line">
  2160. </div>
  2161. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2162. <dl class="phpdocumentor-argument-list">
  2163. <dt class="phpdocumentor-argument-list__entry">
  2164. <span class="phpdocumentor-signature__argument__name">$startX</span>
  2165. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2166. </dt>
  2167. <dd class="phpdocumentor-argument-list__definition">
  2168. </dd>
  2169. <dt class="phpdocumentor-argument-list__entry">
  2170. <span class="phpdocumentor-signature__argument__name">$startY</span>
  2171. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2172. </dt>
  2173. <dd class="phpdocumentor-argument-list__definition">
  2174. </dd>
  2175. <dt class="phpdocumentor-argument-list__entry">
  2176. <span class="phpdocumentor-signature__argument__name">$width</span>
  2177. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2178. </dt>
  2179. <dd class="phpdocumentor-argument-list__definition">
  2180. </dd>
  2181. <dt class="phpdocumentor-argument-list__entry">
  2182. <span class="phpdocumentor-signature__argument__name">$height</span>
  2183. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2184. </dt>
  2185. <dd class="phpdocumentor-argument-list__definition">
  2186. </dd>
  2187. <dt class="phpdocumentor-argument-list__entry">
  2188. <span class="phpdocumentor-signature__argument__name">$value</span>
  2189. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  2190. </dt>
  2191. <dd class="phpdocumentor-argument-list__definition">
  2192. </dd>
  2193. <dt class="phpdocumentor-argument-list__entry">
  2194. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  2195. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2196. </dt>
  2197. <dd class="phpdocumentor-argument-list__definition">
  2198. </dd>
  2199. </dl>
  2200. <section>
  2201. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2202. <span class="phpdocumentor-signature__response_type">static</span>
  2203. </section>
  2204. </article>
  2205. <article
  2206. class="phpdocumentor-element
  2207. -method
  2208. -public
  2209. "
  2210. >
  2211. <h4 class="phpdocumentor-element__name" id="method_setDarkModule">
  2212. setDarkModule()
  2213. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule" class="headerlink"><i class="fas fa-link"></i></a>
  2214. </h4>
  2215. <aside class="phpdocumentor-element-found-in">
  2216. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2217. :
  2218. <span class="phpdocumentor-element-found-in__line">370</span>
  2219. </aside>
  2220. <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>
  2221. <code class="phpdocumentor-code phpdocumentor-signature ">
  2222. <span class="phpdocumentor-signature__visibility">public</span>
  2223. <span class="phpdocumentor-signature__name">setDarkModule</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2224. <div class="phpdocumentor-label-line">
  2225. </div>
  2226. <section class="phpdocumentor-description"><p>4 * version + 9 or moduleCount - 8</p>
  2227. </section>
  2228. <section>
  2229. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2230. <span class="phpdocumentor-signature__response_type">static</span>
  2231. </section>
  2232. </article>
  2233. <article
  2234. class="phpdocumentor-element
  2235. -method
  2236. -public
  2237. "
  2238. >
  2239. <h4 class="phpdocumentor-element__name" id="method_setFinderPattern">
  2240. setFinderPattern()
  2241. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2242. </h4>
  2243. <aside class="phpdocumentor-element-found-in">
  2244. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2245. :
  2246. <span class="phpdocumentor-element-found-in__line">381</span>
  2247. </aside>
  2248. <p class="phpdocumentor-summary">Draws the 7x7 finder patterns in the corners top left/right and bottom left</p>
  2249. <code class="phpdocumentor-code phpdocumentor-signature ">
  2250. <span class="phpdocumentor-signature__visibility">public</span>
  2251. <span class="phpdocumentor-signature__name">setFinderPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2252. <div class="phpdocumentor-label-line">
  2253. </div>
  2254. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.2</p>
  2255. </section>
  2256. <section>
  2257. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2258. <span class="phpdocumentor-signature__response_type">static</span>
  2259. </section>
  2260. </article>
  2261. <article
  2262. class="phpdocumentor-element
  2263. -method
  2264. -public
  2265. "
  2266. >
  2267. <h4 class="phpdocumentor-element__name" id="method_setFormatInfo">
  2268. setFormatInfo()
  2269. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  2270. </h4>
  2271. <aside class="phpdocumentor-element-found-in">
  2272. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2273. :
  2274. <span class="phpdocumentor-element-found-in__line">510</span>
  2275. </aside>
  2276. <p class="phpdocumentor-summary">Draws the format info along the finder patterns. If no $maskPattern, all format info modules will be set to false.</p>
  2277. <code class="phpdocumentor-code phpdocumentor-signature ">
  2278. <span class="phpdocumentor-signature__visibility">public</span>
  2279. <span class="phpdocumentor-signature__name">setFormatInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2280. <div class="phpdocumentor-label-line">
  2281. </div>
  2282. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.9</p>
  2283. </section>
  2284. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2285. <dl class="phpdocumentor-argument-list">
  2286. <dt class="phpdocumentor-argument-list__entry">
  2287. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  2288. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a>|null</span>
  2289. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2290. <dd class="phpdocumentor-argument-list__definition">
  2291. </dd>
  2292. </dl>
  2293. <section>
  2294. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2295. <span class="phpdocumentor-signature__response_type">static</span>
  2296. </section>
  2297. </article>
  2298. <article
  2299. class="phpdocumentor-element
  2300. -method
  2301. -public
  2302. "
  2303. >
  2304. <h4 class="phpdocumentor-element__name" id="method_setLogoSpace">
  2305. setLogoSpace()
  2306. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace" class="headerlink"><i class="fas fa-link"></i></a>
  2307. </h4>
  2308. <aside class="phpdocumentor-element-found-in">
  2309. <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>
  2310. :
  2311. <span class="phpdocumentor-element-found-in__line">425</span>
  2312. </aside>
  2313. <p class="phpdocumentor-summary">Clears a space of $width * $height in order to add a logo or text.</p>
  2314. <code class="phpdocumentor-code phpdocumentor-signature ">
  2315. <span class="phpdocumentor-signature__visibility">public</span>
  2316. <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|null&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|null&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|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startY</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2317. <div class="phpdocumentor-label-line">
  2318. </div>
  2319. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2320. <dl class="phpdocumentor-argument-list">
  2321. <dt class="phpdocumentor-argument-list__entry">
  2322. <span class="phpdocumentor-signature__argument__name">$width</span>
  2323. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2324. </dt>
  2325. <dd class="phpdocumentor-argument-list__definition">
  2326. </dd>
  2327. <dt class="phpdocumentor-argument-list__entry">
  2328. <span class="phpdocumentor-signature__argument__name">$height</span>
  2329. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2330. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2331. <dd class="phpdocumentor-argument-list__definition">
  2332. </dd>
  2333. <dt class="phpdocumentor-argument-list__entry">
  2334. <span class="phpdocumentor-signature__argument__name">$startX</span>
  2335. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2336. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2337. <dd class="phpdocumentor-argument-list__definition">
  2338. </dd>
  2339. <dt class="phpdocumentor-argument-list__entry">
  2340. <span class="phpdocumentor-signature__argument__name">$startY</span>
  2341. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2342. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2343. <dd class="phpdocumentor-argument-list__definition">
  2344. </dd>
  2345. </dl>
  2346. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2347. Tags
  2348. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2349. </h5>
  2350. <dl class="phpdocumentor-tag-list">
  2351. <dt class="phpdocumentor-tag-list__entry">
  2352. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2353. </dt>
  2354. <dd class="phpdocumentor-tag-list__definition">
  2355. </dd>
  2356. <dt class="phpdocumentor-tag-list__entry">
  2357. <span class="phpdocumentor-tag__name">throws</span>
  2358. </dt>
  2359. <dd class="phpdocumentor-tag-list__definition">
  2360. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  2361. </dd>
  2362. </dl>
  2363. <section>
  2364. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2365. <span class="phpdocumentor-signature__response_type">static</span>
  2366. </section>
  2367. </article>
  2368. <article
  2369. class="phpdocumentor-element
  2370. -method
  2371. -public
  2372. "
  2373. >
  2374. <h4 class="phpdocumentor-element__name" id="method_setQuietZone">
  2375. setQuietZone()
  2376. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone" class="headerlink"><i class="fas fa-link"></i></a>
  2377. </h4>
  2378. <aside class="phpdocumentor-element-found-in">
  2379. <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>
  2380. :
  2381. <span class="phpdocumentor-element-found-in__line">417</span>
  2382. </aside>
  2383. <p class="phpdocumentor-summary">Draws the &quot;quiet zone&quot; of $size around the matrix</p>
  2384. <code class="phpdocumentor-code phpdocumentor-signature ">
  2385. <span class="phpdocumentor-signature__visibility">public</span>
  2386. <span class="phpdocumentor-signature__name">setQuietZone</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int|null&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">static</span></code>
  2387. <div class="phpdocumentor-label-line">
  2388. </div>
  2389. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2390. <dl class="phpdocumentor-argument-list">
  2391. <dt class="phpdocumentor-argument-list__entry">
  2392. <span class="phpdocumentor-signature__argument__name">$quietZoneSize</span>
  2393. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  2394. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  2395. <dd class="phpdocumentor-argument-list__definition">
  2396. </dd>
  2397. </dl>
  2398. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2399. Tags
  2400. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2401. </h5>
  2402. <dl class="phpdocumentor-tag-list">
  2403. <dt class="phpdocumentor-tag-list__entry">
  2404. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  2405. </dt>
  2406. <dd class="phpdocumentor-tag-list__definition">
  2407. </dd>
  2408. <dt class="phpdocumentor-tag-list__entry">
  2409. <span class="phpdocumentor-tag__name">throws</span>
  2410. </dt>
  2411. <dd class="phpdocumentor-tag-list__definition">
  2412. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  2413. </dd>
  2414. </dl>
  2415. <section>
  2416. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2417. <span class="phpdocumentor-signature__response_type">static</span>
  2418. </section>
  2419. </article>
  2420. <article
  2421. class="phpdocumentor-element
  2422. -method
  2423. -public
  2424. "
  2425. >
  2426. <h4 class="phpdocumentor-element__name" id="method_setSeparators">
  2427. setSeparators()
  2428. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators" class="headerlink"><i class="fas fa-link"></i></a>
  2429. </h4>
  2430. <aside class="phpdocumentor-element-found-in">
  2431. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2432. :
  2433. <span class="phpdocumentor-element-found-in__line">405</span>
  2434. </aside>
  2435. <p class="phpdocumentor-summary">Draws the separator lines around the finder patterns</p>
  2436. <code class="phpdocumentor-code phpdocumentor-signature ">
  2437. <span class="phpdocumentor-signature__visibility">public</span>
  2438. <span class="phpdocumentor-signature__name">setSeparators</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2439. <div class="phpdocumentor-label-line">
  2440. </div>
  2441. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.3</p>
  2442. </section>
  2443. <section>
  2444. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2445. <span class="phpdocumentor-signature__response_type">static</span>
  2446. </section>
  2447. </article>
  2448. <article
  2449. class="phpdocumentor-element
  2450. -method
  2451. -public
  2452. "
  2453. >
  2454. <h4 class="phpdocumentor-element__name" id="method_setTimingPattern">
  2455. setTimingPattern()
  2456. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern" class="headerlink"><i class="fas fa-link"></i></a>
  2457. </h4>
  2458. <aside class="phpdocumentor-element-found-in">
  2459. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2460. :
  2461. <span class="phpdocumentor-element-found-in__line">464</span>
  2462. </aside>
  2463. <p class="phpdocumentor-summary">Draws the timing pattern (h/v checkered line between the finder patterns)</p>
  2464. <code class="phpdocumentor-code phpdocumentor-signature ">
  2465. <span class="phpdocumentor-signature__visibility">public</span>
  2466. <span class="phpdocumentor-signature__name">setTimingPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2467. <div class="phpdocumentor-label-line">
  2468. </div>
  2469. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 7.3.4</p>
  2470. </section>
  2471. <section>
  2472. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2473. <span class="phpdocumentor-signature__response_type">static</span>
  2474. </section>
  2475. </article>
  2476. <article
  2477. class="phpdocumentor-element
  2478. -method
  2479. -public
  2480. "
  2481. >
  2482. <h4 class="phpdocumentor-element__name" id="method_setVersionNumber">
  2483. setVersionNumber()
  2484. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber" class="headerlink"><i class="fas fa-link"></i></a>
  2485. </h4>
  2486. <aside class="phpdocumentor-element-found-in">
  2487. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2488. :
  2489. <span class="phpdocumentor-element-found-in__line">486</span>
  2490. </aside>
  2491. <p class="phpdocumentor-summary">Draws the version information, 2x 3x6 pixel</p>
  2492. <code class="phpdocumentor-code phpdocumentor-signature ">
  2493. <span class="phpdocumentor-signature__visibility">public</span>
  2494. <span class="phpdocumentor-signature__name">setVersionNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2495. <div class="phpdocumentor-label-line">
  2496. </div>
  2497. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.10</p>
  2498. </section>
  2499. <section>
  2500. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2501. <span class="phpdocumentor-signature__response_type">static</span>
  2502. </section>
  2503. </article>
  2504. <article
  2505. class="phpdocumentor-element
  2506. -method
  2507. -public
  2508. "
  2509. >
  2510. <h4 class="phpdocumentor-element__name" id="method_writeCodewords">
  2511. writeCodewords()
  2512. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  2513. </h4>
  2514. <aside class="phpdocumentor-element-found-in">
  2515. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2516. :
  2517. <span class="phpdocumentor-element-found-in__line">698</span>
  2518. </aside>
  2519. <p class="phpdocumentor-summary">Maps the interleaved binary $data on the matrix</p>
  2520. <code class="phpdocumentor-code phpdocumentor-signature ">
  2521. <span class="phpdocumentor-signature__visibility">public</span>
  2522. <span class="phpdocumentor-signature__name">writeCodewords</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2523. <div class="phpdocumentor-label-line">
  2524. </div>
  2525. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2526. <dl class="phpdocumentor-argument-list">
  2527. <dt class="phpdocumentor-argument-list__entry">
  2528. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  2529. : <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>
  2530. </dt>
  2531. <dd class="phpdocumentor-argument-list__definition">
  2532. </dd>
  2533. </dl>
  2534. <section>
  2535. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2536. <span class="phpdocumentor-signature__response_type">static</span>
  2537. </section>
  2538. </article>
  2539. <article
  2540. class="phpdocumentor-element
  2541. -method
  2542. -protected
  2543. "
  2544. >
  2545. <h4 class="phpdocumentor-element__name" id="method_createMatrix">
  2546. createMatrix()
  2547. <a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  2548. </h4>
  2549. <aside class="phpdocumentor-element-found-in">
  2550. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRMatrix.php"><a href="files/src-data-qrmatrix.html"><abbr title="src/Data/QRMatrix.php">QRMatrix.php</abbr></a></abbr>
  2551. :
  2552. <span class="phpdocumentor-element-found-in__line">154</span>
  2553. </aside>
  2554. <p class="phpdocumentor-summary">Creates a 2-dimensional array (square) of the given $size</p>
  2555. <code class="phpdocumentor-code phpdocumentor-signature ">
  2556. <span class="phpdocumentor-signature__visibility">protected</span>
  2557. <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>
  2558. <div class="phpdocumentor-label-line">
  2559. </div>
  2560. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2561. <dl class="phpdocumentor-argument-list">
  2562. <dt class="phpdocumentor-argument-list__entry">
  2563. <span class="phpdocumentor-signature__argument__name">$size</span>
  2564. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2565. </dt>
  2566. <dd class="phpdocumentor-argument-list__definition">
  2567. </dd>
  2568. <dt class="phpdocumentor-argument-list__entry">
  2569. <span class="phpdocumentor-signature__argument__name">$value</span>
  2570. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2571. </dt>
  2572. <dd class="phpdocumentor-argument-list__definition">
  2573. </dd>
  2574. </dl>
  2575. <section>
  2576. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2577. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  2578. </section>
  2579. </article>
  2580. <article
  2581. class="phpdocumentor-element
  2582. -method
  2583. -private
  2584. "
  2585. >
  2586. <h4 class="phpdocumentor-element__name" id="method_copyVersionBit">
  2587. copyVersionBit()
  2588. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyVersionBit" class="headerlink"><i class="fas fa-link"></i></a>
  2589. </h4>
  2590. <aside class="phpdocumentor-element-found-in">
  2591. <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>
  2592. :
  2593. <span class="phpdocumentor-element-found-in__line">242</span>
  2594. </aside>
  2595. <code class="phpdocumentor-code phpdocumentor-signature ">
  2596. <span class="phpdocumentor-signature__visibility">private</span>
  2597. <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>
  2598. <div class="phpdocumentor-label-line">
  2599. </div>
  2600. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2601. <dl class="phpdocumentor-argument-list">
  2602. <dt class="phpdocumentor-argument-list__entry">
  2603. <span class="phpdocumentor-signature__argument__name">$i</span>
  2604. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2605. </dt>
  2606. <dd class="phpdocumentor-argument-list__definition">
  2607. </dd>
  2608. <dt class="phpdocumentor-argument-list__entry">
  2609. <span class="phpdocumentor-signature__argument__name">$j</span>
  2610. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2611. </dt>
  2612. <dd class="phpdocumentor-argument-list__definition">
  2613. </dd>
  2614. <dt class="phpdocumentor-argument-list__entry">
  2615. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  2616. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2617. </dt>
  2618. <dd class="phpdocumentor-argument-list__definition">
  2619. </dd>
  2620. </dl>
  2621. <section>
  2622. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2623. <span class="phpdocumentor-signature__response_type">int</span>
  2624. </section>
  2625. </article>
  2626. <article
  2627. class="phpdocumentor-element
  2628. -method
  2629. -private
  2630. "
  2631. >
  2632. <h4 class="phpdocumentor-element__name" id="method_decodeVersionInformation">
  2633. decodeVersionInformation()
  2634. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation" class="headerlink"><i class="fas fa-link"></i></a>
  2635. </h4>
  2636. <aside class="phpdocumentor-element-found-in">
  2637. <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>
  2638. :
  2639. <span class="phpdocumentor-element-found-in__line">350</span>
  2640. </aside>
  2641. <p class="phpdocumentor-summary">Decodes the version information from the given bit sequence, returns null if no valid match is found.</p>
  2642. <code class="phpdocumentor-code phpdocumentor-signature ">
  2643. <span class="phpdocumentor-signature__visibility">private</span>
  2644. <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>
  2645. <div class="phpdocumentor-label-line">
  2646. </div>
  2647. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2648. <dl class="phpdocumentor-argument-list">
  2649. <dt class="phpdocumentor-argument-list__entry">
  2650. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  2651. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2652. </dt>
  2653. <dd class="phpdocumentor-argument-list__definition">
  2654. </dd>
  2655. </dl>
  2656. <section>
  2657. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2658. <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>
  2659. </section>
  2660. </article>
  2661. <article
  2662. class="phpdocumentor-element
  2663. -method
  2664. -private
  2665. "
  2666. >
  2667. <h4 class="phpdocumentor-element__name" id="method_doDecodeFormatInformation">
  2668. doDecodeFormatInformation()
  2669. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  2670. </h4>
  2671. <aside class="phpdocumentor-element-found-in">
  2672. <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>
  2673. :
  2674. <span class="phpdocumentor-element-found-in__line">254</span>
  2675. </aside>
  2676. <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>
  2677. <code class="phpdocumentor-code phpdocumentor-signature ">
  2678. <span class="phpdocumentor-signature__visibility">private</span>
  2679. <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>
  2680. <div class="phpdocumentor-label-line">
  2681. </div>
  2682. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2683. <dl class="phpdocumentor-argument-list">
  2684. <dt class="phpdocumentor-argument-list__entry">
  2685. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo1</span>
  2686. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2687. </dt>
  2688. <dd class="phpdocumentor-argument-list__definition">
  2689. </dd>
  2690. <dt class="phpdocumentor-argument-list__entry">
  2691. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo2</span>
  2692. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2693. </dt>
  2694. <dd class="phpdocumentor-argument-list__definition">
  2695. </dd>
  2696. </dl>
  2697. <section>
  2698. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2699. <span class="phpdocumentor-signature__response_type">int|null</span>
  2700. </section>
  2701. </article>
  2702. <article
  2703. class="phpdocumentor-element
  2704. -method
  2705. -private
  2706. "
  2707. >
  2708. <h4 class="phpdocumentor-element__name" id="method_numBitsDiffering">
  2709. numBitsDiffering()
  2710. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering" class="headerlink"><i class="fas fa-link"></i></a>
  2711. </h4>
  2712. <aside class="phpdocumentor-element-found-in">
  2713. <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>
  2714. :
  2715. <span class="phpdocumentor-element-found-in__line">398</span>
  2716. </aside>
  2717. <code class="phpdocumentor-code phpdocumentor-signature ">
  2718. <span class="phpdocumentor-signature__visibility">private</span>
  2719. <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>
  2720. <div class="phpdocumentor-label-line">
  2721. </div>
  2722. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2723. <dl class="phpdocumentor-argument-list">
  2724. <dt class="phpdocumentor-argument-list__entry">
  2725. <span class="phpdocumentor-signature__argument__name">$a</span>
  2726. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2727. </dt>
  2728. <dd class="phpdocumentor-argument-list__definition">
  2729. </dd>
  2730. <dt class="phpdocumentor-argument-list__entry">
  2731. <span class="phpdocumentor-signature__argument__name">$b</span>
  2732. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2733. </dt>
  2734. <dd class="phpdocumentor-argument-list__definition">
  2735. </dd>
  2736. </dl>
  2737. <section>
  2738. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2739. <span class="phpdocumentor-signature__response_type">int</span>
  2740. </section>
  2741. </article>
  2742. <article
  2743. class="phpdocumentor-element
  2744. -method
  2745. -private
  2746. "
  2747. >
  2748. <h4 class="phpdocumentor-element__name" id="method_readFormatInformation">
  2749. readFormatInformation()
  2750. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  2751. </h4>
  2752. <aside class="phpdocumentor-element-found-in">
  2753. <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>
  2754. :
  2755. <span class="phpdocumentor-element-found-in__line">181</span>
  2756. </aside>
  2757. <p class="phpdocumentor-summary">Reads format information from one of its two locations within the QR Code.</p>
  2758. <code class="phpdocumentor-code phpdocumentor-signature ">
  2759. <span class="phpdocumentor-signature__visibility">private</span>
  2760. <span class="phpdocumentor-signature__name">readFormatInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2761. <div class="phpdocumentor-label-line">
  2762. </div>
  2763. <section class="phpdocumentor-description"><p>Throws if both format information locations cannot be parsed as the valid encoding of format information.</p>
  2764. </section>
  2765. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2766. Tags
  2767. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2768. </h5>
  2769. <dl class="phpdocumentor-tag-list">
  2770. <dt class="phpdocumentor-tag-list__entry">
  2771. <span class="phpdocumentor-tag__name">throws</span>
  2772. </dt>
  2773. <dd class="phpdocumentor-tag-list__definition">
  2774. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  2775. </dd>
  2776. </dl>
  2777. <section>
  2778. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2779. <span class="phpdocumentor-signature__response_type">static</span>
  2780. </section>
  2781. </article>
  2782. <article
  2783. class="phpdocumentor-element
  2784. -method
  2785. -private
  2786. "
  2787. >
  2788. <h4 class="phpdocumentor-element__name" id="method_readVersion">
  2789. readVersion()
  2790. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion" class="headerlink"><i class="fas fa-link"></i></a>
  2791. </h4>
  2792. <aside class="phpdocumentor-element-found-in">
  2793. <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>
  2794. :
  2795. <span class="phpdocumentor-element-found-in__line">298</span>
  2796. </aside>
  2797. <p class="phpdocumentor-summary">Reads version information from one of its two locations within the QR Code.</p>
  2798. <code class="phpdocumentor-code phpdocumentor-signature ">
  2799. <span class="phpdocumentor-signature__visibility">private</span>
  2800. <span class="phpdocumentor-signature__name">readVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  2801. <div class="phpdocumentor-label-line">
  2802. </div>
  2803. <section class="phpdocumentor-description"><p>Throws if both version information locations cannot be parsed as the valid encoding of version information.</p>
  2804. </section>
  2805. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  2806. Tags
  2807. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion#tags" class="headerlink"><i class="fas fa-link"></i></a>
  2808. </h5>
  2809. <dl class="phpdocumentor-tag-list">
  2810. <dt class="phpdocumentor-tag-list__entry">
  2811. <span class="phpdocumentor-tag__name">throws</span>
  2812. </dt>
  2813. <dd class="phpdocumentor-tag-list__definition">
  2814. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  2815. </dd>
  2816. <dt class="phpdocumentor-tag-list__entry">
  2817. <span class="phpdocumentor-tag__name">noinspection</span>
  2818. </dt>
  2819. <dd class="phpdocumentor-tag-list__definition">
  2820. <section class="phpdocumentor-description"><p>DuplicatedCode</p>
  2821. </section>
  2822. </dd>
  2823. </dl>
  2824. <section>
  2825. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2826. <span class="phpdocumentor-signature__response_type">static</span>
  2827. </section>
  2828. </article>
  2829. <article
  2830. class="phpdocumentor-element
  2831. -method
  2832. -private
  2833. "
  2834. >
  2835. <h4 class="phpdocumentor-element__name" id="method_uRShift">
  2836. uRShift()
  2837. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift" class="headerlink"><i class="fas fa-link"></i></a>
  2838. </h4>
  2839. <aside class="phpdocumentor-element-found-in">
  2840. <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>
  2841. :
  2842. <span class="phpdocumentor-element-found-in__line">386</span>
  2843. </aside>
  2844. <code class="phpdocumentor-code phpdocumentor-signature ">
  2845. <span class="phpdocumentor-signature__visibility">private</span>
  2846. <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>
  2847. <div class="phpdocumentor-label-line">
  2848. </div>
  2849. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  2850. <dl class="phpdocumentor-argument-list">
  2851. <dt class="phpdocumentor-argument-list__entry">
  2852. <span class="phpdocumentor-signature__argument__name">$a</span>
  2853. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2854. </dt>
  2855. <dd class="phpdocumentor-argument-list__definition">
  2856. </dd>
  2857. <dt class="phpdocumentor-argument-list__entry">
  2858. <span class="phpdocumentor-signature__argument__name">$b</span>
  2859. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  2860. </dt>
  2861. <dd class="phpdocumentor-argument-list__definition">
  2862. </dd>
  2863. </dl>
  2864. <section>
  2865. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  2866. <span class="phpdocumentor-signature__response_type">int</span>
  2867. </section>
  2868. </article>
  2869. </section>
  2870. <div class="phpdocumentor-modal" id="source-view">
  2871. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  2872. <div class="phpdocumentor-modal-container">
  2873. <div class="phpdocumentor-modal-content">
  2874. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Decoder/BitMatrix.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  2875. </div>
  2876. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  2877. </div>
  2878. </div>
  2879. <script type="text/javascript">
  2880. (function () {
  2881. function loadExternalCodeSnippet(el, url, line) {
  2882. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  2883. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  2884. const language = 'php';
  2885. const code = document.createElement('code');
  2886. code.className = 'language-' + language;
  2887. pre.textContent = '';
  2888. pre.setAttribute('data-line', line)
  2889. code.textContent = 'Loading…';
  2890. pre.appendChild(code);
  2891. var xhr = new XMLHttpRequest();
  2892. xhr.open('GET', src, true);
  2893. xhr.onreadystatechange = function () {
  2894. if (xhr.readyState !== 4) {
  2895. return;
  2896. }
  2897. if (xhr.status < 400 && xhr.responseText) {
  2898. code.textContent = xhr.responseText;
  2899. Prism.highlightElement(code);
  2900. return;
  2901. }
  2902. if (xhr.status === 404) {
  2903. code.textContent = '✖ Error: File could not be found';
  2904. return;
  2905. }
  2906. if (xhr.status >= 400) {
  2907. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2908. return;
  2909. }
  2910. code.textContent = '✖ Error: An unknown error occurred';
  2911. };
  2912. xhr.send(null);
  2913. });
  2914. }
  2915. const modalButtons = document.querySelectorAll("[data-modal]");
  2916. const openedAsLocalFile = window.location.protocol === 'file:';
  2917. if (modalButtons.length > 0 && openedAsLocalFile) {
  2918. console.warn(
  2919. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  2920. 'browsers block XHR requests when a page is opened this way'
  2921. );
  2922. }
  2923. modalButtons.forEach(function (trigger) {
  2924. if (openedAsLocalFile) {
  2925. trigger.setAttribute("hidden", "hidden");
  2926. }
  2927. trigger.addEventListener("click", function (event) {
  2928. event.preventDefault();
  2929. const modal = document.getElementById(trigger.dataset.modal);
  2930. if (!modal) {
  2931. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  2932. return;
  2933. }
  2934. modal.classList.add("phpdocumentor-modal__open");
  2935. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  2936. const exits = modal.querySelectorAll("[data-exit-button]");
  2937. exits.forEach(function (exit) {
  2938. exit.addEventListener("click", function (event) {
  2939. event.preventDefault();
  2940. modal.classList.remove("phpdocumentor-modal__open");
  2941. });
  2942. });
  2943. });
  2944. });
  2945. })();
  2946. </script>
  2947. </article>
  2948. </section>
  2949. <section class="phpdocumentor-on-this-page__sidebar">
  2950. <section class="phpdocumentor-on-this-page__content">
  2951. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  2952. <ul class="phpdocumentor-list -clean">
  2953. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  2954. <li>
  2955. <ul class="phpdocumentor-list -clean">
  2956. <li><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-constants">Constants</a></li>
  2957. <li><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-properties">Properties</a></li>
  2958. <li><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#toc-methods">Methods</a></li>
  2959. </ul>
  2960. </li>
  2961. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  2962. <li>
  2963. <ul class="phpdocumentor-list -clean">
  2964. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_IS_DARK">IS_DARK</a></li>
  2965. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT">M_ALIGNMENT</a></li>
  2966. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_ALIGNMENT_DARK">M_ALIGNMENT_DARK</a></li>
  2967. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE">M_DARKMODULE</a></li>
  2968. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DARKMODULE_LIGHT">M_DARKMODULE_LIGHT</a></li>
  2969. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA">M_DATA</a></li>
  2970. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_DATA_DARK">M_DATA_DARK</a></li>
  2971. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER">M_FINDER</a></li>
  2972. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DARK">M_FINDER_DARK</a></li>
  2973. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT">M_FINDER_DOT</a></li>
  2974. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FINDER_DOT_LIGHT">M_FINDER_DOT_LIGHT</a></li>
  2975. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT">M_FORMAT</a></li>
  2976. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_FORMAT_DARK">M_FORMAT_DARK</a></li>
  2977. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO">M_LOGO</a></li>
  2978. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_LOGO_DARK">M_LOGO_DARK</a></li>
  2979. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_NULL">M_NULL</a></li>
  2980. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE">M_QUIETZONE</a></li>
  2981. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_QUIETZONE_DARK">M_QUIETZONE_DARK</a></li>
  2982. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR">M_SEPARATOR</a></li>
  2983. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_SEPARATOR_DARK">M_SEPARATOR_DARK</a></li>
  2984. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING">M_TIMING</a></li>
  2985. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_TIMING_DARK">M_TIMING_DARK</a></li>
  2986. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION">M_VERSION</a></li>
  2987. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_M_VERSION_DARK">M_VERSION_DARK</a></li>
  2988. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#constant_neighbours">neighbours</a></li>
  2989. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_DECODE_LOOKUP">DECODE_LOOKUP</a></li>
  2990. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#constant_FORMAT_INFO_MASK_QR">FORMAT_INFO_MASK_QR</a></li>
  2991. </ul>
  2992. </li>
  2993. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  2994. <li>
  2995. <ul class="phpdocumentor-list -clean">
  2996. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_eccLevel">$eccLevel</li>
  2997. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_maskPattern">$maskPattern</li>
  2998. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_matrix">$matrix</li>
  2999. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_moduleCount">$moduleCount</li>
  3000. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#property_version">$version</li>
  3001. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror">$mirror</li>
  3002. </ul>
  3003. </li>
  3004. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  3005. <li>
  3006. <ul class="phpdocumentor-list -clean">
  3007. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct">__construct()</a></li>
  3008. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_check">check()</a></li>
  3009. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkNeighbours">checkNeighbours()</a></li>
  3010. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkType">checkType()</a></li>
  3011. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_checkTypeIn">checkTypeIn()</a></li>
  3012. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_flip">flip()</a></li>
  3013. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_get">get()</a></li>
  3014. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getEccLevel">getEccLevel()</a></li>
  3015. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMaskPattern">getMaskPattern()</a></li>
  3016. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getMatrix">getMatrix()</a></li>
  3017. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize">getSize()</a></li>
  3018. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getVersion">getVersion()</a></li>
  3019. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_initFunctionalPatterns">initFunctionalPatterns()</a></li>
  3020. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_invert">invert()</a></li>
  3021. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_isDark">isDark()</a></li>
  3022. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_mask">mask()</a></li>
  3023. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirrorDiagonal">mirrorDiagonal()</a></li>
  3024. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords">readCodewords()</a></li>
  3025. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_resetVersionInfo">resetVersionInfo()</a></li>
  3026. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_rotate90">rotate90()</a></li>
  3027. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_set">set()</a></li>
  3028. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setAlignmentPattern">setAlignmentPattern()</a></li>
  3029. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setArea">setArea()</a></li>
  3030. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setDarkModule">setDarkModule()</a></li>
  3031. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFinderPattern">setFinderPattern()</a></li>
  3032. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setFormatInfo">setFormatInfo()</a></li>
  3033. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setLogoSpace">setLogoSpace()</a></li>
  3034. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setQuietZone">setQuietZone()</a></li>
  3035. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setSeparators">setSeparators()</a></li>
  3036. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setTimingPattern">setTimingPattern()</a></li>
  3037. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_setVersionNumber">setVersionNumber()</a></li>
  3038. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_writeCodewords">writeCodewords()</a></li>
  3039. <li class=""><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_createMatrix">createMatrix()</a></li>
  3040. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyVersionBit">copyVersionBit()</a></li>
  3041. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation">decodeVersionInformation()</a></li>
  3042. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation">doDecodeFormatInformation()</a></li>
  3043. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering">numBitsDiffering()</a></li>
  3044. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation">readFormatInformation()</a></li>
  3045. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion">readVersion()</a></li>
  3046. <li class=""><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift">uRShift()</a></li>
  3047. </ul>
  3048. </li>
  3049. </ul>
  3050. </section>
  3051. </section>
  3052. </div>
  3053. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  3054. <section class="phpdocumentor-search-results__dialog">
  3055. <header class="phpdocumentor-search-results__header">
  3056. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  3057. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  3058. </header>
  3059. <section class="phpdocumentor-search-results__body">
  3060. <ul class="phpdocumentor-search-results__entries"></ul>
  3061. </section>
  3062. </section>
  3063. </section>
  3064. </div>
  3065. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  3066. </main>
  3067. <script>
  3068. cssVars({});
  3069. </script>
  3070. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  3071. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  3072. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  3073. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  3074. </body>
  3075. </html>