respect-validation/docs/rules/SubdivisionCode.md
Henrique Moody 0c07060a04
Rename "Consecutive" to "Circuit"
The "Consecutive" rule is now renamed to "Circuit" to better reflect its
behavior of stopping at the first failure. I also favour this name
because it's much shorter.
2024-12-20 16:53:56 +01:00

59 lines
2 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
```
## Templates
### `SubdivisionCode::TEMPLATE_STANDARD`
| Mode | Template |
|------------|-----------------------------------------------------------------------|
| `default` | {{name}} must be a subdivision code of {{countryName|trans}} |
| `inverted` | {{name}} must not be a subdivision code of {{countryName|trans}} |
## Template placeholders
| Placeholder | Description |
|---------------|------------------------------------------------------------------|
| `countryName` | |
| `name` | The validated input or the custom validator name (if specified). |
## 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:
- [Circuit](Circuit.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