├── .github
    ├── FUNDING.yml
    └── workflows
    │   └── ci.yml
├── LICENSE
├── composer.json
├── psalm.xml
└── src
    ├── CountryPostcodeFormatter.php
    ├── FormatHelper
        └── StripPrefix.php
    ├── Formatter
        ├── ADFormatter.php
        ├── AFFormatter.php
        ├── AIFormatter.php
        ├── ALFormatter.php
        ├── AMFormatter.php
        ├── AQFormatter.php
        ├── ARFormatter.php
        ├── ASFormatter.php
        ├── ATFormatter.php
        ├── AUFormatter.php
        ├── AXFormatter.php
        ├── AZFormatter.php
        ├── BAFormatter.php
        ├── BBFormatter.php
        ├── BDFormatter.php
        ├── BEFormatter.php
        ├── BGFormatter.php
        ├── BHFormatter.php
        ├── BLFormatter.php
        ├── BMFormatter.php
        ├── BNFormatter.php
        ├── BRFormatter.php
        ├── BTFormatter.php
        ├── BYFormatter.php
        ├── CAFormatter.php
        ├── CCFormatter.php
        ├── CHFormatter.php
        ├── CLFormatter.php
        ├── CNFormatter.php
        ├── COFormatter.php
        ├── CRFormatter.php
        ├── CUFormatter.php
        ├── CVFormatter.php
        ├── CXFormatter.php
        ├── CYFormatter.php
        ├── CZFormatter.php
        ├── DEFormatter.php
        ├── DKFormatter.php
        ├── DOFormatter.php
        ├── DZFormatter.php
        ├── ECFormatter.php
        ├── EEFormatter.php
        ├── EGFormatter.php
        ├── ESFormatter.php
        ├── ETFormatter.php
        ├── FIFormatter.php
        ├── FKFormatter.php
        ├── FMFormatter.php
        ├── FOFormatter.php
        ├── FRFormatter.php
        ├── GBFormatter.php
        ├── GEFormatter.php
        ├── GFFormatter.php
        ├── GGFormatter.php
        ├── GIFormatter.php
        ├── GLFormatter.php
        ├── GNFormatter.php
        ├── GPFormatter.php
        ├── GRFormatter.php
        ├── GSFormatter.php
        ├── GTFormatter.php
        ├── GUFormatter.php
        ├── GWFormatter.php
        ├── HNFormatter.php
        ├── HRFormatter.php
        ├── HTFormatter.php
        ├── HUFormatter.php
        ├── ICFormatter.php
        ├── IDFormatter.php
        ├── IEFormatter.php
        ├── ILFormatter.php
        ├── IMFormatter.php
        ├── INFormatter.php
        ├── IOFormatter.php
        ├── IQFormatter.php
        ├── IRFormatter.php
        ├── ISFormatter.php
        ├── ITFormatter.php
        ├── JEFormatter.php
        ├── JOFormatter.php
        ├── JPFormatter.php
        ├── KEFormatter.php
        ├── KGFormatter.php
        ├── KHFormatter.php
        ├── KRFormatter.php
        ├── KWFormatter.php
        ├── KYFormatter.php
        ├── KZFormatter.php
        ├── LAFormatter.php
        ├── LBFormatter.php
        ├── LCFormatter.php
        ├── LIFormatter.php
        ├── LKFormatter.php
        ├── LRFormatter.php
        ├── LSFormatter.php
        ├── LTFormatter.php
        ├── LUFormatter.php
        ├── LVFormatter.php
        ├── MAFormatter.php
        ├── MCFormatter.php
        ├── MDFormatter.php
        ├── MEFormatter.php
        ├── MFFormatter.php
        ├── MGFormatter.php
        ├── MHFormatter.php
        ├── MKFormatter.php
        ├── MMFormatter.php
        ├── MNFormatter.php
        ├── MPFormatter.php
        ├── MQFormatter.php
        ├── MSFormatter.php
        ├── MTFormatter.php
        ├── MUFormatter.php
        ├── MVFormatter.php
        ├── MXFormatter.php
        ├── MYFormatter.php
        ├── MZFormatter.php
        ├── NCFormatter.php
        ├── NEFormatter.php
        ├── NFFormatter.php
        ├── NGFormatter.php
        ├── NIFormatter.php
        ├── NLFormatter.php
        ├── NOFormatter.php
        ├── NPFormatter.php
        ├── NZFormatter.php
        ├── OMFormatter.php
        ├── PAFormatter.php
        ├── PEFormatter.php
        ├── PFFormatter.php
        ├── PGFormatter.php
        ├── PHFormatter.php
        ├── PKFormatter.php
        ├── PLFormatter.php
        ├── PMFormatter.php
        ├── PNFormatter.php
        ├── PRFormatter.php
        ├── PSFormatter.php
        ├── PTFormatter.php
        ├── PWFormatter.php
        ├── PYFormatter.php
        ├── REFormatter.php
        ├── ROFormatter.php
        ├── RSFormatter.php
        ├── RUFormatter.php
        ├── SAFormatter.php
        ├── SDFormatter.php
        ├── SEFormatter.php
        ├── SGFormatter.php
        ├── SHFormatter.php
        ├── SIFormatter.php
        ├── SJFormatter.php
        ├── SKFormatter.php
        ├── SMFormatter.php
        ├── SNFormatter.php
        ├── SVFormatter.php
        ├── SZFormatter.php
        ├── TCFormatter.php
        ├── TFFormatter.php
        ├── THFormatter.php
        ├── TJFormatter.php
        ├── TMFormatter.php
        ├── TNFormatter.php
        ├── TRFormatter.php
        ├── TTFormatter.php
        ├── TWFormatter.php
        ├── TZFormatter.php
        ├── UAFormatter.php
        ├── USFormatter.php
        ├── UYFormatter.php
        ├── UZFormatter.php
        ├── VAFormatter.php
        ├── VCFormatter.php
        ├── VEFormatter.php
        ├── VGFormatter.php
        ├── VIFormatter.php
        ├── VNFormatter.php
        ├── WFFormatter.php
        ├── WSFormatter.php
        ├── YTFormatter.php
        ├── ZAFormatter.php
        └── ZMFormatter.php
    ├── InvalidPostcodeException.php
    ├── PostcodeFormatter.php
    └── UnknownCountryException.php


/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: BenMorel
2 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | 
 3 | on:
 4 |   push:
 5 |   pull_request:
 6 | 
 7 | env:
 8 |   PSALM_PHP_VERSION: "8.4"
 9 |   COVERAGE_PHP_VERSION: "8.4"
10 | 
11 | jobs:
12 |   phpunit:
13 |     name: PHPUnit
14 |     runs-on: ubuntu-latest
15 | 
16 |     strategy:
17 |       fail-fast: false
18 |       matrix:
19 |         php-version:
20 |           - "8.1"
21 |           - "8.2"
22 |           - "8.3"
23 |           - "8.4"
24 |         deps:
25 |           - "highest"
26 |         include:
27 |           - php-version: "8.1"
28 |             deps: "lowest"
29 | 
30 |     steps:
31 |       - name: Checkout
32 |         uses: actions/checkout@v4
33 | 
34 |       - name: Setup PHP
35 |         uses: shivammathur/setup-php@v2
36 |         with:
37 |           php-version: ${{ matrix.php-version }}
38 |           coverage: pcov
39 | 
40 |       - name: Install composer dependencies
41 |         uses: ramsey/composer-install@v3
42 |         with:
43 |           dependency-versions: ${{ matrix.deps }}
44 | 
45 |       - name: Run PHPUnit
46 |         run: vendor/bin/phpunit
47 |         if: ${{ matrix.php-version != env.COVERAGE_PHP_VERSION }}
48 | 
49 |       - name: Run PHPUnit with coverage
50 |         run: |
51 |           mkdir -p build/logs
52 |           vendor/bin/phpunit --coverage-clover build/logs/clover.xml
53 |         if: ${{ matrix.php-version == env.COVERAGE_PHP_VERSION }}
54 | 
55 |       - name: Upload coverage report to Coveralls
56 |         run: vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml -v
57 |         env:
58 |           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59 |         if: ${{ matrix.php-version == env.COVERAGE_PHP_VERSION }}
60 | 
61 |   psalm:
62 |     name: Psalm
63 |     runs-on: ubuntu-latest
64 | 
65 |     steps:
66 |       - name: Checkout
67 |         uses: actions/checkout@v4
68 | 
69 |       - name: Setup PHP
70 |         uses: shivammathur/setup-php@v2
71 |         with:
72 |           php-version: ${{ env.PSALM_PHP_VERSION }}
73 | 
74 |       - name: Install composer dependencies
75 |         uses: ramsey/composer-install@v3
76 | 
77 |       - name: Run Psalm
78 |         run: vendor/bin/psalm --no-progress
79 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2013-present Benjamin Morel
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "brick/postcode",
 3 |   "description": "A library to format and validate postcodes",
 4 |   "type": "library",
 5 |   "keywords": [
 6 |     "Brick",
 7 |     "Postcode"
 8 |   ],
 9 |   "license": "MIT",
