respect-validation/docs/rules/SubdivisionCode.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

43 lines
1.1 KiB
Markdown

# SubdivisionCode
- `SubdivisionCode(string $countryCode)`
Validates subdivision country codes according to [ISO 3166-2][].
The `$countryCode` must be a country in [ISO 3166-1 alpha-2][] format.
**This rule requires [sokil/php-isocodes][] and [php-isocodes-db-only][] to be installed.**
```php
v::subdivisionCode('BR')->isValid('SP'); // true
v::subdivisionCode('US')->isValid('CA'); // true
```
## Categorization
- ISO codes
- Localization
## Changelog
Version | Description
--------|-------------
3.0.0 | Require [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][]
1.0.0 | Created
***
See also:
- [Consecutive](Consecutive.md)
- [CountryCode](CountryCode.md)
- [CurrencyCode](CurrencyCode.md)
- [Nip](Nip.md)
- [Pesel](Pesel.md)
- [PolishIdCard](PolishIdCard.md)
- [PublicDomainSuffix](PublicDomainSuffix.md)
- [Tld](Tld.md)
[ISO 3166-1 alpha-2]: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 "ISO 3166-1 alpha-2"
[ISO 3166-2]: http://en.wikipedia.org/wiki/ISO_3166-2 "ISO 3166-2"
[sokil/php-isocodes]: https://github.com/sokil/php-isocodes
[sokil/php-isocodes-db-only]: https://github.com/sokil/php-isocodes-db-only