ilCourseParticipantsGroupsTableGUI Class Reference

Collaboration diagram for ilCourseParticipantsGroupsTableGUI:

Public Member Functions
	__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)
	getHTML ()
	handleCommands ()

Data Fields
const string	TABLE_COL_NAME = 'name'
const string	TABLE_COL_LOGIN = 'login'
const string	TABLE_COL_GROUP_NUMBER = 'groups_number'
const string	TABLE_COL_GROUPS = 'groups'
const string	TABLE_FILTER_NAME = 'filter_name'
const string	TABLE_FILTER_GROUPS = 'filter_groups'
	foreach ( $user_ids as $user_id)

Protected Member Functions
	buildAddToGroupString (int $group_ref_id)
	getColumns ()
	getActions ()
	getFilterFields ()
	initTable ()
	readIdsFromQuery ()
	addToGroup (array $user_ids, int $group_ref_id)
	unsubscribe (array $user_ids, int $group_id)

Protected Attributes
const string	ALL_OBJECTS = 'ALL_OBJECTS'
const string	TABLE_ID = 'crsprtcpntsgrpstbl'
const string	FILTER_ID = 'crsprtcpntsgrpstbl_filter'
const string	ROW_ID = 'row_ids'
const string	TABLE_ACTION_ID = 'table_action'
const string	TABLE_ACTION_ADD_TO_GROUP = 'add_to_group'
const string	LNG_TABLE_COL_NAME = 'name'
const string	LNG_TABLE_COL_LOGIN = 'login'
const string	LNG_TABLE_COL_GROUP_NUMBER = 'crs_groups_nr'
const string	LNG_TABLE_COL_GROUPS = 'groups'
const string	LNG_TABLE_ACTION_CONFIRM_UNSUBSCRIBE = 'grp_unsubscribe'
const string	LNG_TABLE_TITLE = 'crs_grp_assignments'
const string	LNG_ADD_TO_GROUP = 'crs_add_to_group'
URLBuilder	$url_builder
ilURLBuilderToken	$action_parameter_token
ilURLBuilderToken	$row_id_token
ilDataTable	$table
ilFilter	$filter

Private Member Functions
	initFilter ()

Detailed Description

Definition at line 32 of file class.ilCourseParticipantsGroupsTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilCourseParticipantsGroupsTableGUI::__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
	)

Definition at line 60 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\lng().

      {
        $this->lng->loadLanguageModule('grp');
    }

Here is the call graph for this function:

Member Function Documentation

addToGroup()

ilCourseParticipantsGroupsTableGUI::addToGroup ( array  $user_ids, int  $group_ref_id  )

protected

Definition at line 182 of file class.ilCourseParticipantsGroupsTableGUI.php.

References $message, ilGroupParticipants\_getInstanceByObjId(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\lng(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Referenced by handleCommands().

                                                                     : 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');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildAddToGroupString()

ilCourseParticipantsGroupsTableGUI::buildAddToGroupString ( int  $group_ref_id )

protected

Definition at line 76 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by getActions(), and handleCommands().

                                                               : string
    {
        return self::TABLE_ACTION_ADD_TO_GROUP . '_' . $group_ref_id;
    }

Here is the caller graph for this function:

getActions()

ilCourseParticipantsGroupsTableGUI::getActions ( )

protected

Definition at line 99 of file class.ilCourseParticipantsGroupsTableGUI.php.

References $ref_id, $row_id_token, buildAddToGroupString(), and ILIAS\Repository\lng().

Referenced by initTable().

                                   : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ilCourseParticipantsGroupsTableGUI::getColumns ( )

protected

Definition at line 81 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\lng().

Referenced by initTable().

                                   : 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)
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilterFields()

ilCourseParticipantsGroupsTableGUI::getFilterFields ( )

protected

Returns

[]

Definition at line 145 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\lng().

Referenced by initFilter().

                                        : 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()
            )
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilCourseParticipantsGroupsTableGUI::getHTML

(

)

Definition at line 262 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\filter(), initFilter(), and initTable().

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

Here is the call graph for this function:

handleCommands()

ilCourseParticipantsGroupsTableGUI::handleCommands

(

)

Definition at line 272 of file class.ilCourseParticipantsGroupsTableGUI.php.

References $ref_id, addToGroup(), buildAddToGroupString(), initTable(), readIdsFromQuery(), ILIAS\Repository\refinery(), and unsubscribe().

                                    : 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;
            }
        }
    }

Here is the call graph for this function:

initFilter()

ilCourseParticipantsGroupsTableGUI::initFilter ( )

private

Definition at line 126 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), and getFilterFields().

Referenced by getHTML().

                                 : 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
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTable()

ilCourseParticipantsGroupsTableGUI::initTable ( )

protected

Definition at line 158 of file class.ilCourseParticipantsGroupsTableGUI.php.

References getActions(), getColumns(), and ILIAS\Repository\lng().

Referenced by getHTML(), and handleCommands().

                                  : 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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readIdsFromQuery()

ilCourseParticipantsGroupsTableGUI::readIdsFromQuery ( )

protected

Definition at line 173 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ILIAS\Repository\refinery().

Referenced by handleCommands().

                                         : 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]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unsubscribe()