10 |   "require": {
11 |     "php": "^8.1"
12 |   },
13 |   "require-dev": {
14 |     "phpunit/phpunit": "^9.0",
15 |     "php-coveralls/php-coveralls": "^2.0",
16 |     "vimeo/psalm": "6.3.0"
17 |   },
18 |   "autoload": {
19 |     "psr-4": {
20 |       "Brick\\Postcode\\": "src/"
21 |     }
22 |   },
23 |   "autoload-dev": {
24 |     "psr-4": {
25 |       "Brick\\Postcode\\Tests\\": "tests/"
26 |     }
27 |   }
28 | }
29 | 


--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <psalm
 3 |     errorLevel="1"
 4 |     resolveFromConfigFile="true"
 5 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6 |     xmlns="https://getpsalm.org/schema/config"
 7 |     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 8 |     findUnusedBaselineEntry="true"
 9 |     findUnusedPsalmSuppress="true"
10 |     findUnusedCode="false"
11 | >
12 |     <projectFiles>
13 |         <directory name="src" />
14 |         <ignoreFiles>
15 |             <directory name="vendor" />
16 |         </ignoreFiles>
17 |     </projectFiles>
18 | </psalm>
19 | 


--------------------------------------------------------------------------------
/src/CountryPostcodeFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode;
 6 | 
 7 | /**
 8 |  * Validates and formats postcodes for a country.
 9 |  *
10 |  * If the implementation defines a constructor, this must not take any parameters.
11 |  */
12 | interface CountryPostcodeFormatter
13 | {
14 |     /**
15 |      * Validates and formats the given postcode.
16 |      *
17 |      * The postcode must be a non-empty string of uppercase alphanumeric characters, with no separator.
18 |      *
19 |      * @param string $postcode The postcode to format.
20 |      *
21 |      * @return string|null The formatted postcode, or NULL if the postcode is invalid.
22 |      */
23 |     public function format(string $postcode) : ?string;
24 | }
25 | 


