respect-validation/docs/rules/CountryCode.md
Henrique Moody 061a3c9c09
Rename method "validate()" to "isValid()"
The method has been renamed some time ago, but I haven't updated the
documentation to cause less confusion. Now that I want to start updating
the documentation, I switched the default branch on GitHub to the latest
stable version, so I assume there will be less confusion in the
documentation, and I can start updating the docs for the next version.
2024-12-02 22:11:57 +01:00

1.3 KiB

CountryCode

  • CountryCode()
  • CountryCode("alpha-2"|"alpha-3"|"numeric" $set)

Validates whether the input is a country code in ISO 3166-1 standard.

This rule requires sokil/php-isocodes and sokil/php-isocodes-db-only to be installed.

v::countryCode()->isValid('BR'); // true

v::countryCode('alpha-2')->isValid('NL'); // true
v::countryCode('alpha-3')->isValid('USA'); // true
v::countryCode('numeric')->isValid('504'); // true

This rule supports the three sets of country codes:

  • ISO 3166-1 alpha-2: alpha-2
  • ISO 3166-1 alpha-3: alpha-3
  • ISO 3166-1 numeric: numeric

When no set is defined, the rule uses 'alpha-2' (CountryCode::ALPHA2).

Categorization

  • ISO codes
  • Localization

Changelog

Version Description
3.0.0 Require sokil/php-isocodes and sokil/php-isocodes-db-only
2.0.0 Became case-sensitive
0.5.0 Created

See also: