chillerlan-QRCode-Decoder-BitMatrix.html 193 KB

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