Purpose.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Help;

final class Purpose
{
    public const PURPOSE_TOOLTIP = 2;

    protected int $purpose;

    public function __construct(
        int $purpose
    ) {
        if (!in_array($purpose, [self::PURPOSE_TOOLTIP])) {
            throw new \InvalidArgumentException("Invalid purpose: $purpose");
        }
        $this->purpose = $purpose;
    }

    public function isTooltip(): bool
    {
        return $this->purpose === self::PURPOSE_TOOLTIP;
    }

    public static function Tooltip(): self
    {
        return new self(self::PURPOSE_TOOLTIP);
    }
}