Node.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

/* Copyright (c) 2019 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

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\Implementation\Component\SignalGeneratorInterface;

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

    protected $link;

    protected $label;

    protected $expanded = false;

    protected $highlighted = false;

    protected $subnodes = [];

    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)
    {
        return $this->withTriggeredSignal($signal, 'click');
    }

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

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