ilCourseParticipantsGroupsTableGUI::unsubscribe ( array  $user_ids, int  $group_id  )

protected

Definition at line 215 of file class.ilCourseParticipantsGroupsTableGUI.php.

References $user_id, ilGroupParticipants\_getInstanceByObjId(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER.

Referenced by handleCommands().

                                                                  : 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'), '')
            );
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_parameter_token

ilURLBuilderToken ilCourseParticipantsGroupsTableGUI::$action_parameter_token

protected

Definition at line 55 of file class.ilCourseParticipantsGroupsTableGUI.php.

$filter

ilFilter ilCourseParticipantsGroupsTableGUI::$filter

protected

Definition at line 58 of file class.ilCourseParticipantsGroupsTableGUI.php.

$row_id_token

ilURLBuilderToken ilCourseParticipantsGroupsTableGUI::$row_id_token

protected

Definition at line 56 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by getActions().

$table

ilDataTable ilCourseParticipantsGroupsTableGUI::$table

protected

Definition at line 57 of file class.ilCourseParticipantsGroupsTableGUI.php.

$url_builder

URLBuilder ilCourseParticipantsGroupsTableGUI::$url_builder

protected

Definition at line 54 of file class.ilCourseParticipantsGroupsTableGUI.php.

ALL_OBJECTS

const string ilCourseParticipantsGroupsTableGUI::ALL_OBJECTS = 'ALL_OBJECTS'

protected

Definition at line 40 of file class.ilCourseParticipantsGroupsTableGUI.php.

FILTER_ID

const string ilCourseParticipantsGroupsTableGUI::FILTER_ID = 'crsprtcpntsgrpstbl_filter'

protected

Definition at line 42 of file class.ilCourseParticipantsGroupsTableGUI.php.

foreach

ilCourseParticipantsGroupsTableGUI::foreach($user_ids as $user_id)

Initial value:

{
        $items = []

Definition at line 238 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_ADD_TO_GROUP

const string ilCourseParticipantsGroupsTableGUI::LNG_ADD_TO_GROUP = 'crs_add_to_group'

protected

Definition at line 52 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_ACTION_CONFIRM_UNSUBSCRIBE

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_ACTION_CONFIRM_UNSUBSCRIBE = 'grp_unsubscribe'

protected

Definition at line 50 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_COL_GROUP_NUMBER

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_COL_GROUP_NUMBER = 'crs_groups_nr'

protected

Definition at line 48 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_COL_GROUPS

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_COL_GROUPS = 'groups'

protected

Definition at line 49 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_COL_LOGIN

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_COL_LOGIN = 'login'

protected

Definition at line 47 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_COL_NAME

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_COL_NAME = 'name'

protected

Definition at line 46 of file class.ilCourseParticipantsGroupsTableGUI.php.

LNG_TABLE_TITLE

const string ilCourseParticipantsGroupsTableGUI::LNG_TABLE_TITLE = 'crs_grp_assignments'

protected

Definition at line 51 of file class.ilCourseParticipantsGroupsTableGUI.php.

ROW_ID

const string ilCourseParticipantsGroupsTableGUI::ROW_ID = 'row_ids'

protected

Definition at line 43 of file class.ilCourseParticipantsGroupsTableGUI.php.

TABLE_ACTION_ADD_TO_GROUP

const string ilCourseParticipantsGroupsTableGUI::TABLE_ACTION_ADD_TO_GROUP = 'add_to_group'

protected

Definition at line 45 of file class.ilCourseParticipantsGroupsTableGUI.php.

TABLE_ACTION_ID

const string ilCourseParticipantsGroupsTableGUI::TABLE_ACTION_ID = 'table_action'

protected

Definition at line 44 of file class.ilCourseParticipantsGroupsTableGUI.php.

TABLE_COL_GROUP_NUMBER

const string ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUP_NUMBER = 'groups_number'

Definition at line 36 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\getRows().

TABLE_COL_GROUPS

const string ilCourseParticipantsGroupsTableGUI::TABLE_COL_GROUPS = 'groups'

Definition at line 37 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\getRows().

TABLE_COL_LOGIN

const string ilCourseParticipantsGroupsTableGUI::TABLE_COL_LOGIN = 'login'

Definition at line 35 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\getRows().

TABLE_COL_NAME

const string ilCourseParticipantsGroupsTableGUI::TABLE_COL_NAME = 'name'

Definition at line 34 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\getRows().

TABLE_FILTER_GROUPS

const string ilCourseParticipantsGroupsTableGUI::TABLE_FILTER_GROUPS = 'filter_groups'

Definition at line 39 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\__construct().

TABLE_FILTER_NAME

const string ilCourseParticipantsGroupsTableGUI::TABLE_FILTER_NAME = 'filter_name'

Definition at line 38 of file class.ilCourseParticipantsGroupsTableGUI.php.

Referenced by ilCourseParticipantsGroupsTableDataRetrieval\__construct().

TABLE_ID

const string ilCourseParticipantsGroupsTableGUI::TABLE_ID = 'crsprtcpntsgrpstbl'

protected

Definition at line 41 of file class.ilCourseParticipantsGroupsTableGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Course/classes/class.ilCourseParticipantsGroupsTableGUI.php