TreeTool.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\Scope\Tool\Factory;

use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isTopItem;
use ILIAS\UI\Component\Symbol\Glyph;
use ILIAS\UI\Component\Symbol\Icon;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Component\Tree\Tree;
use LogicException;

class TreeTool extends AbstractBaseTool implements isTopItem, hasSymbol, isToolItem
{
    use \ILIAS\GlobalScreen\Scope\SymbolDecoratorTrait;

    protected ?Symbol $symbol = null;
    protected Tree $tree;
    protected string $title;

    public function withTitle(string $title): hasTitle
    {
        $clone = clone($this);
        $clone->title = $title;

        return $clone;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function withSymbol(Symbol $symbol): hasSymbol
    {
        // bugfix mantis 25526: make aria labels mandatory
        if (($symbol instanceof Glyph\Glyph && $symbol->getAriaLabel() === "") ||
            ($symbol instanceof Icon\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 withTree(Tree $tree): self
    {
        $clone = clone($this);
        $clone->tree = $tree;

        return $clone;
    }

    public function getTree(): Tree
    {
        return $this->tree;
    }

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

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