chillerlan-QRCode-Decoder-BitMatrix.html 189 KB

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