chillerlan-QRCode-Decoder-BitMatrix.html 208 KB

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