Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 1.12 KB

readme.md

File metadata and controls

44 lines (25 loc) · 1.12 KB
Raw

Postal-code-validator

Validate Formatting of World-Wide Postal Codes according this "List of postal codes" article on Wikipedia

Installation

composer require sirprize/postal-code-validator

Usage

Check If Country Is Supported

use Sirprize\PostalCodeValidator\Validator;

$validator = new Validator();
$validator->hasCountry('CH'); // returns true

Check If Postal Code Is Properly Formatted

use Sirprize\PostalCodeValidator\Validator;

$validator = new Validator();
$validator->isValid('CH', 'usjU87jsdf'); // returns false
$validator->isValid('CH', '3007'); // returns true

Get The Possible Formats For a Specific Country

use Sirprize\PostalCodeValidator\Validator;

$validator = new Validator();
$validator->getFormats('GB'); // returns ['@@## #@@', '@#@ #@@', '@@# #@@', '@@#@ #@@', '@## #@@', '@# #@@']

Formatting

  • # = 0-9
  • @ = a-zA-Z

Country Codes

Postal-code-validator uses ISO 3166 2-letter country codes

License

See LICENSE.