Home Explore Help
Sign In
mrkad
/
php-qrcode
mirror of https://github.com/chillerlan/php-qrcode.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 4686d55db0
Branches Tags
php-qrcode
/
classes
/
chillerlan-QRCode-Common-MaskPattern.html

chillerlan-QRCode-Common-MaskPattern.html 82 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4.     <meta charset="utf-8">
    5. 

  5.             <title>Documentation</title>
    6. 

  6.     
    7. 

  7.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8.     <base href="../">
    9. 

  9.     <link rel="icon" href="images/favicon.ico"/>
    10. 

  10.     <link rel="stylesheet" href="css/normalize.css">
    11. 

  11.     <link rel="stylesheet" href="css/base.css">
    12. 

  12.             <link rel="preconnect" href="https://fonts.gstatic.com">
    13. 

  13.         <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
    14. 

  14.         <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
    15. 

  15.         <link rel="stylesheet" href="css/template.css">
    16. 

  16.         <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" />
    17. 

  17.         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
    18. 

  18.         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
    19. 

  19.         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
    20. 

  20.                 <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
    21. 

  21.         <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
    22. 

  22.         <script src="js/template.js"></script>
    23. 

  23.         <script src="js/search.js"></script>
    24. 

  24.         <script defer src="js/searchIndex.js"></script>
    25. 

  25.     </head>
    26. 

  26. <body id="top">
    27. 

  27.     <header class="phpdocumentor-header phpdocumentor-section">
    28. 

  28.     <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
    29. 

  29.     <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
    30. 

  30.     <label class="phpdocumentor-header__menu-icon" for="menu-button">
    31. 

  31.         <i class="fas fa-bars"></i>
    32. 

  32.     </label>
    33. 

  33.     <section data-search-form class="phpdocumentor-search">
    34. 

  34.     <label>
    35. 

  35.         <span class="visually-hidden">Search for</span>
    36. 

  36.         <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
    37. 

  37.             <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
    38. 

  38.             <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
    39. 

  39.         </svg>
    40. 

  40.         <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
    41. 

  41.     </label>
    42. 

  42. </section>
    43. 

  43. 

  44.     <nav class="phpdocumentor-topnav">
    45. 

  45.     <ul class="phpdocumentor-topnav__menu">
    46. 

  46.                         <li class="phpdocumentor-topnav__menu-item -menu">
    47. 

  47.                 <a href="https://php-qrcode.readthedocs.io">
    48. 

  48.                     <span>
    49. 

  49.                                                                         User Manual
    50. 

  50.                     </span>
    51. 

  51.                 </a>
    52. 

  52.             </li>
    53. 

  53.                                 <li class="phpdocumentor-topnav__menu-item -social">
    54. 

  54.                 <a href="https://github.com/chillerlan/php-qrcode">
    55. 

  55.                     <span>
    56. 

  56.                                                                         <i class="fab fa-github"></i>
    57. 

  57.                                                 
    58. 

  58.                     </span>
    59. 

  59.                 </a>
    60. 

  60.             </li>
    61. 

  61.                     <li class="phpdocumentor-topnav__menu-item -social">
    62. 

  62.                 <a href="https://github.com/chillerlan/php-qrcode/discussions">
    63. 

  63.                     <span>
    64. 

  64.                                                                         <i class="fas fa-envelope-open-text"></i>
    65. 

  65.                                                 
    66. 

  66.                     </span>
    67. 

  67.                 </a>
    68. 

  68.             </li>
    69. 

  69.                 </ul>
    70. 

  70. </nav>
    71. 

  71. </header>
    72. 

  72. 

  73.     <main class="phpdocumentor">
    74. 

  74.         <div class="phpdocumentor-section">
    75. 

  75.             <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
    76. 

  76. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
    77. 

  77.     Menu
    78. 

  78. </label>
    79. 

  79. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
    80. 

  80.                     <section class="phpdocumentor-sidebar__category -namespaces">
    81. 

  81.             <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
    82. 

  82.                                     <h4 class="phpdocumentor-sidebar__root-namespace">
    83. 

  83.     <a href="namespaces/chillerlan.html" class="">chillerlan</a>
    84. 

  84. </h4>
    85. 

  85.     <ul class="phpdocumentor-list">
    86. 

  86.                     <li>
    87. 

  87.                 <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
    88. 

  88.                 
    89. 

  89.             </li>
    90. 

  90.                     <li>
    91. 

  91.                 <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
    92. 

  92.                 
    93. 

  93.             </li>
    94. 

  94.             </ul>
    95. 

  95. 

  96.                         </section>
    97. 

  97.                 <section class="phpdocumentor-sidebar__category -packages">
    98. 

  98.             <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
    99. 

  99.                                     <h4 class="phpdocumentor-sidebar__root-namespace">
    100. 

  100.     <a href="packages/Application.html" class="">Application</a>
    101. 

  101. </h4>
    102. 

  102. 

  103.                         </section>
    104. 

  104.             
    105. 

  105.     <section class="phpdocumentor-sidebar__category -reports">
    106. 

  106.         <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
    107. 

  107.                 <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
    108. 

  108.         <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
    109. 

  109.         <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
    110. 

  110.     </section>
    111. 

  111. 

  112.     <section class="phpdocumentor-sidebar__category -indices">
    113. 

  113.         <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
    114. 

  114.         <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
    115. 

  115.     </section>
    116. 

  116. </aside>
    117. 

  117. 

  118.             <div class="phpdocumentor-column -nine phpdocumentor-content">
    119. 

  119.                                 <section>
    120. 

  120.                                         <ul class="phpdocumentor-breadcrumbs">
    121. 

  121.             <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
    122. 

  122.             <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
    123. 

  123.             <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-common.html">Common</a></li>
    124. 

  124.     </ul>
    125. 

  125. 

  126.     <article class="phpdocumentor-element -class">
    127. 

  127.         <h2 class="phpdocumentor-content__title">
    128. 

  128.     MaskPattern
    129. 

  129. 

  130.     
    131. 

  131.             <div class="phpdocumentor-element__package">
    132. 

  132.             in package
    133. 

  133.             <ul class="phpdocumentor-breadcrumbs">
    134. 

  134.                                     <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
    135. 

  135.                             </ul>
    136. 

  136.         </div>
    137. 

  137.     
    138. 

  138.     
    139. 

  139.     </h2>
    140. 

  140. 

  141. <div class="phpdocumentor-label-line">
    142. 

  142. 

  143.     <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
    144. 

  144. 

  145. 

  146. </div>
    147. 

  147. 

  148.         <aside class="phpdocumentor-element-found-in">
    149. 

  149.     <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>
    150. 

  150.     :
    151. 

  151.     <span class="phpdocumentor-element-found-in__line">27</span>
    152. 

  152. 

  153.     </aside>
    154. 

  154. 

  155.             <p class="phpdocumentor-summary">ISO/IEC 18004:2000 Section 8.8.1
    156. 

  156. ISO/IEC 18004:2000 Section 8.8.2 - Evaluation of masking results</p>
    157. 

  157. 

  158. 

  159. 

  160. 

  161.     <h5 class="phpdocumentor-tag-list__heading" id="tags">
    162. 

  162.         Tags
    163. 

  163.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
    164. 

  164. 

  165.     </h5>
    166. 

  166.     <dl class="phpdocumentor-tag-list">
    167. 

  167.                                     <dt class="phpdocumentor-tag-list__entry">
    168. 

  168.                     <span class="phpdocumentor-tag__name">see</span>
    169. 

  169.                 </dt>
    170. 

  170.                 <dd class="phpdocumentor-tag-list__definition">
    171. 

  171.                                                                                     <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>
    172. 

  172.                                         
    173. 

  173.                                              
    174. 

  174.                                     </dd>
    175. 

  175.                             <dt class="phpdocumentor-tag-list__entry">
    176. 

  176.                     <span class="phpdocumentor-tag__name">see</span>
    177. 

  177.                 </dt>
    178. 

  178.                 <dd class="phpdocumentor-tag-list__definition">
    179. 

  179.                                                                                     <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>
    180. 

  180.                                         
    181. 

  181.                                              
    182. 

  182.                                     </dd>
    183. 

  183.                                             </dl>
    184. 

  184. 

  185. 

  186. 

  187. 

  188. 

  189. <h3 id="toc">
    190. 

  190.     Table of Contents
    191. 

  191.     <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
    192. 

  192. 

  193. </h3>
    194. 

  194. 

  195. 

  196. 

  197. 

  198. 

  199. 

  200. 

  201. <h4 id="toc-constants">
    202. 

  202.     Constants
    203. 

  203.     <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
    204. 

  204. 

  205. </h4>
    206. 

  206. <dl class="phpdocumentor-table-of-contents">
    207. 

  207.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    208. 

  208.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO">AUTO</a>
    209. 

  209.     <span>
    210. 

  210.         &nbsp;= -1                            </span>
    211. 

  211. </dt>
    212. 

  212. 

  213.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    214. 

  214.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000">PATTERN_000</a>
    215. 

  215.     <span>
    216. 

  216.         &nbsp;= 0b0                            </span>
    217. 

  217. </dt>
    218. 

  218. 

  219.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    220. 

  220.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001">PATTERN_001</a>
    221. 

  221.     <span>
    222. 

  222.         &nbsp;= 0b1                            </span>
    223. 

  223. </dt>
    224. 

  224. 

  225.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    226. 

  226.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010">PATTERN_010</a>
    227. 

  227.     <span>
    228. 

  228.         &nbsp;= 0b10                            </span>
    229. 

  229. </dt>
    230. 

  230. 

  231.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    232. 

  232.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011">PATTERN_011</a>
    233. 

  233.     <span>
    234. 

  234.         &nbsp;= 0b11                            </span>
    235. 

  235. </dt>
    236. 

  236. 

  237.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    238. 

  238.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100">PATTERN_100</a>
    239. 

  239.     <span>
    240. 

  240.         &nbsp;= 0b100                            </span>
    241. 

  241. </dt>
    242. 

  242. 

  243.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    244. 

  244.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101">PATTERN_101</a>
    245. 

  245.     <span>
    246. 

  246.         &nbsp;= 0b101                            </span>
    247. 

  247. </dt>
    248. 

  248. 

  249.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    250. 

  250.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110">PATTERN_110</a>
    251. 

  251.     <span>
    252. 

  252.         &nbsp;= 0b110                            </span>
    253. 

  253. </dt>
    254. 

  254. 

  255.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    256. 

  256.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111">PATTERN_111</a>
    257. 

  257.     <span>
    258. 

  258.         &nbsp;= 0b111                            </span>
    259. 

  259. </dt>
    260. 

  260. 

  261.             <dt class="phpdocumentor-table-of-contents__entry -constant -public">
    262. 

  262.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS">PATTERNS</a>
    263. 

  263.     <span>
    264. 

  264.         &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>
    265. 

  265. </dt>
    266. 

  266. 

  267.             <dt class="phpdocumentor-table-of-contents__entry -constant -private">
    268. 

  268.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1">PENALTY_N1</a>
    269. 

  269.     <span>
    270. 

  270.         &nbsp;= 3                            </span>
    271. 

  271. </dt>
    272. 

  272. 

  273.             <dt class="phpdocumentor-table-of-contents__entry -constant -private">
    274. 

  274.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2">PENALTY_N2</a>
    275. 

  275.     <span>
    276. 

  276.         &nbsp;= 3                            </span>
    277. 

  277. </dt>
    278. 

  278. 

  279.             <dt class="phpdocumentor-table-of-contents__entry -constant -private">
    280. 

  280.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3">PENALTY_N3</a>
    281. 

  281.     <span>
    282. 

  282.         &nbsp;= 40                            </span>
    283. 

  283. </dt>
    284. 

  284. 

  285.             <dt class="phpdocumentor-table-of-contents__entry -constant -private">
    286. 

  286.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4">PENALTY_N4</a>
    287. 

  287.     <span>
    288. 

  288.         &nbsp;= 10                            </span>
    289. 

  289. </dt>
    290. 

  290. 

  291.     </dl>
    292. 

  292. 

  293. 

  294. <h4 id="toc-properties">
    295. 

  295.     Properties
    296. 

  296.     <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
    297. 

  297. 

  298. </h4>
    299. 

  299. <dl class="phpdocumentor-table-of-contents">
    300. 

  300.             <dt class="phpdocumentor-table-of-contents__entry -property -private">
    301. 

  301.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern">$maskPattern</a>
    302. 

  302.     <span>
    303. 

  303.                         &nbsp;: int            </span>
    304. 

  304. </dt>
    305. 

  305. <dd>The current mask pattern value (0-7)</dd>
    306. 

  306. 

  307.     </dl>
    308. 

  308. 

  309. <h4 id="toc-methods">
    310. 

  310.     Methods
    311. 

  311.     <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
    312. 

  312. 

  313. </h4>
    314. 

  314. <dl class="phpdocumentor-table-of-contents">
    315. 

  315.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    316. 

  316.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct">__construct()</a>
    317. 

  317.     <span>
    318. 

  318.                                 &nbsp;: mixed    </span>
    319. 

  319. </dt>
    320. 

  320. <dd>MaskPattern constructor.</dd>
    321. 

  321. 

  322.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    323. 

  323.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern">getBestPattern()</a>
    324. 

  324.     <span>
    325. 

  325.                                 &nbsp;: self    </span>
    326. 

  326. </dt>
    327. 

  327. <dd>Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result</dd>
    328. 

  328. 

  329.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    330. 

  330.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask">getMask()</a>
    331. 

  331.     <span>
    332. 

  332.                                 &nbsp;: <abbr title="\Closure">Closure</abbr>    </span>
    333. 

  333. </dt>
    334. 

  334. <dd>Returns a closure that applies the mask for the chosen mask pattern.</dd>
    335. 

  335. 

  336.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    337. 

  337.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern">getPattern()</a>
    338. 

  338.     <span>
    339. 

  339.                                 &nbsp;: int    </span>
    340. 

  340. </dt>
    341. 

  341. <dd>Returns the current mask pattern</dd>
    342. 

  342. 

  343.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    344. 

  344.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1">testRule1()</a>
    345. 

  345.     <span>
    346. 

  346.                                 &nbsp;: int    </span>
    347. 

  347. </dt>
    348. 

  348. <dd>Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
    349. 

  349. give penalty to them. Example: 00000 or 11111.</dd>
    350. 

  350. 

  351.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    352. 

  352.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2">testRule2()</a>
    353. 

  353.     <span>
    354. 

  354.                                 &nbsp;: int    </span>
    355. 

  355. </dt>
    356. 

  356. <dd>Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
    357. 

  357. penalty to them. This is actually equivalent to the spec&#039;s rule, which is to find MxN blocks and give a
    358. 

  358. penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.</dd>
    359. 

  359. 

  360.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    361. 

  361.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3">testRule3()</a>
    362. 

  362.     <span>
    363. 

  363.                                 &nbsp;: int    </span>
    364. 

  364. </dt>
    365. 

  365. <dd>Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4
    366. 

  366. starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them.  If we
    367. 

  367. find patterns like 000010111010000, we give penalty once.</dd>
    368. 

  368. 

  369.             <dt class="phpdocumentor-table-of-contents__entry -method -public">
    370. 

  370.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4">testRule4()</a>
    371. 

  371.     <span>
    372. 

  372.                                 &nbsp;: int    </span>
    373. 

  373. </dt>
    374. 

  374. <dd>Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
    375. 

  375. penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.</dd>
    376. 

  376. 

  377.             <dt class="phpdocumentor-table-of-contents__entry -method -private">
    378. 

  378.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1">applyRule1()</a>
    379. 

  379.     <span>
    380. 

  380.                                 &nbsp;: int    </span>
    381. 

  381. </dt>
    382. 

  382. 

  383.             <dt class="phpdocumentor-table-of-contents__entry -method -private">
    384. 

  384.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal">isWhiteHorizontal()</a>
    385. 

  385.     <span>
    386. 

  386.                                 &nbsp;: bool    </span>
    387. 

  387. </dt>
    388. 

  388. 

  389.             <dt class="phpdocumentor-table-of-contents__entry -method -private">
    390. 

  390.     <a class="" href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical">isWhiteVertical()</a>
    391. 

  391.     <span>
    392. 

  392.                                 &nbsp;: bool    </span>
    393. 

  393. </dt>
    394. 

  394. 

  395.     </dl>
    396. 

  396. 

  397. 

  398. 

  399.         
    400. 

  400.     <section class="phpdocumentor-constants">
    401. 

  401.         <h3 class="phpdocumentor-elements__header" id="constants">
    402. 

  402.             Constants
    403. 

  403.             <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
    404. 

  404. 

  405.         </h3>
    406. 

  406.                     <article class="phpdocumentor-element -constant -public ">
    407. 

  407.     <h4 class="phpdocumentor-element__name" id="constant_AUTO">
    408. 

  408.         AUTO
    409. 

  409.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
    410. 

  410. 

  411.     </h4>
    412. 

  412. 

  413.     <aside class="phpdocumentor-element-found-in">
    414. 

  414.     <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>
    415. 

  415.     :
    416. 

  416.     <span class="phpdocumentor-element-found-in__line">34</span>
    417. 

  417. 

  418.     </aside>
    419. 

  419. 

  420.     
    421. 

  421.     
    422. 

  422.     <code class="phpdocumentor-signature phpdocumentor-code ">
    423. 

  423.     <span class="phpdocumentor-signature__visibility">public</span>
    424. 

  424.         <span class="phpdocumentor-signature__type">int</span>
    425. 

  425.     <span class="phpdocumentor-signature__name">AUTO</span>
    426. 

  426.     = <span class="phpdocumentor-signature__default-value">-1</span>
    427. 

  427. </code>
    428. 

  428. 

  429. 

  430.     
    431. 

  431.     
    432. 

  432.     
    433. 

  433.     <h5 class="phpdocumentor-tag-list__heading" id="tags">
    434. 

  434.         Tags
    435. 

  435.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO#tags" class="headerlink"><i class="fas fa-link"></i></a>
    436. 

  436. 

  437.     </h5>
    438. 

  438.     <dl class="phpdocumentor-tag-list">
    439. 

  439.                                     <dt class="phpdocumentor-tag-list__entry">
    440. 

  440.                     <span class="phpdocumentor-tag__name">see</span>
    441. 

  441.                 </dt>
    442. 

  442.                 <dd class="phpdocumentor-tag-list__definition">
    443. 

  443.                                                                                     <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>
    444. 

  444.                                         
    445. 

  445.                                              
    446. 

  446.                                     </dd>
    447. 

  447.                                             </dl>
    448. 

  448. 

  449.     
    450. 

  450. 

  451. </article>
    452. 

  452.                     <article class="phpdocumentor-element -constant -public ">
    453. 

  453.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_000">
    454. 

  454.         PATTERN_000
    455. 

  455.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000" class="headerlink"><i class="fas fa-link"></i></a>
    456. 

  456. 

  457.     </h4>
    458. 

  458. 

  459.     <aside class="phpdocumentor-element-found-in">
    460. 

  460.     <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>
    461. 

  461.     :
    462. 

  462.     <span class="phpdocumentor-element-found-in__line">36</span>
    463. 

  463. 

  464.     </aside>
    465. 

  465. 

  466.     
    467. 

  467.     
    468. 

  468.     <code class="phpdocumentor-signature phpdocumentor-code ">
    469. 

  469.     <span class="phpdocumentor-signature__visibility">public</span>
    470. 

  470.         <span class="phpdocumentor-signature__type">mixed</span>
    471. 

  471.     <span class="phpdocumentor-signature__name">PATTERN_000</span>
    472. 

  472.     = <span class="phpdocumentor-signature__default-value">0b0</span>
    473. 

  473. </code>
    474. 

  474. 

  475. 

  476.     
    477. 

  477.     
    478. 

  478.     
    479. 

  479. 

  480.     
    481. 

  481. 

  482. </article>
    483. 

  483.                     <article class="phpdocumentor-element -constant -public ">
    484. 

  484.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_001">
    485. 

  485.         PATTERN_001
    486. 

  486.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001" class="headerlink"><i class="fas fa-link"></i></a>
    487. 

  487. 

  488.     </h4>
    489. 

  489. 

  490.     <aside class="phpdocumentor-element-found-in">
    491. 

  491.     <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>
    492. 

  492.     :
    493. 

  493.     <span class="phpdocumentor-element-found-in__line">37</span>
    494. 

  494. 

  495.     </aside>
    496. 

  496. 

  497.     
    498. 

  498.     
    499. 

  499.     <code class="phpdocumentor-signature phpdocumentor-code ">
    500. 

  500.     <span class="phpdocumentor-signature__visibility">public</span>
    501. 

  501.         <span class="phpdocumentor-signature__type">mixed</span>
    502. 

  502.     <span class="phpdocumentor-signature__name">PATTERN_001</span>
    503. 

  503.     = <span class="phpdocumentor-signature__default-value">0b1</span>
    504. 

  504. </code>
    505. 

  505. 

  506. 

  507.     
    508. 

  508.     
    509. 

  509.     
    510. 

  510. 

  511.     
    512. 

  512. 

  513. </article>
    514. 

  514.                     <article class="phpdocumentor-element -constant -public ">
    515. 

  515.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_010">
    516. 

  516.         PATTERN_010
    517. 

  517.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010" class="headerlink"><i class="fas fa-link"></i></a>
    518. 

  518. 

  519.     </h4>
    520. 

  520. 

  521.     <aside class="phpdocumentor-element-found-in">
    522. 

  522.     <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>
    523. 

  523.     :
    524. 

  524.     <span class="phpdocumentor-element-found-in__line">38</span>
    525. 

  525. 

  526.     </aside>
    527. 

  527. 

  528.     
    529. 

  529.     
    530. 

  530.     <code class="phpdocumentor-signature phpdocumentor-code ">
    531. 

  531.     <span class="phpdocumentor-signature__visibility">public</span>
    532. 

  532.         <span class="phpdocumentor-signature__type">mixed</span>
    533. 

  533.     <span class="phpdocumentor-signature__name">PATTERN_010</span>
    534. 

  534.     = <span class="phpdocumentor-signature__default-value">0b10</span>
    535. 

  535. </code>
    536. 

  536. 

  537. 

  538.     
    539. 

  539.     
    540. 

  540.     
    541. 

  541. 

  542.     
    543. 

  543. 

  544. </article>
    545. 

  545.                     <article class="phpdocumentor-element -constant -public ">
    546. 

  546.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_011">
    547. 

  547.         PATTERN_011
    548. 

  548.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011" class="headerlink"><i class="fas fa-link"></i></a>
    549. 

  549. 

  550.     </h4>
    551. 

  551. 

  552.     <aside class="phpdocumentor-element-found-in">
    553. 

  553.     <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>
    554. 

  554.     :
    555. 

  555.     <span class="phpdocumentor-element-found-in__line">39</span>
    556. 

  556. 

  557.     </aside>
    558. 

  558. 

  559.     
    560. 

  560.     
    561. 

  561.     <code class="phpdocumentor-signature phpdocumentor-code ">
    562. 

  562.     <span class="phpdocumentor-signature__visibility">public</span>
    563. 

  563.         <span class="phpdocumentor-signature__type">mixed</span>
    564. 

  564.     <span class="phpdocumentor-signature__name">PATTERN_011</span>
    565. 

  565.     = <span class="phpdocumentor-signature__default-value">0b11</span>
    566. 

  566. </code>
    567. 

  567. 

  568. 

  569.     
    570. 

  570.     
    571. 

  571.     
    572. 

  572. 

  573.     
    574. 

  574. 

  575. </article>
    576. 

  576.                     <article class="phpdocumentor-element -constant -public ">
    577. 

  577.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_100">
    578. 

  578.         PATTERN_100
    579. 

  579.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100" class="headerlink"><i class="fas fa-link"></i></a>
    580. 

  580. 

  581.     </h4>
    582. 

  582. 

  583.     <aside class="phpdocumentor-element-found-in">
    584. 

  584.     <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>
    585. 

  585.     :
    586. 

  586.     <span class="phpdocumentor-element-found-in__line">40</span>
    587. 

  587. 

  588.     </aside>
    589. 

  589. 

  590.     
    591. 

  591.     
    592. 

  592.     <code class="phpdocumentor-signature phpdocumentor-code ">
    593. 

  593.     <span class="phpdocumentor-signature__visibility">public</span>
    594. 

  594.         <span class="phpdocumentor-signature__type">mixed</span>
    595. 

  595.     <span class="phpdocumentor-signature__name">PATTERN_100</span>
    596. 

  596.     = <span class="phpdocumentor-signature__default-value">0b100</span>
    597. 

  597. </code>
    598. 

  598. 

  599. 

  600.     
    601. 

  601.     
    602. 

  602.     
    603. 

  603. 

  604.     
    605. 

  605. 

  606. </article>
    607. 

  607.                     <article class="phpdocumentor-element -constant -public ">
    608. 

  608.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_101">
    609. 

  609.         PATTERN_101
    610. 

  610.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101" class="headerlink"><i class="fas fa-link"></i></a>
    611. 

  611. 

  612.     </h4>
    613. 

  613. 

  614.     <aside class="phpdocumentor-element-found-in">
    615. 

  615.     <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>
    616. 

  616.     :
    617. 

  617.     <span class="phpdocumentor-element-found-in__line">41</span>
    618. 

  618. 

  619.     </aside>
    620. 

  620. 

  621.     
    622. 

  622.     
    623. 

  623.     <code class="phpdocumentor-signature phpdocumentor-code ">
    624. 

  624.     <span class="phpdocumentor-signature__visibility">public</span>
    625. 

  625.         <span class="phpdocumentor-signature__type">mixed</span>
    626. 

  626.     <span class="phpdocumentor-signature__name">PATTERN_101</span>
    627. 

  627.     = <span class="phpdocumentor-signature__default-value">0b101</span>
    628. 

  628. </code>
    629. 

  629. 

  630. 

  631.     
    632. 

  632.     
    633. 

  633.     
    634. 

  634. 

  635.     
    636. 

  636. 

  637. </article>
    638. 

  638.                     <article class="phpdocumentor-element -constant -public ">
    639. 

  639.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_110">
    640. 

  640.         PATTERN_110
    641. 

  641.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110" class="headerlink"><i class="fas fa-link"></i></a>
    642. 

  642. 

  643.     </h4>
    644. 

  644. 

  645.     <aside class="phpdocumentor-element-found-in">
    646. 

  646.     <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>
    647. 

  647.     :
    648. 

  648.     <span class="phpdocumentor-element-found-in__line">42</span>
    649. 

  649. 

  650.     </aside>
    651. 

  651. 

  652.     
    653. 

  653.     
    654. 

  654.     <code class="phpdocumentor-signature phpdocumentor-code ">
    655. 

  655.     <span class="phpdocumentor-signature__visibility">public</span>
    656. 

  656.         <span class="phpdocumentor-signature__type">mixed</span>
    657. 

  657.     <span class="phpdocumentor-signature__name">PATTERN_110</span>
    658. 

  658.     = <span class="phpdocumentor-signature__default-value">0b110</span>
    659. 

  659. </code>
    660. 

  660. 

  661. 

  662.     
    663. 

  663.     
    664. 

  664.     
    665. 

  665. 

  666.     
    667. 

  667. 

  668. </article>
    669. 

  669.                     <article class="phpdocumentor-element -constant -public ">
    670. 

  670.     <h4 class="phpdocumentor-element__name" id="constant_PATTERN_111">
    671. 

  671.         PATTERN_111
    672. 

  672.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111" class="headerlink"><i class="fas fa-link"></i></a>
    673. 

  673. 

  674.     </h4>
    675. 

  675. 

  676.     <aside class="phpdocumentor-element-found-in">
    677. 

  677.     <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>
    678. 

  678.     :
    679. 

  679.     <span class="phpdocumentor-element-found-in__line">43</span>
    680. 

  680. 

  681.     </aside>
    682. 

  682. 

  683.     
    684. 

  684.     
    685. 

  685.     <code class="phpdocumentor-signature phpdocumentor-code ">
    686. 

  686.     <span class="phpdocumentor-signature__visibility">public</span>
    687. 

  687.         <span class="phpdocumentor-signature__type">mixed</span>
    688. 

  688.     <span class="phpdocumentor-signature__name">PATTERN_111</span>
    689. 

  689.     = <span class="phpdocumentor-signature__default-value">0b111</span>
    690. 

  690. </code>
    691. 

  691. 

  692. 

  693.     
    694. 

  694.     
    695. 

  695.     
    696. 

  696. 

  697.     
    698. 

  698. 

  699. </article>
    700. 

  700.                     <article class="phpdocumentor-element -constant -public ">
    701. 

  701.     <h4 class="phpdocumentor-element__name" id="constant_PATTERNS">
    702. 

  702.         PATTERNS
    703. 

  703.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS" class="headerlink"><i class="fas fa-link"></i></a>
    704. 

  704. 

  705.     </h4>
    706. 

  706. 

  707.     <aside class="phpdocumentor-element-found-in">
    708. 

  708.     <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>
    709. 

  709.     :
    710. 

  710.     <span class="phpdocumentor-element-found-in__line">48</span>
    711. 

  711. 

  712.     </aside>
    713. 

  713. 

  714.     
    715. 

  715.     
    716. 

  716.     <code class="phpdocumentor-signature phpdocumentor-code ">
    717. 

  717.     <span class="phpdocumentor-signature__visibility">public</span>
    718. 

  718.         <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
    719. 

  719.     <span class="phpdocumentor-signature__name">PATTERNS</span>
    720. 

  720.     = <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>
    721. 

  721. </code>
    722. 

  722. 

  723. 

  724.     
    725. 

  725.     
    726. 

  726.     
    727. 

  727. 

  728.     
    729. 

  729. 

  730. </article>
    731. 

  731.                     <article class="phpdocumentor-element -constant -private ">
    732. 

  732.     <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N1">
    733. 

  733.         PENALTY_N1
    734. 

  734.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1" class="headerlink"><i class="fas fa-link"></i></a>
    735. 

  735. 

  736.     </h4>
    737. 

  737. 

  738.     <aside class="phpdocumentor-element-found-in">
    739. 

  739.     <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>
    740. 

  740.     :
    741. 

  741.     <span class="phpdocumentor-element-found-in__line">64</span>
    742. 

  742. 

  743.     </aside>
    744. 

  744. 

  745.     
    746. 

  746.     
    747. 

  747.     <code class="phpdocumentor-signature phpdocumentor-code ">
    748. 

  748.     <span class="phpdocumentor-signature__visibility">private</span>
    749. 

  749.         <span class="phpdocumentor-signature__type">mixed</span>
    750. 

  750.     <span class="phpdocumentor-signature__name">PENALTY_N1</span>
    751. 

  751.     = <span class="phpdocumentor-signature__default-value">3</span>
    752. 

  752. </code>
    753. 

  753. 

  754. 

  755.     
    756. 

  756.     
    757. 

  757.     
    758. 

  758. 

  759.     
    760. 

  760. 

  761. </article>
    762. 

  762.                     <article class="phpdocumentor-element -constant -private ">
    763. 

  763.     <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N2">
    764. 

  764.         PENALTY_N2
    765. 

  765.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2" class="headerlink"><i class="fas fa-link"></i></a>
    766. 

  766. 

  767.     </h4>
    768. 

  768. 

  769.     <aside class="phpdocumentor-element-found-in">
    770. 

  770.     <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>
    771. 

  771.     :
    772. 

  772.     <span class="phpdocumentor-element-found-in__line">65</span>
    773. 

  773. 

  774.     </aside>
    775. 

  775. 

  776.     
    777. 

  777.     
    778. 

  778.     <code class="phpdocumentor-signature phpdocumentor-code ">
    779. 

  779.     <span class="phpdocumentor-signature__visibility">private</span>
    780. 

  780.         <span class="phpdocumentor-signature__type">mixed</span>
    781. 

  781.     <span class="phpdocumentor-signature__name">PENALTY_N2</span>
    782. 

  782.     = <span class="phpdocumentor-signature__default-value">3</span>
    783. 

  783. </code>
    784. 

  784. 

  785. 

  786.     
    787. 

  787.     
    788. 

  788.     
    789. 

  789. 

  790.     
    791. 

  791. 

  792. </article>
    793. 

  793.                     <article class="phpdocumentor-element -constant -private ">
    794. 

  794.     <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N3">
    795. 

  795.         PENALTY_N3
    796. 

  796.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3" class="headerlink"><i class="fas fa-link"></i></a>
    797. 

  797. 

  798.     </h4>
    799. 

  799. 

  800.     <aside class="phpdocumentor-element-found-in">
    801. 

  801.     <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>
    802. 

  802.     :
    803. 

  803.     <span class="phpdocumentor-element-found-in__line">66</span>
    804. 

  804. 

  805.     </aside>
    806. 

  806. 

  807.     
    808. 

  808.     
    809. 

  809.     <code class="phpdocumentor-signature phpdocumentor-code ">
    810. 

  810.     <span class="phpdocumentor-signature__visibility">private</span>
    811. 

  811.         <span class="phpdocumentor-signature__type">mixed</span>
    812. 

  812.     <span class="phpdocumentor-signature__name">PENALTY_N3</span>
    813. 

  813.     = <span class="phpdocumentor-signature__default-value">40</span>
    814. 

  814. </code>
    815. 

  815. 

  816. 

  817.     
    818. 

  818.     
    819. 

  819.     
    820. 

  820. 

  821.     
    822. 

  822. 

  823. </article>
    824. 

  824.                     <article class="phpdocumentor-element -constant -private ">
    825. 

  825.     <h4 class="phpdocumentor-element__name" id="constant_PENALTY_N4">
    826. 

  826.         PENALTY_N4
    827. 

  827.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4" class="headerlink"><i class="fas fa-link"></i></a>
    828. 

  828. 

  829.     </h4>
    830. 

  830. 

  831.     <aside class="phpdocumentor-element-found-in">
    832. 

  832.     <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>
    833. 

  833.     :
    834. 

  834.     <span class="phpdocumentor-element-found-in__line">67</span>
    835. 

  835. 

  836.     </aside>
    837. 

  837. 

  838.     
    839. 

  839.     
    840. 

  840.     <code class="phpdocumentor-signature phpdocumentor-code ">
    841. 

  841.     <span class="phpdocumentor-signature__visibility">private</span>
    842. 

  842.         <span class="phpdocumentor-signature__type">mixed</span>
    843. 

  843.     <span class="phpdocumentor-signature__name">PENALTY_N4</span>
    844. 

  844.     = <span class="phpdocumentor-signature__default-value">10</span>
    845. 

  845. </code>
    846. 

  846. 

  847. 

  848.     
    849. 

  849.     
    850. 

  850.     
    851. 

  851. 

  852.     
    853. 

  853. 

  854. </article>
    855. 

  855.             </section>
    856. 

  856. 

  857.         
    858. 

  858.     <section class="phpdocumentor-properties">
    859. 

  859.         <h3 class="phpdocumentor-elements__header" id="properties">
    860. 

  860.             Properties
    861. 

  861.             <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
    862. 

  862. 

  863.         </h3>
    864. 

  864.                     <article
    865. 

  865.         class="
    866. 

  866.             phpdocumentor-element
    867. 

  867.             -property
    868. 

  868.             -private
    869. 

  869.                                                                     "
    870. 

  870. >
    871. 

  871.     <h4 class="phpdocumentor-element__name" id="property_maskPattern">
    872. 

  872.         $maskPattern
    873. 

  873.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern" class="headerlink"><i class="fas fa-link"></i></a>
    874. 

  874. 

  875.         <span class="phpdocumentor-element__modifiers">
    876. 

  876.                                             </span>
    877. 

  877.     </h4>
    878. 

  878.     <aside class="phpdocumentor-element-found-in">
    879. 

  879.     <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>
    880. 

  880.     :
    881. 

  881.     <span class="phpdocumentor-element-found-in__line">72</span>
    882. 

  882. 

  883.     </aside>
    884. 

  884. 

  885.         <p class="phpdocumentor-summary">The current mask pattern value (0-7)</p>
    886. 

  886. 

  887.     
    888. 

  888.     <code class="phpdocumentor-code phpdocumentor-signature ">
    889. 

  889.         <span class="phpdocumentor-signature__visibility">private</span>
    890. 

  890.             <span class="phpdocumentor-signature__type">int</span>
    891. 

  891.     <span class="phpdocumentor-signature__name">$maskPattern</span>
    892. 

  892.     </code>
    893. 

  893. 

  894.     
    895. 

  895.     
    896. 

  896.     
    897. 

  897. 

  898.     
    899. 

  899. 

  900.     
    901. 

  901. 

  902. </article>
    903. 

  903.             </section>
    904. 

  904. 

  905.             <section class="phpdocumentor-methods">
    906. 

  906.         <h3 class="phpdocumentor-elements__header" id="methods">
    907. 

  907.             Methods
    908. 

  908.             <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
    909. 

  909. 

  910.         </h3>
    911. 

  911.                     <article
    912. 

  912.         class="phpdocumentor-element
    913. 

  913.             -method
    914. 

  914.             -public
    915. 

  915.                                                         "
    916. 

  916. >
    917. 

  917.     <h4 class="phpdocumentor-element__name" id="method___construct">
    918. 

  918.         __construct()
    919. 

  919.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
    920. 

  920. 

  921.     </h4>
    922. 

  922.     <aside class="phpdocumentor-element-found-in">
    923. 

  923.     <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>
    924. 

  924.     :
    925. 

  925.     <span class="phpdocumentor-element-found-in__line">79</span>
    926. 

  926. 

  927.     </aside>
    928. 

  928. 

  929.         <p class="phpdocumentor-summary">MaskPattern constructor.</p>
    930. 

  930. 

  931.     <code class="phpdocumentor-code phpdocumentor-signature ">
    932. 

  932.     <span class="phpdocumentor-signature__visibility">public</span>
    933. 

  933.                     <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>
    934. 

  934. 

  935.     <div class="phpdocumentor-label-line">
    936. 

  936.         </div>
    937. 

  937.     
    938. 

  938.     
    939. 

  939.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    940. 

  940.     <dl class="phpdocumentor-argument-list">
    941. 

  941.                     <dt class="phpdocumentor-argument-list__entry">
    942. 

  942.                 <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
    943. 

  943.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    944. 

  944.                             </dt>
    945. 

  945.             <dd class="phpdocumentor-argument-list__definition">
    946. 

  946.                 
    947. 

  947.             </dd>
    948. 

  948.             </dl>
    949. 

  949. 

  950.     
    951. 

  951.     <h5 class="phpdocumentor-tag-list__heading" id="tags">
    952. 

  952.         Tags
    953. 

  953.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
    954. 

  954. 

  955.     </h5>
    956. 

  956.     <dl class="phpdocumentor-tag-list">
    957. 

  957.                                     <dt class="phpdocumentor-tag-list__entry">
    958. 

  958.                     <span class="phpdocumentor-tag__name">throws</span>
    959. 

  959.                 </dt>
    960. 

  960.                 <dd class="phpdocumentor-tag-list__definition">
    961. 

  961.                                                                 <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
    962. 

  962.                                                             
    963. 

  963.                                              
    964. 

  964.                                     </dd>
    965. 

  965.                                             </dl>
    966. 

  966. 

  967.     
    968. 

  968. 

  969.     
    970. 

  970. </article>
    971. 

  971.                     <article
    972. 

  972.         class="phpdocumentor-element
    973. 

  973.             -method
    974. 

  974.             -public
    975. 

  975.                                     -static                    "
    976. 

  976. >
    977. 

  977.     <h4 class="phpdocumentor-element__name" id="method_getBestPattern">
    978. 

  978.         getBestPattern()
    979. 

  979.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern" class="headerlink"><i class="fas fa-link"></i></a>
    980. 

  980. 

  981.     </h4>
    982. 

  982.     <aside class="phpdocumentor-element-found-in">
    983. 

  983.     <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>
    984. 

  984.     :
    985. 

  985.     <span class="phpdocumentor-element-found-in__line">121</span>
    986. 

  986. 

  987.     </aside>
    988. 

  988. 

  989.         <p class="phpdocumentor-summary">Evaluates the matrix of the given data interface and returns a new mask pattern instance for the best result</p>
    990. 

  990. 

  991.     <code class="phpdocumentor-code phpdocumentor-signature ">
    992. 

  992.     <span class="phpdocumentor-signature__visibility">public</span>
    993. 

  993.             <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>
    994. 

  994. 

  995.     <div class="phpdocumentor-label-line">
    996. 

  996.         </div>
    997. 

  997.     
    998. 

  998.     
    999. 

  999.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1000. 

  1000.     <dl class="phpdocumentor-argument-list">
    1001. 

  1001.                     <dt class="phpdocumentor-argument-list__entry">
    1002. 

  1002.                 <span class="phpdocumentor-signature__argument__name">$QRMatrix</span>
    1003. 

  1003.                 : <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>
    1004. 

  1004.                             </dt>
    1005. 

  1005.             <dd class="phpdocumentor-argument-list__definition">
    1006. 

  1006.                 
    1007. 

  1007.             </dd>
    1008. 

  1008.             </dl>
    1009. 

  1009. 

  1010.     
    1011. 

  1011. 

  1012.     
    1013. 

  1013. 

  1014.             <section>
    1015. 

  1015.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1016. 

  1016.         <span class="phpdocumentor-signature__response_type">self</span>
    1017. 

  1017.             </section>
    1018. 

  1018. 

  1019. </article>
    1020. 

  1020.                     <article
    1021. 

  1021.         class="phpdocumentor-element
    1022. 

  1022.             -method
    1023. 

  1023.             -public
    1024. 

  1024.                                                         "
    1025. 

  1025. >
    1026. 

  1026.     <h4 class="phpdocumentor-element__name" id="method_getMask">
    1027. 

  1027.         getMask()
    1028. 

  1028.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask" class="headerlink"><i class="fas fa-link"></i></a>
    1029. 

  1029. 

  1030.     </h4>
    1031. 

  1031.     <aside class="phpdocumentor-element-found-in">
    1032. 

  1032.     <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>
    1033. 

  1033.     :
    1034. 

  1034.     <span class="phpdocumentor-element-found-in__line">104</span>
    1035. 

  1035. 

  1036.     </aside>
    1037. 

  1037. 

  1038.         <p class="phpdocumentor-summary">Returns a closure that applies the mask for the chosen mask pattern.</p>
    1039. 

  1039. 

  1040.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1041. 

  1041.     <span class="phpdocumentor-signature__visibility">public</span>
    1042. 

  1042.                     <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>
    1043. 

  1043. 

  1044.     <div class="phpdocumentor-label-line">
    1045. 

  1045.         </div>
    1046. 

  1046.     
    1047. 

  1047.         <section class="phpdocumentor-description"><p>Note that the diagram in section 6.8.1 is misleading since it indicates that $i is column position
    1048. 

  1048. and $j is row position. In fact, as the text says, $i is row position and $j is column position.</p>
    1049. 

  1049. </section>
    1050. 

  1050. 

  1051.     
    1052. 

  1052.     
    1053. 

  1053.     <h5 class="phpdocumentor-tag-list__heading" id="tags">
    1054. 

  1054.         Tags
    1055. 

  1055.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask#tags" class="headerlink"><i class="fas fa-link"></i></a>
    1056. 

  1056. 

  1057.     </h5>
    1058. 

  1058.     <dl class="phpdocumentor-tag-list">
    1059. 

  1059.                                     <dt class="phpdocumentor-tag-list__entry">
    1060. 

  1060.                     <span class="phpdocumentor-tag__name">see</span>
    1061. 

  1061.                 </dt>
    1062. 

  1062.                 <dd class="phpdocumentor-tag-list__definition">
    1063. 

  1063.                                                                                     <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>
    1064. 

  1064.                                         
    1065. 

  1065.                                              
    1066. 

  1066.                                     </dd>
    1067. 

  1067.                             <dt class="phpdocumentor-tag-list__entry">
    1068. 

  1068.                     <span class="phpdocumentor-tag__name">see</span>
    1069. 

  1069.                 </dt>
    1070. 

  1070.                 <dd class="phpdocumentor-tag-list__definition">
    1071. 

  1071.                                                                                     <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>
    1072. 

  1072.                                         
    1073. 

  1073.                                              
    1074. 

  1074.                                     </dd>
    1075. 

  1075.                                             </dl>
    1076. 

  1076. 

  1077.     
    1078. 

  1078. 

  1079.             <section>
    1080. 

  1080.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1081. 

  1081.         <span class="phpdocumentor-signature__response_type"><abbr title="\Closure">Closure</abbr></span>
    1082. 

  1082.             </section>
    1083. 

  1083. 

  1084. </article>
    1085. 

  1085.                     <article
    1086. 

  1086.         class="phpdocumentor-element
    1087. 

  1087.             -method
    1088. 

  1088.             -public
    1089. 

  1089.                                                         "
    1090. 

  1090. >
    1091. 

  1091.     <h4 class="phpdocumentor-element__name" id="method_getPattern">
    1092. 

  1092.         getPattern()
    1093. 

  1093.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern" class="headerlink"><i class="fas fa-link"></i></a>
    1094. 

  1094. 

  1095.     </h4>
    1096. 

  1096.     <aside class="phpdocumentor-element-found-in">
    1097. 

  1097.     <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>
    1098. 

  1098.     :
    1099. 

  1099.     <span class="phpdocumentor-element-found-in__line">91</span>
    1100. 

  1100. 

  1101.     </aside>
    1102. 

  1102. 

  1103.         <p class="phpdocumentor-summary">Returns the current mask pattern</p>
    1104. 

  1104. 

  1105.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1106. 

  1106.     <span class="phpdocumentor-signature__visibility">public</span>
    1107. 

  1107.                     <span class="phpdocumentor-signature__name">getPattern</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
    1108. 

  1108. 

  1109.     <div class="phpdocumentor-label-line">
    1110. 

  1110.         </div>
    1111. 

  1111.     
    1112. 

  1112.     
    1113. 

  1113.     
    1114. 

  1114.     
    1115. 

  1115. 

  1116.     
    1117. 

  1117. 

  1118.             <section>
    1119. 

  1119.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1120. 

  1120.         <span class="phpdocumentor-signature__response_type">int</span>
    1121. 

  1121.             </section>
    1122. 

  1122. 

  1123. </article>
    1124. 

  1124.                     <article
    1125. 

  1125.         class="phpdocumentor-element
    1126. 

  1126.             -method
    1127. 

  1127.             -public
    1128. 

  1128.                                     -static                    "
    1129. 

  1129. >
    1130. 

  1130.     <h4 class="phpdocumentor-element__name" id="method_testRule1">
    1131. 

  1131.         testRule1()
    1132. 

  1132.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1" class="headerlink"><i class="fas fa-link"></i></a>
    1133. 

  1133. 

  1134.     </h4>
    1135. 

  1135.     <aside class="phpdocumentor-element-found-in">
    1136. 

  1136.     <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>
    1137. 

  1137.     :
    1138. 

  1138.     <span class="phpdocumentor-element-found-in__line">146</span>
    1139. 

  1139. 

  1140.     </aside>
    1141. 

  1141. 

  1142.         <p class="phpdocumentor-summary">Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
    1143. 

  1143. give penalty to them. Example: 00000 or 11111.</p>
    1144. 

  1144. 

  1145.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1146. 

  1146.     <span class="phpdocumentor-signature__visibility">public</span>
    1147. 

  1147.             <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, array&lt;string|int, bool&gt;&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>
    1148. 

  1148. 

  1149.     <div class="phpdocumentor-label-line">
    1150. 

  1150.         </div>
    1151. 

  1151.     
    1152. 

  1152.     
    1153. 

  1153.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1154. 

  1154.     <dl class="phpdocumentor-argument-list">
    1155. 

  1155.                     <dt class="phpdocumentor-argument-list__entry">
    1156. 

  1156.                 <span class="phpdocumentor-signature__argument__name">$matrix</span>
    1157. 

  1157.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
    1158. 

  1158.                             </dt>
    1159. 

  1159.             <dd class="phpdocumentor-argument-list__definition">
    1160. 

  1160.                 
    1161. 

  1161.             </dd>
    1162. 

  1162.                     <dt class="phpdocumentor-argument-list__entry">
    1163. 

  1163.                 <span class="phpdocumentor-signature__argument__name">$height</span>
    1164. 

  1164.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1165. 

  1165.                             </dt>
    1166. 

  1166.             <dd class="phpdocumentor-argument-list__definition">
    1167. 

  1167.                 
    1168. 

  1168.             </dd>
    1169. 

  1169.                     <dt class="phpdocumentor-argument-list__entry">
    1170. 

  1170.                 <span class="phpdocumentor-signature__argument__name">$width</span>
    1171. 

  1171.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1172. 

  1172.                             </dt>
    1173. 

  1173.             <dd class="phpdocumentor-argument-list__definition">
    1174. 

  1174.                 
    1175. 

  1175.             </dd>
    1176. 

  1176.             </dl>
    1177. 

  1177. 

  1178.     
    1179. 

  1179. 

  1180.     
    1181. 

  1181. 

  1182.             <section>
    1183. 

  1183.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1184. 

  1184.         <span class="phpdocumentor-signature__response_type">int</span>
    1185. 

  1185.             </section>
    1186. 

  1186. 

  1187. </article>
    1188. 

  1188.                     <article
    1189. 

  1189.         class="phpdocumentor-element
    1190. 

  1190.             -method
    1191. 

  1191.             -public
    1192. 

  1192.                                     -static                    "
    1193. 

  1193. >
    1194. 

  1194.     <h4 class="phpdocumentor-element__name" id="method_testRule2">
    1195. 

  1195.         testRule2()
    1196. 

  1196.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2" class="headerlink"><i class="fas fa-link"></i></a>
    1197. 

  1197. 

  1198.     </h4>
    1199. 

  1199.     <aside class="phpdocumentor-element-found-in">
    1200. 

  1200.     <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>
    1201. 

  1201.     :
    1202. 

  1202.     <span class="phpdocumentor-element-found-in__line">200</span>
    1203. 

  1203. 

  1204.     </aside>
    1205. 

  1205. 

  1206.         <p class="phpdocumentor-summary">Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
    1207. 

  1207. penalty to them. This is actually equivalent to the spec&#039;s rule, which is to find MxN blocks and give a
    1208. 

  1208. penalty proportional to (M-1)x(N-1), because this is the number of 2x2 blocks inside such a block.</p>
    1209. 

  1209. 

  1210.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1211. 

  1211.     <span class="phpdocumentor-signature__visibility">public</span>
    1212. 

  1212.             <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, array&lt;string|int, bool&gt;&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>
    1213. 

  1213. 

  1214.     <div class="phpdocumentor-label-line">
    1215. 

  1215.         </div>
    1216. 

  1216.     
    1217. 

  1217.     
    1218. 

  1218.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1219. 

  1219.     <dl class="phpdocumentor-argument-list">
    1220. 

  1220.                     <dt class="phpdocumentor-argument-list__entry">
    1221. 

  1221.                 <span class="phpdocumentor-signature__argument__name">$matrix</span>
    1222. 

  1222.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
    1223. 

  1223.                             </dt>
    1224. 

  1224.             <dd class="phpdocumentor-argument-list__definition">
    1225. 

  1225.                 
    1226. 

  1226.             </dd>
    1227. 

  1227.                     <dt class="phpdocumentor-argument-list__entry">
    1228. 

  1228.                 <span class="phpdocumentor-signature__argument__name">$height</span>
    1229. 

  1229.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1230. 

  1230.                             </dt>
    1231. 

  1231.             <dd class="phpdocumentor-argument-list__definition">
    1232. 

  1232.                 
    1233. 

  1233.             </dd>
    1234. 

  1234.                     <dt class="phpdocumentor-argument-list__entry">
    1235. 

  1235.                 <span class="phpdocumentor-signature__argument__name">$width</span>
    1236. 

  1236.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1237. 

  1237.                             </dt>
    1238. 

  1238.             <dd class="phpdocumentor-argument-list__definition">
    1239. 

  1239.                 
    1240. 

  1240.             </dd>
    1241. 

  1241.             </dl>
    1242. 

  1242. 

  1243.     
    1244. 

  1244. 

  1245.     
    1246. 

  1246. 

  1247.             <section>
    1248. 

  1248.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1249. 

  1249.         <span class="phpdocumentor-signature__response_type">int</span>
    1250. 

  1250.             </section>
    1251. 

  1251. 

  1252. </article>
    1253. 

  1253.                     <article
    1254. 

  1254.         class="phpdocumentor-element
    1255. 

  1255.             -method
    1256. 

  1256.             -public
    1257. 

  1257.                                     -static                    "
    1258. 

  1258. >
    1259. 

  1259.     <h4 class="phpdocumentor-element__name" id="method_testRule3">
    1260. 

  1260.         testRule3()
    1261. 

  1261.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3" class="headerlink"><i class="fas fa-link"></i></a>
    1262. 

  1262. 

  1263.     </h4>
    1264. 

  1264.     <aside class="phpdocumentor-element-found-in">
    1265. 

  1265.     <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>
    1266. 

  1266.     :
    1267. 

  1267.     <span class="phpdocumentor-element-found-in__line">235</span>
    1268. 

  1268. 

  1269.     </aside>
    1270. 

  1270. 

  1271.         <p class="phpdocumentor-summary">Apply mask penalty rule 3 and return the penalty. Find consecutive runs of 1:1:3:1:1:4
    1272. 

  1272. starting with black, or 4:1:1:3:1:1 starting with white, and give penalty to them.  If we
    1273. 

  1273. find patterns like 000010111010000, we give penalty once.</p>
    1274. 

  1274. 

  1275.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1276. 

  1276.     <span class="phpdocumentor-signature__visibility">public</span>
    1277. 

  1277.             <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, array&lt;string|int, bool&gt;&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>
    1278. 

  1278. 

  1279.     <div class="phpdocumentor-label-line">
    1280. 

  1280.         </div>
    1281. 

  1281.     
    1282. 

  1282.     
    1283. 

  1283.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1284. 

  1284.     <dl class="phpdocumentor-argument-list">
    1285. 

  1285.                     <dt class="phpdocumentor-argument-list__entry">
    1286. 

  1286.                 <span class="phpdocumentor-signature__argument__name">$matrix</span>
    1287. 

  1287.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
    1288. 

  1288.                             </dt>
    1289. 

  1289.             <dd class="phpdocumentor-argument-list__definition">
    1290. 

  1290.                 
    1291. 

  1291.             </dd>
    1292. 

  1292.                     <dt class="phpdocumentor-argument-list__entry">
    1293. 

  1293.                 <span class="phpdocumentor-signature__argument__name">$height</span>
    1294. 

  1294.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1295. 

  1295.                             </dt>
    1296. 

  1296.             <dd class="phpdocumentor-argument-list__definition">
    1297. 

  1297.                 
    1298. 

  1298.             </dd>
    1299. 

  1299.                     <dt class="phpdocumentor-argument-list__entry">
    1300. 

  1300.                 <span class="phpdocumentor-signature__argument__name">$width</span>
    1301. 

  1301.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1302. 

  1302.                             </dt>
    1303. 

  1303.             <dd class="phpdocumentor-argument-list__definition">
    1304. 

  1304.                 
    1305. 

  1305.             </dd>
    1306. 

  1306.             </dl>
    1307. 

  1307. 

  1308.     
    1309. 

  1309. 

  1310.     
    1311. 

  1311. 

  1312.             <section>
    1313. 

  1313.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1314. 

  1314.         <span class="phpdocumentor-signature__response_type">int</span>
    1315. 

  1315.             </section>
    1316. 

  1316. 

  1317. </article>
    1318. 

  1318.                     <article
    1319. 

  1319.         class="phpdocumentor-element
    1320. 

  1320.             -method
    1321. 

  1321.             -public
    1322. 

  1322.                                     -static                    "
    1323. 

  1323. >
    1324. 

  1324.     <h4 class="phpdocumentor-element__name" id="method_testRule4">
    1325. 

  1325.         testRule4()
    1326. 

  1326.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4" class="headerlink"><i class="fas fa-link"></i></a>
    1327. 

  1327. 

  1328.     </h4>
    1329. 

  1329.     <aside class="phpdocumentor-element-found-in">
    1330. 

  1330.     <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>
    1331. 

  1331.     :
    1332. 

  1332.     <span class="phpdocumentor-element-found-in__line">323</span>
    1333. 

  1333. 

  1334.     </aside>
    1335. 

  1335. 

  1336.         <p class="phpdocumentor-summary">Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
    1337. 

  1337. penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance.</p>
    1338. 

  1338. 

  1339.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1340. 

  1340.     <span class="phpdocumentor-signature__visibility">public</span>
    1341. 

  1341.             <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, array&lt;string|int, bool&gt;&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>
    1342. 

  1342. 

  1343.     <div class="phpdocumentor-label-line">
    1344. 

  1344.         </div>
    1345. 

  1345.     
    1346. 

  1346.     
    1347. 

  1347.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1348. 

  1348.     <dl class="phpdocumentor-argument-list">
    1349. 

  1349.                     <dt class="phpdocumentor-argument-list__entry">
    1350. 

  1350.                 <span class="phpdocumentor-signature__argument__name">$matrix</span>
    1351. 

  1351.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
    1352. 

  1352.                             </dt>
    1353. 

  1353.             <dd class="phpdocumentor-argument-list__definition">
    1354. 

  1354.                 
    1355. 

  1355.             </dd>
    1356. 

  1356.                     <dt class="phpdocumentor-argument-list__entry">
    1357. 

  1357.                 <span class="phpdocumentor-signature__argument__name">$height</span>
    1358. 

  1358.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1359. 

  1359.                             </dt>
    1360. 

  1360.             <dd class="phpdocumentor-argument-list__definition">
    1361. 

  1361.                 
    1362. 

  1362.             </dd>
    1363. 

  1363.                     <dt class="phpdocumentor-argument-list__entry">
    1364. 

  1364.                 <span class="phpdocumentor-signature__argument__name">$width</span>
    1365. 

  1365.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1366. 

  1366.                             </dt>
    1367. 

  1367.             <dd class="phpdocumentor-argument-list__definition">
    1368. 

  1368.                 
    1369. 

  1369.             </dd>
    1370. 

  1370.             </dl>
    1371. 

  1371. 

  1372.     
    1373. 

  1373. 

  1374.     
    1375. 

  1375. 

  1376.             <section>
    1377. 

  1377.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1378. 

  1378.         <span class="phpdocumentor-signature__response_type">int</span>
    1379. 

  1379.             </section>
    1380. 

  1380. 

  1381. </article>
    1382. 

  1382.                     <article
    1383. 

  1383.         class="phpdocumentor-element
    1384. 

  1384.             -method
    1385. 

  1385.             -private
    1386. 

  1386.                                     -static                    "
    1387. 

  1387. >
    1388. 

  1388.     <h4 class="phpdocumentor-element__name" id="method_applyRule1">
    1389. 

  1389.         applyRule1()
    1390. 

  1390.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1" class="headerlink"><i class="fas fa-link"></i></a>
    1391. 

  1391. 

  1392.     </h4>
    1393. 

  1393.     <aside class="phpdocumentor-element-found-in">
    1394. 

  1394.     <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>
    1395. 

  1395.     :
    1396. 

  1396.     <span class="phpdocumentor-element-found-in__line">165</span>
    1397. 

  1397. 

  1398.     </aside>
    1399. 

  1399. 

  1400.     
    1401. 

  1401.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1402. 

  1402.     <span class="phpdocumentor-signature__visibility">private</span>
    1403. 

  1403.             <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, bool&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>
    1404. 

  1404. 

  1405.     <div class="phpdocumentor-label-line">
    1406. 

  1406.         </div>
    1407. 

  1407.     
    1408. 

  1408.     
    1409. 

  1409.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1410. 

  1410.     <dl class="phpdocumentor-argument-list">
    1411. 

  1411.                     <dt class="phpdocumentor-argument-list__entry">
    1412. 

  1412.                 <span class="phpdocumentor-signature__argument__name">$rc</span>
    1413. 

  1413.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, bool&gt;</span>
    1414. 

  1414.                             </dt>
    1415. 

  1415.             <dd class="phpdocumentor-argument-list__definition">
    1416. 

  1416.                 
    1417. 

  1417.             </dd>
    1418. 

  1418.             </dl>
    1419. 

  1419. 

  1420.     
    1421. 

  1421. 

  1422.     
    1423. 

  1423. 

  1424.             <section>
    1425. 

  1425.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1426. 

  1426.         <span class="phpdocumentor-signature__response_type">int</span>
    1427. 

  1427.             </section>
    1428. 

  1428. 

  1429. </article>
    1430. 

  1430.                     <article
    1431. 

  1431.         class="phpdocumentor-element
    1432. 

  1432.             -method
    1433. 

  1433.             -private
    1434. 

  1434.                                     -static                    "
    1435. 

  1435. >
    1436. 

  1436.     <h4 class="phpdocumentor-element__name" id="method_isWhiteHorizontal">
    1437. 

  1437.         isWhiteHorizontal()
    1438. 

  1438.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal" class="headerlink"><i class="fas fa-link"></i></a>
    1439. 

  1439. 

  1440.     </h4>
    1441. 

  1441.     <aside class="phpdocumentor-element-found-in">
    1442. 

  1442.     <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>
    1443. 

  1443.     :
    1444. 

  1444.     <span class="phpdocumentor-element-found-in__line">284</span>
    1445. 

  1445. 

  1446.     </aside>
    1447. 

  1447. 

  1448.     
    1449. 

  1449.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1450. 

  1450.     <span class="phpdocumentor-signature__visibility">private</span>
    1451. 

  1451.             <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, bool&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>
    1452. 

  1452. 

  1453.     <div class="phpdocumentor-label-line">
    1454. 

  1454.         </div>
    1455. 

  1455.     
    1456. 

  1456.     
    1457. 

  1457.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1458. 

  1458.     <dl class="phpdocumentor-argument-list">
    1459. 

  1459.                     <dt class="phpdocumentor-argument-list__entry">
    1460. 

  1460.                 <span class="phpdocumentor-signature__argument__name">$row</span>
    1461. 

  1461.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, bool&gt;</span>
    1462. 

  1462.                             </dt>
    1463. 

  1463.             <dd class="phpdocumentor-argument-list__definition">
    1464. 

  1464.                 
    1465. 

  1465.             </dd>
    1466. 

  1466.                     <dt class="phpdocumentor-argument-list__entry">
    1467. 

  1467.                 <span class="phpdocumentor-signature__argument__name">$width</span>
    1468. 

  1468.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1469. 

  1469.                             </dt>
    1470. 

  1470.             <dd class="phpdocumentor-argument-list__definition">
    1471. 

  1471.                 
    1472. 

  1472.             </dd>
    1473. 

  1473.                     <dt class="phpdocumentor-argument-list__entry">
    1474. 

  1474.                 <span class="phpdocumentor-signature__argument__name">$from</span>
    1475. 

  1475.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1476. 

  1476.                             </dt>
    1477. 

  1477.             <dd class="phpdocumentor-argument-list__definition">
    1478. 

  1478.                 
    1479. 

  1479.             </dd>
    1480. 

  1480.                     <dt class="phpdocumentor-argument-list__entry">
    1481. 

  1481.                 <span class="phpdocumentor-signature__argument__name">$to</span>
    1482. 

  1482.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1483. 

  1483.                             </dt>
    1484. 

  1484.             <dd class="phpdocumentor-argument-list__definition">
    1485. 

  1485.                 
    1486. 

  1486.             </dd>
    1487. 

  1487.             </dl>
    1488. 

  1488. 

  1489.     
    1490. 

  1490. 

  1491.     
    1492. 

  1492. 

  1493.             <section>
    1494. 

  1494.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1495. 

  1495.         <span class="phpdocumentor-signature__response_type">bool</span>
    1496. 

  1496.             </section>
    1497. 

  1497. 

  1498. </article>
    1499. 

  1499.                     <article
    1500. 

  1500.         class="phpdocumentor-element
    1501. 

  1501.             -method
    1502. 

  1502.             -private
    1503. 

  1503.                                     -static                    "
    1504. 

  1504. >
    1505. 

  1505.     <h4 class="phpdocumentor-element__name" id="method_isWhiteVertical">
    1506. 

  1506.         isWhiteVertical()
    1507. 

  1507.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical" class="headerlink"><i class="fas fa-link"></i></a>
    1508. 

  1508. 

  1509.     </h4>
    1510. 

  1510.     <aside class="phpdocumentor-element-found-in">
    1511. 

  1511.     <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>
    1512. 

  1512.     :
    1513. 

  1513.     <span class="phpdocumentor-element-found-in__line">302</span>
    1514. 

  1514. 

  1515.     </aside>
    1516. 

  1516. 

  1517.     
    1518. 

  1518.     <code class="phpdocumentor-code phpdocumentor-signature ">
    1519. 

  1519.     <span class="phpdocumentor-signature__visibility">private</span>
    1520. 

  1520.             <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, array&lt;string|int, bool&gt;&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>
    1521. 

  1521. 

  1522.     <div class="phpdocumentor-label-line">
    1523. 

  1523.         </div>
    1524. 

  1524.     
    1525. 

  1525.     
    1526. 

  1526.         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
    1527. 

  1527.     <dl class="phpdocumentor-argument-list">
    1528. 

  1528.                     <dt class="phpdocumentor-argument-list__entry">
    1529. 

  1529.                 <span class="phpdocumentor-signature__argument__name">$matrix</span>
    1530. 

  1530.                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, bool&gt;&gt;</span>
    1531. 

  1531.                             </dt>
    1532. 

  1532.             <dd class="phpdocumentor-argument-list__definition">
    1533. 

  1533.                 
    1534. 

  1534.             </dd>
    1535. 

  1535.                     <dt class="phpdocumentor-argument-list__entry">
    1536. 

  1536.                 <span class="phpdocumentor-signature__argument__name">$height</span>
    1537. 

  1537.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1538. 

  1538.                             </dt>
    1539. 

  1539.             <dd class="phpdocumentor-argument-list__definition">
    1540. 

  1540.                 
    1541. 

  1541.             </dd>
    1542. 

  1542.                     <dt class="phpdocumentor-argument-list__entry">
    1543. 

  1543.                 <span class="phpdocumentor-signature__argument__name">$x</span>
    1544. 

  1544.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1545. 

  1545.                             </dt>
    1546. 

  1546.             <dd class="phpdocumentor-argument-list__definition">
    1547. 

  1547.                 
    1548. 

  1548.             </dd>
    1549. 

  1549.                     <dt class="phpdocumentor-argument-list__entry">
    1550. 

  1550.                 <span class="phpdocumentor-signature__argument__name">$from</span>
    1551. 

  1551.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1552. 

  1552.                             </dt>
    1553. 

  1553.             <dd class="phpdocumentor-argument-list__definition">
    1554. 

  1554.                 
    1555. 

  1555.             </dd>
    1556. 

  1556.                     <dt class="phpdocumentor-argument-list__entry">
    1557. 

  1557.                 <span class="phpdocumentor-signature__argument__name">$to</span>
    1558. 

  1558.                 : <span class="phpdocumentor-signature__argument__return-type">int</span>
    1559. 

  1559.                             </dt>
    1560. 

  1560.             <dd class="phpdocumentor-argument-list__definition">
    1561. 

  1561.                 
    1562. 

  1562.             </dd>
    1563. 

  1563.             </dl>
    1564. 

  1564. 

  1565.     
    1566. 

  1566. 

  1567.     
    1568. 

  1568. 

  1569.             <section>
    1570. 

  1570.         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
    1571. 

  1571.         <span class="phpdocumentor-signature__response_type">bool</span>
    1572. 

  1572.             </section>
    1573. 

  1573. 

  1574. </article>
    1575. 

  1575.             </section>
    1576. 

  1576. 

  1577.         <div class="phpdocumentor-modal" id="source-view">
    1578. 

  1578.     <div class="phpdocumentor-modal-bg" data-exit-button></div>
    1579. 

  1579.     <div class="phpdocumentor-modal-container">
    1580. 

  1580.         <div class="phpdocumentor-modal-content">
    1581. 

  1581.             <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>
    1582. 

  1582.         </div>
    1583. 

  1583.         <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
    1584. 

  1584.     </div>
    1585. 

  1585. </div>
    1586. 

  1586. 

  1587.     <script type="text/javascript">
    1588. 

  1588.         (function () {
    1589. 

  1589.             function loadExternalCodeSnippet(el, url, line) {
    1590. 

  1590.                 Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
    1591. 

  1591.                     const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
    1592. 

  1592.                     const language = 'php';
    1593. 

  1593. 

  1594.                     const code = document.createElement('code');
    1595. 

  1595.                     code.className = 'language-' + language;
    1596. 

  1596.                     pre.textContent = '';
    1597. 

  1597.                     pre.setAttribute('data-line', line)
    1598. 

  1598.                     code.textContent = 'Loading…';
    1599. 

  1599.                     pre.appendChild(code);
    1600. 

  1600. 

  1601.                     var xhr = new XMLHttpRequest();
    1602. 

  1602. 

  1603.                     xhr.open('GET', src, true);
    1604. 

  1604. 

  1605.                     xhr.onreadystatechange = function () {
    1606. 

  1606.                         if (xhr.readyState !== 4) {
    1607. 

  1607.                             return;
    1608. 

  1608.                         }
    1609. 

  1609. 

  1610.                         if (xhr.status < 400 && xhr.responseText) {
    1611. 

  1611.                             code.textContent = xhr.responseText;
    1612. 

  1612.                             Prism.highlightElement(code);
    1613. 

  1613.                             d=document.getElementsByClassName("line-numbers");
    1614. 

  1614.                             d[0].scrollTop = d[0].children[1].offsetTop;
    1615. 

  1615.                             return;
    1616. 

  1616.                         }
    1617. 

  1617. 

  1618.                         if (xhr.status === 404) {
    1619. 

  1619.                             code.textContent = '✖ Error: File could not be found';
    1620. 

  1620.                             return;
    1621. 

  1621.                         }
    1622. 

  1622. 

  1623.                         if (xhr.status >= 400) {
    1624. 

  1624.                             code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
    1625. 

  1625.                             return;
    1626. 

  1626.                         }
    1627. 

  1627. 

  1628.                         code.textContent = '✖ Error: An unknown error occurred';
    1629. 

  1629.                     };
    1630. 

  1630. 

  1631.                     xhr.send(null);
    1632. 

  1632.                 });
    1633. 

  1633.             }
    1634. 

  1634. 

  1635.             const modalButtons = document.querySelectorAll("[data-modal]");
    1636. 

  1636.             const openedAsLocalFile = window.location.protocol === 'file:';
    1637. 

  1637.             if (modalButtons.length > 0 && openedAsLocalFile) {
    1638. 

  1638.                 console.warn(
    1639. 

  1639.                     'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
    1640. 

  1640.                     'browsers block XHR requests when a page is opened this way'
    1641. 

  1641.                 );
    1642. 

  1642.             }
    1643. 

  1643. 

  1644.             modalButtons.forEach(function (trigger) {
    1645. 

  1645.                 if (openedAsLocalFile) {
    1646. 

  1646.                     trigger.setAttribute("hidden", "hidden");
    1647. 

  1647.                 }
    1648. 

  1648. 

  1649.                 trigger.addEventListener("click", function (event) {
    1650. 

  1650.                     event.preventDefault();
    1651. 

  1651.                     const modal = document.getElementById(trigger.dataset.modal);
    1652. 

  1652.                     if (!modal) {
    1653. 

  1653.                         console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
    1654. 

  1654.                         return;
    1655. 

  1655.                     }
    1656. 

  1656.                     modal.classList.add("phpdocumentor-modal__open");
    1657. 

  1657. 

  1658.                     loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
    1659. 

  1659.                     const exits = modal.querySelectorAll("[data-exit-button]");
    1660. 

  1660.                     exits.forEach(function (exit) {
    1661. 

  1661.                         exit.addEventListener("click", function (event) {
    1662. 

  1662.                             event.preventDefault();
    1663. 

  1663.                             modal.classList.remove("phpdocumentor-modal__open");
    1664. 

  1664.                         });
    1665. 

  1665.                     });
    1666. 

  1666.                 });
    1667. 

  1667.             });
    1668. 

  1668.         })();
    1669. 

  1669.     </script>
    1670. 

  1670. 

  1671.     </article>
    1672. 

  1672.                                 </section>
    1673. 

  1673.                 <section class="phpdocumentor-on-this-page__sidebar">
    1674. 

  1674.                                 
    1675. 

  1675.     <section class="phpdocumentor-on-this-page__content">
    1676. 

  1676.         <strong class="phpdocumentor-on-this-page__title">On this page</strong>
    1677. 

  1677. 

  1678.         <ul class="phpdocumentor-list -clean">
    1679. 

  1679.             <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
    1680. 

  1680.             <li>
    1681. 

  1681.                 <ul class="phpdocumentor-list -clean">
    1682. 

  1682.                                         <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-constants">Constants</a></li>
    1683. 

  1683.                                                             <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-properties">Properties</a></li>
    1684. 

  1684.                                                             <li><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#toc-methods">Methods</a></li>
    1685. 

  1685.                                     </ul>
    1686. 

  1686.             </li>
    1687. 

  1687.                             <li class="phpdocumentor-on-this-page-section__title">Constants</li>
    1688. 

  1688.                 <li>
    1689. 

  1689.                     <ul class="phpdocumentor-list -clean">
    1690. 

  1690.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO">AUTO</a></li>
    1691. 

  1691.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_000">PATTERN_000</a></li>
    1692. 

  1692.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_001">PATTERN_001</a></li>
    1693. 

  1693.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_010">PATTERN_010</a></li>
    1694. 

  1694.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_011">PATTERN_011</a></li>
    1695. 

  1695.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_100">PATTERN_100</a></li>
    1696. 

  1696.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_101">PATTERN_101</a></li>
    1697. 

  1697.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_110">PATTERN_110</a></li>
    1698. 

  1698.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERN_111">PATTERN_111</a></li>
    1699. 

  1699.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PATTERNS">PATTERNS</a></li>
    1700. 

  1700.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N1">PENALTY_N1</a></li>
    1701. 

  1701.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N2">PENALTY_N2</a></li>
    1702. 

  1702.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N3">PENALTY_N3</a></li>
    1703. 

  1703.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_PENALTY_N4">PENALTY_N4</a></li>
    1704. 

  1704.                                             </ul>
    1705. 

  1705.                 </li>
    1706. 

  1706.             
    1707. 

  1707.                             <li class="phpdocumentor-on-this-page-section__title">Properties</li>
    1708. 

  1708.                 <li>
    1709. 

  1709.                     <ul class="phpdocumentor-list -clean">
    1710. 

  1710.                                                     <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#property_maskPattern">$maskPattern</a></li>
    1711. 

  1711.                                             </ul>
    1712. 

  1712.                 </li>
    1713. 

  1713.             
    1714. 

  1714.                         <li class="phpdocumentor-on-this-page-section__title">Methods</li>
    1715. 

  1715.             <li>
    1716. 

  1716.                 <ul class="phpdocumentor-list -clean">
    1717. 

  1717.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method___construct">__construct()</a></li>
    1718. 

  1718.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getBestPattern">getBestPattern()</a></li>
    1719. 

  1719.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getMask">getMask()</a></li>
    1720. 

  1720.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_getPattern">getPattern()</a></li>
    1721. 

  1721.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule1">testRule1()</a></li>
    1722. 

  1722.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule2">testRule2()</a></li>
    1723. 

  1723.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule3">testRule3()</a></li>
    1724. 

  1724.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_testRule4">testRule4()</a></li>
    1725. 

  1725.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_applyRule1">applyRule1()</a></li>
    1726. 

  1726.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteHorizontal">isWhiteHorizontal()</a></li>
    1727. 

  1727.                                             <li class=""><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#method_isWhiteVertical">isWhiteVertical()</a></li>
    1728. 

  1728.                                     </ul>
    1729. 

  1729.             </li>
    1730. 

  1730.                     </ul>
    1731. 

  1731.     </section>
    1732. 

  1732. 

  1733.                 </section>
    1734. 

  1734.                             </div>
    1735. 

  1735.             <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
    1736. 

  1736.     <section class="phpdocumentor-search-results__dialog">
    1737. 

  1737.         <header class="phpdocumentor-search-results__header">
    1738. 

  1738.             <h2 class="phpdocumentor-search-results__title">Search results</h2>
    1739. 

  1739.             <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
    1740. 

  1740.         </header>
    1741. 

  1741.         <section class="phpdocumentor-search-results__body">
    1742. 

  1742.             <ul class="phpdocumentor-search-results__entries"></ul>
    1743. 

  1743.         </section>
    1744. 

  1744.     </section>
    1745. 

  1745. </section>
    1746. 

  1746.         </div>
    1747. 

  1747.         <a href="classes/chillerlan-QRCode-Common-MaskPattern.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
    1748. 

  1748. 

  1749.     </main>
    1750. 

  1750. 

  1751.     <script>
    1752. 

  1752.         cssVars({});
    1753. 

  1753.     </script>
    1754. 

  1754.     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
    1755. 

  1755.     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
    1756. 

  1756.     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
    1757. 

  1757.     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
    1758. 

  1758. </body>
    1759. 

  1759. </html>
    1760.