chillerlan-QRCode-Decoder-BitMatrix.html 191 KB

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