PostCode.php

<?php

namespace MatchBot\Domain;

use Doctrine\ORM\Mapping\Embeddable;
use MatchBot\Application\Assert;
use MatchBot\Application\Assertion;
use MatchBot\Application\AssertionFailedException;

readonly class PostCode
{
    /**
     * Originally Based on the simplified pattern suggestions in https://stackoverflow.com/a/51885364/2803757
     * Copied from donate-frontend to matchbot.
     */
    public const string UK_VALIDATION_REGEX = '/^([A-Z][A-HJ-Y]?\d[A-Z\d]? \d[A-Z]{2}|GIR 0A{2})$/';

    /**
     * Much looser to support all postcode formats we know of around the world.
     */
    public const string INTERNATIONAL_VALIDATION_REGEX = '/^[0-9a-zA-Z -]{2,8}$/';
    public string $value;

    private function __construct(string $value, bool $skipUkSpecificValidation)
    {
        $value = trim(mb_strtoupper($value));

        Assertion::betweenLength($value, 2, 8);

        if (! $skipUkSpecificValidation) {
            Assertion::regex($value, self::UK_VALIDATION_REGEX);
        } else {
            Assertion::regex($value, self::INTERNATIONAL_VALIDATION_REGEX);
        }

        $this->value = $value;
    }

    public static function of(string $value, bool $skipUKSpecificValidation = false): self
    {
        return new self($value, $skipUKSpecificValidation);
    }
}