Node.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Tree\Node;

use ILIAS\Data\URI;
use ILIAS\UI\Component\Tree\Node\Node as INode;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Component\Clickable;

abstract class Node implements INode
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    protected array $subnodes = [];
    protected ?URI $link = null;
    protected string $label;
    protected bool $expanded = false;
    protected bool $highlighted = false;

    public function __construct(string $label, ?URI $link = null)
    {
        $this->label = $label;
        $this->link = $link;
    }

    public function getLabel(): string
    {
        return $this->label;
    }

    public function withAdditionalSubnode(INode $node): INode
    {
        $this->subnodes[] = $node;
        return $this;
    }

    public function getSubnodes(): array
    {
        return $this->subnodes;
    }

    public function withExpanded(bool $expanded): INode
    {
        $clone = clone $this;
        $clone->expanded = $expanded;
        return $clone;
    }

    public function isExpanded(): bool
    {
        return $this->expanded;
    }

    public function withHighlighted(bool $highlighted): INode
    {
        $clone = clone $this;
        $clone->highlighted = $highlighted;
        return $clone;
    }

    public function isHighlighted(): bool
    {
        return $this->highlighted;
    }

    public function withOnClick(Signal $signal): self
    {
        return $this->withTriggeredSignal($signal, 'click');
    }

    public function appendOnClick(Signal $signal): self
    {
        return $this->appendTriggeredSignal($signal, 'click');
    }

    public function getLink(): ?URI
    {
        return $this->link;
    }
}