mirror of https://github.com/Respect/Validation.git synced 2026-03-16 07:15:45 +01:00

Henrique Moody be72a54845

Add templates to each rule documentation

They only know what message a rule produces when they try running it.
Including the messages in the documentation will make it easier for
people to know what to expect.

There are a couple of undocumented placeholders, but I can live with
that for now.

2024-12-06 00:21:47 +01:00

1.9 KiB

Raw Blame History

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.

Templates

PostalCode::TEMPLATE_STANDARD

Mode	Template
`default`	{{name}} must be a valid postal code on {{countryCode}}
`inverted`	{{name}} must not be a valid postal code on {{countryCode}}

Template placeholders

Placeholder	Description
`countryCode`
`name`	The validated input or the custom validator name (if specified).

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

1.9 KiB Raw Blame History