chillerlan-QRCode-Common-FormatInformation.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-common.html">Common</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. FormatInformation
  89. <div class="phpdocumentor-element__package">
  90. in package
  91. <ul class="phpdocumentor-breadcrumbs">
  92. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  93. </ul>
  94. </div>
  95. </h2>
  96. <aside class="phpdocumentor-element-found-in">
  97. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/FormatInformation.php"><a href="files/src-common-formatinformation.html"><abbr title="src/Common/FormatInformation.php">FormatInformation.php</abbr></a></abbr>
  98. :
  99. <span class="phpdocumentor-element-found-in__line">20</span>
  100. </aside>
  101. <p class="phpdocumentor-summary">Encapsulates a QR Code&#039;s format information, including the data mask used and error correction level.</p>
  102. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  103. Tags
  104. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  105. </h5>
  106. <dl class="phpdocumentor-tag-list">
  107. <dt class="phpdocumentor-tag-list__entry">
  108. <span class="phpdocumentor-tag__name">author</span>
  109. </dt>
  110. <dd class="phpdocumentor-tag-list__definition">
  111. <section class="phpdocumentor-description"><p>Sean Owen</p>
  112. </section>
  113. </dd>
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">see</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  119. </dd>
  120. </dl>
  121. <h3 id="toc">
  122. Table of Contents
  123. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  124. </h3>
  125. <dl class="phpdocumentor-table-of-contents">
  126. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  127. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_DECODE_LOOKUP">DECODE_LOOKUP</a>
  128. <span>
  129. &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>
  130. </dt>
  131. <dd>See ISO 18004:2006, Annex C, Table C.1</dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  133. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_FORMAT_INFO_MASK_QR">FORMAT_INFO_MASK_QR</a>
  134. <span>
  135. &nbsp;= 0x5412 </span>
  136. </dt>
  137. <dd></dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  139. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_errorCorrectionLevel">$errorCorrectionLevel</a>
  140. <span>
  141. &nbsp;: int </span>
  142. </dt>
  143. <dd>The current ECC level value</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  145. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_maskPattern">$maskPattern</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>The current mask pattern (0-7)</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  151. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method___construct">__construct()</a>
  152. <span>
  153. &nbsp;: mixed </span>
  154. </dt>
  155. <dd>Receives the format information from a parsed QR Code, detects ECC level and mask pattern</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  157. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getErrorCorrectionLevel">getErrorCorrectionLevel()</a>
  158. <span>
  159. &nbsp;: <a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a> </span>
  160. </dt>
  161. <dd>Returns and EccLevel instance ith the detected ECC level set</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  163. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getMaskPattern">getMaskPattern()</a>
  164. <span>
  165. &nbsp;: <a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a> </span>
  166. </dt>
  167. <dd>Returns a MaskPattern instance with the detected mask pattern set</dd>
  168. </dl>
  169. <section class="phpdocumentor-constants">
  170. <h3 class="phpdocumentor-elements__header" id="constants">
  171. Constants
  172. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  173. </h3>
  174. <article class="phpdocumentor-element -constant -public ">
  175. <h4 class="phpdocumentor-element__name" id="constant_DECODE_LOOKUP">
  176. DECODE_LOOKUP
  177. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_DECODE_LOOKUP" class="headerlink"><i class="fas fa-link"></i></a>
  178. </h4>
  179. <aside class="phpdocumentor-element-found-in">
  180. <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>
  181. :
  182. <span class="phpdocumentor-element-found-in__line">29</span>
  183. </aside>
  184. <p class="phpdocumentor-summary">See ISO 18004:2006, Annex C, Table C.1</p>
  185. <code class="phpdocumentor-signature phpdocumentor-code ">
  186. <span class="phpdocumentor-signature__visibility">public</span>
  187. <span class="phpdocumentor-signature__type">mixed</span>
  188. <span class="phpdocumentor-signature__name">DECODE_LOOKUP</span>
  189. = <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>
  190. </code>
  191. <section class="phpdocumentor-description"><p>[data bits, sequence after masking]</p>
  192. </section>
  193. <section class="phpdocumentor-description"></section>
  194. </article>
  195. <article class="phpdocumentor-element -constant -public ">
  196. <h4 class="phpdocumentor-element__name" id="constant_FORMAT_INFO_MASK_QR">
  197. FORMAT_INFO_MASK_QR
  198. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#constant_FORMAT_INFO_MASK_QR" class="headerlink"><i class="fas fa-link"></i></a>
  199. </h4>
  200. <aside class="phpdocumentor-element-found-in">
  201. <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>
  202. :
  203. <span class="phpdocumentor-element-found-in__line">22</span>
  204. </aside>
  205. <code class="phpdocumentor-signature phpdocumentor-code ">
  206. <span class="phpdocumentor-signature__visibility">public</span>
  207. <span class="phpdocumentor-signature__type">mixed</span>
  208. <span class="phpdocumentor-signature__name">FORMAT_INFO_MASK_QR</span>
  209. = <span class="phpdocumentor-signature__default-value">0x5412</span>
  210. </code>
  211. <section class="phpdocumentor-description"></section>
  212. <section class="phpdocumentor-description"></section>
  213. </article>
  214. </section>
  215. <section class="phpdocumentor-properties">
  216. <h3 class="phpdocumentor-elements__header" id="properties">
  217. Properties
  218. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  219. </h3>
  220. <article
  221. class="
  222. phpdocumentor-element
  223. -property
  224. -private
  225. "
  226. >
  227. <h4 class="phpdocumentor-element__name" id="property_errorCorrectionLevel">
  228. $errorCorrectionLevel
  229. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_errorCorrectionLevel" class="headerlink"><i class="fas fa-link"></i></a>
  230. <span class="phpdocumentor-element__modifiers">
  231. </span>
  232. </h4>
  233. <aside class="phpdocumentor-element-found-in">
  234. <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>
  235. :
  236. <span class="phpdocumentor-element-found-in__line">72</span>
  237. </aside>
  238. <p class="phpdocumentor-summary">The current ECC level value</p>
  239. <code class="phpdocumentor-code phpdocumentor-signature ">
  240. <span class="phpdocumentor-signature__visibility">private</span>
  241. <span class="phpdocumentor-signature__type">int</span>
  242. <span class="phpdocumentor-signature__name">$errorCorrectionLevel</span>
  243. </code>
  244. <section class="phpdocumentor-description"><p>L: 0b01
  245. M: 0b00
  246. Q: 0b11
  247. H: 0b10</p>
  248. </section>
  249. <section class="phpdocumentor-description"></section>
  250. </article>
  251. <article
  252. class="
  253. phpdocumentor-element
  254. -property
  255. -private
  256. "
  257. >
  258. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  259. $maskPattern
  260. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  261. <span class="phpdocumentor-element__modifiers">
  262. </span>
  263. </h4>
  264. <aside class="phpdocumentor-element-found-in">
  265. <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>
  266. :
  267. <span class="phpdocumentor-element-found-in__line">77</span>
  268. </aside>
  269. <p class="phpdocumentor-summary">The current mask pattern (0-7)</p>
  270. <code class="phpdocumentor-code phpdocumentor-signature ">
  271. <span class="phpdocumentor-signature__visibility">private</span>
  272. <span class="phpdocumentor-signature__type">int</span>
  273. <span class="phpdocumentor-signature__name">$maskPattern</span>
  274. </code>
  275. <section class="phpdocumentor-description"></section>
  276. </article>
  277. </section>
  278. <section class="phpdocumentor-methods">
  279. <h3 class="phpdocumentor-elements__header" id="methods">
  280. Methods
  281. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  282. </h3>
  283. <article
  284. class="phpdocumentor-element
  285. -method
  286. -public
  287. "
  288. >
  289. <h4 class="phpdocumentor-element__name" id="method___construct">
  290. __construct()
  291. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  292. </h4>
  293. <aside class="phpdocumentor-element-found-in">
  294. <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>
  295. :
  296. <span class="phpdocumentor-element-found-in__line">82</span>
  297. </aside>
  298. <p class="phpdocumentor-summary">Receives the format information from a parsed QR Code, detects ECC level and mask pattern</p>
  299. <code class="phpdocumentor-code phpdocumentor-signature ">
  300. <span class="phpdocumentor-signature__visibility">public</span>
  301. <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>
  302. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  303. <dl class="phpdocumentor-argument-list">
  304. <dt class="phpdocumentor-argument-list__entry">
  305. <span class="phpdocumentor-signature__argument__name">$formatInfo</span>
  306. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  307. </dt>
  308. <dd class="phpdocumentor-argument-list__definition">
  309. <section class="phpdocumentor-description"></section>
  310. </dd>
  311. </dl>
  312. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  313. <span class="phpdocumentor-signature__response_type">mixed</span>
  314. &mdash;
  315. </article>
  316. <article
  317. class="phpdocumentor-element
  318. -method
  319. -public
  320. "
  321. >
  322. <h4 class="phpdocumentor-element__name" id="method_getErrorCorrectionLevel">
  323. getErrorCorrectionLevel()
  324. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getErrorCorrectionLevel" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h4>
  326. <aside class="phpdocumentor-element-found-in">
  327. <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>
  328. :
  329. <span class="phpdocumentor-element-found-in__line">90</span>
  330. </aside>
  331. <p class="phpdocumentor-summary">Returns and EccLevel instance ith the detected ECC level set</p>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">public</span>
  334. <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>
  335. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  336. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-EccLevel.html"><abbr title="\chillerlan\QRCode\Common\EccLevel">EccLevel</abbr></a></span>
  337. &mdash;
  338. </article>
  339. <article
  340. class="phpdocumentor-element
  341. -method
  342. -public
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="method_getMaskPattern">
  346. getMaskPattern()
  347. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#method_getMaskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  348. </h4>
  349. <aside class="phpdocumentor-element-found-in">
  350. <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>
  351. :
  352. <span class="phpdocumentor-element-found-in__line">97</span>
  353. </aside>
  354. <p class="phpdocumentor-summary">Returns a MaskPattern instance with the detected mask pattern set</p>
  355. <code class="phpdocumentor-code phpdocumentor-signature ">
  356. <span class="phpdocumentor-signature__visibility">public</span>
  357. <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>
  358. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  359. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html"><abbr title="\chillerlan\QRCode\Common\MaskPattern">MaskPattern</abbr></a></span>
  360. &mdash;
  361. </article>
  362. </section>
  363. <script type="text/javascript">
  364. function loadExternalCodeSnippets(line) {
  365. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  366. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  367. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  368. var language = 'php';
  369. var code = document.createElement('code');
  370. code.className = 'language-' + language;
  371. pre.textContent = '';
  372. pre.setAttribute('data-line', line)
  373. code.textContent = 'Loading…';
  374. pre.appendChild(code);
  375. var xhr = new XMLHttpRequest();
  376. xhr.open('GET', src, true);
  377. xhr.onreadystatechange = function () {
  378. if (xhr.readyState == 4) {
  379. if (xhr.status < 400 && xhr.responseText) {
  380. code.textContent = xhr.responseText;
  381. Prism.highlightElement(code);
  382. }
  383. else if (xhr.status >= 400) {
  384. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  385. }
  386. else {
  387. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  388. }
  389. }
  390. };
  391. xhr.send(null);
  392. });
  393. }
  394. var modals = document.querySelectorAll("[data-modal]");
  395. modals.forEach(function (trigger) {
  396. trigger.addEventListener("click", function (event) {
  397. //event.preventDefault();
  398. const modal = document.getElementById(trigger.dataset.modal);
  399. modal.classList.add("phpdocumentor-modal__open");
  400. loadExternalCodeSnippets(trigger.dataset.line)
  401. const exits = modal.querySelectorAll("[data-exit-button]");
  402. exits.forEach(function (exit) {
  403. exit.addEventListener("click", function (event) {
  404. event.preventDefault();
  405. modal.classList.remove("phpdocumentor-modal__open");
  406. });
  407. });
  408. });
  409. });
  410. </script>
  411. </article>
  412. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  413. <section class="phpdocumentor-search-results__dialog">
  414. <header class="phpdocumentor-search-results__header">
  415. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  416. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  417. </header>
  418. <section class="phpdocumentor-search-results__body">
  419. <ul class="phpdocumentor-search-results__entries"></ul>
  420. </section>
  421. </section>
  422. </section>
  423. </div>
  424. </div>
  425. <a href="classes/chillerlan-QRCode-Common-FormatInformation.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  426. </main>
  427. <script>
  428. cssVars({});
  429. </script>
  430. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  431. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  432. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  433. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  434. </body>
  435. </html>