class.ilCourseParticipantsGroupsTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data\Factory as ilDataFactory;
use ILIAS\DI\UIServices as ilUIServices;
use ILIAS\HTTP\Services as ilHTTPServices;
use ILIAS\Refinery\Factory as ilRefineryFactory;
use ILIAS\UI\Component\Table\Data as ilDataTable;
use ILIAS\UI\Component\Input\Container\Filter\Filter as ilFilter;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken as ilURLBuilderToken;
use JetBrains\PhpStorm\NoReturn;
use ILIAS\UI\Component\Input\Container\Filter\Standard as FilterComponent;

class ilCourseParticipantsGroupsTableGUI
{
    public const string TABLE_COL_NAME = 'name';
    public const string TABLE_COL_LOGIN = 'login';
    public const string TABLE_COL_GROUP_NUMBER = 'groups_number';
    public const string TABLE_COL_GROUPS = 'groups';
    public const string TABLE_FILTER_NAME = 'filter_name';
    public const string TABLE_FILTER_GROUPS = 'filter_groups';
    protected const string ALL_OBJECTS = 'ALL_OBJECTS';
    protected const string TABLE_ID = 'crsprtcpntsgrpstbl';
    protected const string FILTER_ID = 'crsprtcpntsgrpstbl_filter';
    protected const string ROW_ID = 'row_ids';
    protected const string TABLE_ACTION_ID = 'table_action';
    protected const string TABLE_ACTION_ADD_TO_GROUP = 'add_to_group';
    protected const string LNG_TABLE_COL_NAME = 'name';
    protected const string LNG_TABLE_COL_LOGIN = 'login';
    protected const string LNG_TABLE_COL_GROUP_NUMBER = 'crs_groups_nr';
    protected const string LNG_TABLE_COL_GROUPS = 'groups';
    protected const string LNG_TABLE_ACTION_CONFIRM_UNSUBSCRIBE = 'grp_unsubscribe';
    protected const string LNG_TABLE_TITLE = 'crs_grp_assignments';
    protected const string LNG_ADD_TO_GROUP = 'crs_add_to_group';

    protected URLBuilder $url_builder;
    protected ilURLBuilderToken $action_parameter_token;
    protected ilURLBuilderToken $row_id_token;
    protected ilDataTable $table;
    protected ilFilter $filter;

    public function __construct(
        protected ilCourseParticipantsGroupsTableDataRetrieval $data_retrieval,
        protected ilUIServices $ui_services,
        protected ilUIService $ui_service,
        protected ilHTTPServices $http_services,
        protected ilRefineryFactory $refinery,
        protected ilLanguage $lng,
        protected ilCtrl $ctrl,
        protected ilDataFactory $data_factory,
        protected ilGlobalTemplateInterface $tpl,
        protected ilAccess $access,
        protected ilObjectDataCache $object_data_cache
    ) {
        $this->lng->loadLanguageModule('grp');
    }

    protected function buildAddToGroupString(int $group_ref_id): string
    {
        return self::TABLE_ACTION_ADD_TO_GROUP . '_' . $group_ref_id;
    }

    protected function getColumns(): array
    {
        return [
            self::TABLE_COL_NAME => $this->ui_services->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_NAME)
            ),
            self::TABLE_COL_LOGIN => $this->ui_services->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_LOGIN)
            ),
            self::TABLE_COL_GROUP_NUMBER => $this->ui_services->factory()->table()->column()->number(
                $this->lng->txt(self::LNG_TABLE_COL_GROUP_NUMBER)
            ),
            self::TABLE_COL_GROUPS => $this->ui_services->factory()->table()->column()->text(
                $this->lng->txt(self::LNG_TABLE_COL_GROUPS)
            )->withIsSortable(false)
        ];
    }

    protected function getActions(): array
    {
        $this->url_builder = new URLBuilder($this->data_factory->uri($this->http_services->request()->getUri()->__toString()));
        list($this->url_builder, $this->action_parameter_token, $this->row_id_token) =
            $this->url_builder->acquireParameters(
                ['datatable', self::TABLE_ID],
                self::TABLE_ACTION_ID,
                self::ROW_ID
            );
        $actions = [];
        foreach ($this->data_retrieval->getSelectableGroups() as $ref_id => $group_name) {
            $action_id = $this->buildAddToGroupString((int) $ref_id);
            $actions[$action_id] = $this->ui_services->factory()->table()->action()->multi(
                $this->lng->txt(self::LNG_ADD_TO_GROUP) . ': ' . $group_name,
                $this->url_builder->withParameter($this->action_parameter_token, $action_id),
                $this->row_id_token
            );
            $action_id = $this->data_retrieval->buildConfirmUnsubscribeActionId((int) $ref_id);
            $actions[$action_id] = $this->ui_services->factory()->table()->action()->single(
                $group_name . ' ' . $this->lng->txt(self::LNG_TABLE_ACTION_CONFIRM_UNSUBSCRIBE),
                $this->url_builder->withParameter($this->action_parameter_token, $action_id),
                $this->row_id_token
            )->withAsync(true);
        }
        return $actions;
    }

    private function initFilter(): void
    {
        if (isset($this->filter)) {
            return;
        }
        $filter_fields = $this->getFilterFields();
        $this->filter = $this->ui_service->filter()->standard(
            self::FILTER_ID,
            $this->ctrl->getLinkTargetByClass(ilCourseParticipantsGroupsGUI::class, 'show'),
            $filter_fields,
            array_fill(0, count($filter_fields), true),
            true,
            true
        );
    }

    protected function getFilterFields(): array
    {
        return [
            self::TABLE_FILTER_NAME => $this->ui_services->factory()->input()->field()->text(
                $this->lng->txt(self::LNG_TABLE_COL_NAME)
            ),
            self::TABLE_FILTER_GROUPS => $this->ui_services->factory()->input()->field()->select(
                $this->lng->txt(self::TABLE_COL_GROUPS),
                $this->data_retrieval->getSelectableGroups()
            )
        ];
    }

    protected function initTable(): void
    {
        if (isset($this->table)) {
            return;
        }
        $this->table = $this->ui_services->factory()->table()->data(
            $this->data_retrieval,
            $this->lng->txt(self::LNG_TABLE_TITLE),
            $this->getColumns()
        )
            ->withId(self::TABLE_ID)
            ->withActions($this->getActions())
            ->withRequest($this->http_services->request());
    }

    protected function readIdsFromQuery(): array
    {
        $tokens = $this->http_services->wrapper()->query()->retrieve(
            $this->row_id_token->getName(),
            $this->refinery->custom()->transformation(fn($v) => $v)
        );
        return is_null($tokens) ? [] : (is_array($tokens) ? $tokens : [$tokens]);
    }

    protected function addToGroup(array $user_ids, int $group_ref_id): void
    {
        if (!$this->access->checkRbacOrPositionPermissionAccess('manage_members', 'manage_members', $group_ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
            $this->ctrl->redirectByClass(ilCourseParticipantsGroupsGUI::class, 'show');
            return;
        }
        $members_obj = ilGroupParticipants::_getInstanceByObjId($this->object_data_cache->lookupObjId($group_ref_id));
        $rejected_count = 0;
        foreach ($user_ids as $new_member) {
            if (!$members_obj->add((int) $new_member, ilParticipants::IL_GRP_MEMBER)) {
                $rejected_count++;
                continue;
            }
            $members_obj->sendNotification(
                ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                (int) $new_member
            );
        }
        if ($rejected_count === 0) {
            $message = $this->lng->txt('grp_msg_member_assigned');
        } else {
            $accepted_count = count($user_ids) - $rejected_count;
            $message = sprintf(
                $this->lng->txt('grp_not_all_users_assigned_msg'),
                $accepted_count,
                $rejected_count
            );
        }
        $this->tpl->setOnScreenMessage('success', $message, true);
        $this->ctrl->redirectByClass(ilCourseParticipantsGroupsGUI::class, 'show');
    }

    protected function unsubscribe(array $user_ids, int $group_id): void
    {
        foreach ($user_ids as $user_id) {
            if (!$this->access->checkRbacOrPositionPermissionAccess('manage_members', 'manage_members', $group_id)) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
                $this->ctrl->redirectByClass(ilCourseParticipantsGroupsGUI::class, 'show');
                return;
            }
            $members_obj = ilGroupParticipants::_getInstanceByObjId($this->object_data_cache->lookupObjId($group_id));
            $members_obj->delete((int) $user_id);
            // Send notification
            $members_obj->sendNotification(
                ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER,
                (int) $user_id
            );
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("grp_msg_membership_annulled"), true);
        $this->ctrl->redirectByClass(ilCourseParticipantsGroupsGUI::class, "show");
    }

    #[NoReturn] protected function showConfirmUnsubscribeModal(array $user_ids, int $group_ref_id): void
    {
        $items = [];
        foreach ($user_ids as $user_id) {
            $items[] = $this->ui_services->factory()->modal()->interruptiveItem()->standard(
                $user_id . '',
                ilUserUtil::getNamePresentation($user_id, false, false, "", true),
                $this->ui_services->factory()->image()->standard(ilUtil::getImagePath('standard/icon_usr.svg'), '')
            );
        }
        echo($this->ui_services->renderer()->renderAsync([
            $this->ui_services->factory()->modal()->interruptive(
                $this->lng->txt('confirm'),
                $this->lng->txt('grp_dismiss_member'),
                (string) $this->url_builder
                    ->withParameter(
                        $this->action_parameter_token,
                        $this->data_retrieval->buildUnsubscribeActionId($group_ref_id)
                    )->withParameter(
                        $this->row_id_token,
                        $user_ids
                    )->buildURI()
            )->withAffectedItems($items)
        ]));
        exit();
    }

    public function getHTML(): string
    {
        $this->initTable();
        $this->initFilter();
        return $this->ui_services->renderer()->render([
            $this->filter,
            $this->table->withFilter($this->filter->getInputs())
        ]);
    }

    public function handleCommands(): void
    {
        $this->initTable();
        if (!$this->http_services->wrapper()->query()->has($this->action_parameter_token->getName())) {
            return;
        }
        $action = $this->http_services->wrapper()->query()->retrieve(
            $this->action_parameter_token->getName(),
            $this->refinery->to()->string()
        );
        $tokens = $this->http_services->wrapper()->query()->retrieve(
            $this->row_id_token->getName(),
            $this->refinery->custom()->transformation(fn($v) => $v)
        );
        $all_entries = ($tokens[0] ?? "") === self::ALL_OBJECTS;
        $user_ids = [];
        if ($all_entries) {
            $user_ids = $this->data_retrieval->getAllUserIds();
        }
        if (!$all_entries) {
            $user_ids = $this->readIdsFromQuery();
        }
        foreach ($this->data_retrieval->getSelectableGroups() as $ref_id => $group_name) {
            if ($action === $this->buildAddToGroupString((int) $ref_id)) {
                $this->addToGroup($user_ids, $ref_id);
                break;
            }
            if ($action === $this->data_retrieval->buildUnsubscribeActionId($ref_id)) {
                $this->unsubscribe($user_ids, $ref_id);
                break;
            }
            if ($action === $this->data_retrieval->buildConfirmUnsubscribeActionId($ref_id)) {
                $this->showConfirmUnsubscribeModal($user_ids, $ref_id);
                break;
            }
        }
    }
}