ContextQMD
Back to Validation

CountryCode

docs/validators/CountryCode.md

3.1.12.5 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> SPDX-FileContributor: William Espindola <[email protected]> -->

CountryCode

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

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

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

php
v::countryCode()->assert('BR');
// Validation passes successfully

v::countryCode('alpha-2')->assert('NL');
// Validation passes successfully

v::countryCode('alpha-3')->assert('USA');
// Validation passes successfully

v::countryCode('numeric')->assert('504');
// Validation passes successfully

This validator 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 validator uses 'alpha-2' (CountryCode::ALPHA2).

Templates

CountryCode::TEMPLATE_STANDARD

ModeTemplate
default{{subject}} must be a country code
inverted{{subject}} must not be a country code

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • ISO codes
  • Localization

Changelog

VersionDescription
3.0.0Templates changed
3.0.0Require sokil/php-isocodes and sokil/php-isocodes-db-only
2.0.0Became case-sensitive
0.5.0Created

See Also