DocumentTable.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\LegalDocuments\Table;
 
use Closure;
use Generator;
use ilCalendarSettings;
use ilCtrlInterface;
use ILIAS\Data\Factory;
use ILIAS\Data\URI;
use ILIAS\LegalDocuments\ConsumerToolbox\UI;
use ILIAS\LegalDocuments\EditLinks;
use ILIAS\LegalDocuments\Repository\DocumentRepository;
use ILIAS\LegalDocuments\Value\Criterion;
use ILIAS\LegalDocuments\Value\Document;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Table\Action\Single;
use ILIAS\UI\Component\Table\OrderingRetrieval;
use ILIAS\UI\Component\Table\OrderingRow;
use ILIAS\UI\Component\Table\OrderingRowBuilder;
use ILIAS\UI\Component\Table\Action\Multi;
use ILIAS\UI\Component\Table\Ordering;
use ILIAS\UI\Renderer;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken;
use ilObjUser;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ServerRequestInterface;
 
class DocumentTable implements OrderingRetrieval
{
    public const CMD_EDIT_DOCUMENT = 'editDocument';
    public const CMD_DELETE_DOCUMENT = 'deleteDocument';
    public const CMD_DELETE_DOCUMENTS = 'deleteDocuments';
    public const CMD_ADD_CRITERION = 'addCriterion';
 
    private readonly ServerRequestInterface|RequestInterface $request;
    private readonly Factory $data_factory;
    private readonly ilCtrlInterface $ctrl;
    private readonly Ordering $table;
    private readonly Renderer $ui_renderer;
    private readonly ilObjUser $user;
    private readonly \DateTimeZone $usr_timezone;
 
    private array $modals = [];
 
    public function __construct(
        private readonly Closure $criterion_as_component,
        private readonly DocumentRepository $repository,
        private readonly UI $ui,
        private readonly DocumentModal $modal,
        private readonly object $gui,
        private readonly ?EditLinks $edit_links = null,
        ServerRequestInterface|RequestInterface|null $request = null,
        ?Factory $data_factory = null,
        ?ilCtrlInterface $ctrl = null,
        ?Renderer $ui_renderer = null,
        ?ilObjUser $user = null
    ) {
        global $DIC;
        $this->request = $request ?: $DIC->http()->request();
        $this->data_factory = $data_factory ?: new Factory();
        $this->ctrl = $ctrl ?: $DIC->ctrl();
        $this->ui_renderer = $ui_renderer ?: $DIC->ui()->renderer();
        $this->user = $user ?: $DIC->user();
        $this->usr_timezone = new \DateTimeZone($this->user->getTimeZone());
 
        $this->table = $this->buildTable();
    }
 
    private function buildTable(): Ordering
    {
        $uiTable = $this->ui->create()->table();
 
        if ((int) $this->user->getTimeFormat() === ilCalendarSettings::TIME_FORMAT_12) {
            $date_format = $this->data_factory->dateFormat()->withTime12($this->user->getDateFormat());
        } else {
            $date_format = $this->data_factory->dateFormat()->withTime24($this->user->getDateFormat());
        }
 
        $table = $uiTable->ordering(
            $this,
            (new URI((string) $this->request->getUri()))->withParameter('cmd', 'saveOrder'),
            $this->ui->txt('tbl_docs_title'),
            [
                'title' => $uiTable->column()->text($this->ui->txt('tbl_docs_head_title')),
                'created' => $uiTable->column()->date($this->ui->txt('tbl_docs_head_created'), $date_format),
                'change' => $uiTable->column()->date($this->ui->txt('tbl_docs_head_last_change'), $date_format),
                'criteria' => $uiTable->column()->text($this->ui->txt('tbl_docs_head_criteria')),
            ],
        )
            ->withId('legalDocsTable')
            ->withRequest($this->request);
 
        if ($this->edit_links) {
            $table = $table->withActions($this->buildTableActions());
        }
 
        return $table;
    }
 
