chillerlan-QRCode-Decoder-BitMatrix.html 75 KB

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