Colour.php

<?php

namespace MatchBot\Domain;

use MatchBot\Application\Assertion;
use OpenApi\Attributes as OA;

/**
 * Represents a 24 bit colour in the sRGB colour space.
 */
#[OA\Schema(
    description: "Represents a 24-bit color in the sRGB color space",
    type: "string",
    format: "hex-color",
    example: "#B30510"
)]
readonly class Colour
{
    private string $hexCode;

    private function __construct(
        string $hexCode
    ) {
        $this->hexCode = \strtoupper($hexCode);
        Assertion::regex($this->hexCode, '/^#[A-F0-9]{6}$/', 'Hex color code required');
    }

    public static function fromHex(string $hexCode): self
    {
        return new self($hexCode);
    }

    public static function black(): Colour
    {
        return Colour::fromHex('#000000');
    }

    public static function white(): Colour
    {
        return Colour::fromHex('#FFFFFF');
    }

    /**
     * @return string hex colour code prefixed with #, e.g. '#B30510'
     */
    public function toHex(): string
    {
        return $this->hexCode;
    }

    public function __toString(): string
    {
        return $this->hexCode;
    }
}