chillerlan-QRCode-Common-FormatInformation.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569
  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-common.html">Common</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. FormatInformation
  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/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">20</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Encapsulates a QR Code&#039;s format information, including the data mask used and error correction level.</p>
  106. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  107. Tags
  108. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  109. </h5>
  110. <dl class="phpdocumentor-tag-list">
  111. <dt class="phpdocumentor-tag-list__entry">
  112. <span class="phpdocumentor-tag__name">author</span>
  113. </dt>
  114. <dd class="phpdocumentor-tag-list__definition">
  115. <section class="phpdocumentor-description"><p>Sean Owen</p>
  116. </section>
  117. </dd>
  118. <dt class="phpdocumentor-tag-list__entry">
  119. <span class="phpdocumentor-tag__name">see</span>
  120. </dt>
  121. <dd class="phpdocumentor-tag-list__definition">
  122. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  123. </dd>
  124. </dl>
  125. <h3 id="toc">
  126. Table of Contents
  127. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  128. </h3>
  129. <dl class="phpdocumentor-table-of-contents">
  130. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  131. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_DECODE_LOOKUP">DECODE_LOOKUP</a>
  132. <span>
  133. &nbsp;= [[0x0, 0x5412], [0x1, 0x5125], [0x2, 0x5e7c], [0x3, 0x5b4b], [0x4, 0x45f9], [0x5, 0x40ce], [0x6, 0x4f97], [0x7, 0x4aa0], [0x8, 0x77c4], [0x9, 0x72f3], [0xa, 0x7daa], [0xb, 0x789d], [0xc, 0x662f], [0xd, 0x6318], [0xe, 0x6c41], [0xf, 0x6976], [0x10, 0x1689], [0x11, 0x13be], [0x12, 0x1ce7], [0x13, 0x19d0], [0x14, 0x762], [0x15, 0x255], [0x16, 0xd0c], [0x17, 0x83b], [0x18, 0x355f], [0x19, 0x3068], [0x1a, 0x3f31], [0x1b, 0x3a06], [0x1c, 0x24b4], [0x1d, 0x2183], [0x1e, 0x2eda], [0x1f, 0x2bed]] </span>
  134. </dt>
  135. <dd>See ISO 18004:2006, Annex C, Table C.1</dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  137. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_FORMAT_INFO_MASK_QR">FORMAT_INFO_MASK_QR</a>
  138. <span>
  139. &nbsp;= 0x5412 </span>
  140. </dt>
  141. <dd></dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  143. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_errorCorrectionLevel">$errorCorrectionLevel</a>
  144. <span>
  145. &nbsp;: int </span>
  146. </dt>
  147. <dd>The current ECC level value</dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  149. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_maskPattern">$maskPattern</a>
  150. <span>
  151. &nbsp;: int </span>
  152. </dt>
  153. <dd>The current mask pattern (0-7)</dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  155. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method___construct">__construct()</a>
  156. <span>
  157. &nbsp;: mixed </span>
  158. </dt>
  159. <dd>Receives the format information from a parsed QR Code, detects ECC level and mask pattern</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  161. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getErrorCorrectionLevel">getErrorCorrectionLevel()</a>
  162. <span>
  163. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  164. </dt>
  165. <dd>Returns and EccLevel instance ith the detected ECC level set</dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  167. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getMaskPattern">getMaskPattern()</a>
  168. <span>
  169. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span>
  170. </dt>
  171. <dd>Returns a MaskPattern instance with the detected mask pattern set</dd>
  172. </dl>
  173. <section class="phpdocumentor-constants">
  174. <h3 class="phpdocumentor-elements__header" id="constants">
  175. Constants
  176. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  177. </h3>
  178. <article class="phpdocumentor-element -constant -public ">
  179. <h4 class="phpdocumentor-element__name" id="constant_DECODE_LOOKUP">
  180. DECODE_LOOKUP
  181. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_DECODE_LOOKUP" class="headerlink"><i class="fas fa-link"></i></a>
  182. </h4>
  183. <aside class="phpdocumentor-element-found-in">
  184. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  185. :
  186. <span class="phpdocumentor-element-found-in__line">29</span>
  187. </aside>
  188. <p class="phpdocumentor-summary">See ISO 18004:2006, Annex C, Table C.1</p>
  189. <code class="phpdocumentor-signature phpdocumentor-code ">
  190. <span class="phpdocumentor-signature__visibility">public</span>
  191. <span class="phpdocumentor-signature__type">mixed</span>
  192. <span class="phpdocumentor-signature__name">DECODE_LOOKUP</span>
  193. = <span class="phpdocumentor-signature__default-value">[[0x0, 0x5412], [0x1, 0x5125], [0x2, 0x5e7c], [0x3, 0x5b4b], [0x4, 0x45f9], [0x5, 0x40ce], [0x6, 0x4f97], [0x7, 0x4aa0], [0x8, 0x77c4], [0x9, 0x72f3], [0xa, 0x7daa], [0xb, 0x789d], [0xc, 0x662f], [0xd, 0x6318], [0xe, 0x6c41], [0xf, 0x6976], [0x10, 0x1689], [0x11, 0x13be], [0x12, 0x1ce7], [0x13, 0x19d0], [0x14, 0x762], [0x15, 0x255], [0x16, 0xd0c], [0x17, 0x83b], [0x18, 0x355f], [0x19, 0x3068], [0x1a, 0x3f31], [0x1b, 0x3a06], [0x1c, 0x24b4], [0x1d, 0x2183], [0x1e, 0x2eda], [0x1f, 0x2bed]]</span>
  194. </code>
  195. <section class="phpdocumentor-description"><p>[data bits, sequence after masking]</p>
  196. </section>
  197. <section class="phpdocumentor-description"></section>
  198. </article>
  199. <article class="phpdocumentor-element -constant -public ">
  200. <h4 class="phpdocumentor-element__name" id="constant_FORMAT_INFO_MASK_QR">
  201. FORMAT_INFO_MASK_QR
  202. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_FORMAT_INFO_MASK_QR" class="headerlink"><i class="fas fa-link"></i></a>
  203. </h4>
  204. <aside class="phpdocumentor-element-found-in">
  205. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  206. :
  207. <span class="phpdocumentor-element-found-in__line">22</span>
  208. </aside>
  209. <code class="phpdocumentor-signature phpdocumentor-code ">
  210. <span class="phpdocumentor-signature__visibility">public</span>
  211. <span class="phpdocumentor-signature__type">mixed</span>
  212. <span class="phpdocumentor-signature__name">FORMAT_INFO_MASK_QR</span>
  213. = <span class="phpdocumentor-signature__default-value">0x5412</span>
  214. </code>
  215. <section class="phpdocumentor-description"></section>
  216. <section class="phpdocumentor-description"></section>
  217. </article>
  218. </section>
  219. <section class="phpdocumentor-properties">
  220. <h3 class="phpdocumentor-elements__header" id="properties">
  221. Properties
  222. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  223. </h3>
  224. <article
  225. class="
  226. phpdocumentor-element
  227. -property
  228. -private
  229. "
  230. >
  231. <h4 class="phpdocumentor-element__name" id="property_errorCorrectionLevel">
  232. $errorCorrectionLevel
  233. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_errorCorrectionLevel" class="headerlink"><i class="fas fa-link"></i></a>
  234. <span class="phpdocumentor-element__modifiers">
  235. </span>
  236. </h4>
  237. <aside class="phpdocumentor-element-found-in">
  238. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  239. :
  240. <span class="phpdocumentor-element-found-in__line">72</span>
  241. </aside>
  242. <p class="phpdocumentor-summary">The current ECC level value</p>
  243. <code class="phpdocumentor-code phpdocumentor-signature ">
  244. <span class="phpdocumentor-signature__visibility">private</span>
  245. <span class="phpdocumentor-signature__type">int</span>
  246. <span class="phpdocumentor-signature__name">$errorCorrectionLevel</span>
  247. </code>
  248. <section class="phpdocumentor-description"><p>L: 0b01
  249. M: 0b00
  250. Q: 0b11
  251. H: 0b10</p>
  252. </section>
  253. <section class="phpdocumentor-description"></section>
  254. </article>
  255. <article
  256. class="
  257. phpdocumentor-element
  258. -property
  259. -private
  260. "
  261. >
  262. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  263. $maskPattern
  264. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  265. <span class="phpdocumentor-element__modifiers">
  266. </span>
  267. </h4>
  268. <aside class="phpdocumentor-element-found-in">
  269. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  270. :
  271. <span class="phpdocumentor-element-found-in__line">77</span>
  272. </aside>
  273. <p class="phpdocumentor-summary">The current mask pattern (0-7)</p>
  274. <code class="phpdocumentor-code phpdocumentor-signature ">
  275. <span class="phpdocumentor-signature__visibility">private</span>
  276. <span class="phpdocumentor-signature__type">int</span>
  277. <span class="phpdocumentor-signature__name">$maskPattern</span>
  278. </code>
  279. <section class="phpdocumentor-description"></section>
  280. </article>
  281. </section>
  282. <section class="phpdocumentor-methods">
  283. <h3 class="phpdocumentor-elements__header" id="methods">
  284. Methods
  285. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  286. </h3>
  287. <article
  288. class="phpdocumentor-element
  289. -method
  290. -public
  291. "
  292. >
  293. <h4 class="phpdocumentor-element__name" id="method___construct">
  294. __construct()
  295. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  296. </h4>
  297. <aside class="phpdocumentor-element-found-in">
  298. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  299. :
  300. <span class="phpdocumentor-element-found-in__line">82</span>
  301. </aside>
  302. <p class="phpdocumentor-summary">Receives the format information from a parsed QR Code, detects ECC level and mask pattern</p>
  303. <code class="phpdocumentor-code phpdocumentor-signature ">
  304. <span class="phpdocumentor-signature__visibility">public</span>
  305. <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">$formatInfo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  306. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  307. <dl class="phpdocumentor-argument-list">
  308. <dt class="phpdocumentor-argument-list__entry">
  309. <span class="phpdocumentor-signature__argument__name">$formatInfo</span>
  310. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  311. </dt>
  312. <dd class="phpdocumentor-argument-list__definition">
  313. <section class="phpdocumentor-description"></section>
  314. </dd>
  315. </dl>
  316. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  317. <span class="phpdocumentor-signature__response_type">mixed</span>
  318. &mdash;
  319. </article>
  320. <article
  321. class="phpdocumentor-element
  322. -method
  323. -public
  324. "
  325. >
  326. <h4 class="phpdocumentor-element__name" id="method_getErrorCorrectionLevel">
  327. getErrorCorrectionLevel()
  328. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getErrorCorrectionLevel" class="headerlink"><i class="fas fa-link"></i></a>
  329. </h4>
  330. <aside class="phpdocumentor-element-found-in">
  331. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  332. :
  333. <span class="phpdocumentor-element-found-in__line">90</span>
  334. </aside>
  335. <p class="phpdocumentor-summary">Returns and EccLevel instance ith the detected ECC level set</p>
  336. <code class="phpdocumentor-code phpdocumentor-signature ">
  337. <span class="phpdocumentor-signature__visibility">public</span>
  338. <span class="phpdocumentor-signature__name">getErrorCorrectionLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span></code>
  339. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  340. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  341. &mdash;
  342. </article>
  343. <article
  344. class="phpdocumentor-element
  345. -method
  346. -public
  347. "
  348. >
  349. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  350. getMaskPattern()
  351. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  352. </h4>
  353. <aside class="phpdocumentor-element-found-in">
  354. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  355. :
  356. <span class="phpdocumentor-element-found-in__line">97</span>
  357. </aside>
  358. <p class="phpdocumentor-summary">Returns a MaskPattern instance with the detected mask pattern set</p>
  359. <code class="phpdocumentor-code phpdocumentor-signature ">
  360. <span class="phpdocumentor-signature__visibility">public</span>
  361. <span class="phpdocumentor-signature__name">getMaskPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span></code>
  362. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  363. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  364. &mdash;
  365. </article>
  366. </section>
  367. <script type="text/javascript">
  368. function loadExternalCodeSnippets(line) {
  369. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  370. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  371. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  372. var language = 'php';
  373. var code = document.createElement('code');
  374. code.className = 'language-' + language;
  375. pre.textContent = '';
  376. pre.setAttribute('data-line', line)
  377. code.textContent = 'Loading…';
  378. pre.appendChild(code);
  379. var xhr = new XMLHttpRequest();
  380. xhr.open('GET', src, true);
  381. xhr.onreadystatechange = function () {
  382. if (xhr.readyState == 4) {
  383. if (xhr.status < 400 && xhr.responseText) {
  384. code.textContent = xhr.responseText;
  385. Prism.highlightElement(code);
  386. }
  387. else if (xhr.status >= 400) {
  388. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  389. }
  390. else {
  391. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  392. }
  393. }
  394. };
  395. xhr.send(null);
  396. });
  397. }
  398. var modals = document.querySelectorAll("[data-modal]");
  399. modals.forEach(function (trigger) {
  400. trigger.addEventListener("click", function (event) {
  401. //event.preventDefault();
  402. const modal = document.getElementById(trigger.dataset.modal);
  403. modal.classList.add("phpdocumentor-modal__open");
  404. loadExternalCodeSnippets(trigger.dataset.line)
  405. const exits = modal.querySelectorAll("[data-exit-button]");
  406. exits.forEach(function (exit) {
  407. exit.addEventListener("click", function (event) {
  408. event.preventDefault();
  409. modal.classList.remove("phpdocumentor-modal__open");
  410. });
  411. });
  412. });
  413. });
  414. </script>
  415. </article>
  416. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  417. <section class="phpdocumentor-search-results__dialog">
  418. <header class="phpdocumentor-search-results__header">
  419. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  420. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  421. </header>
  422. <section class="phpdocumentor-search-results__body">
  423. <ul class="phpdocumentor-search-results__entries"></ul>
  424. </section>
  425. </section>
  426. </section>
  427. </div>
  428. </div>
  429. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  430. </main>
  431. <script>
  432. cssVars({});
  433. </script>
  434. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  435. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  436. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  437. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  438. </body>
  439. </html>