AIFormatter.php

<?php

declare(strict_types=1);

namespace Brick\Postcode\Formatter;

use Brick\Postcode\CountryPostcodeFormatter;

/**
 * Validates and formats postcodes in Anguilla.
 *
 * Anguilla uses a single postcode for all addresses.
 * This formatter accepts both the digits 2640, and the full postcode AI2640.
 *
 * @see https://en.wikipedia.org/wiki/List_of_postal_codes
 */
final class AIFormatter implements CountryPostcodeFormatter
{
    public function hint(): string
    {
        return 'Anguilla uses a single postcode for all addresses.';
    }

    public function format(string $postcode): ?string
    {
        if ($postcode === '2640' || $postcode === 'AI2640') {
            return 'AI-2640';
        }

        return null;
    }
}