Footer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\MainControls;

use ILIAS\UI\Component\MainControls;
use ILIAS\UI\Component\Modal;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\Link\Standard as Link;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\UI\Component\Button\Shy;
use ILIAS\UI\Component\Signal;
use ILIAS\Data\URI;

class Footer implements MainControls\Footer
{
    use ComponentHelper;

    private array $modals = [];

    protected ?URI $permanent_url = null;

    protected array $link_groups = [];

    protected array $icons = [];

    protected array $links = [];

    protected array $texts = [];

    public function withAdditionalLinkGroup(string $title, array $actions): MainControls\Footer
    {
        $this->checkArgListElements('actions', $actions, [Link::class, Shy::class]);

        $clone = clone $this;
        $clone->link_groups[] = [$title, $actions];
        return $clone;
    }

    public function getAdditionalLinkGroups(): array
    {
        return $this->link_groups;
    }

    public function withAdditionalLink(Link|Shy ...$actions): MainControls\Footer
    {
        $this->checkArgListElements('actions', $actions, [Link::class, Shy::class]);

        $clone = clone $this;
        array_push($clone->links, ...$actions);
        return $clone;
    }

    public function getAdditionalLinks(): array
    {
        return $this->links;
    }

    public function withAdditionalIcon(Icon $icon, Signal|URI|null $action = null): MainControls\Footer
    {
        $clone = clone $this;
        $clone->icons[] = [$icon, $action];
        return $clone;
    }

    public function getAdditionalIcons(): array
    {
        return $this->icons;
    }

    public function withAdditionalText(string ...$texts): MainControls\Footer
    {
        $clone = clone $this;
        array_push($clone->texts, ...$texts);
        return $clone;
    }

    public function getAdditionalTexts(): array
    {
        return $this->texts;
    }

    public function withPermanentURL(URI $url): MainControls\Footer
    {
        $clone = clone $this;
        $clone->permanent_url = $url;
        return $clone;
    }

    public function getPermanentURL(): ?URI
    {
        return $this->permanent_url;
    }

    public function getModals(): array
    {
        return $this->modals;
    }

    public function withAdditionalModal(Modal\RoundTrip $modal): MainControls\Footer
    {
        $clone = clone $this;
        $clone->modals[] = $modal;
        return $clone;
    }

}