respect-validation/docs/rules/CountryCode.md

# CountryCode

- `CountryCode()`
- `CountryCode(string $set)`

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

```php
v::countryCode()->validate('BR'); // true

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

This rule supports the three sets of country codes:

- ISO 3166-1 alpha-2 (`'alpha-2'` or `CountryCode::ALPHA2`)
- ISO 3166-1 alpha-3 (`'alpha-3'` or `CountryCode::ALPHA3`)
- ISO 3166-1 numeric (`'numeric'` or `CountryCode::NUMERIC`).

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

This rules uses data from [iso-codes][].

## Categorization

- ISO codes
- Localization

## Changelog

Version | Description
--------|-------------
  2.0.0 | Became case-sensitive
  0.5.0 | Created

***
See also:

- [CurrencyCode](CurrencyCode.md)
- [LanguageCode](LanguageCode.md)
- [PostalCode](PostalCode.md)
- [PublicDomainSuffix](PublicDomainSuffix.md)
- [SubdivisionCode](SubdivisionCode.md)
- [Tld](Tld.md)

[ISO 3166-1]: https://wikipedia.org/wiki/ISO_3166-1
[iso-codes]: https://salsa.debian.org/iso-codes-team/iso-codes
Update documentation 2015-01-30 09:40:06 +01:00			`# CountryCode`

Change how documentation of rules are presented Rules are not always used from the alias `v`, neither called staticaly. 2017-03-27 14:47:07 +02:00			- `CountryCode()`
Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00			- `CountryCode(string $set)`
Update documentation 2015-01-30 09:40:06 +01:00
Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00			`Validates whether the input is a country code in [ISO 3166-1][] standard.`
Update documentation 2015-01-30 09:40:06 +01:00
			```php
Documentation improvements - Add a space after comments with `//`; - Add missing "See also" sections in some files 2015-10-20 02:53:25 +02:00			`v::countryCode()->validate('BR'); // true`
Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00
			`v::countryCode('alpha-2')->validate('NL'); // true`
			`v::countryCode('alpha-3')->validate('USA'); // true`
			`v::countryCode('numeric')->validate('504'); // true`
Update documentation 2015-01-30 09:40:06 +01:00			```

Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00			`This rule supports the three sets of country codes:`

			- ISO 3166-1 alpha-2 (`'alpha-2'` or `CountryCode::ALPHA2`)
			- ISO 3166-1 alpha-3 (`'alpha-3'` or `CountryCode::ALPHA3`)
			- ISO 3166-1 numeric (`'numeric'` or `CountryCode::NUMERIC`).

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

Revert "Use "sokil/php-isocodes" on CountryCode" This reverts commit 2060207f44bde9cae6f42c3d13c777b011b4de01. 2021-03-19 14:59:26 +01:00			`This rules uses data from [iso-codes][].`
Update list of Country Codes To update the list of countries, I decided to use the iso-codes [1] instead of GeoNames [2] as it seems like that one is more often updated. This commit will also create a Bash script to update that list in the future. [1]: https://salsa.debian.org/iso-codes-team/iso-codes [2]: http://www.geonames.org/ Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-05-26 14:41:29 +02:00
Add "Categorization" section to rule documentations Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-05-11 18:32:13 +02:00			`## Categorization`

			`- ISO codes`
			`- Localization`

Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			`## Changelog`

			`Version \| Description`
			`--------\|-------------`
Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00			`2.0.0 \| Became case-sensitive`
Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			`0.5.0 \| Created`

Standard for "See also:" on documentation 2015-08-20 06:38:41 +02:00			`***`
Update documentation 2015-01-30 09:40:06 +01:00			`See also:`

Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [CurrencyCode](CurrencyCode.md)`
			`- [LanguageCode](LanguageCode.md)`
			`- [PostalCode](PostalCode.md)`
Fix broken documentation links Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2024-02-19 11:23:29 +01:00			`- [PublicDomainSuffix](PublicDomainSuffix.md)`
Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [SubdivisionCode](SubdivisionCode.md)`
Uniform Markdown lists on documentation 2017-03-28 11:53:14 +02:00			`- [Tld](Tld.md)`
Apply contribution guidelines to "CountryCode" rule The "AbstractSearcher" already does most of the job that "CountryCode" was doing, so using it as parent class made more sense. That also makes the validation case-sensitive which is not a problem since the standard ISO 3166-1 in fact enforces an specific case for the country codes. The documentation about the rule is also updated. Co-Authored-By: Henrique Moody <henriquemoody@gmail.com> 2018-06-13 05:01:03 +02:00
			`[ISO 3166-1]: https://wikipedia.org/wiki/ISO_3166-1`
Revert "Use "sokil/php-isocodes" on CountryCode" This reverts commit 2060207f44bde9cae6f42c3d13c777b011b4de01. 2021-03-19 14:59:26 +01:00			`[iso-codes]: https://salsa.debian.org/iso-codes-team/iso-codes`