    public function getRows(
        OrderingRowBuilder $row_builder,
        array $visible_column_ids
    ): Generator {
        foreach ($this->repository->all() as $document) {
            yield $this->buildTableRow($row_builder, $document);
        }
    }
 
    private function buildTableRow(OrderingRowBuilder $row_builder, Document $document): OrderingRow
    {
        $criterion_components = [];
        foreach ($document->criteria() as $criterion) {
            $criterion_components[] = $this->ui->create()->legacy()->content('<div style="display: flex; gap: 1rem;">');
            $criterion_components[] = $this->criterionName($criterion);
 
            if ($this->edit_links) {
                $delete_modal = $this->ui->create()->modal()->interruptive(
                    $this->ui->txt('doc_detach_crit_confirm_title'),
                    $this->ui->txt('doc_sure_detach_crit'),
                    $this->edit_links->deleteCriterion($document, $criterion)
                );
 
                $dropdown = $this->ui->create()->dropdown()->standard([
                    $this->ui->create()->button()->shy(
                        $this->ui->txt('edit'),
                        $this->edit_links->editCriterion($document, $criterion)
                    ),
                    $this->ui->create()->button()->shy(
                        $this->ui->txt('delete'),
                        ''
                    )->withOnClick($delete_modal->getShowSignal())
                ]);
 
                $this->modals[] = $delete_modal;
                $criterion_components[] = $dropdown;
            }
 
            $criterion_components[] = $this->ui->create()->legacy()->content('</div>');
        }
 
        $table_row = [
            'id' => $document->id(),
            'title' => $this->ui_renderer->render($this->modal->create($document->content())),
            'created' => $document->meta()->creation()->time()->setTimezone($this->usr_timezone),
            'change' => $document->meta()->lastModification()->time()->setTimezone($this->usr_timezone),
            'criteria' => $this->ui_renderer->render($criterion_components),
        ];
        return $row_builder->buildOrderingRow((string) $document->id(), $table_row);
    }
 
    public function criterionName(Criterion $criterion): Component
    {
        return ($this->criterion_as_component)($criterion->content());
    }
 
    public function getTotalRowCount(
        mixed $additional_viewcontrol_data,
        mixed $filter_data,
        mixed $additional_parameters
    ): ?int {
        return $this->repository->countAll();
    }
 
    public function render(): string
    {
        // This MUST be rendered BEFORE $this->modal->components(),
        // because the components are filled within the rendering process.
        $html = $this->ui_renderer->render($this->table);
 
        return $html . $this->ui_renderer->render([...$this->modal->popComponents(), ...$this->modals]);
    }
 
    private function buildTableActions(): array
    {
        return [
            self::CMD_DELETE_DOCUMENTS => $this->buildTableAction(self::CMD_DELETE_DOCUMENTS, $this->ui->txt('delete'), true),
            self::CMD_EDIT_DOCUMENT => $this->buildTableAction(self::CMD_EDIT_DOCUMENT, $this->ui->txt('edit')),
            self::CMD_ADD_CRITERION => $this->buildTableAction(
                self::CMD_ADD_CRITERION,
                $this->ui->txt('tbl_docs_action_add_criterion')
            ),
            self::CMD_DELETE_DOCUMENT => $this->buildTableAction(self::CMD_DELETE_DOCUMENT, $this->ui->txt('delete')),
        ];
    }
 
    private function buildTableAction(string $cmd, string $title, bool $multi = false): Single|Multi
    {
        $uri = $this->data_factory->uri(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this->gui, $cmd)
        );
 
        [
            $url_builder,
            $action_parameter_token,
            $row_id_token
        ] = (new URLBuilder($uri))->acquireParameters(
            ['legal_document'],
            'action',
            'id'
        );
 
        if ($multi) {
            return $this->ui->create()->table()->action()->multi(
                $title,
                $url_builder->withParameter($action_parameter_token, $cmd),
                $row_id_token
            );
        }
 
        return $this->ui->create()->table()->action()->single(
            $title,
            $url_builder->withParameter($action_parameter_token, $cmd),
            $row_id_token
        );
    }
}