hasSymbolTrait.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
namespace ILIAS\GlobalScreen\Scope\MainMenu\Factory;

use ILIAS\UI\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Implementation\Component\Symbol\Icon\Icon;
use LogicException;

trait hasSymbolTrait
{
    protected ?Symbol $symbol = null;

    public function withSymbol(Symbol $symbol): hasSymbol
    {
        // bugfix mantis 25526: make aria labels mandatory
        if (($symbol instanceof Glyph && $symbol->getAriaLabel() === "") ||
            ($symbol instanceof Icon && $symbol->getLabel() === "")) {
            throw new LogicException("the symbol's aria label MUST be set to ensure accessibility");
        }

        $clone = clone $this;
        $clone->symbol = $symbol;

        return $clone;
    }

    public function getSymbol(): Symbol
    {
        return $this->symbol;
    }

    public function hasSymbol(): bool
    {
        return $this->symbol instanceof Symbol;
    }
}