chillerlan-QRCode-Decoder-BitMatrix.html 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588
  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"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. BitMatrix
  89. <div class="phpdocumentor-element__package">
  90. in package
  91. <ul class="phpdocumentor-breadcrumbs">
  92. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  93. </ul>
  94. </div>
  95. </h2>
  96. <aside class="phpdocumentor-element-found-in">
  97. <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>
  98. :
  99. <span class="phpdocumentor-element-found-in__line">21</span>
  100. </aside>
  101. <h3 id="toc">
  102. Table of Contents
  103. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  104. </h3>
  105. <dl class="phpdocumentor-table-of-contents">
  106. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  107. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_bits">$bits</a>
  108. <span>
  109. &nbsp;: array&lt;string|int, mixed&gt; </span>
  110. </dt>
  111. <dd></dd>
  112. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  113. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_dimension">$dimension</a>
  114. <span>
  115. &nbsp;: int </span>
  116. </dt>
  117. <dd></dd>
  118. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  119. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_formatInfo">$formatInfo</a>
  120. <span>
  121. &nbsp;: <a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null </span>
  122. </dt>
  123. <dd></dd>
  124. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  125. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror">$mirror</a>
  126. <span>
  127. &nbsp;: bool </span>
  128. </dt>
  129. <dd></dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  131. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_rowSize">$rowSize</a>
  132. <span>
  133. &nbsp;: int </span>
  134. </dt>
  135. <dd></dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  137. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_version">$version</a>
  138. <span>
  139. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  140. </dt>
  141. <dd></dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  143. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct">__construct()</a>
  144. <span>
  145. &nbsp;: mixed </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  149. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_flip">flip()</a>
  150. <span>
  151. &nbsp;: self </span>
  152. </dt>
  153. <dd>Flips the given bit. 1 &lt;&lt; (0xf9 &amp; 0x1f)</dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  155. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_get">get()</a>
  156. <span>
  157. &nbsp;: bool </span>
  158. </dt>
  159. <dd>Gets the requested bit, where true means black.</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  161. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getDimension">getDimension()</a>
  162. <span>
  163. &nbsp;: int </span>
  164. </dt>
  165. <dd></dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  167. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getFormatInfo">getFormatInfo()</a>
  168. <span>
  169. &nbsp;: <a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null </span>
  170. </dt>
  171. <dd></dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  173. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getVersion">getVersion()</a>
  174. <span>
  175. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  176. </dt>
  177. <dd></dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  179. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirror">mirror()</a>
  180. <span>
  181. &nbsp;: self </span>
  182. </dt>
  183. <dd>Mirror the bit matrix in order to attempt a second reading.</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  185. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords">readCodewords()</a>
  186. <span>
  187. &nbsp;: array&lt;string|int, mixed&gt; </span>
  188. </dt>
  189. <dd>Reads the bits in the BitMatrix representing the finder pattern in the
  190. correct order in order to reconstruct the codewords bytes contained within the
  191. QR Code.</dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  193. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_set">set()</a>
  194. <span>
  195. &nbsp;: self </span>
  196. </dt>
  197. <dd>Sets the given bit to true.</dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  199. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setMirror">setMirror()</a>
  200. <span>
  201. &nbsp;: self </span>
  202. </dt>
  203. <dd>Prepare the parser for a mirrored operation.</dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  205. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setRegion">setRegion()</a>
  206. <span>
  207. &nbsp;: self </span>
  208. </dt>
  209. <dd>Sets a square region of the bit matrix to true.</dd>
  210. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  211. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_buildFunctionPattern">buildFunctionPattern()</a>
  212. <span>
  213. &nbsp;: self </span>
  214. </dt>
  215. <dd>See ISO 18004:2006 Annex E</dd>
  216. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  217. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyBit">copyBit()</a>
  218. <span>
  219. &nbsp;: int </span>
  220. </dt>
  221. <dd></dd>
  222. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  223. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation">decodeVersionInformation()</a>
  224. <span>
  225. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null </span>
  226. </dt>
  227. <dd></dd>
  228. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  229. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation">doDecodeFormatInformation()</a>
  230. <span>
  231. &nbsp;: <a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null </span>
  232. </dt>
  233. <dd></dd>
  234. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  235. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering">numBitsDiffering()</a>
  236. <span>
  237. &nbsp;: int </span>
  238. </dt>
  239. <dd></dd>
  240. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  241. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation">readFormatInformation()</a>
  242. <span>
  243. &nbsp;: <a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a> </span>
  244. </dt>
  245. <dd>Reads format information from one of its two locations within the QR Code.</dd>
  246. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  247. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion">readVersion()</a>
  248. <span>
  249. &nbsp;: <a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a> </span>
  250. </dt>
  251. <dd>Reads version information from one of its two locations within the QR Code.</dd>
  252. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  253. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_unmask">unmask()</a>
  254. <span>
  255. &nbsp;: void </span>
  256. </dt>
  257. <dd>Implementations of this method reverse the data masking process applied to a QR Code and
  258. make its bits ready to read.</dd>
  259. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  260. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift">uRShift()</a>
  261. <span>
  262. &nbsp;: int </span>
  263. </dt>
  264. <dd></dd>
  265. </dl>
  266. <section class="phpdocumentor-properties">
  267. <h3 class="phpdocumentor-elements__header" id="properties">
  268. Properties
  269. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  270. </h3>
  271. <article
  272. class="
  273. phpdocumentor-element
  274. -property
  275. -private
  276. "
  277. >
  278. <h4 class="phpdocumentor-element__name" id="property_bits">
  279. $bits
  280. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_bits" class="headerlink"><i class="fas fa-link"></i></a>
  281. <span class="phpdocumentor-element__modifiers">
  282. </span>
  283. </h4>
  284. <aside class="phpdocumentor-element-found-in">
  285. <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>
  286. :
  287. <span class="phpdocumentor-element-found-in__line">25</span>
  288. </aside>
  289. <code class="phpdocumentor-code phpdocumentor-signature ">
  290. <span class="phpdocumentor-signature__visibility">private</span>
  291. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  292. <span class="phpdocumentor-signature__name">$bits</span>
  293. </code>
  294. <section class="phpdocumentor-description"></section>
  295. <section class="phpdocumentor-description"></section>
  296. </article>
  297. <article
  298. class="
  299. phpdocumentor-element
  300. -property
  301. -private
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="property_dimension">
  305. $dimension
  306. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_dimension" class="headerlink"><i class="fas fa-link"></i></a>
  307. <span class="phpdocumentor-element__modifiers">
  308. </span>
  309. </h4>
  310. <aside class="phpdocumentor-element-found-in">
  311. <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>
  312. :
  313. <span class="phpdocumentor-element-found-in__line">23</span>
  314. </aside>
  315. <code class="phpdocumentor-code phpdocumentor-signature ">
  316. <span class="phpdocumentor-signature__visibility">private</span>
  317. <span class="phpdocumentor-signature__type">int</span>
  318. <span class="phpdocumentor-signature__name">$dimension</span>
  319. </code>
  320. <section class="phpdocumentor-description"></section>
  321. <section class="phpdocumentor-description"></section>
  322. </article>
  323. <article
  324. class="
  325. phpdocumentor-element
  326. -property
  327. -private
  328. "
  329. >
  330. <h4 class="phpdocumentor-element__name" id="property_formatInfo">
  331. $formatInfo
  332. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_formatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  333. <span class="phpdocumentor-element__modifiers">
  334. </span>
  335. </h4>
  336. <aside class="phpdocumentor-element-found-in">
  337. <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>
  338. :
  339. <span class="phpdocumentor-element-found-in__line">27</span>
  340. </aside>
  341. <code class="phpdocumentor-code phpdocumentor-signature ">
  342. <span class="phpdocumentor-signature__visibility">private</span>
  343. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null</span>
  344. <span class="phpdocumentor-signature__name">$formatInfo</span>
  345. = <span class="phpdocumentor-signature__default-value">null</span></code>
  346. <section class="phpdocumentor-description"></section>
  347. <section class="phpdocumentor-description"></section>
  348. </article>
  349. <article
  350. class="
  351. phpdocumentor-element
  352. -property
  353. -private
  354. "
  355. >
  356. <h4 class="phpdocumentor-element__name" id="property_mirror">
  357. $mirror
  358. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_mirror" class="headerlink"><i class="fas fa-link"></i></a>
  359. <span class="phpdocumentor-element__modifiers">
  360. </span>
  361. </h4>
  362. <aside class="phpdocumentor-element-found-in">
  363. <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>
  364. :
  365. <span class="phpdocumentor-element-found-in__line">28</span>
  366. </aside>
  367. <code class="phpdocumentor-code phpdocumentor-signature ">
  368. <span class="phpdocumentor-signature__visibility">private</span>
  369. <span class="phpdocumentor-signature__type">bool</span>
  370. <span class="phpdocumentor-signature__name">$mirror</span>
  371. = <span class="phpdocumentor-signature__default-value">false</span></code>
  372. <section class="phpdocumentor-description"></section>
  373. <section class="phpdocumentor-description"></section>
  374. </article>
  375. <article
  376. class="
  377. phpdocumentor-element
  378. -property
  379. -private
  380. "
  381. >
  382. <h4 class="phpdocumentor-element__name" id="property_rowSize">
  383. $rowSize
  384. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_rowSize" class="headerlink"><i class="fas fa-link"></i></a>
  385. <span class="phpdocumentor-element__modifiers">
  386. </span>
  387. </h4>
  388. <aside class="phpdocumentor-element-found-in">
  389. <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>
  390. :
  391. <span class="phpdocumentor-element-found-in__line">24</span>
  392. </aside>
  393. <code class="phpdocumentor-code phpdocumentor-signature ">
  394. <span class="phpdocumentor-signature__visibility">private</span>
  395. <span class="phpdocumentor-signature__type">int</span>
  396. <span class="phpdocumentor-signature__name">$rowSize</span>
  397. </code>
  398. <section class="phpdocumentor-description"></section>
  399. <section class="phpdocumentor-description"></section>
  400. </article>
  401. <article
  402. class="
  403. phpdocumentor-element
  404. -property
  405. -private
  406. "
  407. >
  408. <h4 class="phpdocumentor-element__name" id="property_version">
  409. $version
  410. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
  411. <span class="phpdocumentor-element__modifiers">
  412. </span>
  413. </h4>
  414. <aside class="phpdocumentor-element-found-in">
  415. <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>
  416. :
  417. <span class="phpdocumentor-element-found-in__line">26</span>
  418. </aside>
  419. <code class="phpdocumentor-code phpdocumentor-signature ">
  420. <span class="phpdocumentor-signature__visibility">private</span>
  421. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span>
  422. <span class="phpdocumentor-signature__name">$version</span>
  423. = <span class="phpdocumentor-signature__default-value">null</span></code>
  424. <section class="phpdocumentor-description"></section>
  425. <section class="phpdocumentor-description"></section>
  426. </article>
  427. </section>
  428. <section class="phpdocumentor-methods">
  429. <h3 class="phpdocumentor-elements__header" id="methods">
  430. Methods
  431. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  432. </h3>
  433. <article
  434. class="phpdocumentor-element
  435. -method
  436. -public
  437. "
  438. >
  439. <h4 class="phpdocumentor-element__name" id="method___construct">
  440. __construct()
  441. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  442. </h4>
  443. <aside class="phpdocumentor-element-found-in">
  444. <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>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">33</span>
  447. </aside>
  448. <code class="phpdocumentor-code phpdocumentor-signature ">
  449. <span class="phpdocumentor-signature__visibility">public</span>
  450. <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>
  451. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  452. <dl class="phpdocumentor-argument-list">
  453. <dt class="phpdocumentor-argument-list__entry">
  454. <span class="phpdocumentor-signature__argument__name">$dimension</span>
  455. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  456. </dt>
  457. <dd class="phpdocumentor-argument-list__definition">
  458. <section class="phpdocumentor-description"></section>
  459. </dd>
  460. </dl>
  461. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  462. <span class="phpdocumentor-signature__response_type">mixed</span>
  463. &mdash;
  464. </article>
  465. <article
  466. class="phpdocumentor-element
  467. -method
  468. -public
  469. "
  470. >
  471. <h4 class="phpdocumentor-element__name" id="method_flip">
  472. flip()
  473. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_flip" class="headerlink"><i class="fas fa-link"></i></a>
  474. </h4>
  475. <aside class="phpdocumentor-element-found-in">
  476. <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>
  477. :
  478. <span class="phpdocumentor-element-found-in__line">60</span>
  479. </aside>
  480. <p class="phpdocumentor-summary">Flips the given bit. 1 &lt;&lt; (0xf9 &amp; 0x1f)</p>
  481. <code class="phpdocumentor-code phpdocumentor-signature ">
  482. <span class="phpdocumentor-signature__visibility">public</span>
  483. <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>
  484. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  485. <dl class="phpdocumentor-argument-list">
  486. <dt class="phpdocumentor-argument-list__entry">
  487. <span class="phpdocumentor-signature__argument__name">$x</span>
  488. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  489. </dt>
  490. <dd class="phpdocumentor-argument-list__definition">
  491. <section class="phpdocumentor-description"><p>; The horizontal component (i.e. which column)</p>
  492. </section>
  493. </dd>
  494. <dt class="phpdocumentor-argument-list__entry">
  495. <span class="phpdocumentor-signature__argument__name">$y</span>
  496. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  497. </dt>
  498. <dd class="phpdocumentor-argument-list__definition">
  499. <section class="phpdocumentor-description"><p>; The vertical component (i.e. which row)</p>
  500. </section>
  501. </dd>
  502. </dl>
  503. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  504. <span class="phpdocumentor-signature__response_type">self</span>
  505. &mdash;
  506. </article>
  507. <article
  508. class="phpdocumentor-element
  509. -method
  510. -public
  511. "
  512. >
  513. <h4 class="phpdocumentor-element__name" id="method_get">
  514. get()
  515. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
  516. </h4>
  517. <aside class="phpdocumentor-element-found-in">
  518. <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>
  519. :
  520. <span class="phpdocumentor-element-found-in__line">136</span>
  521. </aside>
  522. <p class="phpdocumentor-summary">Gets the requested bit, where true means black.</p>
  523. <code class="phpdocumentor-code phpdocumentor-signature ">
  524. <span class="phpdocumentor-signature__visibility">public</span>
  525. <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">bool</span></code>
  526. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  527. <dl class="phpdocumentor-argument-list">
  528. <dt class="phpdocumentor-argument-list__entry">
  529. <span class="phpdocumentor-signature__argument__name">$x</span>
  530. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  531. </dt>
  532. <dd class="phpdocumentor-argument-list__definition">
  533. <section class="phpdocumentor-description"><p>The horizontal component (i.e. which column)</p>
  534. </section>
  535. </dd>
  536. <dt class="phpdocumentor-argument-list__entry">
  537. <span class="phpdocumentor-signature__argument__name">$y</span>
  538. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  539. </dt>
  540. <dd class="phpdocumentor-argument-list__definition">
  541. <section class="phpdocumentor-description"><p>The vertical component (i.e. which row)</p>
  542. </section>
  543. </dd>
  544. </dl>
  545. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  546. <span class="phpdocumentor-signature__response_type">bool</span>
  547. &mdash;
  548. <section class="phpdocumentor-description"><p>value of given bit in matrix</p>
  549. </section>
  550. </article>
  551. <article
  552. class="phpdocumentor-element
  553. -method
  554. -public
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="method_getDimension">
  558. getDimension()
  559. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getDimension" class="headerlink"><i class="fas fa-link"></i></a>
  560. </h4>
  561. <aside class="phpdocumentor-element-found-in">
  562. <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>
  563. :
  564. <span class="phpdocumentor-element-found-in__line">110</span>
  565. </aside>
  566. <code class="phpdocumentor-code phpdocumentor-signature ">
  567. <span class="phpdocumentor-signature__visibility">public</span>
  568. <span class="phpdocumentor-signature__name">getDimension</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  569. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  570. <span class="phpdocumentor-signature__response_type">int</span>
  571. &mdash;
  572. <section class="phpdocumentor-description"><p>The dimension (width/height) of the matrix</p>
  573. </section>
  574. </article>
  575. <article
  576. class="phpdocumentor-element
  577. -method
  578. -public
  579. "
  580. >
  581. <h4 class="phpdocumentor-element__name" id="method_getFormatInfo">
  582. getFormatInfo()
  583. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getFormatInfo" class="headerlink"><i class="fas fa-link"></i></a>
  584. </h4>
  585. <aside class="phpdocumentor-element-found-in">
  586. <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>
  587. :
  588. <span class="phpdocumentor-element-found-in__line">117</span>
  589. </aside>
  590. <code class="phpdocumentor-code phpdocumentor-signature ">
  591. <span class="phpdocumentor-signature__visibility">public</span>
  592. <span class="phpdocumentor-signature__name">getFormatInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null</span></code>
  593. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  594. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null</span>
  595. &mdash;
  596. </article>
  597. <article
  598. class="phpdocumentor-element
  599. -method
  600. -public
  601. "
  602. >
  603. <h4 class="phpdocumentor-element__name" id="method_getVersion">
  604. getVersion()
  605. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
  606. </h4>
  607. <aside class="phpdocumentor-element-found-in">
  608. <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>
  609. :
  610. <span class="phpdocumentor-element-found-in__line">124</span>
  611. </aside>
  612. <code class="phpdocumentor-code phpdocumentor-signature ">
  613. <span class="phpdocumentor-signature__visibility">public</span>
  614. <span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a>|null</span></code>
  615. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  616. <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>
  617. &mdash;
  618. </article>
  619. <article
  620. class="phpdocumentor-element
  621. -method
  622. -public
  623. "
  624. >
  625. <h4 class="phpdocumentor-element__name" id="method_mirror">
  626. mirror()
  627. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_mirror" class="headerlink"><i class="fas fa-link"></i></a>
  628. </h4>
  629. <aside class="phpdocumentor-element-found-in">
  630. <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>
  631. :
  632. <span class="phpdocumentor-element-found-in__line">193</span>
  633. </aside>
  634. <p class="phpdocumentor-summary">Mirror the bit matrix in order to attempt a second reading.</p>
  635. <code class="phpdocumentor-code phpdocumentor-signature ">
  636. <span class="phpdocumentor-signature__visibility">public</span>
  637. <span class="phpdocumentor-signature__name">mirror</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  638. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  639. <span class="phpdocumentor-signature__response_type">self</span>
  640. &mdash;
  641. </article>
  642. <article
  643. class="phpdocumentor-element
  644. -method
  645. -public
  646. "
  647. >
  648. <h4 class="phpdocumentor-element__name" id="method_readCodewords">
  649. readCodewords()
  650. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readCodewords" class="headerlink"><i class="fas fa-link"></i></a>
  651. </h4>
  652. <aside class="phpdocumentor-element-found-in">
  653. <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>
  654. :
  655. <span class="phpdocumentor-element-found-in__line">260</span>
  656. </aside>
  657. <p class="phpdocumentor-summary">Reads the bits in the BitMatrix representing the finder pattern in the
  658. correct order in order to reconstruct the codewords bytes contained within the
  659. QR Code.</p>
  660. <code class="phpdocumentor-code phpdocumentor-signature ">
  661. <span class="phpdocumentor-signature__visibility">public</span>
  662. <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>
  663. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  664. Tags
  665. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  666. </h5>
  667. <dl class="phpdocumentor-tag-list">
  668. <dt class="phpdocumentor-tag-list__entry">
  669. <span class="phpdocumentor-tag__name">throws</span>
  670. </dt>
  671. <dd class="phpdocumentor-tag-list__definition">
  672. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  673. <section class="phpdocumentor-description"><p>if the exact number of bytes expected is not read</p>
  674. </section>
  675. </dd>
  676. </dl>
  677. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  678. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  679. &mdash;
  680. <section class="phpdocumentor-description"><p>bytes encoded within the QR Code</p>
  681. </section>
  682. </article>
  683. <article
  684. class="phpdocumentor-element
  685. -method
  686. -public
  687. "
  688. >
  689. <h4 class="phpdocumentor-element__name" id="method_set">
  690. set()
  691. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
  692. </h4>
  693. <aside class="phpdocumentor-element-found-in">
  694. <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>
  695. :
  696. <span class="phpdocumentor-element-found-in__line">45</span>
  697. </aside>
  698. <p class="phpdocumentor-summary">Sets the given bit to true.</p>
  699. <code class="phpdocumentor-code phpdocumentor-signature ">
  700. <span class="phpdocumentor-signature__visibility">public</span>
  701. <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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  702. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  703. <dl class="phpdocumentor-argument-list">
  704. <dt class="phpdocumentor-argument-list__entry">
  705. <span class="phpdocumentor-signature__argument__name">$x</span>
  706. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  707. </dt>
  708. <dd class="phpdocumentor-argument-list__definition">
  709. <section class="phpdocumentor-description"><p>; The horizontal component (i.e. which column)</p>
  710. </section>
  711. </dd>
  712. <dt class="phpdocumentor-argument-list__entry">
  713. <span class="phpdocumentor-signature__argument__name">$y</span>
  714. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  715. </dt>
  716. <dd class="phpdocumentor-argument-list__definition">
  717. <section class="phpdocumentor-description"><p>; The vertical component (i.e. which row)</p>
  718. </section>
  719. </dd>
  720. </dl>
  721. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  722. <span class="phpdocumentor-signature__response_type">self</span>
  723. &mdash;
  724. </article>
  725. <article
  726. class="phpdocumentor-element
  727. -method
  728. -public
  729. "
  730. >
  731. <h4 class="phpdocumentor-element__name" id="method_setMirror">
  732. setMirror()
  733. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setMirror" class="headerlink"><i class="fas fa-link"></i></a>
  734. </h4>
  735. <aside class="phpdocumentor-element-found-in">
  736. <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>
  737. :
  738. <span class="phpdocumentor-element-found-in__line">232</span>
  739. </aside>
  740. <p class="phpdocumentor-summary">Prepare the parser for a mirrored operation.</p>
  741. <code class="phpdocumentor-code phpdocumentor-signature ">
  742. <span class="phpdocumentor-signature__visibility">public</span>
  743. <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>
  744. <section class="phpdocumentor-description"><p>This flag has effect only on the #readFormatInformation() and the
  745. #readVersion(). Before proceeding with #readCodewords() the
  746. #mirror() method should be called.</p>
  747. </section>
  748. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  749. <dl class="phpdocumentor-argument-list">
  750. <dt class="phpdocumentor-argument-list__entry">
  751. <span class="phpdocumentor-signature__argument__name">$mirror</span>
  752. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  753. </dt>
  754. <dd class="phpdocumentor-argument-list__definition">
  755. <section class="phpdocumentor-description"><p>Whether to read version and format information mirrored.</p>
  756. </section>
  757. </dd>
  758. </dl>
  759. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  760. <span class="phpdocumentor-signature__response_type">self</span>
  761. &mdash;
  762. </article>
  763. <article
  764. class="phpdocumentor-element
  765. -method
  766. -public
  767. "
  768. >
  769. <h4 class="phpdocumentor-element__name" id="method_setRegion">
  770. setRegion()
  771. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_setRegion" class="headerlink"><i class="fas fa-link"></i></a>
  772. </h4>
  773. <aside class="phpdocumentor-element-found-in">
  774. <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>
  775. :
  776. <span class="phpdocumentor-element-found-in__line">78</span>
  777. </aside>
  778. <p class="phpdocumentor-summary">Sets a square region of the bit matrix to true.</p>
  779. <code class="phpdocumentor-code phpdocumentor-signature ">
  780. <span class="phpdocumentor-signature__visibility">public</span>
  781. <span class="phpdocumentor-signature__name">setRegion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$left</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">$top</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  782. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  783. <dl class="phpdocumentor-argument-list">
  784. <dt class="phpdocumentor-argument-list__entry">
  785. <span class="phpdocumentor-signature__argument__name">$left</span>
  786. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  787. </dt>
  788. <dd class="phpdocumentor-argument-list__definition">
  789. <section class="phpdocumentor-description"><p>; The horizontal position to begin at (inclusive)</p>
  790. </section>
  791. </dd>
  792. <dt class="phpdocumentor-argument-list__entry">
  793. <span class="phpdocumentor-signature__argument__name">$top</span>
  794. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  795. </dt>
  796. <dd class="phpdocumentor-argument-list__definition">
  797. <section class="phpdocumentor-description"><p>; The vertical position to begin at (inclusive)</p>
  798. </section>
  799. </dd>
  800. <dt class="phpdocumentor-argument-list__entry">
  801. <span class="phpdocumentor-signature__argument__name">$width</span>
  802. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  803. </dt>
  804. <dd class="phpdocumentor-argument-list__definition">
  805. <section class="phpdocumentor-description"><p>; The width of the region</p>
  806. </section>
  807. </dd>
  808. <dt class="phpdocumentor-argument-list__entry">
  809. <span class="phpdocumentor-signature__argument__name">$height</span>
  810. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  811. </dt>
  812. <dd class="phpdocumentor-argument-list__definition">
  813. <section class="phpdocumentor-description"><p>; The height of the region</p>
  814. </section>
  815. </dd>
  816. </dl>
  817. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  818. Tags
  819. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  820. </h5>
  821. <dl class="phpdocumentor-tag-list">
  822. <dt class="phpdocumentor-tag-list__entry">
  823. <span class="phpdocumentor-tag__name">throws</span>
  824. </dt>
  825. <dd class="phpdocumentor-tag-list__definition">
  826. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  827. </dd>
  828. </dl>
  829. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  830. <span class="phpdocumentor-signature__response_type">self</span>
  831. &mdash;
  832. </article>
  833. <article
  834. class="phpdocumentor-element
  835. -method
  836. -private
  837. "
  838. >
  839. <h4 class="phpdocumentor-element__name" id="method_buildFunctionPattern">
  840. buildFunctionPattern()
  841. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_buildFunctionPattern" class="headerlink"><i class="fas fa-link"></i></a>
  842. </h4>
  843. <aside class="phpdocumentor-element-found-in">
  844. <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>
  845. :
  846. <span class="phpdocumentor-element-found-in__line">147</span>
  847. </aside>
  848. <p class="phpdocumentor-summary">See ISO 18004:2006 Annex E</p>
  849. <code class="phpdocumentor-code phpdocumentor-signature ">
  850. <span class="phpdocumentor-signature__visibility">private</span>
  851. <span class="phpdocumentor-signature__name">buildFunctionPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  852. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  853. <span class="phpdocumentor-signature__response_type">self</span>
  854. &mdash;
  855. </article>
  856. <article
  857. class="phpdocumentor-element
  858. -method
  859. -private
  860. "
  861. >
  862. <h4 class="phpdocumentor-element__name" id="method_copyBit">
  863. copyBit()
  864. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_copyBit" class="headerlink"><i class="fas fa-link"></i></a>
  865. </h4>
  866. <aside class="phpdocumentor-element-found-in">
  867. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  868. :
  869. <span class="phpdocumentor-element-found-in__line">243</span>
  870. </aside>
  871. <code class="phpdocumentor-code phpdocumentor-signature ">
  872. <span class="phpdocumentor-signature__visibility">private</span>
  873. <span class="phpdocumentor-signature__name">copyBit</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>
  874. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  875. <dl class="phpdocumentor-argument-list">
  876. <dt class="phpdocumentor-argument-list__entry">
  877. <span class="phpdocumentor-signature__argument__name">$i</span>
  878. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  879. </dt>
  880. <dd class="phpdocumentor-argument-list__definition">
  881. <section class="phpdocumentor-description"></section>
  882. </dd>
  883. <dt class="phpdocumentor-argument-list__entry">
  884. <span class="phpdocumentor-signature__argument__name">$j</span>
  885. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  886. </dt>
  887. <dd class="phpdocumentor-argument-list__definition">
  888. <section class="phpdocumentor-description"></section>
  889. </dd>
  890. <dt class="phpdocumentor-argument-list__entry">
  891. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  892. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  893. </dt>
  894. <dd class="phpdocumentor-argument-list__definition">
  895. <section class="phpdocumentor-description"></section>
  896. </dd>
  897. </dl>
  898. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  899. <span class="phpdocumentor-signature__response_type">int</span>
  900. &mdash;
  901. </article>
  902. <article
  903. class="phpdocumentor-element
  904. -method
  905. -private
  906. "
  907. >
  908. <h4 class="phpdocumentor-element__name" id="method_decodeVersionInformation">
  909. decodeVersionInformation()
  910. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_decodeVersionInformation" class="headerlink"><i class="fas fa-link"></i></a>
  911. </h4>
  912. <aside class="phpdocumentor-element-found-in">
  913. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/BitMatrix.php"><a href="files/src-decoder-bitmatrix.html"><abbr title="src/Decoder/BitMatrix.php">BitMatrix.php</abbr></a></abbr>
  914. :
  915. <span class="phpdocumentor-element-found-in__line">481</span>
  916. </aside>
  917. <code class="phpdocumentor-code phpdocumentor-signature ">
  918. <span class="phpdocumentor-signature__visibility">private</span>
  919. <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>
  920. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  921. <dl class="phpdocumentor-argument-list">
  922. <dt class="phpdocumentor-argument-list__entry">
  923. <span class="phpdocumentor-signature__argument__name">$versionBits</span>
  924. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  925. </dt>
  926. <dd class="phpdocumentor-argument-list__definition">
  927. </dd>
  928. </dl>
  929. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  930. <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>
  931. &mdash;
  932. </article>
  933. <article
  934. class="phpdocumentor-element
  935. -method
  936. -private
  937. "
  938. >
  939. <h4 class="phpdocumentor-element__name" id="method_doDecodeFormatInformation">
  940. doDecodeFormatInformation()
  941. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_doDecodeFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  942. </h4>
  943. <aside class="phpdocumentor-element-found-in">
  944. <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>
  945. :
  946. <span class="phpdocumentor-element-found-in__line">385</span>
  947. </aside>
  948. <code class="phpdocumentor-code phpdocumentor-signature ">
  949. <span class="phpdocumentor-signature__visibility">private</span>
  950. <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"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null</span></code>
  951. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  952. <dl class="phpdocumentor-argument-list">
  953. <dt class="phpdocumentor-argument-list__entry">
  954. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo1</span>
  955. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  956. </dt>
  957. <dd class="phpdocumentor-argument-list__definition">
  958. <section class="phpdocumentor-description"><p>format info indicator, with mask still applied</p>
  959. </section>
  960. </dd>
  961. <dt class="phpdocumentor-argument-list__entry">
  962. <span class="phpdocumentor-signature__argument__name">$maskedFormatInfo2</span>
  963. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  964. </dt>
  965. <dd class="phpdocumentor-argument-list__definition">
  966. <section class="phpdocumentor-description"><p>second copy of same info; both are checked at the same time
  967. to establish best match</p>
  968. </section>
  969. </dd>
  970. </dl>
  971. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  972. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a>|null</span>
  973. &mdash;
  974. <section class="phpdocumentor-description"><p>information about the format it specifies, or null
  975. if doesn't seem to match any known pattern</p>
  976. </section>
  977. </article>
  978. <article
  979. class="phpdocumentor-element
  980. -method
  981. -private
  982. "
  983. >
  984. <h4 class="phpdocumentor-element__name" id="method_numBitsDiffering">
  985. numBitsDiffering()
  986. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_numBitsDiffering" class="headerlink"><i class="fas fa-link"></i></a>
  987. </h4>
  988. <aside class="phpdocumentor-element-found-in">
  989. <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>
  990. :
  991. <span class="phpdocumentor-element-found-in__line">529</span>
  992. </aside>
  993. <code class="phpdocumentor-code phpdocumentor-signature ">
  994. <span class="phpdocumentor-signature__visibility">private</span>
  995. <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>
  996. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  997. <dl class="phpdocumentor-argument-list">
  998. <dt class="phpdocumentor-argument-list__entry">
  999. <span class="phpdocumentor-signature__argument__name">$a</span>
  1000. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1001. </dt>
  1002. <dd class="phpdocumentor-argument-list__definition">
  1003. <section class="phpdocumentor-description"></section>
  1004. </dd>
  1005. <dt class="phpdocumentor-argument-list__entry">
  1006. <span class="phpdocumentor-signature__argument__name">$b</span>
  1007. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1008. </dt>
  1009. <dd class="phpdocumentor-argument-list__definition">
  1010. <section class="phpdocumentor-description"></section>
  1011. </dd>
  1012. </dl>
  1013. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1014. <span class="phpdocumentor-signature__response_type">int</span>
  1015. &mdash;
  1016. </article>
  1017. <article
  1018. class="phpdocumentor-element
  1019. -method
  1020. -private
  1021. "
  1022. >
  1023. <h4 class="phpdocumentor-element__name" id="method_readFormatInformation">
  1024. readFormatInformation()
  1025. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readFormatInformation" class="headerlink"><i class="fas fa-link"></i></a>
  1026. </h4>
  1027. <aside class="phpdocumentor-element-found-in">
  1028. <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>
  1029. :
  1030. <span class="phpdocumentor-element-found-in__line">323</span>
  1031. </aside>
  1032. <p class="phpdocumentor-summary">Reads format information from one of its two locations within the QR Code.</p>
  1033. <code class="phpdocumentor-code phpdocumentor-signature ">
  1034. <span class="phpdocumentor-signature__visibility">private</span>
  1035. <span class="phpdocumentor-signature__name">readFormatInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a></span></code>
  1036. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1037. Tags
  1038. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1039. </h5>
  1040. <dl class="phpdocumentor-tag-list">
  1041. <dt class="phpdocumentor-tag-list__entry">
  1042. <span class="phpdocumentor-tag__name">throws</span>
  1043. </dt>
  1044. <dd class="phpdocumentor-tag-list__definition">
  1045. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  1046. <section class="phpdocumentor-description"><p>if both format information locations cannot be parsed as
  1047. the valid encoding of format information</p>
  1048. </section>
  1049. </dd>
  1050. </dl>
  1051. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1052. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-FormatInformation.html"><abbr title="\chillerlan\QRCode\Common\FormatInformation">FormatInformation</abbr></a></span>
  1053. &mdash;
  1054. <section class="phpdocumentor-description"><p>encapsulating the QR Code's format info</p>
  1055. </section>
  1056. </article>
  1057. <article
  1058. class="phpdocumentor-element
  1059. -method
  1060. -private
  1061. "
  1062. >
  1063. <h4 class="phpdocumentor-element__name" id="method_readVersion">
  1064. readVersion()
  1065. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_readVersion" class="headerlink"><i class="fas fa-link"></i></a>
  1066. </h4>
  1067. <aside class="phpdocumentor-element-found-in">
  1068. <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>
  1069. :
  1070. <span class="phpdocumentor-element-found-in__line">430</span>
  1071. </aside>
  1072. <p class="phpdocumentor-summary">Reads version information from one of its two locations within the QR Code.</p>
  1073. <code class="phpdocumentor-code phpdocumentor-signature ">
  1074. <span class="phpdocumentor-signature__visibility">private</span>
  1075. <span class="phpdocumentor-signature__name">readVersion</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></span></code>
  1076. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1077. Tags
  1078. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1079. </h5>
  1080. <dl class="phpdocumentor-tag-list">
  1081. <dt class="phpdocumentor-tag-list__entry">
  1082. <span class="phpdocumentor-tag__name">throws</span>
  1083. </dt>
  1084. <dd class="phpdocumentor-tag-list__definition">
  1085. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  1086. <section class="phpdocumentor-description"><p>if both version information locations cannot be parsed as
  1087. the valid encoding of version information</p>
  1088. </section>
  1089. </dd>
  1090. </dl>
  1091. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1092. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-Version.html"><abbr title="\chillerlan\QRCode\Common\Version">Version</abbr></a></span>
  1093. &mdash;
  1094. <section class="phpdocumentor-description"><p>encapsulating the QR Code's version</p>
  1095. </section>
  1096. </article>
  1097. <article
  1098. class="phpdocumentor-element
  1099. -method
  1100. -private
  1101. "
  1102. >
  1103. <h4 class="phpdocumentor-element__name" id="method_unmask">
  1104. unmask()
  1105. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_unmask" class="headerlink"><i class="fas fa-link"></i></a>
  1106. </h4>
  1107. <aside class="phpdocumentor-element-found-in">
  1108. <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>
  1109. :
  1110. <span class="phpdocumentor-element-found-in__line">211</span>
  1111. </aside>
  1112. <p class="phpdocumentor-summary">Implementations of this method reverse the data masking process applied to a QR Code and
  1113. make its bits ready to read.</p>
  1114. <code class="phpdocumentor-code phpdocumentor-signature ">
  1115. <span class="phpdocumentor-signature__visibility">private</span>
  1116. <span class="phpdocumentor-signature__name">unmask</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1117. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1118. <span class="phpdocumentor-signature__response_type">void</span>
  1119. &mdash;
  1120. </article>
  1121. <article
  1122. class="phpdocumentor-element
  1123. -method
  1124. -private
  1125. "
  1126. >
  1127. <h4 class="phpdocumentor-element__name" id="method_uRShift">
  1128. uRShift()
  1129. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#method_uRShift" class="headerlink"><i class="fas fa-link"></i></a>
  1130. </h4>
  1131. <aside class="phpdocumentor-element-found-in">
  1132. <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>
  1133. :
  1134. <span class="phpdocumentor-element-found-in__line">517</span>
  1135. </aside>
  1136. <code class="phpdocumentor-code phpdocumentor-signature ">
  1137. <span class="phpdocumentor-signature__visibility">private</span>
  1138. <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>
  1139. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1140. <dl class="phpdocumentor-argument-list">
  1141. <dt class="phpdocumentor-argument-list__entry">
  1142. <span class="phpdocumentor-signature__argument__name">$a</span>
  1143. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1144. </dt>
  1145. <dd class="phpdocumentor-argument-list__definition">
  1146. <section class="phpdocumentor-description"></section>
  1147. </dd>
  1148. <dt class="phpdocumentor-argument-list__entry">
  1149. <span class="phpdocumentor-signature__argument__name">$b</span>
  1150. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1151. </dt>
  1152. <dd class="phpdocumentor-argument-list__definition">
  1153. <section class="phpdocumentor-description"></section>
  1154. </dd>
  1155. </dl>
  1156. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1157. <span class="phpdocumentor-signature__response_type">int</span>
  1158. &mdash;
  1159. </article>
  1160. </section>
  1161. <script type="text/javascript">
  1162. function loadExternalCodeSnippets(line) {
  1163. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1164. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1165. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1166. var language = 'php';
  1167. var code = document.createElement('code');
  1168. code.className = 'language-' + language;
  1169. pre.textContent = '';
  1170. pre.setAttribute('data-line', line)
  1171. code.textContent = 'Loading…';
  1172. pre.appendChild(code);
  1173. var xhr = new XMLHttpRequest();
  1174. xhr.open('GET', src, true);
  1175. xhr.onreadystatechange = function () {
  1176. if (xhr.readyState == 4) {
  1177. if (xhr.status < 400 && xhr.responseText) {
  1178. code.textContent = xhr.responseText;
  1179. Prism.highlightElement(code);
  1180. }
  1181. else if (xhr.status >= 400) {
  1182. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1183. }
  1184. else {
  1185. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1186. }
  1187. }
  1188. };
  1189. xhr.send(null);
  1190. });
  1191. }
  1192. var modals = document.querySelectorAll("[data-modal]");
  1193. modals.forEach(function (trigger) {
  1194. trigger.addEventListener("click", function (event) {
  1195. //event.preventDefault();
  1196. const modal = document.getElementById(trigger.dataset.modal);
  1197. modal.classList.add("phpdocumentor-modal__open");
  1198. loadExternalCodeSnippets(trigger.dataset.line)
  1199. const exits = modal.querySelectorAll("[data-exit-button]");
  1200. exits.forEach(function (exit) {
  1201. exit.addEventListener("click", function (event) {
  1202. event.preventDefault();
  1203. modal.classList.remove("phpdocumentor-modal__open");
  1204. });
  1205. });
  1206. });
  1207. });
  1208. </script>
  1209. </article>
  1210. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1211. <section class="phpdocumentor-search-results__dialog">
  1212. <header class="phpdocumentor-search-results__header">
  1213. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1214. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1215. </header>
  1216. <section class="phpdocumentor-search-results__body">
  1217. <ul class="phpdocumentor-search-results__entries"></ul>
  1218. </section>
  1219. </section>
  1220. </section>
  1221. </div>
  1222. </div>
  1223. <a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1224. </main>
  1225. <script>
  1226. cssVars({});
  1227. </script>
  1228. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1229. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1230. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1231. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1232. </body>
  1233. </html>