--------------------------------------------------------------------------------
/src/FormatHelper/StripPrefix.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\FormatHelper;
 6 | 
 7 | /**
 8 |  * Strip country code prefix from postalcode if it is valid.
 9 |  *
10 |  * In some countries like Belgium or Luxembourg its common to provide a country code prefix in a postalcode,
11 |  * Although the format is incorrect, many government agencies, businesses and people still use this.
12 |  * Rather than failing this format into an exception, this helper class strips the prefix off before validating it,
13 |  * Thus providing you with the correct format without the country code prefix in it.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Belgium
16 |  *
17 |  * @internal
18 |  */
19 | trait StripPrefix
20 | {
21 |     /**
22 |      * @param string $postcode
23 |      * @param string $prefix
24 |      * @return string
25 |      */
26 |     public function stripPrefix(string $postcode, string $prefix): string
27 |     {
28 |         $prefixLength = strlen($prefix);
29 | 
30 |         if (substr($postcode, 0, $prefixLength) === $prefix) {
31 |             $postcode = substr($postcode, $prefixLength);
32 |         }
33 | 
34 |         return $postcode;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Formatter/ADFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Andorra.
11 |  *
12 |  * Postcodes consist of the letters AD, followed by 3 digits, without separator.
13 |  * This formatter accepts the 3 digits with and without the AD prefix, and always outputs with the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Andorra
17 |  */
18 | final class ADFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (str_starts_with($postcode, 'AD')) {
23 |             $postcode = substr($postcode, 2);
24 |         }
25 | 
26 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return 'AD' . $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/AFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Afghanistan.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * The first two digits (ranging from 10–43) correspond to the province,
15 |  * while the last two digits correspond either to the city/delivery zone (range 01–50)
16 |  * or to the district/delivery zone (range 51–99).
17 |  *
18 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
19 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Afghanistan
20 |  */
21 | final class AFFormatter implements CountryPostcodeFormatter
22 | {
23 |     public function format(string $postcode) : ?string
24 |     {
25 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         $province = substr($postcode, 0, 2);
30 | 
31 |         if ($province < '10' || $province > '43') {
32 |             return null;
33 |         }
34 | 
35 |         return $postcode;
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Formatter/AIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Anguilla.
11 |  *
12 |  * Anguilla uses a single postcode for all addresses.
13 |  * This formatter accepts both the digits 2640, and the full postcode AI2640.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class AIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if ($postcode === '2640' || $postcode === 'AI2640') {
22 |             return 'AI-2640';
23 |         }
24 | 
25 |         return null;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/ALFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Albania.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Albania
16 |  */
17 | final class ALFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/AMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Armenia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Armenia
16 |  */
17 | final class AMFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/AQFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in British Antarctic Territory.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class AQFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'BIQQ1ZZ') {
21 |             return 'BIQQ 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/ARFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Argentina.
11 |  *
12 |  * The postcode is either 4 digits, or 1 letter + 4 digits + 3 letters, with no separators.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Argentina
16 |  */
17 | final class ARFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^(([0-9]{4})|([A-Z][0-9]{4}[A-Z]{3}))$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/ASFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in American Samoa.
11 |  *
12 |  * Mail service in American Samoa is fully integrated with the United States Postal Service.
13 |  * All points in the territory use the same ZIP code, 96799.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_American_Samoa
17 |  */
18 | final class ASFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         $length = strlen($postcode);
23 | 
24 |         if ($length === 5) {
25 |             if ($postcode !== '96799') {
26 |                 return null;
27 |             }
28 | 
29 |             return $postcode;
30 |         }
31 | 
32 |         if (preg_match('/^[0-9]{9}$/', $postcode) !== 1) {
33 |             return null;
34 |         }
35 | 
36 |         $zip = substr($postcode, 0, 5);
37 | 
38 |         if ($zip !== '96799') {
39 |             return null;
40 |         }
41 | 
42 |         $plusFour = substr($postcode, 5);
43 | 
44 |         return $zip . '-' . $plusFour;
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Formatter/ATFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | use Brick\Postcode\FormatHelper\StripPrefix;
 9 | 
10 | /**
11 |  * Validates and formats postcodes in Austria.
12 |  *
13 |  * Postcodes consist of 4 digits, without separator. The first digit must be 1-9.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Austria
17 |  */
18 | final class ATFormatter implements CountryPostcodeFormatter
19 | {
20 |     use StripPrefix;
21 | 
22 |     public function format(string $postcode) : ?string
23 |     {
24 |         $postcode = $this->stripPrefix($postcode, 'A');
25 | 
26 |         if (preg_match('/^[1-9][0-9]{3}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/AUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Australia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postcodes_in_Australia
16 |  */
17 | final class AUFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/AXFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Åland Islands.
11 |  *
12 |  * Postcodes consist of 5 digits, starting with 22.
13 |  * Postcodes may optionally start with "AX-" when used from abroad.
14 |  * This formatter only outputs the prefix if present in the input.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  */
18 | final class AXFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         $length = strlen($postcode);
23 |         $prefix = false;
24 | 
25 |         if ($length === 7) {
26 |             if (!str_starts_with($postcode, 'AX')) {
27 |                 return null;
28 |             }
29 | 
30 |             $postcode = substr($postcode, 2);
31 |             $prefix = true;
32 |         } elseif (strlen($postcode) !== 5) {
33 |             return null;
34 |         }
35 | 
36 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
37 |             return null;
38 |         }
39 | 
40 |         if (!str_starts_with($postcode, '22')) {
41 |             return null;
42 |         }
43 | 
44 |         if ($prefix) {
45 |             return 'AX-' . $postcode;
46 |         }
47 | 
48 |         return $postcode;
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Formatter/AZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Azerbaijan.
11 |  *
12 |  * The postcode format is AZ NNNN, where N represents a digit.
13 |  * This formatter accepts postcodes with and without the AZ prefix, and always outputs the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Azerbaijan
17 |  */
18 | final class AZFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (str_starts_with($postcode, 'AZ')) {
23 |             $postcode = substr($postcode, 2);
24 |         }
25 | 
26 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return 'AZ ' . $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/BAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bosnia and Herzegovina.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class BAFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/BBFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Barbados.
11 |  *
12 |  * Postal codes in Barbados are 5 digit numeric, with BB prefix.
13 |  * This formatter accepts postcodes with and without the BB prefix, and always outputs the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Barbados
17 |  */
18 | final class BBFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (str_starts_with($postcode, 'BB')) {
23 |             $postcode = substr($postcode, 2);
24 |         }
25 | 
26 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return 'BB' . $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/BDFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bangladesh.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Bangladesh
16 |  */
17 | final class BDFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/BEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | use Brick\Postcode\FormatHelper\StripPrefix;
 9 | 
10 | /**
11 |  * Validates and formats postcodes in Belgium.
12 |  *
13 |  * Postcodes consist of 4 digits, without separator.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Belgium
17 |  */
18 | final class BEFormatter implements CountryPostcodeFormatter
19 | {
20 |     use StripPrefix;
21 | 
22 |     public function format(string $postcode) : ?string
23 |     {
24 |         $postcode = $this->stripPrefix($postcode, 'B');
25 | 
26 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/BGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bulgaria.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Bulgaria
16 |  */
17 | final class BGFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/BHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bahrain.
11 |  *
12 |  * Valid post code numbers are 101 to 1216 with gaps in the range. Known as block number formally.
13 |  * The first 1 or 2 digits refer to one of the 12 municipalities of the country.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class BHFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^(1?[0-9])([0-9]{2})$/', $postcode, $matches) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         $municipality = (int) $matches[1];
26 | 
27 |         if ($municipality < 1 || $municipality > 12) {
28 |             return null;
29 |         }
30 | 
31 |         if ($matches[2] === '00') {
32 |             return null;
33 |         }
34 | 
35 |         return $postcode;
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Formatter/BLFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Barthélemy.
11 |  *
12 |  * This country uses a single postcode, 97133.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class BLFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === '97133') {
21 |             return $postcode;
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/BMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bermuda.
11 |  *
12 |  * Postcode formats are AA NN for street addresses, AA AA for P.O. Box addresses (A=letter, N=digit).
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Bermuda
16 |  */
17 | final class BMFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^([A-Z]{2})([A-Z]{2}|[0-9]{2})$/', $postcode, $matches) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $matches[1] . ' ' . $matches[2];
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/BNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Brunei.
11 |  *
12 |  * Postcode format is two letters followed by 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Brunei
16 |  */
17 | final class BNFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[A-Z]{2}[0-9]{4}$/', $postcode, $matches) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/BRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Brazil.
11 |  *
12 |  * Format is 5 digits, hyphen, 3 digits.
13 |  * The old format that used 5 digits is not accepted by this formatter.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/C%C3%B3digo_de_Endere%C3%A7amento_Postal
17 |  */
18 | final class BRFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]{8}$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         return substr($postcode, 0, 5) . '-' . substr($postcode, 5);
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Formatter/BTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Bhutan.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class BTFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/BYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Belarus.
11 |  *
12 |  * Postal codes in Belarus are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class BYFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/CAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Canada.
11 |  *
12 |  * The format is ANA NAN, where A is a letter and N is a digit.
13 |  * Postal codes do not include the letters D, F, I, O, Q or U.
14 |  * The first position also does not make use of the letters W or Z.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Canada
18 |  */
19 | final class CAFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (preg_match('/^([ABCEGHJ-NPRSTV-Z][0-9]){3}$/', $postcode) !== 1) {
24 |             return null;
25 |         }
26 | 
27 |         if ($postcode[0] === 'W' || $postcode[0] === 'Z') {
28 |             return null;
29 |         }
30 | 
31 |         return substr($postcode, 0, 3) . ' ' . substr($postcode, 3);
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Formatter/CCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Cocos (Keeling) Island.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class CCFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/CHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Switzerland.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Switzerland_and_Liechtenstein
16 |  */
17 | final class CHFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/CLFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Chile.
11 |  *
12 |  * Postcodes consist of 7 digits, without separator.
13 |  * According to Wikipedia, postal codes are rarely included in addresses.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Chile
17 |  */
18 | final class CLFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]{7}$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         return $postcode;
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Formatter/CNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in China.
11 |  *
12 |  * China Post uses a six-digit all-numerical system, without separator.
13 |  * The range 000000–009999 is not in use.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_China
17 |  */
18 | final class CNFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         if ($postcode[0] === '0' && $postcode[1] === '0') {
27 |             return null;
28 |         }
29 | 
30 |         return $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/COFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Colombia.
11 |  *
12 |  * Postal codes in Colombia are 6 digit numeric.
13 |  * The first 2 digits represent the department and can range from 00 to 32.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://es.wikipedia.org/wiki/Anexo:C%C3%B3digos_postales_de_Colombia
17 |  */
18 | final class COFormatter implements CountryPostcodeFormatter
19 | {
20 |     private const DEPARTMENTS = [
21 |         '05', '08', '11', '13',
22 |         '15', '17', '18', '19',
23 |         '20', '23', '25', '27',
24 |         '41', '44', '47', '50',
25 |         '52', '54', '63', '66',
26 |         '68', '70', '73', '76',
27 |         '81', '85', '86', '88',
28 |         '91', '94', '95', '97',
29 |         '99'
30 |     ];
31 | 
32 |     public function format(string $postcode) : ?string
33 |     {
34 |         if (preg_match('/^\d{2}(?!0000)\d{4}$/', $postcode) !== 1) {
35 |             return null;
36 |         }
37 | 
38 |         $department = substr($postcode, 0, 2);
39 | 
40 |         if (!in_array($department, self::DEPARTMENTS, true)) {
41 |             return null;
42 |         }
43 | 
44 |         return $postcode;
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Formatter/CRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Costa Rica.
11 |  *
12 |  * Postal codes in Costa Rica are 5 digit numeric.
13 |  * According to Wikipedia, street level format is 5 digits, dash, 4 digits.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/List_of_districts_of_Costa_Rica
17 |  */
18 | final class CRFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         $length = strlen($postcode);
27 | 
28 |         if ($length === 5) {
29 |             return $postcode;
30 |         }
31 | 
32 |         if ($length !== 9) {
33 |             return null;
34 |         }
35 | 
36 |         return substr($postcode, 0, 5) . '-' . substr($postcode, 5);
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Formatter/CUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Cuba.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class CUFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/CVFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Cape Verde.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class CVFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/CXFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Christmas Island.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class CXFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/CYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Cyprus.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  * The postal code system covers the whole island, but is not used on mail to Northern Cyprus.
14 |  * Northern Cyprus uses a 5-digit code commencing 99, introduced in 2013.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Cyprus
18 |  */
19 | final class CYFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
24 |             return null;
25 |         }
26 | 
27 |         $length = strlen($postcode);
28 | 
29 |         if ($length === 4) {
30 |             return $postcode;
31 |         }
32 | 
33 |         if (strlen($postcode) !== 5) {
34 |             return null;
35 |         }
36 | 
37 |         if (!str_starts_with($postcode, '99')) {
38 |             return null;
39 |         }
40 | 
41 |         return $postcode;
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Formatter/CZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Czechia.
11 |  *
12 |  * Postcodes consist of 5 digits in the following format: xxx xx.
13 |  *
14 |  * - The first digit (ranging from 1-7) represents the postal district.
15 |  * - The second digit represents a further geographical division of this
16 |  *   district.
17 |  * - The third and, if necessary, other digits are used to distinguish
18 |  *   the post office and eventually post office boxes.
19 |  *
20 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
21 |  */
22 | final class CZFormatter implements CountryPostcodeFormatter
23 | {
24 |     public function format(string $postcode) : ?string
25 |     {
26 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         $district = $postcode[0];
31 | 
32 |         if ($district < '1' || $district > '7') {
33 |             return null;
34 |         }
35 | 
36 |         return substr($postcode, 0, 3) . ' ' . substr($postcode, 3);
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Formatter/DEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Germany.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Germany
16 |  */
17 | final class DEFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/DKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Denmark.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Denmark
16 |  */
17 | final class DKFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/DOFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Dominican Republic.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class DOFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/DZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Algeria.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Algeria
16 |  */
17 | final class DZFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/ECFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Ecuador.
11 |  *
12 |  * Postal codes in Ecuador have six numeric digits.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Ecuador
16 |  */
17 | final class ECFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/EEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Estonia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class EEFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/EGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Egypt.
11 |  *
12 |  * Postcodes consist of 5 or 7 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Egypt
16 |  * @see https://www.upu.int/UPU/media/upu/PostalEntitiesFiles/addressingUnit/egyEn.pdf
17 |  */
18 | final class EGFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^\d{5}(\d{2})?$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         return $postcode;
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Formatter/ESFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Spain.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Spain
16 |  */
17 | final class ESFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/ETFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Ethiopia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  * According to Wikipedia, the code is only used on a trial basis for Addis Ababa addresses.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class ETFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/FIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Finland.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Finland
16 |  */
17 | final class FIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/FKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Falkland Islands.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class FKFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'FIQQ1ZZ') {
21 |             return 'FIQQ 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/FMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Micronesia.
11 |  *
12 |  * U.S. ZIP codes. Range 96941 - 96944.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class FMFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             $zip = $postcode;
28 |         } elseif ($length === 9) {
29 |             $zip = substr($postcode, 0, 5);
30 |         } else {
31 |             return null;
32 |         }
33 | 
34 |         if ($zip < '96941' || $zip > '96944') {
35 |             return null;
36 |         }
37 | 
38 |         if ($length === 5) {
39 |             return $postcode;
40 |         }
41 | 
42 |         return $zip . '-' . substr($postcode, 5);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Formatter/FOFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Faroe Islands.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class FOFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/FRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in France.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class FRFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GBFormatter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Brick\Postcode\Formatter;
  6 | 
  7 | use Brick\Postcode\CountryPostcodeFormatter;
  8 | 
  9 | /**
 10 |  * Validates and formats the postcodes in the United Kingdom of Great Britain and Northern Ireland.
 11 |  *
 12 |  * Postcodes can have six different formats:
 13 |  *
 14 |  * - A9 9AA
 15 |  * - A9A 9AA
 16 |  * - A99 9AA
 17 |  * - AA9 9AA
 18 |  * - AA9A 9AA
 19 |  * - AA99 9AA
 20 |  *
 21 |  * A stands for a capital letter, 9 stands for a digit.
 22 |  * Only certain letters are allowed for each position in the postcode.
 23 |  * Only certain area codes are permitted.
 24 |  *
 25 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
 26 |  * @see https://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom
 27 |  * @see https://en.wikipedia.org/wiki/List_of_postcode_areas_in_the_United_Kingdom
 28 |  */
 29 | final class GBFormatter implements CountryPostcodeFormatter
 30 | {
 31 |     /**
 32 |      * The list of valid area codes.
 33 |      */
 34 |     private const AREA_CODES = [
 35 |         'AB', 'AL', 'B', 'BA', 'BB', 'BD', 'BH', 'BL', 'BN', 'BR', 'BS', 'BT', 'CA', 'CB', 'CF', 'CH', 'CM', 'CO', 'CR',
 36 |         'CT', 'CV', 'CW', 'DA', 'DD', 'DE', 'DG', 'DH', 'DL', 'DN', 'DT', 'DY', 'E', 'EC', 'EH', 'EN', 'EX', 'FK', 'FY',
 37 |         'G', 'GL', 'GU', 'HA', 'HD', 'HG', 'HP', 'HR', 'HS', 'HU', 'HX', 'IG', 'IP', 'IV', 'KA', 'KT', 'KW', 'KY', 'L',
 38 |         'LA', 'LD', 'LE', 'LL', 'LN', 'LS', 'LU', 'M', 'ME', 'MK', 'ML', 'N', 'NE', 'NG', 'NN', 'NP', 'NR', 'NW', 'OL',
 39 |         'OX', 'PA', 'PE', 'PH', 'PL', 'PO', 'PR', 'RG', 'RH', 'RM', 'S', 'SA', 'SE', 'SG', 'SK', 'SL', 'SM', 'SN', 'SO',
 40 |         'SP', 'SR', 'SS', 'ST', 'SW', 'SY', 'TA', 'TD', 'TF', 'TN', 'TQ', 'TR', 'TS', 'TW', 'UB', 'W', 'WA', 'WC', 'WD',
 41 |         'WF', 'WN', 'WR', 'WS', 'WV', 'YO', 'ZE',
 42 | 
 43 |         // non-geographic
 44 |         'BF', 'BX', 'XX'
 45 |     ];
 46 | 
 47 |     /**
 48 |      * The regular expression patterns, or null if not built yet.
 49 |      *
 50 |      * @psalm-var non-empty-string[]|null
 51 |      *
 52 |      * @var string[]|null
 53 |      */
 54 |     private ?array $patterns = null;
 55 | 
 56 |     public function format(string $postcode) : ?string
 57 |     {
 58 |         // special case
 59 |         if ($postcode === 'GIR0AA') {
 60 |             return 'GIR 0AA';
 61 |         }
 62 | 
 63 |         // regular patterns
 64 |         foreach ($this->getPatterns() as $pattern) {
 65 |             if (preg_match($pattern, $postcode, $matches) === 1) {
 66 |                 [, $outwardCode, $areaCode, $inwardCode] = $matches;
 67 | 
 68 |                 if (! in_array($areaCode, self::AREA_CODES, true)) {
 69 |                     return null;
 70 |                 }
 71 | 
 72 |                 return $outwardCode . ' ' . $inwardCode;
 73 |             }
 74 |         }
 75 | 
 76 |         return null;
 77 |     }
 78 | 
 79 |     /**
 80 |      * Builds the regular expression patterns to check the postcode.
 81 |      *
 82 |      * Each pattern contains 3 capturing groups:
 83 |      *
 84 |      * - The outward code (e.g. WC2E) for formatting
 85 |      * - The area code (ex: WC) for additional checks
 86 |      * - The inward code (e.g. 9RZ) for formatting
 87 |      *
 88 |      * @psalm-return non-empty-string[]
 89 |      *
 90 |      * @return string[]
 91 |      */
 92 |     private function getPatterns() : array
 93 |     {
 94 |         if ($this->patterns !== null) {
 95 |             return $this->patterns;
 96 |         }
 97 | 
 98 |         $n = '[0-9]';
 99 | 
100 |         // outward code alpha chars
101 |         $alphaOut1 = '[ABCDEFGHIJKLMNOPRSTUWYZ]';
102 |         $alphaOut2 = '[ABCDEFGHKLMNOPQRSTUVWXY]';
103 |         $alphaOut3 = '[ABCDEFGHJKPSTUW]';
104 |         $alphaOut4 = '[ABEHMNPRVWXY]';
105 | 
106 |         // inward code alpha chars
107 |         $alphaIn = '[ABCDEFGHJLNPQRSTUWXYZ]';
108 | 
109 |         $outPatterns = [];
110 | 
111 |         // AN
112 |         $outPatterns[] = '(' . $alphaOut1 . ')' . $n;
113 | 
114 |         // ANA
115 |         $outPatterns[] = '(' . $alphaOut1 . ')' . $n . $alphaOut3;
116 | 
117 |         // ANN
118 |         $outPatterns[] = '(' . $alphaOut1 . ')' . $n . $n;
119 | 
120 |         // AAN
121 |         $outPatterns[] = '(' . $alphaOut1 . $alphaOut2 . ')' . $n;
122 | 
123 |         // AANA
124 |         $outPatterns[] = '(' . $alphaOut1 . $alphaOut2 . ')' . $n . $alphaOut4;
125 | 
126 |         // AANN
127 |         $outPatterns[] = '(' . $alphaOut1 . $alphaOut2 . ')' . $n . $n;
128 | 
129 |         $inPattern = $n . $alphaIn . $alphaIn;
130 | 
131 |         $patterns = [];
132 | 
133 |         foreach ($outPatterns as $outPattern) {
134 |             $patterns[] = '/^(' . $outPattern . ')(' . $inPattern . ')$/';
135 |         }
136 | 
137 |         return $this->patterns = $patterns;
138 |     }
139 | }
140 | 


--------------------------------------------------------------------------------
/src/Formatter/GEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Georgia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GEFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in French Guiana.
11 |  *
12 |  * Postcode format is 973NN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GFFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         if (!str_starts_with($postcode, '973')) {
25 |             return null;
26 |         }
27 | 
28 |         return $postcode;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Formatter/GGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats the postcodes in Guernsey.
11 |  *
12 |  * Postcodes can have two different formats:
13 |  *
14 |  * - AAN NAA
15 |  * - AANN NAA
16 |  *
17 |  * A stands for a capital letter, N stands for a digit.
18 |  * The first two letters are always GY.
19 |  *
20 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
21 |  * @see https://en.wikipedia.org/wiki/GY_postcode_area
22 |  */
23 | final class GGFormatter implements CountryPostcodeFormatter
24 | {
25 |     public function format(string $postcode) : ?string
26 |     {
27 |         if (preg_match('/^(GY[0-9]{1,2})([0-9][A-Z][A-Z])$/', $postcode, $matches) !== 1) {
28 |             return null;
29 |         }
30 | 
31 |         return $matches[1] . ' ' . $matches[2];
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Formatter/GIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Gibraltar.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_addresses_in_Gibraltar
16 |  */
17 | final class GIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if ($postcode === 'GX111AA') {
22 |             return 'GX11 1AA';
23 |         }
24 | 
25 |         return null;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/GLFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Greenland.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GLFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Guinea.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GNFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GPFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Guadeloupe.
11 |  *
12 |  * Postcode format is 971NN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GPFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^971[0-9]{2}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Greece.
11 |  *
12 |  * Postcodes consist of 5 digits, in the format NNN NN.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Greece
16 |  */
17 | final class GRFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return substr($postcode, 0, 3) . ' ' . substr($postcode, 3);
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/GSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in South Georgia and the South Sandwich Islands.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GSFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'SIQQ1ZZ') {
21 |             return 'SIQQ 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/GTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Guatemala.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Guatemala
16 |  */
17 | final class GTFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/GUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Guam.
11 |  *
12 |  * U.S. ZIP codes. Range 96910 - 96932.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GUFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             $zip = $postcode;
28 |         } elseif ($length === 9) {
29 |             $zip = substr($postcode, 0, 5);
30 |         } else {
31 |             return null;
32 |         }
33 | 
34 |         if ($zip < '96910' || $zip > '96932') {
35 |             return null;
36 |         }
37 | 
38 |         if ($length === 5) {
39 |             return $postcode;
40 |         }
41 | 
42 |         return $zip . '-' . substr($postcode, 5);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Formatter/GWFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Guinea Bissau.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class GWFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/HNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Honduras.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class HNFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/HRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Croatia.
11 |  *
12 |  * Postal codes in Croatia are 5 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Croatia
16 |  */
17 | final class HRFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/HTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Haiti.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class HTFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/HUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Hungary.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Hungary
16 |  */
17 | final class HUFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode[0] === '0') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/ICFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Canary Islands (a subset of Spain).
11 |  *
12 |  * Postcodes consist of 5 digits, without separator,
13 |  * and start with 35 (Las Palmas) or 38 (Santa Cruz de Tenerife).
14 |  *
15 |  * @see https://www.iso.org/obp/ui/#iso:code:3166:IC
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Spain
18 |  */
19 | final class ICFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (preg_match('/^(35|38)[0-9]{3}$/', $postcode) !== 1) {
24 |             return null;
25 |         }
26 | 
27 |         return $postcode;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Formatter/IDFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Indonesia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Indonesia
16 |  */
17 | final class IDFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode[0] === '0') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/IEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats the postcodes in the Republic of Ireland.
11 |  *
12 |  * Postcodes can have at least the following thirteen different formats:
13 |  *
14 |  * - ANN NNNA
15 |  * - ANN NANN
16 |  * - ANN ANNN
17 |  * - ANN ANNA
18 |  * - ANN ANAN
19 |  * - ANN ANAA
20 |  * - ANN AANN
21 |  * - ANN AANA
22 |  * - ANN AAAN
23 |  *
24 |  * - D6W ANAN
25 |  * - D6W AANN
26 |  * - D6W ANAA
27 |  * - D6W ANNN
28 |  *
29 |  * A stands for the capital letter A,C,D,E,F,H,K,N,P,R,T,V,W,X or Y. N stands for a digit. D6W stans literally for D6W.
30 |  *
31 |  * The first part is one of the 139 Routing Keys, the second is a Unique Identifier.
32 |  * The pdf document linked below defines Eircode's character set on page 11.
33 |  *
34 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
35 |  * @see https://en.wikipedia.org/wiki/Postal_addresses_in_the_Republic_of_Ireland
36 |  * @see https://www.eircode.ie/docs/default-source/Common/prepareyourbusinessforeircode-edition3published.pdf
37 |  * @see https://www.autoaddress.ie/support/developer-centre/resources/routing-key-boundaries
38 |  */
39 | final class IEFormatter implements CountryPostcodeFormatter
40 | {
41 |     /**
42 |      * The regular expression pattern used to validate the postcode and extract the two parts.
43 |      */
44 |     private const PATTERN = '/^'
45 |     . '('
46 |     . 'A41|A42|A45|A63|A67|A75|A81|A82|A83|A84|A85|A86|A91|A92|A94|A96|A98|C15|D01|D02|D03|D04|D05|D06|D6W|D07|D08|D09|'
47 |     . 'D10|D11|D12|D13|D14|D15|D16|D17|D18|D20|D22|D24|E21|E25|E32|E34|E41|E45|E53|E91|F12|F23|F26|F28|F31|F35|F42|F45|'
48 |     . 'F52|F56|F91|F92|F93|F94|H12|H14|H16|H18|H23|H53|H54|H62|H65|H71|H91|K32|K34|K36|K45|K56|K67|K78|N37|N39|N41|N91|'
49 |     . 'P12|P14|P17|P24|P25|P31|P32|P36|P43|P47|P51|P56|P61|P67|P72|P75|P81|P85|R14|R21|R32|R35|R42|R45|R51|R56|R93|R95|'
50 |     . 'T12|T23|T34|T45|T56|V14|V15|V23|V31|V35|V42|V92|V93|V94|V95|W12|W23|W34|W91|X35|X42|X91|Y14|Y21|Y25|Y34|Y35'
51 |     . ')'
52 |     . '([ACDEFHKNPRTVWXY0-9]{4})'
53 |     . '$/';
54 | 
55 |     public function format(string $postcode) : ?string
56 |     {
57 |         if (preg_match(self::PATTERN, $postcode, $matches) !== 1) {
58 |             return null;
59 |         }
60 | 
61 |         return $matches[1] . ' ' . $matches[2];
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Formatter/ILFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Israel.
11 |  *
12 |  * Postcodes consist of 7 digits, without separator.
13 |  * The country used 5 digit postcodes up to 2013. These postcodes are not supported by this formatter.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Israel
17 |  */
18 | final class ILFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]{7}$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         return $postcode;
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Formatter/IMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats the postcodes in the Isle of Man.
11 |  *
12 |  * Postcodes can have two different formats:
13 |  *
14 |  * - IM9 9AA
15 |  * - IM99 9AA
16 |  *
17 |  * A stands for a capital letter, 9 stands for a digit.
18 |  *
19 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
20 |  * @see https://en.wikipedia.org/wiki/IM_postcode_area
21 |  */
22 | final class IMFormatter implements CountryPostcodeFormatter
23 | {
24 |     /**
25 |      * The regular expression pattern used to validate the postcode and extract the two parts.
26 |      */
27 |     private const PATTERN
28 |         = '/^'
29 |         . '(IM[0-9][0-9]?)'
30 |         . '([0-9][A-Z][A-Z])'
31 |         . '$/';
32 | 
33 |     public function format(string $postcode) : ?string
34 |     {
35 |         if (preg_match(self::PATTERN, $postcode, $matches) !== 1) {
36 |             return null;
37 |         }
38 | 
39 |         return $matches[1] . ' ' . $matches[2];
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Formatter/INFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in India.
11 |  *
12 |  * Postcodes consist of 6 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_Index_Number
16 |  */
17 | final class INFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode[0] === '0') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/IOFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in British Indian Ocean Territory.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class IOFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'BBND1ZZ') {
21 |             return 'BBND 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/IQFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Iraq.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Iraq
16 |  */
17 | final class IQFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/IRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Iran.
11 |  *
12 |  * Postcode format is NNNNN NNNNN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class IRFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{10}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return substr($postcode, 0, 5) . ' ' . substr($postcode, 5);
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/ISFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Iceland.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Iceland
16 |  */
17 | final class ISFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode[0] === '0') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/ITFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Italy.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Codice_di_avviamento_postale
16 |  */
17 | final class ITFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/JEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats the postcodes in Jersey.
11 |  *
12 |  * Postcodes can have two different formats:
13 |  *
14 |  * - JE9 9AA
15 |  * - JE99 9AA
16 |  *
17 |  * A stands for a capital letter, 9 stands for a digit.
18 |  *
19 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
20 |  * @see https://en.wikipedia.org/wiki/JE_postcode_area
21 |  */
22 | final class JEFormatter implements CountryPostcodeFormatter
23 | {
24 |     /**
25 |      * The regular expression pattern used to validate the postcode and extract the two parts.
26 |      */
27 |     private const PATTERN
28 |         = '/^'
29 |         . '(JE[0-9][0-9]?)'
30 |         . '([0-9][A-Z][A-Z])'
31 |         . '$/';
32 | 
33 |     public function format(string $postcode) : ?string
34 |     {
35 |         if (preg_match(self::PATTERN, $postcode, $matches) !== 1) {
36 |             return null;
37 |         }
38 | 
39 |         return $matches[1] . ' ' . $matches[2];
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Formatter/JOFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Jordan.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  * According to Wikipedia, postcodes are used for deliveries to PO Boxes only.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class JOFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/JPFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Japan.
11 |  *
12 |  * Postcodes format is NNN-NNNN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Japan
16 |  */
17 | final class JPFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{7}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return substr($postcode, 0, 3) . '-' . substr($postcode, 3);
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/KEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Kenya.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class KEFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/KGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Kyrgyzstan.
11 |  *
12 |  * Postal codes in Kyrgyzstan are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class KGFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/KHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Cambodia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class KHFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/KRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in South Korea.
11 |  *
12 |  * Since 2015, postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_South_Korea
16 |  */
17 | final class KRFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/KWFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Kuwait.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class KWFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/KYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in the Cayman Islands.
11 |  *
12 |  * Postcode format is KYN-NNNN, where N are digits. The first digit can only be 1 to 3.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_the_Cayman_Islands
16 |  */
17 | final class KYFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (!str_starts_with($postcode, 'KY')) {
22 |             return null;
23 |         }
24 | 
25 |         $postcode = substr($postcode, 2);
26 | 
27 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
28 |             return null;
29 |         }
30 | 
31 |         if ($postcode[0] < '1' || $postcode[0] > '3') {
32 |             return null;
33 |         }
34 | 
35 |         return 'KY' . $postcode[0] . '-' . substr($postcode, 1);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Formatter/KZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Kazakhstan.
11 |  *
12 |  * Postal codes in Kazakhstan are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class KZFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Laos.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class LAFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LBFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Lebanon.
11 |  *
12 |  * Postcode format is NNNN NNNN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class LBFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{8}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return substr($postcode, 0, 4) . ' ' . substr($postcode, 4);
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Lucia.
11 |  *
12 |  * The postcode format is LCNN NNN, N standing for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class LCFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^(LC[0-9]{2})([0-9]{3})$/', $postcode, $matches) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $matches[1] . ' ' . $matches[2];
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Liechtenstein.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator, range 9485 to 9498.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Switzerland_and_Liechtenstein
16 |  */
17 | final class LIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode < '9485' || $postcode > '9498') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/LKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Sri Lanka.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Sri_Lanka
16 |  */
17 | final class LKFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/LRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Liberia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class LRFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Lesotho.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class LSFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/LTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Lithuania.
11 |  *
12 |  * Postal codes in Lithuania since 2005 are 5 digit numeric.
13 |  * ISO 3166-1 alpha-2 prefix is allowed, with that the format is LT-NNNNN.
14 |  *
15 |  * This formatter accepts inputs both with and without the LT prefix,
16 |  * and outputs the prefix only if present in the input.
17 |  *
18 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
19 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Lithuania
20 |  */
21 | final class LTFormatter implements CountryPostcodeFormatter
22 | {
23 |     public function format(string $postcode) : ?string
24 |     {
25 |         $length = strlen($postcode);
26 |         $prefix = false;
27 | 
28 |         if ($length === 7) {
29 |             if (!str_starts_with($postcode, 'LT')) {
30 |                 return null;
31 |             }
32 | 
33 |             $postcode = substr($postcode, 2);
34 |             $prefix = true;
35 |         } elseif (strlen($postcode) !== 5) {
36 |             return null;
37 |         }
38 | 
39 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
40 |             return null;
41 |         }
42 | 
43 |         if ($prefix) {
44 |             return 'LT-' . $postcode;
45 |         }
46 | 
47 |         return $postcode;
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Formatter/LUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | use Brick\Postcode\FormatHelper\StripPrefix;
 9 | 
10 | /**
11 |  * Validates and formats postcodes in Luxembourg.
12 |  *
13 |  * Postcodes consist of 4 digits, without separator.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Luxembourg
17 |  */
18 | final class LUFormatter implements CountryPostcodeFormatter
19 | {
20 |     use StripPrefix;
21 | 
22 |     public function format(string $postcode) : ?string
23 |     {
24 |         $postcode = $this->stripPrefix($postcode, 'L');
25 | 
26 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         return $postcode;
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/LVFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Latvia.
11 |  *
12 |  * Postal codes in Latvia are 4 digit numeric and use a mandatory country code (LV) in front.
13 |  * The format is LV-NNNN, where N stands for a digit.
14 |  *
15 |  * This formatter accepts the postcode both with and without the LV prefix, and always outputs the prefix.
16 |  *
17 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
18 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Latvia
19 |  */
20 | final class LVFormatter implements CountryPostcodeFormatter
21 | {
22 |     public function format(string $postcode) : ?string
23 |     {
24 |         if (str_starts_with($postcode, 'LV')) {
25 |             $postcode = substr($postcode, 2);
26 |         }
27 | 
28 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
29 |             return null;
30 |         }
31 | 
32 |         return 'LV-' . $postcode;
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Formatter/MAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Morocco.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Morocco
16 |  */
17 | final class MAFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Monaco.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * Although an independent country, Monaco is part of the French postal code system as if it were a French département,
15 |  * numbered, with codes consisting of 980 and two digits, with 00 being used for deliveries to all physical addresses
16 |  * in the Principality, and 01 to 99 being used for special types of delivery.
17 |  *
18 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
19 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_France#Monaco
20 |  */
21 | final class MCFormatter implements CountryPostcodeFormatter
22 | {
23 |     public function format(string $postcode) : ?string
24 |     {
25 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         if (!str_starts_with($postcode, '980')) {
30 |             return null;
31 |         }
32 | 
33 |         return $postcode;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Formatter/MDFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Moldova.
11 |  *
12 |  * The postcode format is MD-NNNN, where N stands for a digit.
13 |  *
14 |  * This formatter accepts the postcode both with and without the MD prefix, and always outputs the prefix.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Moldova
18 |  */
19 | final class MDFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (str_starts_with($postcode, 'MD')) {
24 |             $postcode = substr($postcode, 2);
25 |         }
26 | 
27 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
28 |             return null;
29 |         }
30 | 
31 |         return 'MD-' . $postcode;
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Formatter/MEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Montenegro.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Montenegro
16 |  */
17 | final class MEFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Martin.
11 |  *
12 |  * This country uses a single postcode, 97150.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MFFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === '97150') {
21 |             return $postcode;
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/MGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Madagascar.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MGFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/MHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Marshall Islands.
11 |  *
12 |  * U.S. ZIP codes. Range 96960 - 96970.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MHFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             $zip = $postcode;
28 |         } elseif ($length === 9) {
29 |             $zip = substr($postcode, 0, 5);
30 |         } else {
31 |             return null;
32 |         }
33 | 
34 |         if ($zip < '96960' || $zip > '96970') {
35 |             return null;
36 |         }
37 | 
38 |         if ($length === 5) {
39 |             return $postcode;
40 |         }
41 | 
42 |         return $zip . '-' . substr($postcode, 5);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Formatter/MKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in the Republic of Macedonia.
11 |  *
12 |  * Postal codes in the Republic of Macedonia are 4 digits in length.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_the_Republic_of_Macedonia
16 |  */
17 | final class MKFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Myanmar.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Myanmar
16 |  */
17 | final class MMFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Mongolia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MNFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/MPFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Northern Mariana Islands.
11 |  *
12 |  * U.S. ZIP codes. Range 96950 - 96952.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_the_Northern_Mariana_Islands
16 |  */
17 | final class MPFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         $length = strlen($postcode);
26 | 
27 |         if ($length === 5) {
28 |             $zip = $postcode;
29 |         } elseif ($length === 9) {
30 |             $zip = substr($postcode, 0, 5);
31 |         } else {
32 |             return null;
33 |         }
34 | 
35 |         if ($zip < '96950' || $zip > '96952') {
36 |             return null;
37 |         }
38 | 
39 |         if ($length === 5) {
40 |             return $postcode;
41 |         }
42 | 
43 |         return $zip . '-' . substr($postcode, 5);
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/src/Formatter/MQFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Martinique.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  * Overseas Department of France. French codes used. Range 97200 - 97290.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class MQFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode < '97200' || $postcode > '97290') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/MSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Montserrat.
11 |  *
12 |  * The format is MSR followed by a space then 4 digits, in the range 1110 to 1350.
13 |  *
14 |  * This formatter accepts the postcode both with and without the MSR prefix, and always outputs the prefix.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  */
18 | final class MSFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (str_starts_with($postcode, 'MSR')) {
23 |             $postcode = substr($postcode, 3);
24 |         }
25 | 
26 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
27 |             return null;
28 |         }
29 | 
30 |         if ($postcode < '1110' || $postcode > '1350') {
31 |             return null;
32 |         }
33 | 
34 |         return 'MSR ' . $postcode;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Formatter/MTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Malta.
11 |  *
12 |  * Postcode format is AAA NNNN, A standing for a letter and N standing for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Malta
16 |  */
17 | final class MTFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^([A-Z]{3})([0-9]{4})$/', $postcode, $matches) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $matches[1] . ' ' . $matches[2];
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Mauritius.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Mauritius
16 |  */
17 | final class MUFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MVFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Maldives.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MVFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/MXFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Mexico.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Mexico
16 |  */
17 | final class MXFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Malaysia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Malaysia
16 |  */
17 | final class MYFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/MZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Mozambique.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class MZFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/NCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in New Caledonia.
11 |  *
12 |  * Overseas Collectivity of France. French codes used. Range 98800 - 98890.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class NCFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         if ($postcode < '98800' || $postcode > '98890') {
25 |             return null;
26 |         }
27 | 
28 |         return $postcode;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Formatter/NEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Niger.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class NEFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/NFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Norfolk Island.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  * Part of the Australian postal code system.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class NFFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/NGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Nigeria.
11 |  *
12 |  * Postal codes in Nigeria are numeric, consisting of six digits.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Nigeria
16 |  */
17 | final class NGFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/NIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Nicaragua.
11 |  *
12 |  * Postal codes in Nicaragua are 5 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Nicaragua
16 |  */
17 | final class NIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/NLFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in the Netherlands.
11 |  *
12 |  * Postcode format is NNNN AA, where N stands for a digit and A for a letter.
13 |  * The letter combinations 'SS', 'SD' and 'SA' are not used.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_the_Netherlands
17 |  */
18 | final class NLFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^([1-9][0-9]{3})([A-Z]{2})$/', $postcode, $matches) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         if (in_array($matches[2], ['SS', 'SD', 'SA'], true)) {
27 |             return null;
28 |         }
29 | 
30 |         return $matches[1] . ' ' . $matches[2];
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/NOFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Norway.
11 |  *
12 |  * Norwegian Postal Codes are 4-digit codes.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Norway
16 |  */
17 | final class NOFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/NPFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Nepal.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Nepal
16 |  */
17 | final class NPFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/NZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in New Zealand.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postcodes_in_New_Zealand
16 |  */
17 | final class NZFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/OMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Oman.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  * Postcodes are used for deliveries to P.O. Boxes only.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class OMFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Panama.
11 |  *
12 |  * The postal codes consist of four numeric digits.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Panama
16 |  */
17 | final class PAFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Peru.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Peru
16 |  */
17 | final class PEFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in French Polynesia.
11 |  *
12 |  * Postcode format is 987NN, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class PFFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         if (!str_starts_with($postcode, '987')) {
25 |             return null;
26 |         }
27 | 
28 |         return $postcode;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Formatter/PGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Papua New Guinea.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class PGFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/PHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in the Philippines.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_ZIP_codes_in_the_Philippines
16 |  */
17 | final class PHFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Pakistan.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Pakistan
16 |  */
17 | final class PKFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PLFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Poland.
11 |  *
12 |  * Postcodes consist of 5 digits in the following format: xy-zzz.
13 |  *
14 |  * - The first digit represents the postal district
15 |  * - The second digit represents the major geographical subdivision of this district
16 |  * - The three digits after the dash represents the post office, or in the case of large cities,
17 |  *   a particular street, part of the street or even separate address.
18 |  *
19 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
20 |  */
21 | final class PLFormatter implements CountryPostcodeFormatter
22 | {
23 |     public function format(string $postcode) : ?string
24 |     {
25 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         return substr($postcode, 0, 2) . '-' . substr($postcode, 2);
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/PMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Pierre and Miquelon.
11 |  *
12 |  * This country uses a single postcode, 97500.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class PMFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === '97500') {
21 |             return $postcode;
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/PNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Pitcairn Islands.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class PNFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'PCRN1ZZ') {
21 |             return 'PCRN 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/PRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Puerto Rico.
11 |  *
12 |  * Puerto Rico is allocated the US ZIP codes 00600 to 00799 and 00900 to 00999.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Puerto_Rico
16 |  */
17 | final class PRFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         $length = strlen($postcode);
26 | 
27 |         if ($length === 5) {
28 |             $zip = $postcode;
29 |         } elseif ($length === 9) {
30 |             $zip = substr($postcode, 0, 5);
31 |         } else {
32 |             return null;
33 |         }
34 | 
35 |         if (! $this->isInRange($zip)) {
36 |             return null;
37 |         }
38 | 
39 |         if ($length === 5) {
40 |             return $postcode;
41 |         }
42 | 
43 |         return $zip . '-' . substr($postcode, 5);
44 |     }
45 | 
46 |     /**
47 |      * @param string $zip
48 |      *
49 |      * @return bool
50 |      */
51 |     private function isInRange(string $zip) : bool
52 |     {
53 |         if ($zip >= '00600' && $zip <= '00799') {
54 |             return true;
55 |         }
56 | 
57 |         if ($zip >= '00900' && $zip <= '00999') {
58 |             return true;
59 |         }
60 | 
61 |         return false;
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Formatter/PSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Palestine.
11 |  *
12 |  * Postcodes consist of 3 digits, without separator.
13 |  * Not yet implemented in practice.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class PSFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{3}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Portugal.
11 |  *
12 |  * Postcode format is NNNN-NNN, N standing for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Portugal
16 |  */
17 | final class PTFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{7}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return substr($postcode, 0, 4) . '-' . substr($postcode, 4);
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/PWFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Palau.
11 |  *
12 |  * U.S. ZIP codes. All locations 96940.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class PWFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             $zip = $postcode;
28 |         } elseif ($length === 9) {
29 |             $zip = substr($postcode, 0, 5);
30 |         } else {
31 |             return null;
32 |         }
33 | 
34 |         if ($zip !== '96940') {
35 |             return null;
36 |         }
37 | 
38 |         if ($length === 5) {
39 |             return $postcode;
40 |         }
41 | 
42 |         return $zip . '-' . substr($postcode, 5);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Formatter/PYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Paraguay.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_of_Paraguay
16 |  */
17 | final class PYFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/REFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Réunion.
11 |  *
12 |  * Postcodes consist of 5 digits, starting with 974, without separator.
13 |  * This is a subset of France postcodes.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class REFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if (!str_starts_with($postcode, '974')) {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/ROFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Romania.
11 |  *
12 |  * Postal codes have six digits and no separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Romania
16 |  */
17 | final class ROFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/RSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Serbia.
11 |  *
12 |  * Serbian postal codes consist of five digits.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Serbia
16 |  */
17 | final class RSFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/RUFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Russia.
11 |  *
12 |  * Postal codes have six digits and no separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Russia
16 |  */
17 | final class RUFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/SAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saudi Arabia.
11 |  *
12 |  * The postcode format is NNNNN for PO Boxes and NNNNN-NNNN for home delivery, N standing for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SAFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             return $postcode;
28 |         }
29 | 
30 |         if ($length === 9) {
31 |             return substr($postcode, 0, 5) . '-' . substr($postcode, -4);
32 |         }
33 | 
34 |         return null;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Formatter/SDFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Sudan.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SDFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/SEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Sweden.
11 |  *
12 |  * Postcode format is NNN NN.
13 |  * The lowest number is 100 00 and the highest number is 984 99.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Sweden
17 |  */
18 | final class SEFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
23 |             return null;
24 |         }
25 | 
26 |         if ($postcode < '10000' || $postcode > '98499') {
27 |             return null;
28 |         }
29 | 
30 |         return substr_replace($postcode, ' ', 3, 0);
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Formatter/SGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Singapore.
11 |  *
12 |  * Postal codes in Singapore consist of six digits, no separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Singapore
16 |  */
17 | final class SGFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/SHFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Helena, Ascension and Tristan da Cunha.
11 |  *
12 |  * - Saint Helena uses one code STHL 1ZZ
13 |  * - Ascension uses one code ASCN 1ZZ
14 |  * - Tristan da Cunha uses one code TDCU 1ZZ.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  */
18 | final class SHFormatter implements CountryPostcodeFormatter
19 | {
20 |     public function format(string $postcode) : ?string
21 |     {
22 |         if ($postcode === 'STHL1ZZ') {
23 |             return 'STHL 1ZZ';
24 |         }
25 | 
26 |         if ($postcode === 'ASCN1ZZ') {
27 |             return 'ASCN 1ZZ';
28 |         }
29 | 
30 |         if ($postcode === 'TDCU1ZZ') {
31 |             return 'TDCU 1ZZ';
32 |         }
33 | 
34 |         return null;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Formatter/SIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Slovenia.
11 |  *
12 |  * The codes consist of four digits written without separator characters.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Slovenia
16 |  */
17 | final class SIFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/SJFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Svalbard and Jan Mayen.
11 |  *
12 |  * This country uses Norwegian 4-digit postal codes.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Norway
16 |  */
17 | final class SJFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/SKFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Slovakia.
11 |  *
12 |  * Postcodes consist of 5 digits in the following format: xxx xx.
13 |  *
14 |  * - The first digit represents the postal district and is either 8, 9, or 0.
15 |  * - Other digits, depending on the district, represent further geographical
16 |  *   division of this district.
17 |  *
18 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
19 |  */
20 | final class SKFormatter implements CountryPostcodeFormatter
21 | {
22 |     public function format(string $postcode) : ?string
23 |     {
24 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
25 |             return null;
26 |         }
27 | 
28 |         $district = $postcode[0];
29 | 
30 |         if (! in_array($district, ['8', '9', '0'], true)) {
31 |             return null;
32 |         }
33 | 
34 |         return substr($postcode, 0, 3) . ' ' . substr($postcode, 3);
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Formatter/SMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in San Marino.
11 |  *
12 |  * The postcode format is 4789N, where N stands for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SMFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         if (!str_starts_with($postcode, '4789')) {
25 |             return null;
26 |         }
27 | 
28 |         return $postcode;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Formatter/SNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Senegal.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SNFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/SVFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in El Salvador.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SVFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/SZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Swaziland.
11 |  *
12 |  * Postcode format is ANNN, A standing for a letter and N for a digit.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class SZFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[A-Z][0-9]{3}$/', $postcode, $matches) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/TCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Turks and Caicos Islands.
11 |  *
12 |  * This country uses a single postcode for all addresses.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class TCFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === 'TKCA1ZZ') {
21 |             return 'TKCA 1ZZ';
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/TFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in French Southern and Antarctic Territories.
11 |  *
12 |  * French codes in the 98400 range have been reserved, but do not seem to be in use at the moment.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class TFFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         if (!str_starts_with($postcode, '984')) {
25 |             return null;
26 |         }
27 | 
28 |         return $postcode;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Formatter/THFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Thailand.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Thailand
16 |  */
17 | final class THFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/TJFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Tajikistan.
11 |  *
12 |  * Postcodes consist of 6 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class TJFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/TMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Turkmenistan.
11 |  *
12 |  * Postal codes in Turkmenistan are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class TMFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/TNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Tunisia.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Tunisia
16 |  */
17 | final class TNFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/TRFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Turkey.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Turkey
16 |  */
17 | final class TRFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/TTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Trinidad and Tobago.
11 |  *
12 |  * Postcodes consist of 6 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Trinidad_and_Tobago
16 |  */
17 | final class TTFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/TWFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Taiwan.
11 |  *
12 |  * Acceptable formats are NNN and NNN-NN, N standing for a digit.
13 |  *
14 |  * The first three digits of the postal code are required; the last two digits are optional.
15 |  *
16 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
17 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_Taiwan
18 |  */
19 | final class TWFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
24 |             return null;
25 |         }
26 | 
27 |         $length = strlen($postcode);
28 | 
29 |         if ($length === 3) {
30 |             return $postcode;
31 |         }
32 | 
33 |         if ($length === 5) {
34 |             return substr($postcode, 0, 3) . '-' . substr($postcode, -2);
35 |         }
36 | 
37 |         return null;
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Formatter/TZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Tanzania.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class TZFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/UAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Ukraine.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Ukraine
16 |  */
17 | final class UAFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/USFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in the United States of America.
11 |  *
12 |  * Postcodes in the USA are called ZIP codes.
13 |  *
14 |  * ZIP codes consist of 5 digits without separator.
15 |  * ZIP+4 codes consist of 5 digits, followed by a dash, followed by 4 digits.
16 |  *
17 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
18 |  */
19 | final class USFormatter implements CountryPostcodeFormatter
20 | {
21 |     public function format(string $postcode) : ?string
22 |     {
23 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
24 |             return null;
25 |         }
26 | 
27 |         $length = strlen($postcode);
28 | 
29 |         if ($length === 5) {
30 |             return $postcode;
31 |         }
32 | 
33 |         if ($length === 9) {
34 |             return substr($postcode, 0, 5) . '-' . substr($postcode, -4);
35 |         }
36 | 
37 |         return null;
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Formatter/UYFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Uruguay.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class UYFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/UZFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Uzbekistan.
11 |  *
12 |  * Postal codes in Uzbekistan are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class UZFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/VAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Vatican.
11 |  *
12 |  * Single code used for all addresses. Part of the Italian postal code system.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class VAFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if ($postcode === '00120') {
21 |             return $postcode;
22 |         }
23 | 
24 |         return null;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/VCFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Saint Vincent and the Grenadines.
11 |  *
12 |  * The postcode format is VCNNNN, where N represents a digit.
13 |  * This formatter accepts postcodes with and without the VC prefix, and always outputs the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class VCFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (str_starts_with($postcode, 'VC')) {
22 |             $postcode = substr($postcode, 2);
23 |         }
24 | 
25 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         return 'VC' . $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/VEFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Venezuela.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class VEFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Formatter/VGFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in British Virgin Islands.
11 |  *
12 |  * The postcode format is VG followed by 4 digits, specifically VG1110 through VG1160.
13 |  * This formatter accepts inputs with and without the VG prefix, and always outputs the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class VGFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (str_starts_with($postcode, 'VG')) {
22 |             $postcode = substr($postcode, 2);
23 |         }
24 | 
25 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         if ($postcode < '1110' || $postcode > '1160') {
30 |             return null;
31 |         }
32 | 
33 |         return 'VG' . $postcode;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Formatter/VIFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in U.S. Virgin Islands.
11 |  *
12 |  * U.S. ZIP codes. Range 00801 - 00851.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class VIFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         $length = strlen($postcode);
25 | 
26 |         if ($length === 5) {
27 |             $zip = $postcode;
28 |         } elseif ($length === 9) {
29 |             $zip = substr($postcode, 0, 5);
30 |         } else {
31 |             return null;
32 |         }
33 | 
34 |         if ($zip < '00801' || $zip > '00851') {
35 |             return null;
36 |         }
37 | 
38 |         if ($length === 5) {
39 |             return $postcode;
40 |         }
41 | 
42 |         return $zip . '-' . substr($postcode, 5);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Formatter/VNFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Vietnam.
11 |  *
12 |  * Postal codes are 6 digit numeric.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/Postal_codes_in_Vietnam
16 |  */
17 | final class VNFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{6}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/WFFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Wallis and Futuna.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  * Overseas Collectivity of France. French codes used. Range 98600 - 98690.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class WFFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode < '98600' || $postcode > '98690') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/WSFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Samoa.
11 |  *
12 |  * The postcode format is WSNNNN, where N represents a digit.
13 |  * This formatter accepts postcodes with and without the WS prefix, and always outputs the prefix.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class WSFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (str_starts_with($postcode, 'WS')) {
22 |             $postcode = substr($postcode, 2);
23 |         }
24 | 
25 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
26 |             return null;
27 |         }
28 | 
29 |         return 'WS' . $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/YTFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Mayotte.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  * Overseas Department of France. French codes used. Range 97600 - 97690.
14 |  *
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
16 |  */
17 | final class YTFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         if ($postcode < '97600' || $postcode > '97690') {
26 |             return null;
27 |         }
28 | 
29 |         return $postcode;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Formatter/ZAFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in South Africa.
11 |  *
12 |  * Postcodes consist of 4 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes_in_South_Africa
16 |  */
17 | final class ZAFormatter implements CountryPostcodeFormatter
18 | {
19 |     public function format(string $postcode) : ?string
20 |     {
21 |         if (preg_match('/^[0-9]{4}$/', $postcode) !== 1) {
22 |             return null;
23 |         }
24 | 
25 |         return $postcode;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Formatter/ZMFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode\Formatter;
 6 | 
 7 | use Brick\Postcode\CountryPostcodeFormatter;
 8 | 
 9 | /**
10 |  * Validates and formats postcodes in Zambia.
11 |  *
12 |  * Postcodes consist of 5 digits, without separator.
13 |  *
14 |  * @see https://en.wikipedia.org/wiki/List_of_postal_codes
15 |  */
16 | final class ZMFormatter implements CountryPostcodeFormatter
17 | {
18 |     public function format(string $postcode) : ?string
19 |     {
20 |         if (preg_match('/^[0-9]{5}$/', $postcode) !== 1) {
21 |             return null;
22 |         }
23 | 
24 |         return $postcode;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/InvalidPostcodeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode;
 6 | 
 7 | /**
 8 |  * Exception thrown when trying to format an invalid postcode.
 9 |  */
10 | final class InvalidPostcodeException extends \Exception
11 | {
12 |     protected string $postcode;
13 |     protected string $country;
14 | 
15 |     /**
16 |      * Construct exception thrown when trying to format an invalid postcode.
17 |      *
18 |      * @param string $postcode
19 |      * @param string $country
20 |      */
21 |     public function __construct(string $postcode, string $country)
22 |     {
23 |         parent::__construct('Invalid postcode: ' . $postcode);
24 |         $this->postcode = $postcode;
25 |         $this->country = $country;
26 |     }
27 | 
28 |     /**
29 |      * Get the invalid postcode associated with this exception.
30 |      *
31 |      * @return string
32 |      */
33 |     public function getPostcode(): string
34 |     {
35 |         return $this->postcode;
36 |     }
37 | 
38 |     /**
39 |      * Get the country ISO2 code associated with this exception.
40 |      *
41 |      * @return string
42 |      */
43 |     public function getCountry(): string
44 |     {
45 |         return $this->country;
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/PostcodeFormatter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode;
 6 | 
 7 | /**
 8 |  * Formats and validates postcodes.
 9 |  */
10 | final class PostcodeFormatter
11 | {
12 |     /**
13 |      * The country postcode formatters, indexed by country code.
14 |      *
15 |      * @var array<string, CountryPostcodeFormatter|null>
16 |      */
17 |     private array $formatters = [];
18 | 
19 |     /**
20 |      * Formats the given postcode.
21 |      *
22 |      * The country code and postcode are case insensitive.
23 |      * The input postcode is allowed to contain space or dash separators, possibly misplaced.
24 |      *
25 |      * @param string $country  The ISO 3166-1 alpha-2 country code.
26 |      * @param string $postcode The postcode to format.
27 |      *
28 |      * @return string
29 |      *
30 |      * @throws UnknownCountryException
31 |      * @throws InvalidPostcodeException
32 |      */
33 |     public function format(string $country, string $postcode) : string
34 |     {
35 |         $postcode = str_replace([' ', '-'], '', $postcode);
36 |         $postcode = strtoupper($postcode);
37 | 
38 |         $formatter = $this->getFormatter($country);
39 | 
40 |         if ($formatter === null) {
41 |             throw new UnknownCountryException($country);
42 |         }
43 | 
44 |         if (preg_match('/^[A-Z0-9]+$/', $postcode) !== 1) {
45 |             throw new InvalidPostcodeException($postcode, $country);
46 |         }
47 | 
48 |         $formatted = $formatter->format($postcode);
49 | 
50 |         if ($formatted === null) {
51 |             throw new InvalidPostcodeException($postcode, $country);
52 |         }
53 | 
54 |         return $formatted;
55 |     }
56 | 
57 |     /**
58 |      * @param string $country
59 |      *
60 |      * @return bool
61 |      */
62 |     public function isSupportedCountry(string $country) : bool
63 |     {
64 |         return $this->getFormatter($country) !== null;
65 |     }
66 | 
67 |     /**
68 |      * @param string $country The ISO 3166-1 alpha-2 country code.
69 |      *
70 |      * @return CountryPostcodeFormatter|null The formatter, or null if the country code is unknown.
71 |      */
72 |     private function getFormatter(string $country) : ?CountryPostcodeFormatter
73 |     {
74 |         if (array_key_exists($country, $this->formatters)) {
75 |             return $this->formatters[$country];
76 |         }
77 | 
78 |         return $this->formatters[$country] = $this->doGetFormatter($country);
79 |     }
80 | 
81 |     private function doGetFormatter(string $country): ?CountryPostcodeFormatter
82 |     {
83 |         $country = strtoupper($country);
84 | 
85 |         if (preg_match('/^[A-Z]{2}$/', $country) !== 1) {
86 |             return null;
87 |         }
88 | 
89 |         /** @var class-string<CountryPostcodeFormatter> $class */
90 |         $class = __NAMESPACE__ . '\\Formatter\\' . $country . 'Formatter';
91 | 
92 |         return class_exists($class) ? new $class() : null;
93 |     }
94 | }
95 | 


--------------------------------------------------------------------------------
/src/UnknownCountryException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Brick\Postcode;
 6 | 
 7 | /**
 8 |  * Exception thrown when an unknown country code is provided.
 9 |  */
10 | final class UnknownCountryException extends \Exception
11 | {
12 |     protected string $country;
13 | 
14 |     /**
15 |      * Construct exception thrown when an unknown country code is provided.
16 |      *
17 |      * @param string $country
18 |      */
19 |     public function __construct(string $country)
20 |     {
21 |         parent::__construct('Unknown country: ' . $country);
22 |         $this->country = $country;
23 |     }
24 | 
25 |     /**
26 |      * Get the unknown country ISO2 code associated with this exception.
27 |      *
28 |      * @return string
29 |      */
30 |     public function getCountry(): string
31 |     {
32 |         return $this->country;
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------