Getting Started

Postal Code is a PHP library for validating postal/ZIP codes for countries worldwide.

Installation

composer require cline/postal-code

Basic Usage

use Cline\PostalCode\PostalCode;

// Validate a postal code
$result = PostalCode::validate('90210', 'US');
$result->isValid(); // true

// UK postal code
$result = PostalCode::validate('SW1A 1AA', 'GB');
$result->isValid(); // true

// German postal code
$result = PostalCode::validate('10115', 'DE');
$result->isValid(); // true

Quick Validation

use Cline\PostalCode\PostalCode;

// Returns boolean
PostalCode::isValid('90210', 'US'); // true
PostalCode::isValid('invalid', 'US'); // false

// With exception on invalid
PostalCode::validateOrFail('90210', 'US'); // Returns result
PostalCode::validateOrFail('invalid', 'US'); // Throws exception

Supported Countries

use Cline\PostalCode\PostalCode;

// Get all supported country codes
$countries = PostalCode::getSupportedCountries();
// ["AD", "AE", "AF", "AG", ...]

// Check if country is supported
PostalCode::isCountrySupported('US'); // true
PostalCode::isCountrySupported('XX'); // false

Formatting

$result = PostalCode::validate('sw1a1aa', 'GB');

// Get formatted version
$result->formatted(); // "SW1A 1AA"

// Original input
$result->input(); // "sw1a1aa"

Next Steps

• Basic Usage - Validation patterns
• Custom Handlers - Add custom validators
• Exception Handling - Handle validation errors
• Laravel Integration - Use with Laravel