chillerlan-QRCode-Decoder-BitMatrix.html 182 KB

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