respect-validation/docs/validators/SubdivisionCode.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
Introduces a Markdown linter for checking the Changelog format.

"See Also" was transformed into a section to make it easier to
handle it with the `Content` class. The "Related" linter was
simplified to reflect that change too.

An additional "alignment" parameter was added to markdown table
generators, allowing the padding and headers to be explicitly
marked with a specific left (-1), middle (0) or right(1)
alignment.

Existing files were fixed using the `fix` option after the
changes.
2026-01-26 19:11:00 +00:00

66 lines
2.2 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# 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&#124;trans}} |
| `inverted` | {{subject}} must not be a subdivision code of {{countryName&#124;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