ilMembershipGUI Class Reference

Base class for member tab content. More...

Inheritance diagram for ilMembershipGUI:

Collaboration diagram for ilMembershipGUI:

Public Member Functions
	__construct (ilObjectGUI $repository_gui, ilObject $repository_obj)
	getParentGUI ()
	getParentObject ()
	getMembersObject ()
	filterUserIdsByRbacOrPositionOfCurrentUser (array $a_user_ids)
	Filter user ids by access. More...
	executeCommand ()
	getAttendanceListUserData (int $user_id, array $filters=[])
	updateParticipants ()
	update members More...
	createMailSignature ()
	Create Mail signature. More...
	addMemberTab (ilTabsGUI $tabs, bool $a_is_participant=false)
	readMemberData (array $usr_ids, array $columns)
	Required for member table guis. More...
	getLocalRoles ()
	confirmAssignSubscribers ()
	Show subscription confirmation. More...
	confirmRefuseSubscribers ()
	Refuse subscriber confirmation. More...
	assignSubscribers ()
	Do assignment of subscription request. More...
	confirmAssignFromWaitingList ()
	Assign from waiting list (confirmatoin) More...
	assignFromWaitingList ()
	Assign from waiting list. More...
	confirmRefuseFromList ()
	Refuse from waiting list (confirmation) More...

Protected Member Functions
	initParticipantsFromPost ()
	initMemberIdFromGet ()
	initSubscribersFromPost ()
	initWaitingListIdsFromPost ()
	getLanguage ()
	getCtrl ()
	getLogger ()
	getMailMemberRoles ()
	checkPermissionBool (string $a_permission, string $a_cmd='', string $a_type='', int $a_ref_id=0)
	checkRbacOrPositionAccessBool (string $a_rbac_perm, string $a_pos_perm, int $a_ref_id=0)
	checkPermission (string $a_permission, string $a_cmd="")
	Check permission If not granted redirect to parent gui. More...
	checkRbacOrPermissionAccess (string $a_rbac_perm, string $a_pos_perm)
	check rbac or position access More...
	canAddOrSearchUsers ()
	Check if current user is allowed to add / search users. More...
	participants ()
	Show participant table, subscriber table, wating list table;. More...
	getParticipantTableTitle ()
	participantsApplyFilter ()
	Apply filter for participant table. More...
	participantsResetFilter ()
	reset participants filter More...
	editMember ()
	Edit one participant. More...
	editParticipants (array $post_participants=array())
	Edit participants. More...
	updateLPFromStatus (int $usr_id, bool $has_passed)
	confirmDeleteParticipants ()
	Show confirmation screen for participants deletion. More...
	deleteParticipants ()
	sendMailToSelectedUsers ()
	getMailContextOptions ()
	membersMap ()
	Members map. More...
	mailMembersBtn ()
	showParticipantsToolbar ()
	Show participants toolbar. More...
	showMemberExportToolbarButton (ilToolbarGUI $toolbar, ?string $a_back_cmd=null, bool $a_separator=false)
	showMailToMemberToolbarButton (ilToolbarGUI $toolbar, ?string $a_back_cmd=null, bool $a_separator=false)
	Show mail to member toolbar button. More...
	getMailButtonLabel ()
	getDefaultCommand ()
	getMemberTabName ()
	setSubTabs (ilTabsGUI $tabs)
	Set sub tabs. More...
	parseSubscriberTable ()
	Parse table of subscription request. More...
	initSubscriberTable ()
	refuseSubscribers ()
	parseWaitingListTable ()
	Parse table of subscription request. More...
	refuseFromList ()
	refuse from waiting list More...
	addToClipboard ()
	Add selected users to user clipboard. More...
	getDefaultRole ()
	activateSubTab (string $a_sub_tab)
	printMembers ()
	printMembersOutput ()
	print members output More...
	printForMembersOutput ()
	print members output More...
	jump2UsersGallery ()
	initAttendanceList (bool $a_for_members=false)

Protected Attributes
GlobalHttpState	$http
Factory	$refinery
ilLanguage	$lng
ilCtrlInterface	$ctrl
ilLogger	$logger
ilGlobalTemplateInterface	$tpl
ilAccessHandler	$access
ilParticipants	$participants = null
ilObjUser	$user
ilErrorHandling	$error
ilTabsGUI	$tabs
ilToolbarGUI	$toolbar
ilRbacSystem	$rbacsystem
ilRbacReview	$rbacreview
ilTree	$tree
array	$member_data = []

Private Attributes
ilObject	$repository_object
ilObjectGUI	$repository_gui

Detailed Description

Base class for member tab content.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 28 of file class.ilMembershipGUI.php.

Constructor & Destructor Documentation

__construct()

ilMembershipGUI::__construct	(	ilObjectGUI	$repository_gui,
		ilObject	$repository_obj
	)

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

References $DIC, $repository_gui, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getParentObject(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->repository_gui = $repository_gui;
        $this->repository_object = $repository_obj;

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('crs');
        $this->lng->loadLanguageModule($this->getParentObject()->getType());
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng->loadLanguageModule('trac');
        $this->logger = $DIC->logger()->mmbr();
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->error = $DIC['ilErr'];
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->rbacreview = $DIC->rbac()->review();
        $this->tree = $DIC->repositoryTree();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

Here is the call graph for this function:

Member Function Documentation

activateSubTab()

ilMembershipGUI::activateSubTab ( string  $a_sub_tab )

protected

Definition at line 1516 of file class.ilMembershipGUI.php.

References ILIAS\Repository\tabs().

Referenced by editMember(), executeCommand(), membersMap(), and participants().

                                                        : void
    {
        $this->tabs->activateSubTab($a_sub_tab);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMemberTab()

ilMembershipGUI::addMemberTab	(	ilTabsGUI	$tabs,
		bool	$a_is_participant = false
	)

Definition at line 983 of file class.ilMembershipGUI.php.

References ilTabsGUI\addTab(), checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), getMemberTabName(), getParentObject(), and ILIAS\Repository\user().

                                                                                 : void
    {
        $mail = new ilMail($this->user->getId());

        $member_tab_name = $this->getMemberTabName();

        $has_manage_members_permission = $this->checkRbacOrPositionAccessBool(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId()
        );

        if ($has_manage_members_permission) {
            $tabs->addTab(
                'members',
                $member_tab_name,
                $this->ctrl->getLinkTarget($this, '')
            );
        } elseif (
            $this->getParentObject()->getShowMembers() &&
            $a_is_participant
        ) {
            $tabs->addTab(
                'members',
                $member_tab_name,
                $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilusersgallerygui'), 'view')
            );
        } elseif (
            $this->getParentObject()->getMailToMembersType() === 1 &&
            $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId()) &&
            $a_is_participant
        ) {
            $tabs->addTab(
                'members',
                $member_tab_name,
                $this->ctrl->getLinkTarget($this, "mailMembersBtn")
            );
        }
    }

Here is the call graph for this function:

addToClipboard()

ilMembershipGUI::addToClipboard ( )

protected

Add selected users to user clipboard.

