Table.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\AdministrativeNotification;
 
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ilCtrlInterface;
use ilLanguage;
use ilADNNotificationGUI;
use ilObjAdministrativeNotificationAccess;
use ilBiblFieldFilterGUI;
use ilADNAbstractGUI;
use ILIAS\UI\URLBuilder;
use ILIAS\Data\URI;
use ILIAS\UI\URLBuilderToken;
 
class Table
{
    public const ACTION_EDIT = 'edit';
    public const ACTION_DELETE = 'delete';
    public const ACTION_RESET = 'reset';
    public const ACTION_DUPLICATE = 'duplicate';
    private Factory $ui_factory;
    private Renderer $ui_renderer;
    private ilCtrlInterface $ctrl;
    private ilLanguage $lng;
    private URLBuilder $url_builder;
    private URLBuilderToken $id_token;
    private bool $write_access;
 
    protected array $components = [];
 
    public function __construct(
        private ilADNNotificationGUI $calling_gui
    ) {
        global $DIC;
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
 
        $this->url_builder = $this->initURIBuilder();
        $this->write_access = (new ilObjAdministrativeNotificationAccess())->hasUserPermissionTo('write');
        $columns = $this->initColumns();
        $actions = $this->initActions();
        $data_retrieval = new DataRetrieval(
            $this->write_access
        );
 
        $this->components[] = $this->ui_factory->table()->data(
            $data_retrieval,
            $this->lng->txt('msg_table_title'),
            $columns,
        )->withActions($actions)->withRequest(
            $DIC->http()->request()
        );
    }
 
    private function initURIBuilder(): URLBuilder
    {
        $url_builder = new URLBuilder(
            $this->getURI(ilBiblFieldFilterGUI::CMD_STANDARD)
        );
 
        // these are the query parameters this instance is controlling
        $query_params_namespace = ['msg', 'notifications'];
        [$url_builder, $this->id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            ilADNAbstractGUI::IDENTIFIER
        );
 
        return $url_builder;
    }
 
    protected function initColumns(): array
    {
        return [
            'title' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_title')),
            'type' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_type')),
            'languages' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_languages')),
            'type_during_event' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_type_during_event')),
            'event_start' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_event_date_start')),
            'event_end' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_event_date_end')),
            'display_start' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_display_date_start')),
            'display_end' => $this->ui_factory->table()->column()->text($this->lng->txt('msg_display_date_end'))
        ];
    }
 
    protected function initActions(): array
    {
        if ($this->write_access === false) {
            return [];
        }
 
        return [
            self::ACTION_EDIT => $this->ui_factory->table()->action()->single(
                $this->lng->txt("btn_edit"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_EDIT)),
                $this->id_token
            ),
            self::ACTION_DELETE => $this->ui_factory->table()->action()->standard(
                $this->lng->txt("btn_delete"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_CONFIRM_DELETE)),
                $this->id_token
            )->withAsync(true),
            self::ACTION_RESET => $this->ui_factory->table()->action()->standard(
                $this->lng->txt("btn_reset"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_RESET)),
                $this->id_token
            ),
            self::ACTION_DUPLICATE => $this->ui_factory->table()->action()->single(
                $this->lng->txt("btn_duplicate"),
                $this->url_builder->withURI($this->getURI(ilADNNotificationGUI::CMD_DUPLICATE)),
                $this->id_token
            ),
        ];
    }
 
    protected function getURI(string $command): URI
    {
        return new URI(
            ILIAS_HTTP_PATH . "/" . $this->ctrl->getLinkTarget(
                $this->calling_gui,
                $command
            )
        );
    }
 
    public function getHTML(): string
    {
        return $this->ui_renderer->render($this->components);
    }
 
    public function getUrlBuilder(): URLBuilder
    {
        return $this->url_builder;
    }
 
    public function getIdToken(): URLBuilderToken
    {
        return $this->id_token;
    }
 
}