RepositoryLink.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item;

use ILIAS\GlobalScreen\Scope\MainMenu\Factory\AbstractChildItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasAction;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbolTrait;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isInterchangeableItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isInterchangeableItemTrait;
use ILIAS\GlobalScreen\Scope\SymbolDecoratorTrait;
use ILIAS\UI\Component\Symbol\Symbol;
use ilLink;
use LogicException;

class RepositoryLink extends AbstractChildItem implements
    hasTitle,
    hasAction,
    hasSymbol,
    isInterchangeableItem,
    isChild
{
    use hasSymbolTrait;
    use SymbolDecoratorTrait;
    use isInterchangeableItemTrait;

    protected int $ref_id = 0;
    protected string $alt_text;
    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 withAltText(string $alt_text): self
    {
        $clone = clone($this);
        $clone->alt_text = $alt_text;

        return $clone;
    }

    public function getAltText(): string
    {
        return $this->alt_text;
    }

    final public function getAction(): string
    {
        return ilLink::_getLink($this->ref_id);
    }

    public function withAction(string $action): hasAction
    {
        $clone = clone $this;
        $clone->ref_id = (int) $action;

        return $clone;
    }

    public function withRefId(int $ref_id): self
    {
        $clone = clone $this;
        $clone->ref_id = $ref_id;

        return $clone;
    }

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

    public function getRefId(): int
    {
        return $this->ref_id;
    }

    public function withIsLinkToExternalAction(bool $is_external): hasAction
    {
        throw new LogicException("Repository-Links are always internal");
    }

    public function isLinkWithExternalAction(): bool
    {
        return false;
    }
}