respect-validation/docs/validators/SubdivisionCode.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.
2026-01-21 06:28:11 +00:00

2.2 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: