19098923587

Committed 05 Nov 2025 10:27AM UTC coverage: 81.782% (-17.6%) from 99.396%

Build # 19098923587

Build Type

Pull #19

github

Committed by

web-flow

Commit Message

Merge 79bf98178 into 8ef37e5aa

Pull Request Pull Request #19: Add hint to formatter, so a hint can be provided if postcode is invalid

Run Details

5 of 184 new or added lines in 183 files covered. (2.72%)

2 existing lines in 1 file now uncovered.

826 of 1010 relevant lines covered (81.78%)

15.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.89

/src/Formatter/USFormatter.php

<?php

declare(strict_types=1);

namespace Brick\Postcode\Formatter;

use Brick\Postcode\CountryPostcodeFormatter;

use function preg_match;
use function strlen;
use function substr;

/**
 * Validates and formats postcodes in the United States of America.
 *
 * Postcodes in the USA are called ZIP codes.
 *
 * ZIP codes consist of 5 digits without separator.
 * ZIP+4 codes consist of 5 digits, followed by a dash, followed by 4 digits.
 *
 * @see https://en.wikipedia.org/wiki/List_of_postal_codes
 */
final class USFormatter implements CountryPostcodeFormatter
{
    public function hint(): string
    {
        return 'Postcodes in the USA are called ZIP codes.';
    }

    public function format(string $postcode): ?string
    {
        if (preg_match('/^[0-9]+$/', $postcode) !== 1) {
            return null;
        }

        $length = strlen($postcode);

        if ($length === 5) {
            return $postcode;
        }

        if ($length === 9) {
            return substr($postcode, 0, 5) . '-' . substr($postcode, -4);
        }

        return null;
    }
}

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

brick / postcode / 19098923587

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous