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)
	Constructor. More...
	getParentGUI ()
	Get parent gui. More...
	getParentObject ()
	Get parent object. More...
	getMembersObject ()
	Get member object. More...
	filterUserIdsByRbacOrPositionOfCurrentUser ($a_user_ids)
	Filter user ids by access. More...
	updateParticipants ()
	update members More...
	createMailSignature ()
	addMemberTab (ilTabsGUI $tabs, $a_is_participant=false)
	add member tab More...
	readMemberData (array $usr_ids, array $columns)
	Required for member table guis. More...
	getLocalRoles ()
	Get parent roles. More...
	confirmAssignSubscribers ()
	Show subscription confirmation. More...
	confirmRefuseSubscribers ()
	Refuse subscriber confirmation. More...
	assignSubscribers ()
	Do assignment of subscription request type $rbacsystem type $ilErr. More...
	confirmAssignFromWaitingList ()
	Assign from waiting list (confirmatoin) More...
	assignFromWaitingList ()
	Assign from waiting list type $rbacsystem. More...
	confirmRefuseFromList ()
	Refuse from waiting list (confirmation) More...

Protected Member Functions
	getLanguage ()
	getCtrl ()
	getLogger ()
	getMailMemberRoles ()
	checkPermissionBool ($a_permission, $a_cmd='', $a_type='', $a_ref_id=0)
	Check permission. More...
	checkRbacOrPositionAccessBool ($a_rbac_perm, $a_pos_perm, $a_ref_id=0)
	Check if rbac or position access is granted. More...
	checkPermission ($a_permission, $a_cmd="")
	Check permission If not granted redirect to parent gui. More...
	checkRbacOrPermissionAccess ($a_rbac_perm, $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...
	participantsApplyFilter ()
	Apply filter for participant table. More...
	participantsResetFilter ()
	reset participants filter More...
	editMember ()
	Edit one participant. More...
	editParticipants ($post_participants=array())
	Edit participants. More...
	confirmDeleteParticipants ()
	Show confirmation screen for participants deletion. More...
	deleteParticipants ()
	sendMailToSelectedUsers ()
	Send mail to selected users. More...
	getMailContextOptions ()
	membersMap ()
	Members map. More...
	mailMembersBtn ()
	Mail to members view type $ilToolbar. More...
	showParticipantsToolbar ()
	Show participants toolbar. More...
	showMemberExportToolbarButton (ilToolbarGUI $toolbar, $a_back_cmd=null, $a_separator=false)
	Show member export button. More...
	showMailToMemberToolbarButton (ilToolbarGUI $toolbar, $a_back_cmd=null, $a_separator=false)
	Show mail to member toolbar button. More...
	getDefaultCommand ()
	Get default command. More...
	getMemberTabName ()
	Get member tab name. More...
	setSubTabs (ilTabsGUI $tabs)
	Set sub tabs. More...
	parseSubscriberTable ()
	Parse table of subscription request. More...
	initSubscriberTable ()
	refuseSubscribers ()
	Refuse subscribers type $rbacsystem. More...
	parseWaitingListTable ()
	Parse table of subscription request. More...
	refuseFromList ()
	refuse from waiting list More...
	addToClipboard ()
	Add selected users to user clipboard. More...
	getDefaultRole ()
	printMembers ()
	Print members. More...
	printMembersOutput ()
	print members output More...
	printForMembersOutput ()
	print members output More...
	jump2UsersGallery ()

Protected Attributes
	$lng = null
	$ctrl = null
	$logger = null
	$tpl
	$access

Private Attributes
	$repository_object = null
	$repository_gui = null

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 11 of file class.ilMembershipGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

ilObject

$repository_obj

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

References $DIC, $GLOBALS, $repository_gui, and getParentObject().

    {
        global $DIC;

        $this->repository_gui = $repository_gui;
        $this->repository_object = $repository_obj;
        
        $this->lng = $GLOBALS['DIC']->language();
        $this->lng->loadLanguageModule('crs');
        $this->lng->loadLanguageModule($this->getParentObject()->getType());
        $this->lng->loadLanguageModule('trac');
        $this->tpl = $GLOBALS['DIC']->ui()->mainTemplate();
        $this->ctrl = $GLOBALS['DIC']->ctrl();
        $this->logger = $DIC->logger()->mmbr();
        $this->access = $GLOBALS['DIC']->access();
    }

Here is the call graph for this function:

Member Function Documentation

addMemberTab()

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

add member tab

Parameters

ilTabsGUI	$tabs
bool	$a_is_participant

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

References $DIC, $GLOBALS, ilTabsGUI\addTab(), checkRbacOrPositionAccessBool(), getMemberTabName(), and getParentObject().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        include_once './Services/Mail/classes/class.ilMail.php';
        $mail = new ilMail($GLOBALS['DIC']['ilUser']->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 (
            (bool) $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 &&
            $GLOBALS['DIC']['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 1550 of file class.ilMembershipGUI.php.

References $_POST, $GLOBALS, ilUserClipboard\getInstance(), and ilUtil\sendFailure().

    {
        // begin-patch clipboard
        $users = [];
        if (isset($_POST['participants'])) {
            $users = (array) $_POST['participants'];
        } elseif (isset($_POST['subscribers'])) {
            $users = (array) $_POST['subscribers'];
        } elseif (isset($_POST['waiting'])) {
            $users = (array) $_POST['waiting'];
        }
        // end-patch clipboard
        if (!count($users)) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        include_once './Services/User/classes/class.ilUserClipboard.php';
        $clip = ilUserClipboard::getInstance($GLOBALS['DIC']['ilUser']->getId());
        $clip->add($users);
        $clip->save();
        
        $this->lng->loadLanguageModule('user');
        ilUtil::sendSuccess($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 type $rbacsystem.

Returns

boolean

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

References $_POST, ilObjectFactory\getInstanceByObjId(), getMembersObject(), getParentObject(), IL_CRS_MEMBER, IL_GRP_MEMBER, ilUtil\sendFailure(), ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, and ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER.

    {
        if (!array_key_exists('waiting', $_POST) || !count($_POST["waiting"])) {
            ilUtil::sendFailure($this->lng->txt("crs_no_users_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        
        $waiting_list = $this->initWaitingList();

        $added_users = 0;
        foreach ($_POST["waiting"] as $user_id) {
            if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                continue;
            }
            if ($this->getMembersObject()->isAssigned($user_id)) {
                continue;
            }
            
            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->add($user_id, IL_CRS_MEMBER);
                $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_ACCEPT_USER, $user_id, true);
                $this->getParentObject()->checkLPStatusSync($user_id);
            }
            if ($this instanceof ilGroupMembershipGUI) {
                include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                $this->getMembersObject()->add($user_id, IL_GRP_MEMBER);
                $this->getMembersObject()->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER,
                    $user_id,
                    true
                );
            }
            if ($this instanceof ilSessionMembershipGUI) {
                $this->getMembersObject()->register($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($user_id);
            ++$added_users;
        }

        if ($added_users) {
            ilUtil::sendSuccess($this->lng->txt("crs_users_added"), true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            ilUtil::sendFailure($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 type $rbacsystem type $ilErr.

Returns

boolean

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

References $_POST, $DIC, $ilErr, getMembersObject(), getParentObject(), ilUtil\sendFailure(), ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, and ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER.

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        
        if (!is_array($_POST["subscribers"])) {
            ilUtil::sendFailure($this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        
        if (!$this->getMembersObject()->assignSubscribers($_POST["subscribers"])) {
            ilUtil::sendFailure($ilErr->getMessage(), true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ($_POST["subscribers"] as $usr_id) {
                if ($this instanceof ilCourseMembershipGUI) {
                    $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_ACCEPT_SUBSCRIBER, $usr_id);
                    $this->getParentObject()->checkLPStatusSync($usr_id);
                }
                if ($this instanceof ilGroupMembershipGUI) {
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER,
                        $usr_id
                    );
                }
                if ($this instanceof ilSessionMembershipGUI) {
                    // todo refactor to participants
                    include_once './Modules/Session/classes/class.ilSessionMembershipMailNotification.php';
                    $noti = new ilSessionMembershipMailNotification();
                    $noti->setRefId($this->getParentObject()->getRefId());
                    $noti->setRecipients(array($usr_id));
                    $noti->setType(ilSessionMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
                    $noti->send();
                }
            }
        }
        ilUtil::sendSuccess($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.

Returns

bool

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

References checkPermissionBool().

Referenced by showParticipantsToolbar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermission()

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

protected

Check permission If not granted redirect to parent gui.

Parameters

string	$a_permission
string	$a_cmd

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

References checkPermissionBool(), getParentGUI(), and ilUtil\sendFailure().

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

    {
        if (!$this->checkPermissionBool($a_permission, $a_cmd)) {
            ilUtil::sendFailure($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 (   $a_permission,   $a_cmd = '',   $a_type = '',   $a_ref_id = 0  )

protected

Check permission.

Parameters

type	$a_permission
type	$a_cmd
type	$a_type
type	$a_ref_id

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

References getParentObject().

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

    {
        if (!$a_ref_id) {
            $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 (   $a_rbac_perm,   $a_pos_perm  )

protected

check rbac or position access

Parameters

$a_rbac_perm
$a_pos_perm

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

References checkRbacOrPositionAccessBool(), getParentGUI(), and ilUtil\sendFailure().

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        if (!$this->checkRbacOrPositionAccessBool($a_rbac_perm, $a_pos_perm)) {
            ilUtil::sendFailure($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 (   $a_rbac_perm,   $a_pos_perm,   $a_ref_id = 0  )

protected

Check if rbac or position access is granted.

Parameters

string	$a_rbac_perm
string	$a_pos_perm
int	$a_ref_id

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

References getParentObject().

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

    {
        if (!$a_ref_id) {
            $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)

Returns

boolean

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

References $_POST, $name, ilObjUser\_lookupName(), ilUtil\getImagePath(), and ilUtil\sendFailure().

    {
        if (!is_array($_POST["waiting"])) {
            ilUtil::sendFailure($this->lng->txt("crs_no_users_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        
        include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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 ($_POST["waiting"] as $waiting) {
            $name = ilObjUser::_lookupName($waiting);

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

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

Here is the call graph for this function:

confirmAssignSubscribers()

ilMembershipGUI::confirmAssignSubscribers

(

)

Show subscription confirmation.

Returns

boolean

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

References $_POST, $name, ilObjUser\_lookupName(), ilUtil\getImagePath(), and ilUtil\sendFailure().

    {
        if (!is_array($_POST["subscribers"])) {
            ilUtil::sendFailure($this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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 ($_POST["subscribers"] as $subscribers) {
            $name = ilObjUser::_lookupName($subscribers);

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

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

Here is the call graph for this function:

confirmDeleteParticipants()

ilMembershipGUI::confirmDeleteParticipants ( )

protected

Show confirmation screen for participants deletion.

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

References $_POST, $DIC, $GLOBALS, $ilUser, $name, ilObjUser\_lookupName(), checkPermissionBool(), ilUtil\getImagePath(), getMembersObject(), ilCourseReferencePathInfo\isReferenceMemberUpdateConfirmationRequired(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $ilUser = $DIC['ilUser'];
        
        $participants = (array) $_POST['participants'];
        
        if (!count($participants)) {
            ilUtil::sendFailure($this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }

        // Check last admin
        if (!$this->getMembersObject()->checkLastAdmin($participants)) {
            ilUtil::sendFailure($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');
            ilUtil::sendInfo($this->lng->txt('rbac_info_only_position_access'));
        }
        
        
        // Access check for admin deletion
        if (
            !$ilAccess->checkAccess(
                'edit_permission',
                '',
                $this->getParentObject()->getRefId()
            ) &&
            !$this->getMembersObject()->isAdmin($GLOBALS['DIC']['ilUser']->getId())
        ) {
            foreach ($participants as $usr_id) {
                if ($this->getMembersObject()->isAdmin($usr_id)) {
                    ilUtil::sendFailure($this->lng->txt("msg_no_perm_perm"), true);
                    $this->ctrl->redirect($this, 'participants');
                }
            }
        }

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

        include_once('./Services/Utilities/classes/class.ilConfirmationGUI.php');
        $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[]',
                $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('icon_usr.svg')
            );
        }
        
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

confirmRefuseFromList()

ilMembershipGUI::confirmRefuseFromList

(

)

Refuse from waiting list (confirmation)

Returns

boolean

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

References $_POST, $name, ilObjUser\_lookupName(), ilUtil\getImagePath(), and ilUtil\sendFailure().

    {
        if (!is_array($_POST["waiting"])) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $this->lng->loadLanguageModule('mmbr');

        include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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 ($_POST["waiting"] as $waiting) {
            $name = ilObjUser::_lookupName($waiting);

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

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

Here is the call graph for this function:

confirmRefuseSubscribers()

ilMembershipGUI::confirmRefuseSubscribers

(

)

Refuse subscriber confirmation.

Returns

boolean

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

References $_POST, $name, ilObjUser\_lookupName(), ilUtil\getImagePath(), and ilUtil\sendFailure().

    {
        if (!is_array($_POST["subscribers"])) {
            ilUtil::sendFailure($this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }

        $this->lng->loadLanguageModule('mmbr');

        include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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 ($_POST["subscribers"] as $subscribers) {
            $name = ilObjUser::_lookupName($subscribers);

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

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

Here is the call graph for this function:

createMailSignature()

ilMembershipGUI::createMailSignature

(

)

Todo:

better implementation Create Mail signature

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

References getParentGUI().

Referenced by sendMailToSelectedUsers().

    {
        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 697 of file class.ilMembershipGUI.php.

References $_POST, $DIC, $GLOBALS, $ilUser, getMembersObject(), getParentObject(), ilUtil\sendFailure(), ilLearningSequenceMembershipMailNotification\TYPE_DISMISS_MEMBER, and ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER.

Referenced by ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];
        $ilUser = $DIC['ilUser'];
                
        $participants = (array) $_POST['participants'];
        
        if (!is_array($participants) or !count($participants)) {
            ilUtil::sendFailure($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 (
            !$ilAccess->checkAccess('edit_permission', '', $this->getParentObject()->getRefId()) &&
            !$this->getMembersObject()->isAdmin($GLOBALS['DIC']['ilUser']->getId())
        ) {
            foreach ($participants as $part) {
                if ($this->getMembersObject()->isAdmin($part)) {
                    ilUtil::sendFailure($this->lng->txt('msg_no_perm_perm'), true);
                    $this->ctrl->redirect($this, 'participants');
                }
            }
        }
        
        if (!$this->getMembersObject()->deleteParticipants($participants)) {
            ilUtil::sendFailure('Error deleting participants.', true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ((array) $_POST["participants"] as $usr_id) {
                $mail_type = 0;
                // @todo more generic
                switch ($this->getParentObject()->getType()) {
                    case 'crs':
                        $mail_type = $this->getMembersObject()->NOTIFY_DISMISS_MEMBER;
                        break;
                    case 'grp':
                        include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                        $mail_type = ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER;
                        break;
                    case 'lso':
                        $mail_type = ilLearningSequenceMembershipMailNotification::TYPE_DISMISS_MEMBER;
                        break;
                }
                $this->getMembersObject()->sendNotification($mail_type, $usr_id);
            }
        }
        ilUtil::sendSuccess($this->lng->txt($this->getParentObject()->getType() . "_members_deleted"), true);
        $this->ctrl->redirect($this, "participants");

        return true;
    }

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 462 of file class.ilMembershipGUI.php.

References editParticipants(), and getParentObject().

    {
        $this->activateSubTab($this->getParentObject()->getType() . "_member_administration");
        return $this->editParticipants(array($_REQUEST['member_id']));
    }

Here is the call graph for this function:

editParticipants()

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

protected

Edit participants.

Parameters

array

$post_participants

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

References $_POST, getMembersObject(), and ilUtil\sendFailure().

Referenced by editMember().

    {
        if (!$post_participants) {
            $post_participants = (array) $_POST['participants'];
        }

        $real_participants = $this->getMembersObject()->getParticipants();
        $participants = array_intersect((array) $post_participants, (array) $real_participants);
        
        if (!count($participants)) {
            ilUtil::sendFailure($this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        $table = $this->initEditParticipantTableGUI($participants);
        $this->tpl->setContent($table->getHTML());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

filterUserIdsByRbacOrPositionOfCurrentUser()

ilMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser

(

$a_user_ids

)

Filter user ids by access.

Parameters

int[]

$a_usr_ids

Returns

int[]

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

References $DIC, $GLOBALS, $ilErr, $ilUser, $ret, ilParticipants\_isParticipant(), checkPermission(), checkRbacOrPermissionAccess(), checkRbacOrPositionAccessBool(), getDefaultCommand(), getDefaultRole(), ilParticipants\getInstance(), getLocalRoles(), getMailMemberRoles(), getMembersObject(), getParentGUI(), getParentObject(), ilCourseConstants\MAIL_ALLOWED_ALL, setSubTabs(), showMailToMemberToolbarButton(), and showMemberExportToolbarButton().

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

    {
        return $a_user_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCtrl()

ilMembershipGUI::getCtrl ( )

protected

Returns

ilCtrl

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

References $ctrl.

Referenced by ilSessionMembershipGUI\updateMembers().

    {
        return $this->ctrl;
    }

Here is the caller graph for this function:

getDefaultCommand()

ilMembershipGUI::getDefaultCommand ( )

protected

Get default command.

Returns

string

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

References checkRbacOrPositionAccessBool(), and getParentObject().

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        $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

Returns

null

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

References $GLOBALS.

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser(), and showParticipantsToolbar().

    {
        return null;
    }

Here is the caller graph for this function:

getLanguage()

ilMembershipGUI::getLanguage ( )

protected

Returns

ilLanguage

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

References $lng.

Referenced by ilSessionMembershipGUI\updateMembers().

    {
        return $this->lng;
    }

Here is the caller graph for this function:

getLocalRoles()

ilMembershipGUI::getLocalRoles

(

)

Get parent roles.

Returns

type

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

References getParentGUI().

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLogger()

ilMembershipGUI::getLogger ( )

protected

Returns

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

References $logger.

    {
        return $this->logger;
    }

getMailContextOptions()

ilMembershipGUI::getMailContextOptions ( )

protected

Returns

array

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

Referenced by sendMailToSelectedUsers().

                                               : array
    {
        return [];
    }

Here is the caller graph for this function:

getMailMemberRoles()

ilMembershipGUI::getMailMemberRoles ( )

protected

Returns

null

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

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        return null;
    }

Here is the caller graph for this function:

getMembersObject()

ilMembershipGUI::getMembersObject

(

)

Get member object.

Returns

ilParticipants

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

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

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

    {
        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

Get member tab name.

Returns

string

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

Referenced by addMemberTab().

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

Here is the caller graph for this function:

getParentGUI()

ilMembershipGUI::getParentGUI

(

)

Get parent gui.

Returns

ilObjectGUI

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

References $repository_gui.

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

    {
        return $this->repository_gui;
    }

Here is the caller graph for this function:

getParentObject()

ilMembershipGUI::getParentObject

(

)

Get parent object.

Returns

ilObject

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

References $repository_object.

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

    {
        return $this->repository_object;
    }

Here is the caller graph for this function:

initSubscriberTable()

ilMembershipGUI::initSubscriberTable ( )

protected

Returns

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

References getParentObject().

Referenced by parseSubscriberTable().

    {
        $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:

jump2UsersGallery()

ilMembershipGUI::jump2UsersGallery ( )

protected

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

References $DIC, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ilPrivacySettings\_getInstance(), ilObjectLP\getInstance(), ilParticipants\getInstance(), getMembersObject(), and getParentObject().

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

Here is the call graph for this function:

mailMembersBtn()

ilMembershipGUI::mailMembersBtn ( )

protected

Mail to members view type $ilToolbar.

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

References $DIC, $GLOBALS, and showMailToMemberToolbarButton().

    {
        global $DIC;

        $ilToolbar = $DIC['ilToolbar'];
        
        $this->showMailToMemberToolbarButton($GLOBALS['DIC']['ilToolbar'], 'mailMembersBtn');
    }

Here is the call graph for this function:

membersMap()

ilMembershipGUI::membersMap ( )

protected

Members map.

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

References $DIC, $tpl, ilParticipants\getInstanceByObjId(), ilMapUtil\getMapGUI(), getParentObject(), and ilMapUtil\isActivated().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $this->activateSubTab($this->getParentObject()->getType() . "_members_map");
        include_once("./Services/Maps/classes/class.ilMapUtil.php");
        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);

        include_once './Services/Membership/classes/class.ilParticipants.php';
        $members = ilParticipants::getInstanceByObjId($this->getParentObject()->getId())->getParticipants();
        foreach ((array) $members as $user_id) {
            $map->addUserMarker($user_id);
        }

        $tpl->setContent($map->getHTML());
        $tpl->setLeftContent($map->getUserListHTML());
    }

Here is the call graph for this function:

parseSubscriberTable()

ilMembershipGUI::parseSubscriberTable ( )

protected

Parse table of subscription request.

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

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

Referenced by participants().

    {
        $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.

Returns

ilWaitingListTableGUI

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

References filterUserIdsByRbacOrPositionOfCurrentUser(), and getParentObject().

Referenced by participants().

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

        include_once './Services/Membership/classes/class.ilWaitingListTableGUI.php';
        $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 403 of file class.ilMembershipGUI.php.

References getParentObject(), parseSubscriberTable(), parseWaitingListTable(), and showParticipantsToolbar().

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

    {
        $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->lng->txt($this->getParentObject()->getType() . '_mem_tbl_header'));
        $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 437 of file class.ilMembershipGUI.php.

References participants().

    {
        $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 449 of file class.ilMembershipGUI.php.

References participants().

    {
        $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 1653 of file class.ilMembershipGUI.php.

References $DIC, getMembersObject(), and getParentObject().

    {
        global $DIC;

        $tabs = $DIC->tabs();
        $tabs->clearTargets();
        $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->setId(0);
        $form = $list->initForm('printForMembersOutput');
        $list->initFromForm();
        $list->setCallback(array($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

Print members.

Todo:

: refactor to own class

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

References $DIC, and checkPermission().

    {
        global $DIC;

        $ilTabs = $DIC['ilTabs'];
        
        $this->checkPermission('read');
        
        $ilTabs->clearTargets();

        $ilTabs->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 1626 of file class.ilMembershipGUI.php.

References $DIC, filterUserIdsByRbacOrPositionOfCurrentUser(), and getMembersObject().

    {
        global $DIC;

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

        $list = $this->initAttendanceList();
        $list->initFromForm();
        $list->setCallback(array($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.

Has to be refactored and should be locate in ilObjCourse, ilObjGroup instead of GUI

Returns

array

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

References getParentGUI().

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

    {
        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

public

Returns

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

References $_POST, getMembersObject(), getParentObject(), ilUtil\sendFailure(), ilSessionMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, and ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER.

    {
        if (!array_key_exists('waiting', $_POST) || !count($_POST['waiting'])) {
            ilUtil::sendFailure($this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        
        $waiting_list = $this->initWaitingList();

        foreach ($_POST["waiting"] as $user_id) {
            $waiting_list->removeFromList($user_id);
            
            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_DISMISS_SUBSCRIBER, $user_id, true);
            }
            if ($this instanceof ilGroupMembershipGUI) {
                include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                $this->getMembersObject()->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER,
                    $user_id,
                    true
                );
            }
            if ($this instanceof ilSessionMembershipGUI) {
                include_once './Modules/Session/classes/class.ilSessionMembershipMailNotification.php';
                $noti = new ilSessionMembershipMailNotification();
                $noti->setRefId($this->getParentObject()->getRefId());
                $noti->setRecipients(array($user_id));
                $noti->setType(ilSessionMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
                $noti->send();
            }
        }
        ilUtil::sendSuccess($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

Refuse subscribers type $rbacsystem.

Returns

boolean

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

References $_POST, $DIC, $GLOBALS, getMembersObject(), getParentObject(), ilUtil\sendFailure(), ilLearningSequenceMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilSessionMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, and ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER.

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        if (!$_POST['subscribers']) {
            ilUtil::sendFailure($this->lng->txt("crs_no_subscribers_selected"), true);
            $this->ctrl->redirect($this, 'participants');
        }
    
        if (!$this->getMembersObject()->deleteSubscribers($_POST["subscribers"])) {
            ilUtil::sendFailure($GLOBALS['DIC']['ilErr']->getMessage(), true);
            $this->ctrl->redirect($this, 'participants');
        } else {
            foreach ($_POST['subscribers'] as $usr_id) {
                if ($this instanceof ilCourseMembershipGUI) {
                    $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_DISMISS_SUBSCRIBER, $usr_id);
                }
                if ($this instanceof ilGroupMembershipGUI) {
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $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
                    );
                }
            }
        }

        ilUtil::sendSuccess($this->lng->txt("crs_subscribers_deleted"), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

sendMailToSelectedUsers()

ilMembershipGUI::sendMailToSelectedUsers ( )

protected

Send mail to selected users.

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

References $_GET, $_POST, ilObjUser\_lookupLogin(), createMailSignature(), getMailContextOptions(), ilMailFormCall\getRedirectTarget(), ilUtil\redirect(), ilUtil\sendFailure(), and ilMailFormCall\setRecipients().

    {
        $participants = [];
        if ($_POST['participants']) {
            $participants = (array) $_POST['participants'];
        } elseif ($_POST['subscribers']) {
            $participants = (array) $_POST['subscribers'];
        } elseif ($_POST['waiting']) {
            $participants = (array) $_POST['waiting'];
        } elseif ($_GET['member_id']) {
            $participants = array($_GET['member_id']);
        }

        if (!count($participants)) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        
        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 1060 of file class.ilMembershipGUI.php.

References $DIC, ilPrivacySettings\_getInstance(), ilTabsGUI\addSubTabTarget(), checkRbacOrPositionAccessBool(), getParentObject(), and ilMapUtil\isActivated().

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        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"
                );
            }
            
            $tree = $DIC->repositoryTree();
            $children = (array) $tree->getSubTree($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'
            );
        }
        
        include_once './Services/Maps/classes/class.ilMapUtil.php';
        if (ilMapUtil::isActivated() && $this->getParentObject()->getEnableMap()) {
            $tabs->addSubTabTarget(
                $this->getParentObject()->getType() . '_members_map',
                $this->ctrl->getLinkTarget($this, 'membersMap'),
                "membersMap",
                get_class($this)
            );
        }
        
        include_once 'Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
        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,   $a_back_cmd = null,   $a_separator = false  )

protected

Show mail to member toolbar button.

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

References $DIC, $ilUser, ilToolbarGUI\addButton(), ilToolbarGUI\addSeparator(), and getParentObject().

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

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];
        include_once 'Services/Mail/classes/class.ilMail.php';
        $mail = new ilMail($ilUser->getId());

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

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

            $toolbar->addButton(
                $this->lng->txt("mail_members"),
                $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,   $a_back_cmd = null,   $a_separator = false  )

protected

Show member export button.

Parameters

ilToolbarGUI	$toolbar
type	$a_back_cmd
type	$a_separator

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

References ilToolbarGUI\addButton(), ilToolbarGUI\addSeparator(), and getParentObject().

Referenced by filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        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 861 of file class.ilMembershipGUI.php.

References $DIC, canAddOrSearchUsers(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), getDefaultRole(), getParentGUI(), and showMailToMemberToolbarButton().

Referenced by participants().

    {
        global $DIC;

        $ilToolbar = $DIC['ilToolbar'];
        
        if ($this->canAddOrSearchUsers()) {
            include_once './Services/Search/classes/class.ilRepositorySearchGUI.php';
            ilRepositorySearchGUI::fillAutoCompleteToolbar(
                $this,
                $ilToolbar,
                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
            $ilToolbar->addSeparator();

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

updateParticipants()

ilMembershipGUI::updateParticipants

(

)

update members

public

Parameters

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

References $_POST, $DIC, $ilUser, getMembersObject(), getParentObject(), and ilUtil\sendFailure().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        $ilAccess = $DIC['ilAccess'];
                
        if (!array_key_exists('participants', $_POST) || !count($_POST['participants'])) {
            ilUtil::sendFailure($this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
        
        $notifications = $_POST['notification'] ? $_POST['notification'] : array();
        $passed = $_POST['passed'] ? $_POST['passed'] : array();
        $blocked = $_POST['blocked'] ? $_POST['blocked'] : array();
        $contact = $_POST['contact'] ? $_POST['contact'] : array();

        // Determine whether the user has the 'edit_permission' permission
        $hasEditPermissionAccess =
            (
                $ilAccess->checkAccess('edit_permission', '', $this->getParentObject()->getRefId()) or
                $this->getMembersObject()->isAdmin($ilUser->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;
        }
                
        // Validate the user ids and role ids in the post data
        foreach ($_POST['participants'] as $usr_id) {
            $memberIsAdmin = $rbacreview->isAssigned($usr_id, $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 &&
                !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)) {
                    ilUtil::sendFailure($this->lng->txt('msg_no_perm_perm'), true);
                    $this->ctrl->redirect($this, 'participants');
                }
                if (!$hasEditPermissionAccess &&
                    $role_id == $adminRoleId &&
                    !$memberIsAdmin) {
                    ilUtil::sendFailure($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, $_POST['roles'][$admin_id])) {
                $has_admin = true;
                break;
            }
        }

        if (!$has_admin && is_array($_POST['roles'])) {
            foreach ($_POST['roles'] as $usrId => $roleIdsToBeAssigned) {
                if (in_array($adminRoleId, $roleIdsToBeAssigned)) {
                    $has_admin = true;
                    break;
                }
            }
        }

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

        foreach ($_POST['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, 0);
            if (($this->getMembersObject()->isTutor($usr_id) or $this->getMembersObject()->isAdmin($usr_id)) and in_array($usr_id, $notifications)) {
                $this->getMembersObject()->updateNotification($usr_id, 1);
            }
            
            $this->getMembersObject()->updateBlocked($usr_id, 0);
            if ((!$this->getMembersObject()->isAdmin($usr_id) and !$this->getMembersObject()->isTutor($usr_id)) and in_array($usr_id, $blocked)) {
                $this->getMembersObject()->updateBlocked($usr_id, 1);
            }
            
            if ($this instanceof ilCourseMembershipGUI) {
                $this->getMembersObject()->updatePassed($usr_id, in_array($usr_id, $passed), true);
                $this->getMembersObject()->sendNotification(
                    $this->getMembersObject()->NOTIFY_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));
        }
        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "participants");
    }

Here is the call graph for this function:

Field Documentation

$access

ilMembershipGUI::$access

protected

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

Referenced by ilLearningSequenceMembershipGUI\__construct(), and ilLearningSequenceMembershipGUI\setSubTabs().

$ctrl

ilMembershipGUI::$ctrl = null

protected

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

Referenced by ilLearningSequenceMembershipGUI\__construct(), and getCtrl().

$lng

ilMembershipGUI::$lng = null

protected

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

Referenced by ilLearningSequenceMembershipGUI\__construct(), getLanguage(), and ilCourseMembershipGUI\getPrintMemberData().

$logger

ilMembershipGUI::$logger = null

protected

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

Referenced by getLogger().

$repository_gui

ilMembershipGUI::$repository_gui = null

private

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

Referenced by __construct(), and getParentGUI().

$repository_object

ilMembershipGUI::$repository_object = null

private

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

Referenced by getParentObject().

$tpl

ilMembershipGUI::$tpl

protected

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

Referenced by membersMap().

---

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

• Services/Membership/classes/class.ilMembershipGUI.php