chillerlan-QRCode-Decoder-BitMatrix.html 145 KB

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