mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 23:05:45 +01:00
d2198dfd01There's more value on showing how `assert()` displays the validation messages than simply showing if `isValid()` returns `true` or `false`. However, that increases the chances of having outdated documentation, so I created a doc linter that updates the Markdown files with the correct message.
63 lines
2.1 KiB
Markdown
63 lines
2.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 validator requires [sokil/php-isocodes][] and [php-isocodes-db-only][] to be installed.**
|
|
|
|
```php
|
|
v::subdivisionCode('BR')->assert('SP');
|
|
// Validation passes successfully
|
|
|
|
v::subdivisionCode('US')->assert('CA');
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `SubdivisionCode::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------- | ------------------------------------------------------------------------ |
|
|
| `default` | {{subject}} must be a subdivision code of {{countryName|trans}} |
|
|
| `inverted` | {{subject}} must not be a subdivision code of {{countryName|trans}} |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ------------- | ---------------------------------------------------------------- |
|
|
| `countryName` | |
|
|
| `subject` | 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
|