Action.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Table\Action;

use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\Table\Action as I;
use ILIAS\UI\Component\Signal;
use ILIAS\Data\URI;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken;

abstract class Action implements I\Action
{
    use ComponentHelper;
    public const OPT_ACTIONID = 'actId';
    public const OPT_ROWID = 'rowid';

    protected Signal|URI $target;
    protected bool $async = false;

    public function __construct(
        protected string $label,
        protected URLBuilder $url_builder,
        protected URLBuilderToken $row_id_parameter
    ) {
        $this->target = $url_builder->buildURI();
    }

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

    public function getTarget(): Signal|URI
    {
        return $this->target;
    }

    public function withSignalTarget(Signal $target): self
    {
        $clone = clone $this;
        $clone->target = $target;
        return $clone;
    }

    public function withAsync(bool $async = true): self
    {
        $clone = clone $this;
        $clone->async = $async;
        return $clone;
    }

    public function isAsync(): bool
    {
        return $this->async;
    }

    public function withRowId(string $row_id): self
    {
        $clone = clone $this;
        $target = $clone->getTarget();

        if ($target instanceof Signal) {
            $target->addOption('rowid', $row_id);
        }
        if ($target instanceof URI) {
            $target = $this->url_builder->withParameter(
                $this->row_id_parameter,
                [$row_id]
            )
            ->buildURI();
        }
        $clone->target = $target;
        return $clone;
    }

    public function getURLBuilderJS(): string
    {
        return $this->url_builder->renderObject([$this->row_id_parameter]);
    }
    public function getURLBuilderTokensJS(): string
    {
        return $this->url_builder->renderTokens([$this->row_id_parameter]);
    }
}