PostalCode.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. <?php
  2. /*
  3. * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
  4. * SPDX-License-Identifier: MIT
  5. */
  6. declare(strict_types=1);
  7. namespace Respect\Validation\Rules;
  8. use Respect\Validation\Exceptions\ComponentException;
  9. use function sprintf;
  10. /**
  11. * Validates whether the input is a valid postal code or not.
  12. *
  13. * @see http://download.geonames.org/export/dump/countryInfo.txt
  14. *
  15. * @author Henrique Moody <henriquemoody@gmail.com>
  16. */
  17. final class PostalCode extends AbstractEnvelope
  18. {
  19. private const DEFAULT_PATTERN = '/^$/';
  20. private const POSTAL_CODES_EXTRA = [
  21. // phpcs:disable Generic.Files.LineLength.TooLong
  22. 'AM' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  23. 'BR' => ['/^\d\d\d\d\d-\d\d\d$/', '/^\d{5}-?\d{3}$/'],
  24. 'EC' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  25. 'GR' => ['/^\d\d\d \d\d$/', '/^(\d{3}\s?\d{2})$/'],
  26. 'GB' => ['/^\w\d \d\w\w|\w\d\d \d\w\w|\w\w\d \d\w\w|\w\w\d\d \d\w\w|\w\d\w \d\w\w|\w\w\d\w \d\w\w|GIR 0AA$/', '/^([Gg][Ii][Rr]\s?0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9]?[A-Za-z]))))\s?[0-9][A-Za-z]{2})$/'],
  27. 'KH' => ['/^\d\d\d\d\d\d?$/', '/^(\d{5,6})$/'],
  28. 'KY' => ['/^KY[1-3]-\d{4}$/', '/^KY[1-3]-?\d{4}$/'],
  29. 'PT' => ['/^\d\d\d\d-\d\d\d$/', '/^\d{4}-?\d{3}\s?[a-zA-Z]{0,25}$/'],
  30. 'RS' => ['/^\d\d\d\d\d\d?$/', '/^(\d{5,6})$/'],
  31. // phpcs:enable Generic.Files.LineLength.TooLong
  32. ];
  33. private const POSTAL_CODES = [
  34. // phpcs:disable Generic.Files.LineLength.TooLong
  35. 'AD' => ['/^AD\d\d\d$/', '/^(?:AD)*(\d{3})$/'],
  36. 'AL' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  37. 'AM' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  38. 'AR' => ['/^\w\d\d\d\d\w\w\w$/', '/^[A-Z]?\d{4}[A-Z]{0,3}$/'],
  39. 'AS' => ['/^\d\d\d\d\d-\d\d\d\d$/', '/96799/'],
  40. 'AT' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  41. 'AU' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  42. 'AX' => ['/^\d\d\d\d\d$/', '/^(?:FI)*(\d{5})$/'],
  43. 'AZ' => ['/^AZ \d\d\d\d$/', '/^(?:AZ)*(\d{4})$/'],
  44. 'BA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  45. 'BB' => ['/^BB\d\d\d\d\d$/', '/^(?:BB)*(\d{5})$/'],
  46. 'BD' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  47. 'BE' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  48. 'BG' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  49. 'BH' => ['/^\d\d\d\d|\d\d\d$/', '/^(\d{3}\d?)$/'],
  50. 'BL' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  51. 'BM' => ['/^\w\w \d\d$/', '/^([A-Z]{2}\d{2})$/'],
  52. 'BN' => ['/^\w\w\d\d\d\d$/', '/^([A-Z]{2}\d{4})$/'],
  53. 'BR' => ['/^\d\d\d\d\d-\d\d\d$/', '/^\d{5}-\d{3}$/'],
  54. 'BY' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  55. 'CA' => ['/^\w\d\w \d\w\d$/', '/^([ABCEGHJKLMNPRSTVXY]\d[ABCEGHJKLMNPRSTVWXYZ]) ?(\d[ABCEGHJKLMNPRSTVWXYZ]\d)$/'],
  56. 'CH' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  57. 'CL' => ['/^\d\d\d\d\d\d\d$/', '/^(\d{7})$/'],
  58. 'CN' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  59. 'CO' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  60. 'CR' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  61. 'CS' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  62. 'CU' => ['/^CP \d\d\d\d\d$/', '/^(?:CP)*(\d{5})$/'],
  63. 'CV' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  64. 'CX' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  65. 'CY' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  66. 'CZ' => ['/^\d\d\d \d\d$/', '/^\d{3}\s?\d{2}$/'],
  67. 'DE' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  68. 'DK' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  69. 'DO' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  70. 'DZ' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  71. 'EC' => ['/^\w\d\d\d\d\w$/', '/^([a-zA-Z]\d{4}[a-zA-Z])$/'],
  72. 'EE' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  73. 'EG' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  74. 'ES' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  75. 'ET' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  76. 'FI' => ['/^\d\d\d\d\d$/', '/^(?:FI)*(\d{5})$/'],
  77. 'FM' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  78. 'FO' => ['/^\d\d\d$/', '/^(?:FO)*(\d{3})$/'],
  79. 'FR' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  80. 'GB' => ['/^\w\d \d\w\w|\w\d\d \d\w\w|\w\w\d \d\w\w|\w\w\d\d \d\w\w|\w\d\w \d\w\w|\w\w\d\w \d\w\w|GIR0AA$/', '/^([Gg][Ii][Rr]\s?0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9]?[A-Za-z]))))\s?[0-9][A-Za-z]{2})$/'],
  81. 'GE' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  82. 'GF' => ['/^\d\d\d\d\d$/', '/^((97|98)3\d{2})$/'],
  83. 'GG' => ['/^\w\d \d\w\w|\w\d\d \d\w\w|\w\w\d \d\w\w|\w\w\d\d \d\w\w|\w\d\w \d\w\w|\w\w\d\w \d\w\w|GIR0AA$/', '/^((?:(?:[A-PR-UWYZ][A-HK-Y]\d[ABEHMNPRV-Y0-9]|[A-PR-UWYZ]\d[A-HJKPS-UW0-9])\s\d[ABD-HJLNP-UW-Z]{2})|GIR\s?0AA)$/'],
  84. 'GL' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  85. 'GP' => ['/^\d\d\d\d\d$/', '/^((97|98)\d{3})$/'],
  86. 'GR' => ['/^\d\d\d \d\d$/', '/^(\d{5})$/'],
  87. 'GT' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  88. 'GU' => ['/^969\d\d$/', '/^(969\d{2})$/'],
  89. 'GW' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  90. 'HN' => ['/^\w\w\d\d\d\d$/', '/^([A-Z]{2}\d{4})$/'],
  91. 'HR' => ['/^\d\d\d\d\d$/', '/^(?:HR)*(\d{5})$/'],
  92. 'HT' => ['/^HT\d\d\d\d$/', '/^(?:HT)*(\d{4})$/'],
  93. 'HU' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  94. 'ID' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  95. 'IE' => ['/^\w\w\w \w\w\w\w$/', '/^(D6W|[AC-FHKNPRTV-Y][0-9]{2})\s?([AC-FHKNPRTV-Y0-9]{4})/'],
  96. 'IL' => ['/^\d\d\d\d\d\d\d$/', '/^(\d{7}|\d{5})$/'],
  97. 'IM' => ['/^\w\d \d\w\w|\w\d\d \d\w\w|\w\w\d \d\w\w|\w\w\d\d \d\w\w|\w\d\w \d\w\w|\w\w\d\w \d\w\w|GIR0AA$/', '/^((?:(?:[A-PR-UWYZ][A-HK-Y]\d[ABEHMNPRV-Y0-9]|[A-PR-UWYZ]\d[A-HJKPS-UW0-9])\s\d[ABD-HJLNP-UW-Z]{2})|GIR\s?0AA)$/'],
  98. 'IN' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  99. 'IQ' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  100. 'IR' => ['/^\d\d\d\d\d\d\d\d\d\d$/', '/^(\d{10})$/'],
  101. 'IS' => ['/^\d\d\d$/', '/^(\d{3})$/'],
  102. 'IT' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  103. 'JE' => ['/^\w\d \d\w\w|\w\d\d \d\w\w|\w\w\d \d\w\w|\w\w\d\d \d\w\w|\w\d\w \d\w\w|\w\w\d\w \d\w\w|GIR0AA$/', '/^((?:(?:[A-PR-UWYZ][A-HK-Y]\d[ABEHMNPRV-Y0-9]|[A-PR-UWYZ]\d[A-HJKPS-UW0-9])\s\d[ABD-HJLNP-UW-Z]{2})|GIR\s?0AA)$/'],
  104. 'JO' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  105. 'JP' => ['/^\d\d\d-\d\d\d\d$/', '/^\d{3}-\d{4}$/'],
  106. 'KE' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  107. 'KG' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  108. 'KH' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  109. 'KP' => ['/^\d\d\d-\d\d\d$/', '/^(\d{6})$/'],
  110. 'KR' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  111. 'KW' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  112. 'KZ' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  113. 'LA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  114. 'LB' => ['/^\d\d\d\d \d\d\d\d|\d\d\d\d$/', '/^(\d{4}(\d{4})?)$/'],
  115. 'LI' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  116. 'LK' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  117. 'LR' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  118. 'LS' => ['/^\d\d\d$/', '/^(\d{3})$/'],
  119. 'LT' => ['/^LT-\d\d\d\d\d$/', '/^(?:LT)*(\d{5})$/'],
  120. 'LU' => ['/^L-\d\d\d\d$/', '/^(?:L-)?\d{4}$/'],
  121. 'LV' => ['/^LV-\d\d\d\d$/', '/^(?:LV)*(\d{4})$/'],
  122. 'MA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  123. 'MC' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  124. 'MD' => ['/^MD-\d\d\d\d$/', '/^MD-\d{4}$/'],
  125. 'ME' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  126. 'MF' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  127. 'MG' => ['/^\d\d\d$/', '/^(\d{3})$/'],
  128. 'MH' => ['/^\d\d\d\d\d-\d\d\d\d$/', '/^969\d{2}(-\d{4})$/'],
  129. 'MK' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  130. 'MM' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  131. 'MN' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  132. 'MP' => ['/^\d\d\d\d\d$/', '/^9695\d{1}$/'],
  133. 'MQ' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  134. 'MT' => ['/^\w\w\w \d\d\d\d$/', '/^[A-Z]{3}\s?\d{4}$/'],
  135. 'MV' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  136. 'MW' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  137. 'MX' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  138. 'MY' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  139. 'MZ' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  140. 'NC' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  141. 'NE' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  142. 'NF' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  143. 'NG' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  144. 'NI' => ['/^\d\d\d-\d\d\d-\d$/', '/^(\d{7})$/'],
  145. 'NL' => ['/^\d\d\d\d \w\w$/', '/^(\d{4}\s?[a-zA-Z]{2})$/'],
  146. 'NO' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  147. 'NP' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  148. 'NZ' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  149. 'OM' => ['/^\d\d\d$/', '/^(\d{3})$/'],
  150. 'PE' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  151. 'PF' => ['/^\d\d\d\d\d$/', '/^((97|98)7\d{2})$/'],
  152. 'PG' => ['/^\d\d\d$/', '/^(\d{3})$/'],
  153. 'PH' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  154. 'PK' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  155. 'PL' => ['/^\d\d-\d\d\d$/', '/^\d{2}-\d{3}$/'],
  156. 'PM' => ['/^\d\d\d\d\d$/', '/^(97500)$/'],
  157. 'PR' => ['/^\d\d\d\d\d-\d\d\d\d$/', '/^00[679]\d{2}(?:-\d{4})?$/'],
  158. 'PT' => ['/^\d\d\d\d-\d\d\d$/', '/^\d{4}-\d{3}\s?[a-zA-Z]{0,25}$/'],
  159. 'PW' => ['/^96940$/', '/^(96940)$/'],
  160. 'PY' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  161. 'RE' => ['/^\d\d\d\d\d$/', '/^((97|98)(4|7|8)\d{2})$/'],
  162. 'RO' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  163. 'RS' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  164. 'RU' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  165. 'SA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  166. 'SD' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  167. 'SE' => ['/^\d\d\d \d\d$/', '/^(?:SE)?\d{3}\s\d{2}$/'],
  168. 'SG' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  169. 'SH' => ['/^STHL 1ZZ$/', '/^(STHL1ZZ)$/'],
  170. 'SI' => ['/^\d\d\d\d$/', '/^(?:SI)*(\d{4})$/'],
  171. 'SJ' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  172. 'SK' => ['/^\d\d\d \d\d$/', '/^\d{3}\s?\d{2}$/'],
  173. 'SM' => ['/^4789\d$/', '/^(4789\d)$/'],
  174. 'SN' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  175. 'SO' => ['/^\w\w \d\d\d\d\d$/', '/^([A-Z]{2}\d{5})$/'],
  176. 'SV' => ['/^CP \d\d\d\d$/', '/^(?:CP)*(\d{4})$/'],
  177. 'SZ' => ['/^\w\d\d\d$/', '/^([A-Z]\d{3})$/'],
  178. 'TC' => ['/^TKCA 1ZZ$/', '/^(TKCA 1ZZ)$/'],
  179. 'TH' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  180. 'TJ' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  181. 'TM' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  182. 'TN' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  183. 'TR' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  184. 'TW' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  185. 'UA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  186. 'US' => ['/^\d\d\d\d\d-\d\d\d\d$/', '/^\d{5}(-\d{4})?$/'],
  187. 'UY' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  188. 'UZ' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  189. 'VA' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  190. 'VE' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  191. 'VI' => ['/^\d\d\d\d\d-\d\d\d\d$/', '/^008\d{2}(?:-\d{4})?$/'],
  192. 'VN' => ['/^\d\d\d\d\d\d$/', '/^(\d{6})$/'],
  193. 'WF' => ['/^\d\d\d\d\d$/', '/^(986\d{2})$/'],
  194. 'YT' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  195. 'ZA' => ['/^\d\d\d\d$/', '/^(\d{4})$/'],
  196. 'ZM' => ['/^\d\d\d\d\d$/', '/^(\d{5})$/'],
  197. // phpcs:disable Generic.Files.LineLength.TooLong
  198. ];//end
  199. public function __construct(string $countryCode, bool $formatted = false)
  200. {
  201. $countryCodeRule = new CountryCode();
  202. if (!$countryCodeRule->validate($countryCode)) {
  203. throw new ComponentException(sprintf('Cannot validate postal code from "%s" country', $countryCode));
  204. }
  205. parent::__construct(
  206. new Regex(
  207. self::POSTAL_CODES_EXTRA[$countryCode][$formatted ? 0 : 1] ?? self::POSTAL_CODES[$countryCode][$formatted ? 0 : 1] ?? self::DEFAULT_PATTERN
  208. ),
  209. ['countryCode' => $countryCode]
  210. );
  211. }
  212. }