respect-validation/docs/rules/PostalCode.md
Henrique Moody 9740e24007
Prepare library for the next major version
Version 3.0 will include a few crucial deprecations. This commit adds
some soft deprecations to warn users about these changes.

Some of the biggest changes are:

* The method `validate()` will be renamed to `isValid()`.

* The method `validate()` will be repurposed to return an object with
  failures.

* It won't be possible to handle rules directly; users will need to use
  the `Validator` class to validate with any rule.

There will some more changes, but those are some of the most important
ones, and are the ones that are easy to deprecate right now.
2025-01-07 00:56:42 +01:00

1 KiB

PostalCode

  • PostalCode(string $countryCode, bool $formatted = false)

Validates whether the input is a valid postal code or not.

v::postalCode('BR')->isValid('02179000'); // true
v::postalCode('BR')->isValid('02179-000'); // true
v::postalCode('US')->isValid('02179-000'); // false
v::postalCode('US')->isValid('55372'); // true
v::postalCode('PL')->isValid('99-300'); // true

By default, PostalCode won't validate the format (puncts, spaces), unless you pass $formatted = true:

v::postalCode('BR', true)->isValid('02179000'); // false
v::postalCode('BR', true)->isValid('02179-000'); // true

Message template for this validator includes {{countryCode}}.

Extracted from GeoNames.

Categorization

  • Localization
  • Strings

Changelog

Version Description
2.3.0 Add option to validate formatting
2.2.4 Cambodian postal codes now support 5 and 6 digits
0.7.0 Created

See also: