chillerlan-QRCode-Common-MaskPattern.html 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-common.html">Common</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. MaskPattern
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. </h2>
  126. <div class="phpdocumentor-label-line">
  127. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  128. </div>
  129. <aside class="phpdocumentor-element-found-in">
  130. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  131. :
  132. <span class="phpdocumentor-element-found-in__line">26</span>
  133. </aside>
  134. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Section 8.8.1
  135. ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results</p>
  136. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  137. Tags
  138. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h5>
  140. <dl class="phpdocumentor-tag-list">
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">see</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/data-masking">http://www.thonky.com/qr-code-tutorial/data-masking</a></span>
  146. </dd>
  147. <dt class="phpdocumentor-tag-list__entry">
  148. <span class="phpdocumentor-tag__name">see</span>
  149. </dt>
  150. <dd class="phpdocumentor-tag-list__definition">
  151. <span class="phpdocumentor-tag-link"><a href="https://github.com/zxing/zxing/blob/e9e2bd280bcaeabd59d0f955798384fe6c018a6c/core/src/main/java/com/google/zxing/qrcode/encoder/MaskUtil.java">https://github.com/zxing/zxing/blob/e9e2bd280bcaeabd59d0f955798384fe6c018a6c/core/src/main/java/com/google/zxing/qrcode/encoder/MaskUtil.java</a></span>
  152. </dd>
  153. </dl>
  154. <h3 id="toc">
  155. Table of Contents
  156. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  157. </h3>
  158. <h4 id="toc-constants">
  159. Constants
  160. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  161. </h4>
  162. <dl class="phpdocumentor-table-of-contents">
  163. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  164. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO">AUTO</a>
  165. <span>
  166. &nbsp;= -1 </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  169. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000">PATTERN_000</a>
  170. <span>
  171. &nbsp;= 0b0 </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  174. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001">PATTERN_001</a>
  175. <span>
  176. &nbsp;= 0b1 </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  179. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010">PATTERN_010</a>
  180. <span>
  181. &nbsp;= 0b10 </span>
  182. </dt>
  183. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  184. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011">PATTERN_011</a>
  185. <span>
  186. &nbsp;= 0b11 </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  189. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100">PATTERN_100</a>
  190. <span>
  191. &nbsp;= 0b100 </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  194. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101">PATTERN_101</a>
  195. <span>
  196. &nbsp;= 0b101 </span>
  197. </dt>
  198. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  199. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110">PATTERN_110</a>
  200. <span>
  201. &nbsp;= 0b110 </span>
  202. </dt>
  203. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  204. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111">PATTERN_111</a>
  205. <span>
  206. &nbsp;= 0b111 </span>
  207. </dt>
  208. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  209. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS">PATTERNS</a>
  210. <span>
  211. &nbsp;= [self::PATTERN_000, self::PATTERN_001, self::PATTERN_010, self::PATTERN_011, self::PATTERN_100, self::PATTERN_101, self::PATTERN_110, self::PATTERN_111] </span>
  212. </dt>
  213. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  214. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1">PENALTY_N1</a>
  215. <span>
  216. &nbsp;= 3 </span>
  217. </dt>
  218. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  219. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2">PENALTY_N2</a>
  220. <span>
  221. &nbsp;= 3 </span>
  222. </dt>
  223. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  224. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3">PENALTY_N3</a>
  225. <span>
  226. &nbsp;= 40 </span>
  227. </dt>
  228. <dt class="phpdocumentor-table-of-contents__entry -constant -private">
  229. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4">PENALTY_N4</a>
  230. <span>
  231. &nbsp;= 10 </span>
  232. </dt>
  233. </dl>
  234. <h4 id="toc-properties">
  235. Properties
  236. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  237. </h4>
  238. <dl class="phpdocumentor-table-of-contents">
  239. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  240. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern">$maskPattern</a>
  241. <span>
  242. &nbsp;: int </span>
  243. </dt>
  244. <dd>The current mask pattern value (0-7)</dd>
  245. </dl>
  246. <h4 id="toc-methods">
  247. Methods
  248. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  249. </h4>
  250. <dl class="phpdocumentor-table-of-contents">
  251. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  252. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct">__construct()</a>
  253. <span>
  254. &nbsp;: mixed </span>
  255. </dt>
  256. <dd>MaskPattern constructor.</dd>
  257. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  258. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern">getBestPattern()</a>
  259. <span>
  260. &nbsp;: self </span>
  261. </dt>
  262. <dd>Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result</dd>
  263. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  264. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask">getMask()</a>
  265. <span>
  266. &nbsp;: <abbr title="\Closure">Closure</abbr> </span>
  267. </dt>
  268. <dd>Returns a closure that applies the mask for the chosen mask pattern.</dd>
  269. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  270. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern">getPattern()</a>
  271. <span>
  272. &nbsp;: int </span>
  273. </dt>
  274. <dd>Returns the current mask pattern</dd>
  275. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  276. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1">testRule1()</a>
  277. <span>
  278. &nbsp;: int </span>
  279. </dt>
  280. <dd>Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
  281. give penalty to them. Example: 00000 or 11111.</dd>
  282. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  283. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2">testRule2()</a>
  284. <span>
  285. &nbsp;: int </span>
  286. </dt>
  287. <dd>Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
  288. penalty to them. This is actually equivalent to the spec&#039;s rule, which is to find MxN blocks and give a
  289. penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  291. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3">testRule3()</a>
  292. <span>
  293. &nbsp;: int </span>
  294. </dt>
  295. <dd>Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4
  296. starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them. If we
  297. find patterns like 000010111010000, we give penalty once.</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  299. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4">testRule4()</a>
  300. <span>
  301. &nbsp;: int </span>
  302. </dt>
  303. <dd>Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
  304. penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.</dd>
  305. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  306. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1">applyRule1()</a>
  307. <span>
  308. &nbsp;: int </span>
  309. </dt>
  310. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  311. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal">isWhiteHorizontal()</a>
  312. <span>
  313. &nbsp;: bool </span>
  314. </dt>
  315. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  316. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical">isWhiteVertical()</a>
  317. <span>
  318. &nbsp;: bool </span>
  319. </dt>
  320. </dl>
  321. <section class="phpdocumentor-constants">
  322. <h3 class="phpdocumentor-elements__header" id="constants">
  323. Constants
  324. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h3>
  326. <article class="phpdocumentor-element -constant -public ">
  327. <h4 class="phpdocumentor-element__name" id="constant_AUTO">
  328. AUTO
  329. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  330. </h4>
  331. <aside class="phpdocumentor-element-found-in">
  332. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  333. :
  334. <span class="phpdocumentor-element-found-in__line">33</span>
  335. </aside>
  336. <code class="phpdocumentor-signature phpdocumentor-code ">
  337. <span class="phpdocumentor-signature__visibility">public</span>
  338. <span class="phpdocumentor-signature__type">int</span>
  339. <span class="phpdocumentor-signature__name">AUTO</span>
  340. = <span class="phpdocumentor-signature__default-value">-1</span>
  341. </code>
  342. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  343. Tags
  344. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO#tags" class="headerlink"><i class="fas fa-link"></i></a>
  345. </h5>
  346. <dl class="phpdocumentor-tag-list">
  347. <dt class="phpdocumentor-tag-list__entry">
  348. <span class="phpdocumentor-tag__name">see</span>
  349. </dt>
  350. <dd class="phpdocumentor-tag-list__definition">
  351. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_maskPattern"><abbr title="\chillerlan\QRCode\QROptionsTrait::$maskPattern">QROptionsTrait::$maskPattern</abbr></a></span>
  352. </dd>
  353. </dl>
  354. </article>
  355. <article class="phpdocumentor-element -constant -public ">
  356. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_000">
  357. PATTERN_000
  358. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000" class="headerlink"><i class="fas fa-link"></i></a>
  359. </h4>
  360. <aside class="phpdocumentor-element-found-in">
  361. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  362. :
  363. <span class="phpdocumentor-element-found-in__line">35</span>
  364. </aside>
  365. <code class="phpdocumentor-signature phpdocumentor-code ">
  366. <span class="phpdocumentor-signature__visibility">public</span>
  367. <span class="phpdocumentor-signature__type">mixed</span>
  368. <span class="phpdocumentor-signature__name">PATTERN_000</span>
  369. = <span class="phpdocumentor-signature__default-value">0b0</span>
  370. </code>
  371. </article>
  372. <article class="phpdocumentor-element -constant -public ">
  373. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_001">
  374. PATTERN_001
  375. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h4>
  377. <aside class="phpdocumentor-element-found-in">
  378. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  379. :
  380. <span class="phpdocumentor-element-found-in__line">36</span>
  381. </aside>
  382. <code class="phpdocumentor-signature phpdocumentor-code ">
  383. <span class="phpdocumentor-signature__visibility">public</span>
  384. <span class="phpdocumentor-signature__type">mixed</span>
  385. <span class="phpdocumentor-signature__name">PATTERN_001</span>
  386. = <span class="phpdocumentor-signature__default-value">0b1</span>
  387. </code>
  388. </article>
  389. <article class="phpdocumentor-element -constant -public ">
  390. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_010">
  391. PATTERN_010
  392. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010" class="headerlink"><i class="fas fa-link"></i></a>
  393. </h4>
  394. <aside class="phpdocumentor-element-found-in">
  395. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  396. :
  397. <span class="phpdocumentor-element-found-in__line">37</span>
  398. </aside>
  399. <code class="phpdocumentor-signature phpdocumentor-code ">
  400. <span class="phpdocumentor-signature__visibility">public</span>
  401. <span class="phpdocumentor-signature__type">mixed</span>
  402. <span class="phpdocumentor-signature__name">PATTERN_010</span>
  403. = <span class="phpdocumentor-signature__default-value">0b10</span>
  404. </code>
  405. </article>
  406. <article class="phpdocumentor-element -constant -public ">
  407. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_011">
  408. PATTERN_011
  409. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011" class="headerlink"><i class="fas fa-link"></i></a>
  410. </h4>
  411. <aside class="phpdocumentor-element-found-in">
  412. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  413. :
  414. <span class="phpdocumentor-element-found-in__line">38</span>
  415. </aside>
  416. <code class="phpdocumentor-signature phpdocumentor-code ">
  417. <span class="phpdocumentor-signature__visibility">public</span>
  418. <span class="phpdocumentor-signature__type">mixed</span>
  419. <span class="phpdocumentor-signature__name">PATTERN_011</span>
  420. = <span class="phpdocumentor-signature__default-value">0b11</span>
  421. </code>
  422. </article>
  423. <article class="phpdocumentor-element -constant -public ">
  424. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_100">
  425. PATTERN_100
  426. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100" class="headerlink"><i class="fas fa-link"></i></a>
  427. </h4>
  428. <aside class="phpdocumentor-element-found-in">
  429. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  430. :
  431. <span class="phpdocumentor-element-found-in__line">39</span>
  432. </aside>
  433. <code class="phpdocumentor-signature phpdocumentor-code ">
  434. <span class="phpdocumentor-signature__visibility">public</span>
  435. <span class="phpdocumentor-signature__type">mixed</span>
  436. <span class="phpdocumentor-signature__name">PATTERN_100</span>
  437. = <span class="phpdocumentor-signature__default-value">0b100</span>
  438. </code>
  439. </article>
  440. <article class="phpdocumentor-element -constant -public ">
  441. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_101">
  442. PATTERN_101
  443. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101" class="headerlink"><i class="fas fa-link"></i></a>
  444. </h4>
  445. <aside class="phpdocumentor-element-found-in">
  446. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  447. :
  448. <span class="phpdocumentor-element-found-in__line">40</span>
  449. </aside>
  450. <code class="phpdocumentor-signature phpdocumentor-code ">
  451. <span class="phpdocumentor-signature__visibility">public</span>
  452. <span class="phpdocumentor-signature__type">mixed</span>
  453. <span class="phpdocumentor-signature__name">PATTERN_101</span>
  454. = <span class="phpdocumentor-signature__default-value">0b101</span>
  455. </code>
  456. </article>
  457. <article class="phpdocumentor-element -constant -public ">
  458. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_110">
  459. PATTERN_110
  460. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110" class="headerlink"><i class="fas fa-link"></i></a>
  461. </h4>
  462. <aside class="phpdocumentor-element-found-in">
  463. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  464. :
  465. <span class="phpdocumentor-element-found-in__line">41</span>
  466. </aside>
  467. <code class="phpdocumentor-signature phpdocumentor-code ">
  468. <span class="phpdocumentor-signature__visibility">public</span>
  469. <span class="phpdocumentor-signature__type">mixed</span>
  470. <span class="phpdocumentor-signature__name">PATTERN_110</span>
  471. = <span class="phpdocumentor-signature__default-value">0b110</span>
  472. </code>
  473. </article>
  474. <article class="phpdocumentor-element -constant -public ">
  475. <h4 class="phpdocumentor-element__name" id="constant_PATTERN_111">
  476. PATTERN_111
  477. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111" 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/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  481. :
  482. <span class="phpdocumentor-element-found-in__line">42</span>
  483. </aside>
  484. <code class="phpdocumentor-signature phpdocumentor-code ">
  485. <span class="phpdocumentor-signature__visibility">public</span>
  486. <span class="phpdocumentor-signature__type">mixed</span>
  487. <span class="phpdocumentor-signature__name">PATTERN_111</span>
  488. = <span class="phpdocumentor-signature__default-value">0b111</span>
  489. </code>
  490. </article>
  491. <article class="phpdocumentor-element -constant -public ">
  492. <h4 class="phpdocumentor-element__name" id="constant_PATTERNS">
  493. PATTERNS
  494. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS" class="headerlink"><i class="fas fa-link"></i></a>
  495. </h4>
  496. <aside class="phpdocumentor-element-found-in">
  497. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  498. :
  499. <span class="phpdocumentor-element-found-in__line">47</span>
  500. </aside>
  501. <code class="phpdocumentor-signature phpdocumentor-code ">
  502. <span class="phpdocumentor-signature__visibility">public</span>
  503. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  504. <span class="phpdocumentor-signature__name">PATTERNS</span>
  505. = <span class="phpdocumentor-signature__default-value">[self::PATTERN_000, self::PATTERN_001, self::PATTERN_010, self::PATTERN_011, self::PATTERN_100, self::PATTERN_101, self::PATTERN_110, self::PATTERN_111]</span>
  506. </code>
  507. </article>
  508. <article class="phpdocumentor-element -constant -private ">
  509. <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N1">
  510. PENALTY_N1
  511. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1" class="headerlink"><i class="fas fa-link"></i></a>
  512. </h4>
  513. <aside class="phpdocumentor-element-found-in">
  514. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  515. :
  516. <span class="phpdocumentor-element-found-in__line">63</span>
  517. </aside>
  518. <code class="phpdocumentor-signature phpdocumentor-code ">
  519. <span class="phpdocumentor-signature__visibility">private</span>
  520. <span class="phpdocumentor-signature__type">mixed</span>
  521. <span class="phpdocumentor-signature__name">PENALTY_N1</span>
  522. = <span class="phpdocumentor-signature__default-value">3</span>
  523. </code>
  524. </article>
  525. <article class="phpdocumentor-element -constant -private ">
  526. <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N2">
  527. PENALTY_N2
  528. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2" class="headerlink"><i class="fas fa-link"></i></a>
  529. </h4>
  530. <aside class="phpdocumentor-element-found-in">
  531. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  532. :
  533. <span class="phpdocumentor-element-found-in__line">64</span>
  534. </aside>
  535. <code class="phpdocumentor-signature phpdocumentor-code ">
  536. <span class="phpdocumentor-signature__visibility">private</span>
  537. <span class="phpdocumentor-signature__type">mixed</span>
  538. <span class="phpdocumentor-signature__name">PENALTY_N2</span>
  539. = <span class="phpdocumentor-signature__default-value">3</span>
  540. </code>
  541. </article>
  542. <article class="phpdocumentor-element -constant -private ">
  543. <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N3">
  544. PENALTY_N3
  545. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3" class="headerlink"><i class="fas fa-link"></i></a>
  546. </h4>
  547. <aside class="phpdocumentor-element-found-in">
  548. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  549. :
  550. <span class="phpdocumentor-element-found-in__line">65</span>
  551. </aside>
  552. <code class="phpdocumentor-signature phpdocumentor-code ">
  553. <span class="phpdocumentor-signature__visibility">private</span>
  554. <span class="phpdocumentor-signature__type">mixed</span>
  555. <span class="phpdocumentor-signature__name">PENALTY_N3</span>
  556. = <span class="phpdocumentor-signature__default-value">40</span>
  557. </code>
  558. </article>
  559. <article class="phpdocumentor-element -constant -private ">
  560. <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N4">
  561. PENALTY_N4
  562. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4" class="headerlink"><i class="fas fa-link"></i></a>
  563. </h4>
  564. <aside class="phpdocumentor-element-found-in">
  565. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  566. :
  567. <span class="phpdocumentor-element-found-in__line">66</span>
  568. </aside>
  569. <code class="phpdocumentor-signature phpdocumentor-code ">
  570. <span class="phpdocumentor-signature__visibility">private</span>
  571. <span class="phpdocumentor-signature__type">mixed</span>
  572. <span class="phpdocumentor-signature__name">PENALTY_N4</span>
  573. = <span class="phpdocumentor-signature__default-value">10</span>
  574. </code>
  575. </article>
  576. </section>
  577. <section class="phpdocumentor-properties">
  578. <h3 class="phpdocumentor-elements__header" id="properties">
  579. Properties
  580. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  581. </h3>
  582. <article
  583. class="
  584. phpdocumentor-element
  585. -property
  586. -private
  587. "
  588. >
  589. <h4 class="phpdocumentor-element__name" id="property_maskPattern">
  590. $maskPattern
  591. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
  592. <span class="phpdocumentor-element__modifiers">
  593. </span>
  594. </h4>
  595. <aside class="phpdocumentor-element-found-in">
  596. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  597. :
  598. <span class="phpdocumentor-element-found-in__line">71</span>
  599. </aside>
  600. <p class="phpdocumentor-summary">The current mask pattern value (0-7)</p>
  601. <code class="phpdocumentor-code phpdocumentor-signature ">
  602. <span class="phpdocumentor-signature__visibility">private</span>
  603. <span class="phpdocumentor-signature__type">int</span>
  604. <span class="phpdocumentor-signature__name">$maskPattern</span>
  605. </code>
  606. </article>
  607. </section>
  608. <section class="phpdocumentor-methods">
  609. <h3 class="phpdocumentor-elements__header" id="methods">
  610. Methods
  611. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  612. </h3>
  613. <article
  614. class="phpdocumentor-element
  615. -method
  616. -public
  617. "
  618. >
  619. <h4 class="phpdocumentor-element__name" id="method___construct">
  620. __construct()
  621. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  622. </h4>
  623. <aside class="phpdocumentor-element-found-in">
  624. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  625. :
  626. <span class="phpdocumentor-element-found-in__line">78</span>
  627. </aside>
  628. <p class="phpdocumentor-summary">MaskPattern constructor.</p>
  629. <code class="phpdocumentor-code phpdocumentor-signature ">
  630. <span class="phpdocumentor-signature__visibility">public</span>
  631. <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">$maskPattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  632. <div class="phpdocumentor-label-line">
  633. </div>
  634. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  635. <dl class="phpdocumentor-argument-list">
  636. <dt class="phpdocumentor-argument-list__entry">
  637. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  638. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  639. </dt>
  640. <dd class="phpdocumentor-argument-list__definition">
  641. </dd>
  642. </dl>
  643. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  644. Tags
  645. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  646. </h5>
  647. <dl class="phpdocumentor-tag-list">
  648. <dt class="phpdocumentor-tag-list__entry">
  649. <span class="phpdocumentor-tag__name">throws</span>
  650. </dt>
  651. <dd class="phpdocumentor-tag-list__definition">
  652. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  653. </dd>
  654. </dl>
  655. </article>
  656. <article
  657. class="phpdocumentor-element
  658. -method
  659. -public
  660. -static "
  661. >
  662. <h4 class="phpdocumentor-element__name" id="method_getBestPattern">
  663. getBestPattern()
  664. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern" class="headerlink"><i class="fas fa-link"></i></a>
  665. </h4>
  666. <aside class="phpdocumentor-element-found-in">
  667. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  668. :
  669. <span class="phpdocumentor-element-found-in__line">120</span>
  670. </aside>
  671. <p class="phpdocumentor-summary">Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result</p>
  672. <code class="phpdocumentor-code phpdocumentor-signature ">
  673. <span class="phpdocumentor-signature__visibility">public</span>
  674. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getBestPattern</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$QRMatrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  675. <div class="phpdocumentor-label-line">
  676. </div>
  677. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  678. <dl class="phpdocumentor-argument-list">
  679. <dt class="phpdocumentor-argument-list__entry">
  680. <span class="phpdocumentor-signature__argument__name">$QRMatrix</span>
  681. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  682. </dt>
  683. <dd class="phpdocumentor-argument-list__definition">
  684. </dd>
  685. </dl>
  686. <section>
  687. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  688. <span class="phpdocumentor-signature__response_type">self</span>
  689. </section>
  690. </article>
  691. <article
  692. class="phpdocumentor-element
  693. -method
  694. -public
  695. "
  696. >
  697. <h4 class="phpdocumentor-element__name" id="method_getMask">
  698. getMask()
  699. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask" class="headerlink"><i class="fas fa-link"></i></a>
  700. </h4>
  701. <aside class="phpdocumentor-element-found-in">
  702. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  703. :
  704. <span class="phpdocumentor-element-found-in__line">103</span>
  705. </aside>
  706. <p class="phpdocumentor-summary">Returns a closure that applies the mask for the chosen mask pattern.</p>
  707. <code class="phpdocumentor-code phpdocumentor-signature ">
  708. <span class="phpdocumentor-signature__visibility">public</span>
  709. <span class="phpdocumentor-signature__name">getMask</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Closure">Closure</abbr></span></code>
  710. <div class="phpdocumentor-label-line">
  711. </div>
  712. <section class="phpdocumentor-description"><p>Note that the diagram in section 6.8.1 is misleading since it indicates that $i is column position
  713. and $j is row position. In fact, as the text says, $i is row position and $j is column position.</p>
  714. </section>
  715. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  716. Tags
  717. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask#tags" class="headerlink"><i class="fas fa-link"></i></a>
  718. </h5>
  719. <dl class="phpdocumentor-tag-list">
  720. <dt class="phpdocumentor-tag-list__entry">
  721. <span class="phpdocumentor-tag__name">see</span>
  722. </dt>
  723. <dd class="phpdocumentor-tag-list__definition">
  724. <span class="phpdocumentor-tag-link"><a href="https://www.thonky.com/qr-code-tutorial/mask-patterns">https://www.thonky.com/qr-code-tutorial/mask-patterns</a></span>
  725. </dd>
  726. <dt class="phpdocumentor-tag-list__entry">
  727. <span class="phpdocumentor-tag__name">see</span>
  728. </dt>
  729. <dd class="phpdocumentor-tag-list__definition">
  730. <span class="phpdocumentor-tag-link"><a href="https://github.com/zxing/zxing/blob/e9e2bd280bcaeabd59d0f955798384fe6c018a6c/core/src/main/java/com/google/zxing/qrcode/decoder/DataMask.java#L32-L117">https://github.com/zxing/zxing/blob/e9e2bd280bcaeabd59d0f955798384fe6c018a6c/core/src/main/java/com/google/zxing/qrcode/decoder/DataMask.java#L32-L117</a></span>
  731. </dd>
  732. </dl>
  733. <section>
  734. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  735. <span class="phpdocumentor-signature__response_type"><abbr title="\Closure">Closure</abbr></span>
  736. </section>
  737. </article>
  738. <article
  739. class="phpdocumentor-element
  740. -method
  741. -public
  742. "
  743. >
  744. <h4 class="phpdocumentor-element__name" id="method_getPattern">
  745. getPattern()
  746. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern" class="headerlink"><i class="fas fa-link"></i></a>
  747. </h4>
  748. <aside class="phpdocumentor-element-found-in">
  749. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  750. :
  751. <span class="phpdocumentor-element-found-in__line">90</span>
  752. </aside>
  753. <p class="phpdocumentor-summary">Returns the current mask pattern</p>
  754. <code class="phpdocumentor-code phpdocumentor-signature ">
  755. <span class="phpdocumentor-signature__visibility">public</span>
  756. <span class="phpdocumentor-signature__name">getPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  757. <div class="phpdocumentor-label-line">
  758. </div>
  759. <section>
  760. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  761. <span class="phpdocumentor-signature__response_type">int</span>
  762. </section>
  763. </article>
  764. <article
  765. class="phpdocumentor-element
  766. -method
  767. -public
  768. -static "
  769. >
  770. <h4 class="phpdocumentor-element__name" id="method_testRule1">
  771. testRule1()
  772. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1" class="headerlink"><i class="fas fa-link"></i></a>
  773. </h4>
  774. <aside class="phpdocumentor-element-found-in">
  775. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  776. :
  777. <span class="phpdocumentor-element-found-in__line">143</span>
  778. </aside>
  779. <p class="phpdocumentor-summary">Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
  780. give penalty to them. Example: 00000 or 11111.</p>
  781. <code class="phpdocumentor-code phpdocumentor-signature ">
  782. <span class="phpdocumentor-signature__visibility">public</span>
  783. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">testRule1</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  784. <div class="phpdocumentor-label-line">
  785. </div>
  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">$matrix</span>
  790. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  791. </dt>
  792. <dd class="phpdocumentor-argument-list__definition">
  793. </dd>
  794. <dt class="phpdocumentor-argument-list__entry">
  795. <span class="phpdocumentor-signature__argument__name">$height</span>
  796. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  797. </dt>
  798. <dd class="phpdocumentor-argument-list__definition">
  799. </dd>
  800. <dt class="phpdocumentor-argument-list__entry">
  801. <span class="phpdocumentor-signature__argument__name">$width</span>
  802. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  803. </dt>
  804. <dd class="phpdocumentor-argument-list__definition">
  805. </dd>
  806. </dl>
  807. <section>
  808. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  809. <span class="phpdocumentor-signature__response_type">int</span>
  810. </section>
  811. </article>
  812. <article
  813. class="phpdocumentor-element
  814. -method
  815. -public
  816. -static "
  817. >
  818. <h4 class="phpdocumentor-element__name" id="method_testRule2">
  819. testRule2()
  820. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2" class="headerlink"><i class="fas fa-link"></i></a>
  821. </h4>
  822. <aside class="phpdocumentor-element-found-in">
  823. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  824. :
  825. <span class="phpdocumentor-element-found-in__line">195</span>
  826. </aside>
  827. <p class="phpdocumentor-summary">Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
  828. penalty to them. This is actually equivalent to the spec&#039;s rule, which is to find MxN blocks and give a
  829. penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.</p>
  830. <code class="phpdocumentor-code phpdocumentor-signature ">
  831. <span class="phpdocumentor-signature__visibility">public</span>
  832. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">testRule2</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  833. <div class="phpdocumentor-label-line">
  834. </div>
  835. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  836. <dl class="phpdocumentor-argument-list">
  837. <dt class="phpdocumentor-argument-list__entry">
  838. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  839. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  840. </dt>
  841. <dd class="phpdocumentor-argument-list__definition">
  842. </dd>
  843. <dt class="phpdocumentor-argument-list__entry">
  844. <span class="phpdocumentor-signature__argument__name">$height</span>
  845. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  846. </dt>
  847. <dd class="phpdocumentor-argument-list__definition">
  848. </dd>
  849. <dt class="phpdocumentor-argument-list__entry">
  850. <span class="phpdocumentor-signature__argument__name">$width</span>
  851. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  852. </dt>
  853. <dd class="phpdocumentor-argument-list__definition">
  854. </dd>
  855. </dl>
  856. <section>
  857. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  858. <span class="phpdocumentor-signature__response_type">int</span>
  859. </section>
  860. </article>
  861. <article
  862. class="phpdocumentor-element
  863. -method
  864. -public
  865. -static "
  866. >
  867. <h4 class="phpdocumentor-element__name" id="method_testRule3">
  868. testRule3()
  869. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3" class="headerlink"><i class="fas fa-link"></i></a>
  870. </h4>
  871. <aside class="phpdocumentor-element-found-in">
  872. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  873. :
  874. <span class="phpdocumentor-element-found-in__line">228</span>
  875. </aside>
  876. <p class="phpdocumentor-summary">Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4
  877. starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them. If we
  878. find patterns like 000010111010000, we give penalty once.</p>
  879. <code class="phpdocumentor-code phpdocumentor-signature ">
  880. <span class="phpdocumentor-signature__visibility">public</span>
  881. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">testRule3</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  882. <div class="phpdocumentor-label-line">
  883. </div>
  884. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  885. <dl class="phpdocumentor-argument-list">
  886. <dt class="phpdocumentor-argument-list__entry">
  887. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  888. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  889. </dt>
  890. <dd class="phpdocumentor-argument-list__definition">
  891. </dd>
  892. <dt class="phpdocumentor-argument-list__entry">
  893. <span class="phpdocumentor-signature__argument__name">$height</span>
  894. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  895. </dt>
  896. <dd class="phpdocumentor-argument-list__definition">
  897. </dd>
  898. <dt class="phpdocumentor-argument-list__entry">
  899. <span class="phpdocumentor-signature__argument__name">$width</span>
  900. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  901. </dt>
  902. <dd class="phpdocumentor-argument-list__definition">
  903. </dd>
  904. </dl>
  905. <section>
  906. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  907. <span class="phpdocumentor-signature__response_type">int</span>
  908. </section>
  909. </article>
  910. <article
  911. class="phpdocumentor-element
  912. -method
  913. -public
  914. -static "
  915. >
  916. <h4 class="phpdocumentor-element__name" id="method_testRule4">
  917. testRule4()
  918. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4" class="headerlink"><i class="fas fa-link"></i></a>
  919. </h4>
  920. <aside class="phpdocumentor-element-found-in">
  921. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  922. :
  923. <span class="phpdocumentor-element-found-in__line">314</span>
  924. </aside>
  925. <p class="phpdocumentor-summary">Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
  926. penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.</p>
  927. <code class="phpdocumentor-code phpdocumentor-signature ">
  928. <span class="phpdocumentor-signature__visibility">public</span>
  929. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">testRule4</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$width</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  930. <div class="phpdocumentor-label-line">
  931. </div>
  932. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  933. <dl class="phpdocumentor-argument-list">
  934. <dt class="phpdocumentor-argument-list__entry">
  935. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  936. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  937. </dt>
  938. <dd class="phpdocumentor-argument-list__definition">
  939. </dd>
  940. <dt class="phpdocumentor-argument-list__entry">
  941. <span class="phpdocumentor-signature__argument__name">$height</span>
  942. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  943. </dt>
  944. <dd class="phpdocumentor-argument-list__definition">
  945. </dd>
  946. <dt class="phpdocumentor-argument-list__entry">
  947. <span class="phpdocumentor-signature__argument__name">$width</span>
  948. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  949. </dt>
  950. <dd class="phpdocumentor-argument-list__definition">
  951. </dd>
  952. </dl>
  953. <section>
  954. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  955. <span class="phpdocumentor-signature__response_type">int</span>
  956. </section>
  957. </article>
  958. <article
  959. class="phpdocumentor-element
  960. -method
  961. -private
  962. -static "
  963. >
  964. <h4 class="phpdocumentor-element__name" id="method_applyRule1">
  965. applyRule1()
  966. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1" class="headerlink"><i class="fas fa-link"></i></a>
  967. </h4>
  968. <aside class="phpdocumentor-element-found-in">
  969. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  970. :
  971. <span class="phpdocumentor-element-found-in__line">162</span>
  972. </aside>
  973. <code class="phpdocumentor-code phpdocumentor-signature ">
  974. <span class="phpdocumentor-signature__visibility">private</span>
  975. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">applyRule1</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rc</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  976. <div class="phpdocumentor-label-line">
  977. </div>
  978. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  979. <dl class="phpdocumentor-argument-list">
  980. <dt class="phpdocumentor-argument-list__entry">
  981. <span class="phpdocumentor-signature__argument__name">$rc</span>
  982. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  983. </dt>
  984. <dd class="phpdocumentor-argument-list__definition">
  985. </dd>
  986. </dl>
  987. <section>
  988. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  989. <span class="phpdocumentor-signature__response_type">int</span>
  990. </section>
  991. </article>
  992. <article
  993. class="phpdocumentor-element
  994. -method
  995. -private
  996. -static "
  997. >
  998. <h4 class="phpdocumentor-element__name" id="method_isWhiteHorizontal">
  999. isWhiteHorizontal()
  1000. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal" class="headerlink"><i class="fas fa-link"></i></a>
  1001. </h4>
  1002. <aside class="phpdocumentor-element-found-in">
  1003. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  1004. :
  1005. <span class="phpdocumentor-element-found-in__line">277</span>
  1006. </aside>
  1007. <code class="phpdocumentor-code phpdocumentor-signature ">
  1008. <span class="phpdocumentor-signature__visibility">private</span>
  1009. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">isWhiteHorizontal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$row</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">$from</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">$to</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1010. <div class="phpdocumentor-label-line">
  1011. </div>
  1012. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1013. <dl class="phpdocumentor-argument-list">
  1014. <dt class="phpdocumentor-argument-list__entry">
  1015. <span class="phpdocumentor-signature__argument__name">$row</span>
  1016. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1017. </dt>
  1018. <dd class="phpdocumentor-argument-list__definition">
  1019. </dd>
  1020. <dt class="phpdocumentor-argument-list__entry">
  1021. <span class="phpdocumentor-signature__argument__name">$width</span>
  1022. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1023. </dt>
  1024. <dd class="phpdocumentor-argument-list__definition">
  1025. </dd>
  1026. <dt class="phpdocumentor-argument-list__entry">
  1027. <span class="phpdocumentor-signature__argument__name">$from</span>
  1028. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1029. </dt>
  1030. <dd class="phpdocumentor-argument-list__definition">
  1031. </dd>
  1032. <dt class="phpdocumentor-argument-list__entry">
  1033. <span class="phpdocumentor-signature__argument__name">$to</span>
  1034. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1035. </dt>
  1036. <dd class="phpdocumentor-argument-list__definition">
  1037. </dd>
  1038. </dl>
  1039. <section>
  1040. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1041. <span class="phpdocumentor-signature__response_type">bool</span>
  1042. </section>
  1043. </article>
  1044. <article
  1045. class="phpdocumentor-element
  1046. -method
  1047. -private
  1048. -static "
  1049. >
  1050. <h4 class="phpdocumentor-element__name" id="method_isWhiteVertical">
  1051. isWhiteVertical()
  1052. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical" class="headerlink"><i class="fas fa-link"></i></a>
  1053. </h4>
  1054. <aside class="phpdocumentor-element-found-in">
  1055. <abbr class="phpdocumentor-element-found-in__file" title="src/Common/MaskPattern.php"><a href="files/src-common-maskpattern.html"><abbr title="src/Common/MaskPattern.php">MaskPattern.php</abbr></a></abbr>
  1056. :
  1057. <span class="phpdocumentor-element-found-in__line">295</span>
  1058. </aside>
  1059. <code class="phpdocumentor-code phpdocumentor-signature ">
  1060. <span class="phpdocumentor-signature__visibility">private</span>
  1061. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">isWhiteVertical</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$height</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span 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">$from</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">$to</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1062. <div class="phpdocumentor-label-line">
  1063. </div>
  1064. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1065. <dl class="phpdocumentor-argument-list">
  1066. <dt class="phpdocumentor-argument-list__entry">
  1067. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  1068. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1069. </dt>
  1070. <dd class="phpdocumentor-argument-list__definition">
  1071. </dd>
  1072. <dt class="phpdocumentor-argument-list__entry">
  1073. <span class="phpdocumentor-signature__argument__name">$height</span>
  1074. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1075. </dt>
  1076. <dd class="phpdocumentor-argument-list__definition">
  1077. </dd>
  1078. <dt class="phpdocumentor-argument-list__entry">
  1079. <span class="phpdocumentor-signature__argument__name">$x</span>
  1080. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1081. </dt>
  1082. <dd class="phpdocumentor-argument-list__definition">
  1083. </dd>
  1084. <dt class="phpdocumentor-argument-list__entry">
  1085. <span class="phpdocumentor-signature__argument__name">$from</span>
  1086. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1087. </dt>
  1088. <dd class="phpdocumentor-argument-list__definition">
  1089. </dd>
  1090. <dt class="phpdocumentor-argument-list__entry">
  1091. <span class="phpdocumentor-signature__argument__name">$to</span>
  1092. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1093. </dt>
  1094. <dd class="phpdocumentor-argument-list__definition">
  1095. </dd>
  1096. </dl>
  1097. <section>
  1098. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1099. <span class="phpdocumentor-signature__response_type">bool</span>
  1100. </section>
  1101. </article>
  1102. </section>
  1103. <div class="phpdocumentor-modal" id="source-view">
  1104. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1105. <div class="phpdocumentor-modal-container">
  1106. <div class="phpdocumentor-modal-content">
  1107. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Common/MaskPattern.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1108. </div>
  1109. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1110. </div>
  1111. </div>
  1112. <script type="text/javascript">
  1113. (function () {
  1114. function loadExternalCodeSnippet(el, url, line) {
  1115. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1116. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1117. const language = 'php';
  1118. const code = document.createElement('code');
  1119. code.className = 'language-' + language;
  1120. pre.textContent = '';
  1121. pre.setAttribute('data-line', line)
  1122. code.textContent = 'Loading…';
  1123. pre.appendChild(code);
  1124. var xhr = new XMLHttpRequest();
  1125. xhr.open('GET', src, true);
  1126. xhr.onreadystatechange = function () {
  1127. if (xhr.readyState !== 4) {
  1128. return;
  1129. }
  1130. if (xhr.status < 400 && xhr.responseText) {
  1131. code.textContent = xhr.responseText;
  1132. Prism.highlightElement(code);
  1133. return;
  1134. }
  1135. if (xhr.status === 404) {
  1136. code.textContent = '✖ Error: File could not be found';
  1137. return;
  1138. }
  1139. if (xhr.status >= 400) {
  1140. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1141. return;
  1142. }
  1143. code.textContent = '✖ Error: An unknown error occurred';
  1144. };
  1145. xhr.send(null);
  1146. });
  1147. }
  1148. const modalButtons = document.querySelectorAll("[data-modal]");
  1149. const openedAsLocalFile = window.location.protocol === 'file:';
  1150. if (modalButtons.length > 0 && openedAsLocalFile) {
  1151. console.warn(
  1152. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1153. 'browsers block XHR requests when a page is opened this way'
  1154. );
  1155. }
  1156. modalButtons.forEach(function (trigger) {
  1157. if (openedAsLocalFile) {
  1158. trigger.setAttribute("hidden", "hidden");
  1159. }
  1160. trigger.addEventListener("click", function (event) {
  1161. event.preventDefault();
  1162. const modal = document.getElementById(trigger.dataset.modal);
  1163. if (!modal) {
  1164. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1165. return;
  1166. }
  1167. modal.classList.add("phpdocumentor-modal__open");
  1168. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1169. const exits = modal.querySelectorAll("[data-exit-button]");
  1170. exits.forEach(function (exit) {
  1171. exit.addEventListener("click", function (event) {
  1172. event.preventDefault();
  1173. modal.classList.remove("phpdocumentor-modal__open");
  1174. });
  1175. });
  1176. });
  1177. });
  1178. })();
  1179. </script>
  1180. </article>
  1181. </section>
  1182. <section class="phpdocumentor-on-this-page__sidebar">
  1183. <section class="phpdocumentor-on-this-page__content">
  1184. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1185. <ul class="phpdocumentor-list -clean">
  1186. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1187. <li>
  1188. <ul class="phpdocumentor-list -clean">
  1189. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-constants">Constants</a></li>
  1190. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-properties">Properties</a></li>
  1191. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-methods">Methods</a></li>
  1192. </ul>
  1193. </li>
  1194. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1195. <li>
  1196. <ul class="phpdocumentor-list -clean">
  1197. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO">AUTO</a></li>
  1198. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000">PATTERN_000</a></li>
  1199. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001">PATTERN_001</a></li>
  1200. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010">PATTERN_010</a></li>
  1201. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011">PATTERN_011</a></li>
  1202. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100">PATTERN_100</a></li>
  1203. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101">PATTERN_101</a></li>
  1204. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110">PATTERN_110</a></li>
  1205. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111">PATTERN_111</a></li>
  1206. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS">PATTERNS</a></li>
  1207. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1">PENALTY_N1</a></li>
  1208. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2">PENALTY_N2</a></li>
  1209. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3">PENALTY_N3</a></li>
  1210. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4">PENALTY_N4</a></li>
  1211. </ul>
  1212. </li>
  1213. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1214. <li>
  1215. <ul class="phpdocumentor-list -clean">
  1216. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern">$maskPattern<a href="classes/chillerlan-QRCode-Common-MaskPattern.html"></li>
  1217. </ul>
  1218. </li>
  1219. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1220. <li>
  1221. <ul class="phpdocumentor-list -clean">
  1222. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct">__construct()</a></li>
  1223. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern">getBestPattern()</a></li>
  1224. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask">getMask()</a></li>
  1225. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern">getPattern()</a></li>
  1226. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1">testRule1()</a></li>
  1227. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2">testRule2()</a></li>
  1228. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3">testRule3()</a></li>
  1229. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4">testRule4()</a></li>
  1230. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1">applyRule1()</a></li>
  1231. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal">isWhiteHorizontal()</a></li>
  1232. <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical">isWhiteVertical()</a></li>
  1233. </ul>
  1234. </li>
  1235. </ul>
  1236. </section>
  1237. </section>
  1238. </div>
  1239. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1240. <section class="phpdocumentor-search-results__dialog">
  1241. <header class="phpdocumentor-search-results__header">
  1242. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1243. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1244. </header>
  1245. <section class="phpdocumentor-search-results__body">
  1246. <ul class="phpdocumentor-search-results__entries"></ul>
  1247. </section>
  1248. </section>
  1249. </section>
  1250. </div>
  1251. <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1252. </main>
  1253. <script>
  1254. cssVars({});
  1255. </script>
  1256. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1257. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1258. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1259. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1260. </body>
  1261. </html>