Download the PHP package barbieswimcrew/zip-code-validator without Composer
On this page you can find all versions of the php package barbieswimcrew/zip-code-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download barbieswimcrew/zip-code-validator
More information about barbieswimcrew/zip-code-validator
Files in barbieswimcrew/zip-code-validator
Package zip-code-validator
Short Description Constraint class for international zipcode validation
License MIT
Informations about the package zip-code-validator
Constraint Class for international Zipcode Validation
Installation
This package uses Composer, please checkout the composer website for more information.
The following command will install zip-code-validator
into your project. It will also add a new entry in your composer.json
and update the composer.lock
as well.
This package follows the PSR-4 convention names for its classes, which means you can easily integrate
zip-code-validator
classes loading in your own autoloader.
What now?
For validating a zip code you need to instantiate a new ZipCode class provided by this package to set it as a constraint to your form field, for example:
Another way would be to use the constraint as an annotation of a class property, for example:
You can also use it as a PHP8 Attribute, with parameters passed as an array of options, for example:
Please consider to inject a valid ISO 3166 2-letter country code (e.g. DE, US, FR)!
NOTE: This library validates against known zip code regex patterns and does not validate the existence of a zipcode.
Use a getter to inject the country code dynamically
If you have a form, in which the user can select a country, you may want to validate the zip code dynamically.
In this case you can use the getter
option instead:
To disable that the validator throws an exception, when the zip code pattern is not available for a country,
you can set the strict
option to FALSE
.
The validator will not validate empty strings and null values. To disallow them use the Symfony stock NotNull
or NotBlank
constraint in addition to ZipCode
.
Case insensitive zip code matching
In case you want to match the zip code in a case insensitive way you have to pass a caseSensitiveCheck
parameter with false
value via the constructor:
By the default the library is using case sensitive zip code matching.
Copying / License
This repository is distributed under the MIT License (MIT). You can find the whole license text in the LICENSE file.