respect-validation/docs/rules/PostalCode.md
Alexandre Gomes Gaigalas ce9608d0a8 Auto update postal code list
- For this particular updater, a list of exceptions to the rules
   downloaded by geonames is included in POSTAL_CODES_EXTRA, for
   cases in which we seem to do better than geonames itself based
   on previous user reports.
 - Added an option to also validate formatting of the postal codes.
 - Combined multiple PR bots into a single one.
2023-02-19 00:19:10 -03:00

44 lines
1 KiB
Markdown

# PostalCode
- `PostalCode(string $countryCode, bool $formatted = false)`
Validates whether the input is a valid postal code or not.
```php
v::postalCode('BR')->validate('02179000'); // true
v::postalCode('BR')->validate('02179-000'); // true
v::postalCode('US')->validate('02179-000'); // false
v::postalCode('US')->validate('55372'); // true
v::postalCode('PL')->validate('99-300'); // true
```
By default, `PostalCode` won't validate the format (puncts, spaces), unless you pass `$formatted = true`:
```php
v::postalCode('BR', true)->validate('02179000'); // false
v::postalCode('BR', true)->validate('02179-000'); // true
```
Message template for this validator includes `{{countryCode}}`.
Extracted from [GeoNames](http://www.geonames.org/).
## 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:
- [CountryCode](CountryCode.md)
- [Iban](Iban.md)