Sortation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\ViewControl;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\SignalGeneratorInterface;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Component\Signal;

class Sortation implements C\ViewControl\Sortation
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    protected Signal $select_signal;
    protected ?string $label_prefix = null;
    protected ?string $target_url = null;
    protected string $parameter_name = "sortation";
    protected ?string $active = null;

    public function __construct(
        protected array $options,
        protected string $selected,
        protected SignalGeneratorInterface $signal_generator
    ) {
        $check = array_keys($options);
        $check[] = '';
        $this->checkArgIsElement('selected', $selected, $check, 'one of [' . implode(', ', array_keys($options)) . ']');
        $this->initSignals();
    }

    public function withResetSignals(): self
    {
        $clone = clone $this;
        $clone->initSignals();
        return $clone;
    }

    protected function initSignals(): void
    {
        $this->select_signal = $this->signal_generator->create();
    }

    public function withLabelPrefix(string $label_prefix): self
    {
        $clone = clone $this;
        $clone->label_prefix = $label_prefix;
        return $clone;
    }

    public function getLabelPrefix(): ?string
    {
        return $this->label_prefix;
    }

    public function withTargetURL(string $url, string $parameter_name): self
    {
        $this->checkStringArg("url", $url);
        $this->checkStringArg("parameter_name", $parameter_name);
        $clone = clone $this;
        $clone->target_url = $url;
        $clone->parameter_name = $parameter_name;
        return $clone;
    }

    public function getTargetURL(): ?string
    {
        return $this->target_url;
    }

    public function getParameterName(): string
    {
        return $this->parameter_name;
    }

    public function getOptions(): array
    {
        return $this->options;
    }

    public function withOnSort(Signal $signal): self
    {
        return $this->withTriggeredSignal($signal, 'sort');
    }

    public function getSelectSignal(): Signal
    {
        return $this->select_signal;
    }

    public function withSelected(string $selected_option): self
    {
        $possible = array_keys($this->options);
        $this->checkArgIsElement('selected_option', $selected_option, $possible, 'one of [' . implode(', ', $possible) . ']');
        $clone = clone $this;
        $clone->selected = $selected_option;
        return $clone;
    }

    public function getSelected(): ?string
    {
        return $this->selected;
    }
}