PresentationRow.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Table;

use ILIAS\UI\Component\Table as T;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\SignalGeneratorInterface;
use ILIAS\UI\Implementation\Component\Signal;
use ILIAS\UI\Component\Button\Button;
use ILIAS\UI\Component\Dropdown\Dropdown;
use ILIAS\UI\Component\Listing\Descriptive;

class PresentationRow implements T\PresentationRow
{
    use ComponentHelper;
    use JavaScriptBindable;

    private $action = null;

    protected Signal $show_signal;
    protected Signal $close_signal;
    protected Signal $toggle_signal;
    private ?string $headline = null;
    private ?string $subheadline = null;
    private array $important_fields = [];
    private Descriptive $content;
    private ?string $further_fields_headline = null;
    private array $further_fields = [];
    private array $data;
    protected SignalGeneratorInterface $signal_generator;
    protected string $table_id;

    public function __construct(
        SignalGeneratorInterface $signal_generator,
        string $table_id
    ) {
        $this->signal_generator = $signal_generator;
        $this->table_id = $table_id;
        $this->initSignals();
    }

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

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

    public function getShowSignal(): Signal
    {
        return $this->show_signal;
    }

    public function getCloseSignal(): Signal
    {
        return $this->close_signal;
    }


    public function getToggleSignal(): Signal
    {
        return $this->toggle_signal;
    }


    public function withHeadline($headline): T\PresentationRow
    {
        $this->checkStringArg("string", $headline);
        $clone = clone $this;
        $clone->headline = $headline;
        return $clone;
    }

    public function getHeadline(): ?string
    {
        return $this->headline;
    }

    public function withSubheadline($subheadline): T\PresentationRow
    {
        $this->checkStringArg("string", $subheadline);
        $clone = clone $this;
        $clone->subheadline = $subheadline;
        return $clone;
    }

    public function getSubheadline(): ?string
    {
        return $this->subheadline;
    }

    public function withImportantFields(array $fields): T\PresentationRow
    {
        $clone = clone $this;
        $clone->important_fields = $fields;
        return $clone;
    }

    public function getImportantFields(): array
    {
        return $this->important_fields;
    }


    public function withContent(Descriptive $content): T\PresentationRow
    {
        $clone = clone $this;
        $clone->content = $content;
        return $clone;
    }

    public function getContent(): Descriptive
    {
        return $this->content;
    }


    public function withFurtherFieldsHeadline($headline): T\PresentationRow
    {
        $this->checkStringArg("string", $headline);
        $clone = clone $this;
        $clone->further_fields_headline = $headline;
        return $clone;
    }

    public function getFurtherFieldsHeadline(): ?string
    {
        return $this->further_fields_headline;
    }

    public function withFurtherFields(array $fields): T\PresentationRow
    {
        $clone = clone $this;
        $clone->further_fields = $fields;
        return $clone;
    }

    public function getFurtherFields(): array
    {
        return $this->further_fields;
    }


    public function withAction($action): T\PresentationRow
    {
        $check =
            is_null($action)
            || $action instanceof Button
            || $action instanceof Dropdown;

        $expected =
            " NULL or " .
            " \ILIAS\UI\Component\Button\Button or " .
            " \ILIAS\UI\Component\ropdown\Dropdown";

        $this->checkArg("action", $check, $this->wrongTypeMessage($expected, $action));
        $clone = clone $this;
        $clone->action = $action;
        return $clone;
    }

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

    public function getTableId(): string
    {
        return $this->table_id;
    }
}