respect-validation/docs/validators/SubdivisionCode.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There'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.
2026-01-13 23:37:06 -07:00

2.1 KiB

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.

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: