Link.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Link;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\HasContentLanguage;
use ILIAS\UI\Implementation\Component\HasHelpTopics;
use ILIAS\Data\LanguageTag;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;

abstract class Link implements C\Link\Link
{
    use ComponentHelper;
    use HasContentLanguage;
    use HasHelpTopics;
    use JavaScriptBindable;

    protected string $action;
    protected ?bool $open_in_new_viewport = null;
    protected ?LanguageTag $action_content_language = null;

    protected array $relationships = [];

    public function __construct(string $action)
    {
        $this->action = $action;
    }

    public function getAction(): string
    {
        return $this->action;
    }

    public function withOpenInNewViewport(bool $open_in_new_viewport): C\Link\Link
    {
        $clone = clone $this;
        $clone->open_in_new_viewport = $open_in_new_viewport;
        return $clone;
    }

    public function getOpenInNewViewport(): ?bool
    {
        return $this->open_in_new_viewport;
    }

    public function withLanguageOfReferencedContent(LanguageTag $language): C\Link\Link
    {
        $clone = clone $this;
        $clone->action_content_language = $language;
        return $clone;
    }

    public function getLanguageOfReferencedResource(): ?LanguageTag
    {
        return $this->action_content_language;
    }

    public function withAdditionalRelationshipToReferencedResource(C\Link\Relationship $type): C\Link\Link
    {
        $clone = clone $this;
        if (!in_array($type, $clone->relationships)) {
            $clone->relationships[] = $type;
        }
        return $clone;
    }

    public function getRelationshipsToReferencedResource(): array
    {
        $relationships = $this->relationships;
        if (
            $this->getOpenInNewViewport() &&
            !in_array(C\Link\Relationship::NOOPENER, $relationships)
        ) {
            $relationships[] = C\Link\Relationship::NOOPENER;
        }
        return $relationships;
    }
}