Definition at line 1486 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), ilUserClipboard\getInstance(), ILIAS\FileDelivery\http(), initParticipantsFromPost(), initSubscribersFromPost(), initWaitingListIdsFromPost(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                       : void
    {
        // begin-patch clipboard
        $users = [];
        if ($this->http->wrapper()->post()->has('participants')) {
            $users = $this->initParticipantsFromPost();
        } elseif ($this->http->wrapper()->post()->has('subscribers')) {
            $users = $this->initSubscribersFromPost();
        } elseif ($this->http->wrapper()->post()->has('waiting')) {
            $users = $this->initWaitingListIdsFromPost();
        }
        // end-patch clipboard
        if (!count($users)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $clip = ilUserClipboard::getInstance($this->user->getId());
        $clip->add($users);
        $clip->save();

        $this->lng->loadLanguageModule('user');
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('clipboard_user_added'), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

assignFromWaitingList()

ilMembershipGUI::assignFromWaitingList

(

)

Assign from waiting list.

Definition at line 1352 of file class.ilMembershipGUI.php.

References $user_id, ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByObjId(), getMembersObject(), getParentObject(), ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_GRP_MEMBER, initWaitingListIdsFromPost(), ILIAS\Repository\lng(), ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, and ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER.

                                           : void
    {
        $waiting_list_ids = $this->initWaitingListIdsFromPost();
        if (!count($waiting_list_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_users_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $waiting_list = $this->initWaitingList();

        $added_users = 0;
        foreach ($waiting_list_ids as $user_id) {
            if (!$tmp_obj = ilObjectFactory::getInstanceByObjId((int) $user_id, false)) {
                continue;
            }
            if ($this->getMembersObject()->isAssigned((int) $user_id)) {
                continue;
            }

            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->add($user_id, ilParticipants::IL_CRS_MEMBER);
                $this->getMembersObject()->sendNotification(
                    ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                    (int) $user_id,
                    true
                );
                $this->getParentObject()->checkLPStatusSync((int) $user_id);
            }
            if ($this instanceof ilGroupMembershipGUI) {
                $this->getMembersObject()->add($user_id, ilParticipants::IL_GRP_MEMBER);
                $this->getMembersObject()->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER,
                    (int) $user_id,
                    true
                );
            }
            if ($this instanceof ilSessionMembershipGUI) {
                $this->getMembersObject()->register((int) $user_id);
                $noti = new ilSessionMembershipMailNotification();
                $noti->setRefId($this->getParentObject()->getRefId());
                $noti->setRecipients(array($user_id));
                $noti->setType(ilSessionMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
                $noti->send();
            }

            $waiting_list->removeFromList((int) $user_id);
            ++$added_users;
        }

        if ($added_users) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("crs_users_added"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("crs_users_already_assigned"), true);
        }
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

assignSubscribers()

ilMembershipGUI::assignSubscribers

(

)

Do assignment of subscription request.

Definition at line 1256 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), initSubscribersFromPost(), ILIAS\Repository\lng(), ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, and ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER.

                                       : void
    {
        $subscribers = $this->initSubscribersFromPost();
        if (!count($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        if (!$this->getMembersObject()->assignSubscribers($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->error->getMessage(), true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ($subscribers as $usr_id) {
                if ($this instanceof ilCourseMembershipGUI) {
                    $this->getMembersObject()->sendNotification(
                        ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                    $this->getParentObject()->checkLPStatusSync($usr_id);
                }
                if ($this instanceof ilGroupMembershipGUI) {
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                }
                if ($this instanceof ilSessionMembershipGUI) {
                    // todo refactor to participants
                    $noti = new ilSessionMembershipMailNotification();
                    $noti->setRefId($this->getParentObject()->getRefId());
                    $noti->setRecipients(array($usr_id));
                    $noti->setType(ilSessionMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
                    $noti->send();
                }
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("crs_subscribers_assigned"), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

canAddOrSearchUsers()

ilMembershipGUI::canAddOrSearchUsers ( )

protected

Check if current user is allowed to add / search users.

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

References checkPermissionBool().

Referenced by showParticipantsToolbar().

                                            : bool
    {
        return $this->checkPermissionBool('manage_members');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermission()

ilMembershipGUI::checkPermission ( string  $a_permission, string  $a_cmd = ""  )

protected

Check permission If not granted redirect to parent gui.

Definition at line 193 of file class.ilMembershipGUI.php.

References checkPermissionBool(), ILIAS\Repository\ctrl(), getParentGUI(), and ILIAS\Repository\lng().

Referenced by ilSessionMembershipGUI\deleteParticipants(), executeCommand(), ilLearningSequenceMembershipGUI\printMembers(), printMembers(), and ilSessionMembershipGUI\updateMembers().

                                                                                : void
    {
        if (!$this->checkPermissionBool($a_permission, $a_cmd)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'), true);
            $this->ctrl->redirect($this->getParentGUI());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermissionBool()

ilMembershipGUI::checkPermissionBool ( string  $a_permission, string  $a_cmd = '', string  $a_type = '', int  $a_ref_id = 0  )

protected

Definition at line 166 of file class.ilMembershipGUI.php.

References ILIAS\Repository\access(), and getParentObject().

Referenced by canAddOrSearchUsers(), checkPermission(), ilSessionMembershipGUI\checkRbacOrPositionAccessBool(), and confirmDeleteParticipants().

     : bool {
        if ($a_ref_id === 0) {
            $a_ref_id = $this->getParentObject()->getRefId();
        }
        return $this->access->checkAccess($a_permission, $a_cmd, $a_ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkRbacOrPermissionAccess()

ilMembershipGUI::checkRbacOrPermissionAccess ( string  $a_rbac_perm, string  $a_pos_perm  )

protected

check rbac or position access

Definition at line 204 of file class.ilMembershipGUI.php.

References checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), getParentGUI(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                                                           : void
    {
        if (!$this->checkRbacOrPositionAccessBool($a_rbac_perm, $a_pos_perm)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'), true);
            $this->ctrl->redirect($this->getParentGUI());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkRbacOrPositionAccessBool()

ilMembershipGUI::checkRbacOrPositionAccessBool ( string  $a_rbac_perm, string  $a_pos_perm, int  $a_ref_id = 0  )

protected

Definition at line 178 of file class.ilMembershipGUI.php.

References ILIAS\Repository\access(), and getParentObject().

Referenced by addMemberTab(), ilCourseMembershipGUI\assignMembers(), checkRbacOrPermissionAccess(), executeCommand(), getDefaultCommand(), ilLearningSequenceMembershipGUI\members(), ilLearningSequenceMembershipGUI\printMembers(), ilLearningSequenceMembershipGUI\setSubTabs(), and setSubTabs().

     : bool {
        if ($a_ref_id === 0) {
            $a_ref_id = $this->getParentObject()->getRefId();
        }
        return $this->access->checkRbacOrPositionPermissionAccess($a_rbac_perm, $a_pos_perm, $a_ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmAssignFromWaitingList()

ilMembershipGUI::confirmAssignFromWaitingList

(

)

Assign from waiting list (confirmatoin)

Definition at line 1321 of file class.ilMembershipGUI.php.

References ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), initWaitingListIdsFromPost(), and ILIAS\Repository\lng().

                                                  : void
    {
        $waiting_list_ids = $this->initWaitingListIdsFromPost();
        if (!count($waiting_list_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_users_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $c_gui = new ilConfirmationGUI();
        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "assignFromWaitingList"));
        $c_gui->setHeaderText($this->lng->txt("info_assign_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "participants");
        $c_gui->setConfirm($this->lng->txt("confirm"), "assignFromWaitingList");

        foreach ($waiting_list_ids as $waiting) {
            $name = ilObjUser::_lookupName($waiting);

            $c_gui->addItem(
                'waiting[]',
                (string) $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }

        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

confirmAssignSubscribers()

ilMembershipGUI::confirmAssignSubscribers

(

)

Show subscription confirmation.

Definition at line 1147 of file class.ilMembershipGUI.php.

References ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), initSubscribersFromPost(), and ILIAS\Repository\lng().

                                              : void
    {
        $subscribers = $this->initSubscribersFromPost();
        if (!count($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $c_gui = new ilConfirmationGUI();

        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "assignSubscribers"));
        $c_gui->setHeaderText($this->lng->txt("info_assign_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "participants");
        $c_gui->setConfirm($this->lng->txt("confirm"), "assignSubscribers");

        foreach ($subscribers as $subscriber) {
            $name = ilObjUser::_lookupName($subscriber);

            $c_gui->addItem(
                'subscribers[]',
                (string) $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }
        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

confirmDeleteParticipants()

ilMembershipGUI::confirmDeleteParticipants ( )

protected

Show confirmation screen for participants deletion.

Definition at line 667 of file class.ilMembershipGUI.php.

References $participants, ilObjUser\_lookupName(), ILIAS\Repository\access(), checkPermissionBool(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), getMembersObject(), initParticipantsFromPost(), ilCourseReferencePathInfo\isReferenceMemberUpdateConfirmationRequired(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                                  : void
    {
        $participants = $this->initParticipantsFromPost();

        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }

        // Check last admin
        if (!$this->getMembersObject()->checkLastAdmin($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($this->getParentObject()->getType() . '_at_least_one_admin'), true);
            $this->ctrl->redirect($this, 'participants');
        }

        // if only position access is granted, show additional info
        if (!$this->checkPermissionBool('manage_members')) {
            $this->lng->loadLanguageModule('rbac');
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('rbac_info_only_position_access'));
        }

        // Access check for admin deletion
        if (
            !$this->access->checkAccess(
                'edit_permission',
                '',
                $this->getParentObject()->getRefId()
            ) &&
            !$this->getMembersObject()->isAdmin($this->user->getId())
        ) {
            foreach ($participants as $usr_id) {
                if ($this->getMembersObject()->isAdmin($usr_id)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_perm_perm"), true);
                    $this->ctrl->redirect($this, 'participants');
                }
            }
        }

        if (ilCourseReferencePathInfo::isReferenceMemberUpdateConfirmationRequired(
            $this->repository_object->getRefId(),
            $participants
        )) {
            $this->showDeleteParticipantsConfirmationWithLinkedCourses($participants);
            return;
        }

        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this, 'confirmDeleteParticipants'));
        $confirm->setHeaderText($this->lng->txt($this->getParentObject()->getType() . '_header_delete_members'));
        $confirm->setConfirm($this->lng->txt('confirm'), 'deleteParticipants');
        $confirm->setCancel($this->lng->txt('cancel'), 'participants');

        foreach ($participants as $usr_id) {
            $name = ilObjUser::_lookupName($usr_id);

            $confirm->addItem(
                'participants[]',
                (string) $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

confirmRefuseFromList()

ilMembershipGUI::confirmRefuseFromList

(

)

Refuse from waiting list (confirmation)

Definition at line 1412 of file class.ilMembershipGUI.php.

References ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), initWaitingListIdsFromPost(), and ILIAS\Repository\lng().

                                           : void
    {
        $waiting_list_ids = $this->initWaitingListIdsFromPost();
        if (!count($waiting_list_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $this->lng->loadLanguageModule('mmbr');
        $c_gui = new ilConfirmationGUI();

        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "refuseFromList"));
        $c_gui->setHeaderText($this->lng->txt("info_refuse_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "participants");
        $c_gui->setConfirm($this->lng->txt("confirm"), "refuseFromList");

        foreach ($waiting_list_ids as $waiting) {
            $name = ilObjUser::_lookupName($waiting);

            $c_gui->addItem(
                'waiting[]',
                (string) $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }
        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

confirmRefuseSubscribers()

ilMembershipGUI::confirmRefuseSubscribers

(

)

Refuse subscriber confirmation.

Definition at line 1179 of file class.ilMembershipGUI.php.

References ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), initSubscribersFromPost(), and ILIAS\Repository\lng().

                                              : void
    {
        $subscribers = $this->initSubscribersFromPost();
        if (!count($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $this->lng->loadLanguageModule('mmbr');
        $c_gui = new ilConfirmationGUI();
        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "refuseSubscribers"));
        $c_gui->setHeaderText($this->lng->txt("info_refuse_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "participants");
        $c_gui->setConfirm($this->lng->txt("confirm"), "refuseSubscribers");

        foreach ($subscribers as $subscriber_id) {
            $name = ilObjUser::_lookupName($subscriber_id);

            $c_gui->addItem(
                'subscribers[]',
                (string) $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }

        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

createMailSignature()

ilMembershipGUI::createMailSignature

(

)

Create Mail signature.

Todo:

better implementation

Definition at line 961 of file class.ilMembershipGUI.php.

References getParentGUI().

Referenced by sendMailToSelectedUsers().

                                         : string
    {
        return $this->getParentGUI()->createMailSignature();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteParticipants()

ilMembershipGUI::deleteParticipants ( )

protected

Definition at line 732 of file class.ilMembershipGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), initParticipantsFromPost(), ILIAS\Repository\lng(), ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER, ilLearningSequenceMembershipMailNotification\TYPE_DISMISS_MEMBER, ilCourseMembershipMailNotification\TYPE_DISMISS_MEMBER, and ILIAS\Repository\user().

Referenced by ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses().

                                           : void
    {
        $participants = $this->initParticipantsFromPost();
        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        // If the user doesn't have the edit_permission and is not administrator, he may not remove
        // members who have the course administrator role
        if (
            !$this->access->checkAccess('edit_permission', '', $this->getParentObject()->getRefId()) &&
            !$this->getMembersObject()->isAdmin($this->user->getId())
        ) {
            foreach ($participants as $part) {
                if ($this->getMembersObject()->isAdmin($part)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_perm'), true);
                    $this->ctrl->redirect($this, 'participants');
                }
            }
        }

        if (!$this->getMembersObject()->deleteParticipants($participants)) {
            $this->tpl->setOnScreenMessage('failure', 'Error deleting participants.', true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ($participants as $usr_id) {
                $mail_type = 0;
                // @todo more generic
                switch ($this->getParentObject()->getType()) {
                    case 'crs':
                        $mail_type = ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER;
                        break;
                    case 'grp':
                        $mail_type = ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER;
                        break;
                    case 'lso':
                        $mail_type = ilLearningSequenceMembershipMailNotification::TYPE_DISMISS_MEMBER;
                        break;
                }
                $this->getMembersObject()->sendNotification($mail_type, $usr_id);
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt($this->getParentObject()->getType() . "_members_deleted"), true);
        $this->ctrl->redirect($this, "participants");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editMember()

ilMembershipGUI::editMember ( )

protected

Edit one participant.

Definition at line 459 of file class.ilMembershipGUI.php.

References activateSubTab(), editParticipants(), getParentObject(), and initMemberIdFromGet().

                                   : void
    {
        $this->activateSubTab($this->getParentObject()->getType() . "_member_administration");
        $this->editParticipants(array($this->initMemberIdFromGet()));
    }

Here is the call graph for this function:

editParticipants()

ilMembershipGUI::editParticipants ( array  $post_participants = array() )

protected

Edit participants.

Parameters

int[]

$post_participants

Definition at line 469 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), getMembersObject(), initParticipantsFromPost(), and ILIAS\Repository\lng().

Referenced by editMember().

                                                                           : void
    {
        if (!$post_participants) {
            $post_participants = $this->initParticipantsFromPost();
        }

        $real_participants = $this->getMembersObject()->getParticipants();
        $participants = array_intersect($post_participants, $real_participants);

        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $table = $this->initEditParticipantTableGUI($participants);
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilMembershipGUI::executeCommand

(

)

Definition at line 230 of file class.ilMembershipGUI.php.

References $provider, ilParticipants\_isParticipant(), ILIAS\Repository\access(), activateSubTab(), checkPermission(), checkRbacOrPermissionAccess(), checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), getDefaultCommand(), getDefaultRole(), ILIAS\Survey\Mode\getId(), ilParticipants\getInstance(), getLocalRoles(), getMailMemberRoles(), getMembersObject(), getParentGUI(), getParentObject(), ilParticipants\isAdmin(), ILIAS\Repository\lng(), ilCourseConstants\MAIL_ALLOWED_ALL, setSubTabs(), showMailToMemberToolbarButton(), showMemberExportToolbarButton(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

                                    : void
    {
        $cmd = $this->ctrl->getCmd('participants');
        $next_class = $this->ctrl->getNextClass();

        switch ($next_class) {
            case 'ilrepositorysearchgui':

                $this->checkPermission('manage_members');

                $rep_search = new ilRepositorySearchGUI();
                $rep_search->addUserAccessFilterCallable([$this, 'filterUserIdsByRbacOrPositionOfCurrentUser']);

                $participants = $this->getMembersObject();
                if (
                    $participants->isAdmin($this->user->getId()) ||
                    $this->access->checkAccess('manage_members', '', $this->getParentObject()->getRefId())
                ) {
                    $rep_search->setCallback(
                        $this,
                        'assignMembers',
                        $this->getParentGUI()->getLocalRoles(),
                        (string) $this->getDefaultRole()
                    );
                } else {
                    //#18445 excludes admin role
                    $rep_search->setCallback(
                        $this,
                        'assignMembers',
                        $this->getLocalRoles(),
                        (string) $this->getDefaultRole()
                    );
                }

                // Set tabs
                $this->ctrl->setReturn($this, 'participants');
                $ret = $this->ctrl->forwardCommand($rep_search);
                break;

            case 'ilmailmembersearchgui':
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('btn_back'),
                    $this->ctrl->getLinkTarget($this, $this->getDefaultCommand())
                );

                $mail = new ilMail($this->user->getId());
                if (!(
                    $this->getParentObject()->getMailToMembersType() === ilCourseConstants::MAIL_ALLOWED_ALL ||
                        $this->access->checkAccess('manage_members', "", $this->getParentObject()->getRefId())
                ) ||
                    !$this->rbacsystem->checkAccess(
                        'internal_mail',
                        $mail->getMailObjectReferenceId()
                    )) {
                    $this->error->raiseError($this->lng->txt("msg_no_perm_read"), $this->error->MESSAGE);
                }

                $mail_search = new ilMailMemberSearchGUI(
                    $this,
                    $this->getParentObject()->getRefId(),
                    $this->getMailMemberRoles()
                );
                $mail_search->setObjParticipants(
                    ilParticipants::getInstance($this->getParentObject()->getRefId())
                );
                $this->ctrl->forwardCommand($mail_search);
                break;

            case 'ilusersgallerygui':

                $this->setSubTabs($this->tabs);
                $this->tabs->setSubTabActive(
                    $this->getParentObject()->getType() . '_members_gallery'
                );
                $is_admin = $this->checkRbacOrPositionAccessBool('manage_members', 'manage_members');
                $is_participant = ilParticipants::_isParticipant(
                    $this->getParentObject()->getRefId(),
                    $this->user->getId()
                );
                if (
                    !$is_admin &&
                    (
                        !$this->getParentObject()->getShowMembers() ||
                        !$is_participant
                    )
                ) {
                    $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
                }

                $this->showMailToMemberToolbarButton($this->toolbar, 'jump2UsersGallery');
                $this->showMemberExportToolbarButton($this->toolbar, 'jump2UsersGallery');

                $provider = new ilUsersGalleryParticipants($this->getParentObject()->getMembersObject());
                $gallery_gui = new ilUsersGalleryGUI($provider);
                $this->ctrl->forwardCommand($gallery_gui);
                break;

            case 'ilcourseparticipantsgroupsgui':

                $this->setSubTabs($this->tabs);
                $this->checkRbacOrPermissionAccess('manage_members', 'manage_members');

                $cmg_gui = new ilCourseParticipantsGroupsGUI($this->getParentObject()->getRefId());
                if ($cmd === "show" || $cmd = "") {
                    $this->showMailToMemberToolbarButton($this->toolbar);
                }
                $this->ctrl->forwardCommand($cmg_gui);
                break;

            case 'ilsessionoverviewgui':

                $this->setSubTabs($this->tabs);
                $this->checkRbacOrPermissionAccess('manage_members', 'manage_members');

                $prt = ilParticipants::getInstance($this->getParentObject()->getRefId());

                $overview = new ilSessionOverviewGUI($this->getParentObject()->getRefId(), $prt);
                $this->ctrl->forwardCommand($overview);
                break;

            case 'ilmemberexportgui':

                $this->setSubTabs($this->tabs);
                $this->checkRbacOrPermissionAccess('manage_members', 'manage_members');

                $export = new ilMemberExportGUI($this->getParentObject()->getRefId());
                $this->ctrl->forwardCommand($export);
                break;

            case 'ilobjectcustomuserfieldsgui':

                $this->setSubTabs($this->tabs);
                $this->checkRbacOrPermissionAccess('manage_members', 'manage_members');
                $this->activateSubTab($this->getParentObject()->getType() . "_member_administration");
                $this->ctrl->setReturn($this, 'participants');
                $cdf_gui = new ilObjectCustomUserFieldsGUI($this->getParentGUI()->getObject()->getId());
                $this->ctrl->forwardCommand($cdf_gui);
                break;

            default:
                $this->setSubTabs($this->tabs);
                //exclude mailMembersBtn cmd from this check
                if (
                    $cmd === "mailMembersBtn" ||
                    $cmd === 'membersMap' ||
                    $cmd === 'printForMembersOutput' ||
                    $cmd === 'jump2UsersGallery'
                ) {
                    $this->checkPermission('read');
                } else {
                    $this->checkRbacOrPermissionAccess('manage_members', 'manage_members');
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

filterUserIdsByRbacOrPositionOfCurrentUser()

ilMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser

(

array

$a_user_ids

)

Filter user ids by access.

Parameters

int[]

$a_usr_ids

Returns

int[]

Definition at line 225 of file class.ilMembershipGUI.php.

Referenced by parseSubscriberTable(), parseWaitingListTable(), and printMembersOutput().

                                                                                 : array
    {
        return $a_user_ids;
    }

Here is the caller graph for this function:

getAttendanceListUserData()

ilMembershipGUI::getAttendanceListUserData	(	int	$user_id,
		array	$filters = []
	)

Definition at line 427 of file class.ilMembershipGUI.php.

                                                                                : array
    {
        return [];
    }

getCtrl()

ilMembershipGUI::getCtrl ( )

protected

Definition at line 133 of file class.ilMembershipGUI.php.

References $ctrl.

Referenced by ilSessionMembershipGUI\updateMembers().

                                : ilCtrlInterface
    {
        return $this->ctrl;
    }

Here is the caller graph for this function:

getDefaultCommand()

ilMembershipGUI::getDefaultCommand ( )

protected

Definition at line 966 of file class.ilMembershipGUI.php.

References checkRbacOrPositionAccessBool(), and getParentObject().

Referenced by executeCommand().

                                          : string
    {
        $has_manage_members_permission = $this->checkRbacOrPositionAccessBool(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId()
        );
        if ($has_manage_members_permission) {
            return 'participants';
        }

        if ($this->getParentObject()->getShowMembers()) {
            return 'jump2UsersGallery';
        }
        return 'mailMembersBtn';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultRole()

ilMembershipGUI::getDefaultRole ( )

protected

Definition at line 1511 of file class.ilMembershipGUI.php.

Referenced by executeCommand(), and showParticipantsToolbar().

                                       : ?int
    {
        return null;
    }

Here is the caller graph for this function:

getLanguage()

ilMembershipGUI::getLanguage ( )

protected

Definition at line 128 of file class.ilMembershipGUI.php.

References $lng.

Referenced by ilSessionMembershipGUI\updateMembers().

                                    : ilLanguage
    {
        return $this->lng;
    }

Here is the caller graph for this function:

getLocalRoles()

ilMembershipGUI::getLocalRoles

(

)

Returns

array<int, string>

Definition at line 1115 of file class.ilMembershipGUI.php.

References getParentGUI().

Referenced by executeCommand().

                                   : array
    {
        return $this->getParentGUI()->getLocalRoles();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLogger()

ilMembershipGUI::getLogger ( )

protected

Definition at line 138 of file class.ilMembershipGUI.php.

References $logger.

                                  : ilLogger
    {
        return $this->logger;
    }

getMailButtonLabel()

ilMembershipGUI::getMailButtonLabel ( )

protected

Definition at line 952 of file class.ilMembershipGUI.php.

References ILIAS\Repository\lng().

Referenced by showMailToMemberToolbarButton().

                                           : string
    {
        return $this->lng->txt("mail_members");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMailContextOptions()

ilMembershipGUI::getMailContextOptions ( )

protected

Definition at line 817 of file class.ilMembershipGUI.php.

Referenced by sendMailToSelectedUsers().

                                              : array
    {
        return [];
    }

Here is the caller graph for this function:

getMailMemberRoles()

ilMembershipGUI::getMailMemberRoles ( )

protected

Definition at line 161 of file class.ilMembershipGUI.php.

Referenced by executeCommand().

                                           : ?ilAbstractMailMemberRoles
    {
        return null;
    }

Here is the caller graph for this function:

getMembersObject()

ilMembershipGUI::getMembersObject

(

)

Definition at line 153 of file class.ilMembershipGUI.php.

References $participants, ilParticipants\getInstance(), getParentObject(), and participants().

Referenced by assignFromWaitingList(), ilGroupMembershipGUI\assignMembers(), ilCourseMembershipGUI\assignMembers(), assignSubscribers(), confirmDeleteParticipants(), ilSessionMembershipGUI\deleteParticipants(), deleteParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), editParticipants(), executeCommand(), ilSessionMembershipGUI\getAttendanceListUserData(), ilCourseMembershipGUI\getPrintMemberData(), initAttendanceList(), parseSubscriberTable(), printForMembersOutput(), printMembersOutput(), refuseFromList(), refuseSubscribers(), updateParticipants(), ilGroupMembershipGUI\updateParticipantsStatus(), and ilCourseMembershipGUI\updateParticipantsStatus().

                                      : ilParticipants
    {
        if ($this->participants instanceof ilParticipants) {
            return $this->participants;
        }
        return $this->participants = ilParticipants::getInstance($this->getParentObject()->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberTabName()

ilMembershipGUI::getMemberTabName ( )

protected

Definition at line 1023 of file class.ilMembershipGUI.php.

References ILIAS\Repository\lng().

Referenced by addMemberTab().

                                         : string
    {
        return $this->lng->txt('members');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentGUI()

ilMembershipGUI::getParentGUI

(

)

Definition at line 143 of file class.ilMembershipGUI.php.

References $repository_gui.

Referenced by checkPermission(), checkRbacOrPermissionAccess(), createMailSignature(), ilCourseMembershipGUI\deliverCertificate(), executeCommand(), ilGroupMembershipGUI\getDefaultRole(), ilCourseMembershipGUI\getDefaultRole(), getLocalRoles(), ilGroupMembershipGUI\getPrintMemberData(), ilLearningSequenceMembershipGUI\getPrintMemberData(), ilGroupMembershipGUI\initEditParticipantTableGUI(), ilCourseMembershipGUI\initEditParticipantTableGUI(), ilCourseMembershipGUI\readMemberData(), readMemberData(), ilLearningSequenceMembershipGUI\showParticipantsToolbar(), showParticipantsToolbar(), and ilCourseMembershipGUI\updateLPFromStatus().

                                  : ilObjectGUI
    {
        return $this->repository_gui;
    }

Here is the caller graph for this function:

getParentObject()

ilMembershipGUI::getParentObject

(

)

Definition at line 148 of file class.ilMembershipGUI.php.

References $repository_object.

Referenced by __construct(), addMemberTab(), assignFromWaitingList(), ilGroupMembershipGUI\assignMembers(), ilCourseMembershipGUI\assignMembers(), assignSubscribers(), checkPermissionBool(), ilSessionMembershipGUI\checkRbacOrPositionAccessBool(), checkRbacOrPositionAccessBool(), ilSessionMembershipGUI\deleteParticipants(), deleteParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), editMember(), executeCommand(), ilCourseMembershipGUI\filterUserIdsByRbacOrPositionOfCurrentUser(), ilGroupMembershipGUI\filterUserIdsByRbacOrPositionOfCurrentUser(), getDefaultCommand(), ilGroupMembershipGUI\getLocalTypeRole(), ilCourseMembershipGUI\getLocalTypeRole(), ilCourseMembershipGUI\getMailContextOptions(), ilGroupMembershipGUI\getMailContextOptions(), ilSessionMembershipGUI\getMailContextOptions(), getMembersObject(), ilSessionMembershipGUI\getMemberTabName(), ilSessionMembershipGUI\getParticipantTableTitle(), getParticipantTableTitle(), ilCourseMembershipGUI\getPrintMemberData(), initAttendanceList(), ilGroupMembershipGUI\initEditParticipantTableGUI(), ilCourseMembershipGUI\initEditParticipantTableGUI(), ilSessionMembershipGUI\initParticipantTableGUI(), ilGroupMembershipGUI\initParticipantTableGUI(), ilCourseMembershipGUI\initParticipantTableGUI(), ilSessionMembershipGUI\initSubscriberTable(), initSubscriberTable(), ilSessionMembershipGUI\initWaitingList(), ilGroupMembershipGUI\initWaitingList(), ilCourseMembershipGUI\initWaitingList(), membersMap(), parseWaitingListTable(), participants(), printForMembersOutput(), refuseFromList(), refuseSubscribers(), setSubTabs(), ilCourseMembershipGUI\showDeleteParticipantsConfirmationWithLinkedCourses(), showMailToMemberToolbarButton(), showMemberExportToolbarButton(), ilSessionMembershipGUI\updateMembers(), and updateParticipants().

                                     : ilObject
    {
        return $this->repository_object;
    }

Here is the caller graph for this function:

getParticipantTableTitle()

ilMembershipGUI::getParticipantTableTitle ( )

protected

Definition at line 422 of file class.ilMembershipGUI.php.

References getParentObject(), and ILIAS\Repository\lng().

Referenced by participants().

                                                 : string
    {
        return $this->lng->txt($this->getParentObject()->getType() . '_mem_tbl_header');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initAttendanceList()

ilMembershipGUI::initAttendanceList ( bool  $a_for_members = false )

protected

Definition at line 1589 of file class.ilMembershipGUI.php.

References $DIC, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ILIAS\Survey\Mode\getId(), ilObjectLP\getInstance(), ilPrivacySettings\getInstance(), ilParticipants\getInstance(), getMembersObject(), getParentObject(), and ILIAS\Repository\lng().

Referenced by printForMembersOutput(), ilLearningSequenceMembershipGUI\printMembers(), printMembers(), and printMembersOutput().

                                                                      : ?ilAttendanceList
    {
        global $DIC;

        $waiting_list = $this->initWaitingList();

        if ($this instanceof ilSessionMembershipGUI) {
            /*
             * TODO this exact logic is also in ilSessionParticipantsTableGUI and ilSessionMembershipGUI,
             *  should be centralized.
             */
            $member_id = $DIC->repositoryTree()->checkForParentType(
                $this->getParentObject()->getRefId(),
                'grp'
            );
            if (!$member_id) {
                $member_id = $DIC->repositoryTree()->checkForParentType(
                    $this->getParentObject()->getRefId(),
                    'crs'
                );
            }
            if (!$member_id) {
                $DIC->logger()->sess()->warning('Cannot find parent course or group for ref_id: ' . $this->getParentObject()->getRefId());
                $member_id = $this->getParentObject()->getRefId();
            }
            $part = ilParticipants::getInstance($member_id);

            $list = new ilAttendanceList(
                $this,
                $this->getParentObject(),
                $part,
                $waiting_list
            );
        } else {
            $list = new ilAttendanceList(
                $this,
                $this->getParentObject(),
                $this->getMembersObject(),
                $waiting_list
            );
        }
        $list->setId($this->getParentObject()->getType() . '_memlist_' . $this->getParentObject()->getId());

        $list->setTitle(
            $this->lng->txt($this->getParentObject()->getType() . '_members_print_title'),
            $this->lng->txt('obj_' . $this->getParentObject()->getType()) . ': ' . $this->getParentObject()->getTitle()
        );

        $show_tracking =
            (ilObjUserTracking::_enabledLearningProgress() and ilObjUserTracking::_enabledUserRelatedData());
        if ($show_tracking) {
            $olp = ilObjectLP::getInstance($this->getParentObject()->getId());
            $show_tracking = $olp->isActive();
        }
        if ($show_tracking && $this->getParentObject()->getType() !== 'sess') {
            $list->addPreset('progress', $this->lng->txt('learning_progress'), true);
        }

        $privacy = ilPrivacySettings::getInstance();
        if ($privacy->enabledAccessTimesByType($this->getParentObject()->getType())) {
            $list->addPreset('access', $this->lng->txt('last_access'), true);
        }

        switch ($this->getParentObject()->getType()) {
            case 'crs':
                $list->addPreset('status', $this->lng->txt('crs_status'), true);
                $list->addPreset('passed', $this->lng->txt('crs_passed'), true);
                break;

            case 'sess':
                $list->addPreset('mark', $this->lng->txt('trac_mark'), true);
                $list->addPreset('comment', $this->lng->txt('trac_comment'), true);
                if ($this->getParentObject()->enabledRegistration()) {
                    $list->addPreset('registered', $this->lng->txt('event_tbl_registered'), true);
                }
                $list->addPreset('participated', $this->lng->txt('event_tbl_participated'), true);
                $list->addBlank($this->lng->txt('sess_signature'));

                $list->addUserFilter('registered', $this->lng->txt('event_list_registered_only'));
                break;

            case 'grp':
            default:
                break;
        }
        return $list;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initMemberIdFromGet()

ilMembershipGUI::initMemberIdFromGet ( )

protected

Definition at line 91 of file class.ilMembershipGUI.php.

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

Referenced by editMember(), and sendMailToSelectedUsers().

                                            : int
    {
        if ($this->http->wrapper()->query()->has('member_id')) {
            return $this->http->wrapper()->query()->retrieve(
                'member_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initParticipantsFromPost()

ilMembershipGUI::initParticipantsFromPost ( )

protected

Returns

int[]

Definition at line 78 of file class.ilMembershipGUI.php.

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

Referenced by addToClipboard(), confirmDeleteParticipants(), deleteParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), editParticipants(), sendMailToSelectedUsers(), and updateParticipants().

                                                 : array
    {
        if ($this->http->wrapper()->post()->has('participants')) {
            return $this->http->wrapper()->post()->retrieve(
                'participants',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSubscribersFromPost()

ilMembershipGUI::initSubscribersFromPost ( )

protected

Definition at line 102 of file class.ilMembershipGUI.php.

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

Referenced by addToClipboard(), assignSubscribers(), confirmAssignSubscribers(), confirmRefuseSubscribers(), refuseSubscribers(), and sendMailToSelectedUsers().

                                                : array
    {
        if ($this->http->wrapper()->post()->has('subscribers')) {
            return $this->http->wrapper()->post()->retrieve(
                'subscribers',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSubscriberTable()

ilMembershipGUI::initSubscriberTable ( )

protected

Definition at line 1137 of file class.ilMembershipGUI.php.

References getParentObject(), and ILIAS\Repository\lng().

Referenced by parseSubscriberTable().

                                            : ilSubscriberTableGUI
    {
        $subscriber = new ilSubscriberTableGUI($this, $this->getParentObject(), true, true);
        $subscriber->setTitle($this->lng->txt('group_new_registrations'));
        return $subscriber;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initWaitingListIdsFromPost()

ilMembershipGUI::initWaitingListIdsFromPost ( )

protected

Definition at line 115 of file class.ilMembershipGUI.php.

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

Referenced by addToClipboard(), assignFromWaitingList(), confirmAssignFromWaitingList(), confirmRefuseFromList(), refuseFromList(), and sendMailToSelectedUsers().

                                                   : array
    {
        if ($this->http->wrapper()->post()->has('waiting')) {
            return $this->http->wrapper()->post()->retrieve(
                'waiting',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

jump2UsersGallery()

ilMembershipGUI::jump2UsersGallery ( )

protected

Definition at line 1584 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl().

Referenced by ilLearningSequenceMembershipGUI\members().

                                          : void
    {
        $this->ctrl->redirectByClass('ilUsersGalleryGUI');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mailMembersBtn()

ilMembershipGUI::mailMembersBtn ( )

protected

Definition at line 852 of file class.ilMembershipGUI.php.

References showMailToMemberToolbarButton(), and ILIAS\Repository\toolbar().

                                       : void
    {
        $this->showMailToMemberToolbarButton($this->toolbar, 'mailMembersBtn');
    }

Here is the call graph for this function:

membersMap()

ilMembershipGUI::membersMap ( )

protected

Members map.

Definition at line 825 of file class.ilMembershipGUI.php.

References $user_id, activateSubTab(), ILIAS\Survey\Mode\getId(), ilParticipants\getInstanceByObjId(), ilMapUtil\getMapGUI(), getParentObject(), and ilMapUtil\isActivated().

                                   : void
    {
        $this->activateSubTab($this->getParentObject()->getType() . "_members_map");
        if (!ilMapUtil::isActivated() || !$this->getParentObject()->getEnableMap()) {
            return;
        }

        $map = ilMapUtil::getMapGUI();
        $map->setMapId("course_map")
            ->setWidth("700px")
            ->setHeight("500px")
            ->setLatitude($this->getParentObject()->getLatitude())
            ->setLongitude($this->getParentObject()->getLongitude())
            ->setZoom($this->getParentObject()->getLocationZoom())
            ->setEnableTypeControl(true)
            ->setEnableNavigationControl(true)
            ->setEnableCentralMarker(true);

        $members = ilParticipants::getInstanceByObjId($this->getParentObject()->getId())->getParticipants();
        foreach ($members as $user_id) {
            $map->addUserMarker($user_id);
        }

        $this->tpl->setContent($map->getHtml());
        $this->tpl->setLeftContent($map->getUserListHtml());
    }

Here is the call graph for this function:

parseSubscriberTable()

ilMembershipGUI::parseSubscriberTable ( )

protected

Parse table of subscription request.

Definition at line 1123 of file class.ilMembershipGUI.php.

References filterUserIdsByRbacOrPositionOfCurrentUser(), getMembersObject(), and initSubscriberTable().

Referenced by participants().

                                             : ?ilSubscriberTableGUI
    {
        $subscribers = $this->getMembersObject()->getSubscribers();
        $filtered_subscribers = $this->filterUserIdsByRbacOrPositionOfCurrentUser($subscribers);
        if (!count($filtered_subscribers)) {
            return null;
        }
        $subscriber = $this->initSubscriberTable();
        $subscriber->readSubscriberData(
            $filtered_subscribers
        );
        return $subscriber;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseWaitingListTable()

ilMembershipGUI::parseWaitingListTable ( )

protected

Parse table of subscription request.

Definition at line 1299 of file class.ilMembershipGUI.php.

References filterUserIdsByRbacOrPositionOfCurrentUser(), getParentObject(), and ILIAS\Repository\lng().

Referenced by participants().

                                              : ?ilWaitingListTableGUI
    {
        $wait = $this->initWaitingList();

        $wait_users = $this->filterUserIdsByRbacOrPositionOfCurrentUser($wait->getUserIds());
        if (!count($wait_users)) {
            return null;
        }

        $waiting_table = new ilWaitingListTableGUI($this, $this->getParentObject(), $wait);
        $waiting_table->setUserIds(
            $wait_users
        );
        $waiting_table->readUserData();
        $waiting_table->setTitle($this->lng->txt('crs_waiting_list'));

        return $waiting_table;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

participants()

ilMembershipGUI::participants ( )

protected

Show participant table, subscriber table, wating list table;.

Definition at line 391 of file class.ilMembershipGUI.php.

References activateSubTab(), ILIAS\Repository\ctrl(), getParentObject(), getParticipantTableTitle(), parseSubscriberTable(), parseWaitingListTable(), and showParticipantsToolbar().

Referenced by getMembersObject(), ilLearningSequenceMembershipGUI\members(), participantsApplyFilter(), and participantsResetFilter().

                                     : void
    {
        $this->initParticipantTemplate();
        $this->showParticipantsToolbar();
        $this->activateSubTab($this->getParentObject()->getType() . "_member_administration");

        // show waiting list table
        $waiting = $this->parseWaitingListTable();
        if ($waiting instanceof ilWaitingListTableGUI) {
            $this->tpl->setVariable('TABLE_WAIT', $waiting->getHTML());
        }

        // show subscriber table
        $subscriber = $this->parseSubscriberTable();
        if ($subscriber instanceof ilSubscriberTableGUI) {
            $this->tpl->setVariable('TABLE_SUB', $subscriber->getHTML());
        }

        // show member table
        $table = $this->initParticipantTableGUI();
        $table->setTitle($this->getParticipantTableTitle());
        $table->setFormAction($this->ctrl->getFormAction($this));
        $table->parse();

        // filter commands
        $table->setFilterCommand('participantsApplyFilter');
        $table->setResetCommand('participantsResetFilter');

        $this->tpl->setVariable('MEMBERS', $table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

participantsApplyFilter()

ilMembershipGUI::participantsApplyFilter ( )

protected

Apply filter for participant table.

Definition at line 435 of file class.ilMembershipGUI.php.

References participants().

                                                : void
    {
        $table = $this->initParticipantTableGUI();
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->participants();
    }

Here is the call graph for this function:

participantsResetFilter()

ilMembershipGUI::participantsResetFilter ( )

protected

reset participants filter

Definition at line 447 of file class.ilMembershipGUI.php.

References participants().

                                                : void
    {
        $table = $this->initParticipantTableGUI();
        $table->resetOffset();
        $table->resetFilter();

        $this->participants();
    }

Here is the call graph for this function:

printForMembersOutput()

ilMembershipGUI::printForMembersOutput ( )

protected

print members output

Definition at line 1567 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), initAttendanceList(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                              : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'jump2UsersGallery')
        );

        $list = $this->initAttendanceList();
        $list->setTitle($this->lng->txt('obj_' . $this->getParentObject()->getType()) . ': ' . $this->getParentObject()->getTitle());
        $list->initFromSettings();
        $list->setCallback([$this, 'getAttendanceListUserData']);
        $this->member_data = $this->getPrintMemberData($this->getMembersObject()->getParticipants());
        $list->getNonMemberUserData($this->member_data);
        $list->getFullscreenHTML();
    }

Here is the call graph for this function:

printMembers()

ilMembershipGUI::printMembers ( )

protected

Todo:

: refactor to own class

Definition at line 1524 of file class.ilMembershipGUI.php.

References checkPermission(), ILIAS\Repository\ctrl(), initAttendanceList(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                     : void
    {
        $this->checkPermission('read');

        $this->tabs->clearTargets();

        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'participants')
        );

        $list = $this->initAttendanceList();
        $form = $list->initForm('printMembersOutput');
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

printMembersOutput()

ilMembershipGUI::printMembersOutput ( )

protected

print members output

Definition at line 1543 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), filterUserIdsByRbacOrPositionOfCurrentUser(), getMembersObject(), initAttendanceList(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                           : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'participants')
        );

        $list = $this->initAttendanceList();
        $list->initFromForm();
        $list->setCallback([$this, 'getAttendanceListUserData']);
        $this->member_data = $this->getPrintMemberData(
            $this->filterUserIdsByRbacOrPositionOfCurrentUser(
                $this->getMembersObject()->getParticipants()
            )
        );

        $list->getNonMemberUserData($this->member_data);
        $list->getFullscreenHTML();
    }

Here is the call graph for this function:

readMemberData()

ilMembershipGUI::readMemberData	(	array	$usr_ids,
		array	$columns
	)

Required for member table guis.

Todo:

needs refactoring and should not be located in GUI classes

Definition at line 1107 of file class.ilMembershipGUI.php.

References getParentGUI().

Referenced by ilGroupMembershipGUI\getPrintMemberData(), and ilGroupMembershipGUI\initEditParticipantTableGUI().

                                                                  : array
    {
        return $this->getParentGUI()->readMemberData($usr_ids, $columns);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

refuseFromList()

ilMembershipGUI::refuseFromList ( )

protected

refuse from waiting list

Definition at line 1444 of file class.ilMembershipGUI.php.

References $user_id, ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), initWaitingListIdsFromPost(), ILIAS\Repository\lng(), ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, and ilSessionMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER.

                                       : void
    {
        $waiting_list_ids = $this->initWaitingListIdsFromPost();
        if (!count($waiting_list_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $waiting_list = $this->initWaitingList();

        foreach ($waiting_list_ids as $user_id) {
            $waiting_list->removeFromList((int) $user_id);

            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->sendNotification(
                    ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                    (int) $user_id,
                    true
                );
            }
            if ($this instanceof ilGroupMembershipGUI) {
                $this->getMembersObject()->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                    (int) $user_id,
                    true
                );
            }
            if ($this instanceof ilSessionMembershipGUI) {
                $noti = new ilSessionMembershipMailNotification();
                $noti->setRefId($this->getParentObject()->getRefId());
                $noti->setRecipients(array($user_id));
                $noti->setType(ilSessionMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
                $noti->send();
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('crs_users_removed_from_list'), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

refuseSubscribers()

ilMembershipGUI::refuseSubscribers ( )

protected

Definition at line 1208 of file class.ilMembershipGUI.php.

References ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), initSubscribersFromPost(), ILIAS\Repository\lng(), ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilLearningSequenceMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, and ilSessionMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER.

                                          : void
    {
        $subscribers = $this->initSubscribersFromPost();
        if (!count($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        if (!$this->getMembersObject()->deleteSubscribers($subscribers)) {
            $this->tpl->setOnScreenMessage('failure', $this->error->getMessage(), true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ($subscribers as $usr_id) {
                if ($this instanceof ilCourseMembershipGUI) {
                    $this->getMembersObject()->sendNotification(
                        ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                }
                if ($this instanceof ilGroupMembershipGUI) {
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                }
                if ($this instanceof ilSessionMembershipGUI) {
                    $noti = new ilSessionMembershipMailNotification();
                    $noti->setRefId($this->getParentObject()->getRefId());
                    $noti->setRecipients(array($usr_id));
                    $noti->setType(ilSessionMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
                    $noti->send();
                }
                if ($this instanceof ilLearningSequenceMembershipGUI) {
                    $this->getMembersObject()->sendNotification(
                        ilLearningSequenceMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                }
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("crs_subscribers_deleted"), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

sendMailToSelectedUsers()

ilMembershipGUI::sendMailToSelectedUsers ( )

protected

Definition at line 779 of file class.ilMembershipGUI.php.

References ilObjUser\_lookupLogin(), createMailSignature(), ILIAS\Repository\ctrl(), getMailContextOptions(), ilMailFormCall\getRedirectTarget(), ILIAS\FileDelivery\http(), initMemberIdFromGet(), initParticipantsFromPost(), initSubscribersFromPost(), initWaitingListIdsFromPost(), ILIAS\Repository\lng(), ilUtil\redirect(), and ilMailFormCall\setRecipients().

                                                : void
    {
        $participants = [];
        if ($this->http->wrapper()->post()->has('participants')) {
            $participants = $this->initParticipantsFromPost();
        } elseif ($this->http->wrapper()->post()->has('subscribers')) {
            $participants = $this->initSubscribersFromPost();
        } elseif ($this->http->wrapper()->post()->has('waiting')) {
            $participants = $this->initWaitingListIdsFromPost();
        } elseif ($this->http->wrapper()->query()->has('member_id')) {
            $participants = [$this->initMemberIdFromGet()];
        }
        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $rcps = [];
        foreach ($participants as $usr_id) {
            $rcps[] = ilObjUser::_lookupLogin($usr_id);
        }
        $context_options = $this->getMailContextOptions();

        ilMailFormCall::setRecipients($rcps);
        ilUtil::redirect(
            ilMailFormCall::getRedirectTarget(
                $this,
                'participants',
                array(),
                array(
                    'type' => 'new',
                    'sig' => $this->createMailSignature()
                ),
                $context_options
            )
        );
    }

Here is the call graph for this function:

setSubTabs()

ilMembershipGUI::setSubTabs ( ilTabsGUI  $tabs )

protected

Set sub tabs.

Definition at line 1031 of file class.ilMembershipGUI.php.

References ilTabsGUI\addSubTabTarget(), checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), ilPrivacySettings\getInstance(), getParentObject(), and ilMapUtil\isActivated().

Referenced by executeCommand().

                                                  : void
    {
        if ($this->checkRbacOrPositionAccessBool(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId()
        )) {
            $tabs->addSubTabTarget(
                $this->getParentObject()->getType() . "_member_administration",
                $this->ctrl->getLinkTarget($this, 'participants'),
                "members",
                get_class($this)
            );

            // show group overview
            if ($this instanceof ilCourseMembershipGUI) {
                $tabs->addSubTabTarget(
                    "crs_members_groups",
                    $this->ctrl->getLinkTargetByClass("ilCourseParticipantsGroupsGUI", "show"),
                    "",
                    "ilCourseParticipantsGroupsGUI"
                );
            }

            $children = $this->tree->getSubTree(
                $this->tree->getNodeData($this->getParentObject()->getRefId()),
                false,
                ['sess']
            );
            if (count($children)) {
                $tabs->addSubTabTarget(
                    'events',
                    $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilsessionoverviewgui'), 'listSessions'),
                    '',
                    'ilsessionoverviewgui'
                );
            }
            $tabs->addSubTabTarget(
                $this->getParentObject()->getType() . '_members_gallery',
                $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilUsersGalleryGUI')),
                'view',
                'ilUsersGalleryGUI'
            );
        } elseif ($this->getParentObject()->getShowMembers()) {
            // gallery
            $tabs->addSubTabTarget(
                $this->getParentObject()->getType() . '_members_gallery',
                $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilUsersGalleryGUI')),
                'view',
                'ilUsersGalleryGUI'
            );
        }

        if (ilMapUtil::isActivated() && $this->getParentObject()->getEnableMap()) {
            $tabs->addSubTabTarget(
                $this->getParentObject()->getType() . '_members_map',
                $this->ctrl->getLinkTarget($this, 'membersMap'),
                "membersMap",
                get_class($this)
            );
        }

        if (ilPrivacySettings::getInstance()->checkExportAccess($this->getParentObject()->getRefId())) {
            $tabs->addSubTabTarget(
                'export_members',
                $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilmemberexportgui'), 'show'),
                '',
                'ilmemberexportgui'
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMailToMemberToolbarButton()

ilMembershipGUI::showMailToMemberToolbarButton ( ilToolbarGUI  $toolbar, ?string  $a_back_cmd = null, bool  $a_separator = false  )

protected

Show mail to member toolbar button.

Definition at line 923 of file class.ilMembershipGUI.php.

References ILIAS\Repository\access(), ilToolbarGUI\addButton(), ilToolbarGUI\addSeparator(), ILIAS\Repository\ctrl(), getMailButtonLabel(), getParentObject(), and ILIAS\Repository\user().

Referenced by executeCommand(), mailMembersBtn(), ilLearningSequenceMembershipGUI\showParticipantsToolbar(), and showParticipantsToolbar().

     : void {
        $mail = new ilMail($this->user->getId());

        if (
            ($this->getParentObject()->getMailToMembersType() === 1) ||
            (
                $this->access->checkAccess('manage_members', "", $this->getParentObject()->getRefId()) &&
                $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId())
            )
        ) {
            if ($a_separator) {
                $toolbar->addSeparator();
            }

            if ($a_back_cmd !== null) {
                $this->ctrl->setParameter($this, "back_cmd", $a_back_cmd);
            }

            $toolbar->addButton(
                $this->getMailButtonLabel(),
                $this->ctrl->getLinkTargetByClass('ilMailMemberSearchGUI', '')
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMemberExportToolbarButton()

ilMembershipGUI::showMemberExportToolbarButton ( ilToolbarGUI  $toolbar, ?string  $a_back_cmd = null, bool  $a_separator = false  )

protected

Definition at line 898 of file class.ilMembershipGUI.php.

References ilToolbarGUI\addButton(), ilToolbarGUI\addSeparator(), ILIAS\Repository\ctrl(), getParentObject(), and ILIAS\Repository\lng().

Referenced by executeCommand().

     : void {
        if (
            $this->getParentObject()->getType() === 'crs' &&
            $this->getParentObject()->getShowMembersExport()) {
            if ($a_separator) {
                $toolbar->addSeparator();
            }

            if ($a_back_cmd) {
                $this->ctrl->setParameter($this, "back_cmd", $a_back_cmd);
            }
            $toolbar->addButton(
                $this->lng->txt($this->getParentObject()->getType() . '_print_list'),
                $this->ctrl->getLinkTarget($this, 'printForMembersOutput')
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showParticipantsToolbar()

ilMembershipGUI::showParticipantsToolbar ( )

protected

Show participants toolbar.

Definition at line 860 of file class.ilMembershipGUI.php.

References canAddOrSearchUsers(), ILIAS\Repository\ctrl(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), getDefaultRole(), getParentGUI(), ILIAS\Repository\lng(), showMailToMemberToolbarButton(), and ILIAS\Repository\toolbar().

Referenced by participants().

                                                : void
    {
        if ($this->canAddOrSearchUsers()) {
            ilRepositorySearchGUI::fillAutoCompleteToolbar(
                $this,
                $this->toolbar,
                array(
                    'auto_complete_name' => $this->lng->txt('user'),
                    'user_type' => $this->getParentGUI()->getLocalRoles(),
                    'user_type_default' => $this->getDefaultRole(),
                    'submit_name' => $this->lng->txt('add')
                )
            );

            // spacer
            $this->toolbar->addSeparator();

            // search button
            $this->toolbar->addButton(
                $this->lng->txt($this->getParentObject()->getType() . "_search_users"),
                $this->ctrl->getLinkTargetByClass(
                    'ilRepositorySearchGUI',
                    'start'
                )
            );

            // separator
            $this->toolbar->addSeparator();
        }

        // print button
        $this->toolbar->addButton(
            $this->lng->txt($this->getParentObject()->getType() . "_print_list"),
            $this->ctrl->getLinkTarget($this, 'printMembers')
        );
        $this->showMailToMemberToolbarButton($this->toolbar, 'participants', false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateLPFromStatus()

ilMembershipGUI::updateLPFromStatus ( int  $usr_id, bool  $has_passed  )

protected

Definition at line 660 of file class.ilMembershipGUI.php.

Referenced by updateParticipants().

                                                                        : void
    {
    }

Here is the caller graph for this function:

updateParticipants()

ilMembershipGUI::updateParticipants

(

)

update members

Definition at line 489 of file class.ilMembershipGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getMembersObject(), getParentObject(), ILIAS\FileDelivery\http(), initParticipantsFromPost(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilCourseMembershipMailNotification\TYPE_STATUS_CHANGED, updateLPFromStatus(), and ILIAS\Repository\user().

                                        : void
    {
        $participants = $this->initParticipantsFromPost();
        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $notifications = $passed = $blocked = $contact = [];
        if ($this->http->wrapper()->post()->has('notification')) {
            $notifications = $this->http->wrapper()->post()->retrieve(
                'notification',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        if ($this->http->wrapper()->post()->has('passed')) {
            $passed = $this->http->wrapper()->post()->retrieve(
                'passed',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        if ($this->http->wrapper()->post()->has('blocked')) {
            $blocked = $this->http->wrapper()->post()->retrieve(
                'blocked',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        if ($this->http->wrapper()->post()->has('contact')) {
            $contact = $this->http->wrapper()->post()->retrieve(
                'contact',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        // Determine whether the user has the 'edit_permission' permission
        $hasEditPermissionAccess =
            (
                $this->access->checkAccess('edit_permission', '', $this->getParentObject()->getRefId()) or
                $this->getMembersObject()->isAdmin($this->user->getId())
            );

        // Get all assignable local roles of the object, and
        // determine the role id of the course administrator role.
        $assignableLocalRoles = array();
        $adminRoleId = $this->getParentObject()->getDefaultAdminRole();
        foreach ($this->getLocalTypeRole(false) as $title => $role_id) {
            $assignableLocalRoles[$role_id] = $title;
        }

        $post_roles = [];
        if ($this->http->wrapper()->post()->has('roles')) {
            $post_roles = $this->http->wrapper()->post()->retrieve(
                'roles',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->dictOf(
                        $this->refinery->kindlyTo()->int()
                    )
                )
            );
        }

        // Validate the user ids and role ids in the post data
        foreach ($participants as $usr_id) {
            $memberIsAdmin = $this->rbacreview->isAssigned($usr_id, (int) $adminRoleId);

            // If the current user doesn't have the 'edit_permission'
            // permission, make sure he doesn't remove the course
            // administrator role of members who are course administrator.
            if (
                !$hasEditPermissionAccess &&
                $memberIsAdmin &&
                (
                    !is_array($post_roles[$usr_id]) ||
                    !in_array($adminRoleId, $post_roles[$usr_id])
                )
            ) {
                $post_roles[$usr_id][] = $adminRoleId;
            }

            // Validate the role ids in the post data
            foreach ((array) $post_roles[$usr_id] as $role_id) {
                if (!array_key_exists($role_id, $assignableLocalRoles)) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_perm'), true);
                    $this->ctrl->redirect($this, 'participants');
                }
                if (!$hasEditPermissionAccess &&
                    $role_id == $adminRoleId &&
                    !$memberIsAdmin) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_perm'));
                    $this->ctrl->redirect($this, 'participants');
                }
            }
        }

        $has_admin = false;
        foreach ($this->getMembersObject()->getAdmins() as $admin_id) {
            if (!isset($post_roles[$admin_id])) {
                $has_admin = true;
                break;
            }
            if (in_array($adminRoleId, (array) $post_roles[$admin_id])) {
                $has_admin = true;
                break;
            }
        }

        if (!$has_admin && is_array($post_roles)) {
            // TODO PHP8 Review: Check change of SuperGlobals
            foreach ($post_roles as $roleIdsToBeAssigned) {
                if (in_array($adminRoleId, $roleIdsToBeAssigned)) {
                    $has_admin = true;
                    break;
                }
            }
        }

        if (!$has_admin) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($this->getParentObject()->getType() . '_min_one_admin'), true);
            $this->ctrl->redirect($this, 'participants');
        }

        foreach ($participants as $usr_id) {
            $this->getMembersObject()->updateRoleAssignments($usr_id, (array) $post_roles[$usr_id]);

            // Disable notification for all of them
            $this->getMembersObject()->updateNotification($usr_id, false);
            if (($this->getMembersObject()->isTutor($usr_id) || $this->getMembersObject()->isAdmin($usr_id)) && in_array(
                $usr_id,
                $notifications
            )) {
                $this->getMembersObject()->updateNotification($usr_id, true);
            }

            $this->getMembersObject()->updateBlocked($usr_id, false);
            if ((!$this->getMembersObject()->isAdmin($usr_id) && !$this->getMembersObject()->isTutor($usr_id)) && in_array(
                $usr_id,
                $blocked
            )) {
                $this->getMembersObject()->updateBlocked($usr_id, true);
            }

            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->updatePassed($usr_id, in_array($usr_id, $passed), true);
                $this->getMembersObject()->sendNotification(
                    ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED,
                    $usr_id
                );
            }

            if (
                ($this->getMembersObject()->isAdmin($usr_id) || $this->getMembersObject()->isTutor($usr_id)) &&
                in_array($usr_id, $contact)
            ) {
                $this->getMembersObject()->updateContact($usr_id, true);
            } else {
                $this->getMembersObject()->updateContact($usr_id, false);
            }

            $this->updateLPFromStatus($usr_id, in_array($usr_id, $passed));
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "participants");
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilMembershipGUI::$access

protected

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

Referenced by ilLearningSequenceMembershipGUI\setSubTabs().

$ctrl

ilCtrlInterface ilMembershipGUI::$ctrl

protected

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

Referenced by getCtrl().

$error

ilErrorHandling ilMembershipGUI::$error

protected

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

$http

GlobalHttpState ilMembershipGUI::$http

protected

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

$lng

ilLanguage ilMembershipGUI::$lng

protected

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

Referenced by getLanguage().

$logger

ilLogger ilMembershipGUI::$logger

protected

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

Referenced by getLogger().

$member_data

array ilMembershipGUI::$member_data = []

protected

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

Referenced by ilGroupMembershipGUI\getPrintMemberData(), and ilLearningSequenceMembershipGUI\getPrintMemberData().

$participants

ilParticipants ilMembershipGUI::$participants = null

protected

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

Referenced by ilSessionMembershipGUI\confirmDeleteParticipants(), confirmDeleteParticipants(), ilSessionMembershipGUI\deleteParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), getMembersObject(), ilGroupMembershipGUI\updateParticipantsStatus(), and ilLearningSequenceMembershipGUI\updateParticipantsStatus().

$rbacreview

ilRbacReview ilMembershipGUI::$rbacreview

protected

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

$rbacsystem

ilRbacSystem ilMembershipGUI::$rbacsystem

protected

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

$refinery

Factory ilMembershipGUI::$refinery

protected

Definition at line 33 of file class.ilMembershipGUI.php.

Referenced by ilLearningSequenceMembershipGUI\getDefaultCommand().

$repository_gui

ilObjectGUI ilMembershipGUI::$repository_gui

private

Definition at line 31 of file class.ilMembershipGUI.php.

Referenced by __construct(), and getParentGUI().

$repository_object

ilObject ilMembershipGUI::$repository_object

private

Definition at line 30 of file class.ilMembershipGUI.php.

Referenced by getParentObject().

$tabs

ilTabsGUI ilMembershipGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilMembershipGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilMembershipGUI::$tpl

protected

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

$tree

ilTree ilMembershipGUI::$tree

protected

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

$user

ilObjUser ilMembershipGUI::$user

protected

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

---

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

• components/ILIAS/Membership/classes/class.ilMembershipGUI.php