Class ilCourseParticipantsGroupsGUI. More...

Collaboration diagram for ilCourseParticipantsGroupsGUI:

Public Member Functions
	__construct ($a_ref_id)

	executeCommand ()

	show ()

	applyFilter ()

	resetFilter ()

	confirmRemove ()

Protected Member Functions
	remove ()

	getMultiCommandGroupID ()

	add ()

Protected Attributes
ilAccessHandler	$access

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilErrorHandling	$error

ilGlobalTemplateInterface	$tpl

ilObjectDataCache	$objectDataCache

GlobalHttpState	$http

Factory	$refinery

Private Attributes
int	$ref_id = 0

Detailed Description

Class ilCourseParticipantsGroupsGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_Calls ilCourseParticipantsGroupsGUI:

Definition at line 29 of file class.ilCourseParticipantsGroupsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseParticipantsGroupsGUI::__construct ( $a_ref_id )

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

    {
        global $DIC;
 
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->error = $DIC['ilErr'];
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->objectDataCache = $DIC['ilObjDataCache'];
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        $this->ref_id = $a_ref_id;
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), error(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilCourseParticipantsGroupsGUI::add ( )

protected

Definition at line 184 of file class.ilCourseParticipantsGroupsGUI.php.

                            : void
    {
        $grp_id = $this->getMultiCommandGroupID();
        $usr_ids = [];
        if ($this->http->wrapper()->post()->has('usrs')) {
            $usr_ids = $this->http->wrapper()->post()->retrieve(
                'usrs',
                $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
            );
        }
 
        if (count($usr_ids) > 0) {
            if (!$this->access->checkRbacOrPositionPermissionAccess('manage_members', 'manage_members', $grp_id)) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
                $this->show();
                return;
            }
 
            $members_obj = ilGroupParticipants::_getInstanceByObjId($this->objectDataCache->lookupObjId($grp_id));
            $rejected_count = 0;
            foreach ($usr_ids as $new_member) {
                if (!$members_obj->add($new_member, ilParticipants::IL_GRP_MEMBER)) {
                    $rejected_count++;
                    continue;
                }
 
                $members_obj->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                    $new_member
                );
            }
 
            if ($rejected_count === 0) {
                $message = $this->lng->txt('grp_msg_member_assigned');
            } else {
                $accepted_count = count($usr_ids) - $rejected_count;
                $message = sprintf(
                    $this->lng->txt('grp_not_all_users_assigned_msg'),
                    $accepted_count,
                    $rejected_count
                );
            }
            $this->tpl->setOnScreenMessage('success', $message);
        }
        $this->show();
    }

References $message, ilGroupParticipants\_getInstanceByObjId(), ILIAS\Repository\access(), getMultiCommandGroupID(), ILIAS\FileDelivery\http(), ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), show(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

◆ applyFilter()

ilCourseParticipantsGroupsGUI::applyFilter ( )

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

                                 : void
    {
        $tbl_gui = new ilCourseParticipantsGroupsTableGUI($this, "show", $this->ref_id);
        $tbl_gui->resetOffset();
        $tbl_gui->writeFilterToSession();
        $this->show();
    }

References show().

Here is the call graph for this function:

◆ confirmRemove()

ilCourseParticipantsGroupsGUI::confirmRemove ( )

Definition at line 92 of file class.ilCourseParticipantsGroupsGUI.php.

                                   : void
    {
        $grp_id = 0;
        if ($this->http->wrapper()->query()->has('grp_id')) {
            $grp_id = $this->http->wrapper()->query()->retrieve(
                'grp_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this, 'remove'));
        $confirm->addHiddenItem("grp_id", $grp_id);
        $confirm->setHeaderText($this->lng->txt('grp_dismiss_member'));
        $confirm->setConfirm($this->lng->txt('confirm'), 'remove');
        $confirm->setCancel($this->lng->txt('cancel'), 'show');
 
        $usr_id = 0;
        if ($this->http->wrapper()->query()->has('usr_id')) {
            $usr_id = $this->http->wrapper()->query()->retrieve(
                'usr_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $confirm->addItem(
            'usr_id',
            $usr_id,
            ilUserUtil::getNamePresentation($usr_id, false, false, "", true),
            ilUtil::getImagePath('icon_usr.svg')
        );
 
        $this->tpl->setContent($confirm->getHTML());
    }

References ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilUserUtil\getNamePresentation(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ executeCommand()

ilCourseParticipantsGroupsGUI::executeCommand ( )

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

                                    : void
    {
        if (!$this->access->checkRbacOrPositionPermissionAccess('manage_members', 'manage_members', $this->ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->WARNING);
        }
        $cmd = $this->ctrl->getCmd();
        if (!$cmd) {
            $cmd = "show";
        }
        $this->$cmd();
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getMultiCommandGroupID()

ilCourseParticipantsGroupsGUI::getMultiCommandGroupID ( )

protected

Definition at line 160 of file class.ilCourseParticipantsGroupsGUI.php.

                                               : int
    {
        $grp_id = 0;
        $table_command = '';
        if (
            $this->http->wrapper()->post()->has('cmd') &&
            $this->http->wrapper()->post()->has('grp_id')
        ) {
            $grp_id = $this->http->wrapper()->post()->retrieve(
                'grp_id',
                $this->refinery->kindlyTo()->int()
            );
        } elseif (
            $this->http->wrapper()->post()->has('table_top_cmd') &&
            $this->http->wrapper()->post()->has('grp_id_2')
        ) {
            $grp_id = $this->http->wrapper()->post()->retrieve(
                'grp_id_2',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $grp_id;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

ilCourseParticipantsGroupsGUI::remove ( )

protected

Definition at line 125 of file class.ilCourseParticipantsGroupsGUI.php.

                               : void
    {
        $grp_id = 0;
        if ($this->http->wrapper()->post()->has('grp_id')) {
            $grp_id = $this->http->wrapper()->post()->retrieve(
                'grp_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $usr_id = 0;
        if ($this->http->wrapper()->post()->has('usr_id')) {
            $usr_id = $this->http->wrapper()->post()->retrieve(
                'usr_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if (!$this->access->checkRbacOrPositionPermissionAccess('manage_members', 'manage_members', $grp_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
            $this->show();
            return;
        }
 
        $members_obj = ilGroupParticipants::_getInstanceByObjId($this->objectDataCache->lookupObjId($grp_id));
        $members_obj->delete($usr_id);
 
        // Send notification
        $members_obj->sendNotification(
            ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER,
            (int) $usr_id
        );
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("grp_msg_membership_annulled"), true);
        $this->ctrl->redirect($this, "show");
    }

References ilGroupParticipants\_getInstanceByObjId(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), show(), and ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER.

Here is the call graph for this function:

◆ resetFilter()

ilCourseParticipantsGroupsGUI::resetFilter ( )

Definition at line 84 of file class.ilCourseParticipantsGroupsGUI.php.

                                 : void
    {
        $tbl_gui = new ilCourseParticipantsGroupsTableGUI($this, "show", $this->ref_id);
        $tbl_gui->resetOffset();
        $tbl_gui->resetFilter();
        $this->show();
    }

References show().

Here is the call graph for this function:

◆ show()

ilCourseParticipantsGroupsGUI::show ( )

Definition at line 70 of file class.ilCourseParticipantsGroupsGUI.php.

                          : void
    {
        $tbl_gui = new ilCourseParticipantsGroupsTableGUI($this, "show", $this->ref_id);
        $this->tpl->setContent($tbl_gui->getHTML());
    }