mirror of
https://github.com/Respect/Validation.git
synced 2026-03-18 08:09:51 +01:00
061a3c9c09The method has been renamed some time ago, but I haven't updated the documentation to cause less confusion. Now that I want to start updating the documentation, I switched the default branch on GitHub to the latest stable version, so I assume there will be less confusion in the documentation, and I can start updating the docs for the next version.
44 lines
1 KiB
Markdown
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')->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`:
|
|
|
|
|
|
```php
|
|
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](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)
|