ilCourseMembershipGUI Class Reference

Member-tab content. More...

Inheritance diagram for ilCourseMembershipGUI:

Collaboration diagram for ilCourseMembershipGUI:

Public Member Functions
	filterUserIdsByRbacOrPositionOfCurrentUser ($a_user_ids)
	Filter user ids by access. More...
	assignMembers (array $a_usr_ids, $a_type)
	callback from repository search gui ilRbacSystem $rbacsystem More...
	getLocalTypeRole ($a_translation=false)
	getAttendanceListUserData ($a_user_id)
	Callback from attendance list. More...
Public Member Functions inherited from ilMembershipGUI
	__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
	updateParticipantsStatus ()
	=> save button in member table More...
	initParticipantTableGUI ()
	initEditParticipantTableGUI (array $participants)
	init edit participants table gui More...
	initParticipantTemplate ()
	Init participant view template. More...
	updateLPFromStatus ($a_member_id, $a_passed)
	Update lp from status. More...
	initWaitingList ()
	init waiting list More...
	getDefaultRole ()
	deliverCertificate ()
	Deliver certificate for an user on the member list. More...
	getPrintMemberData ($a_members)
	Get print member data. More...
Protected Member Functions inherited from ilMembershipGUI
	getLanguage ()
	getCtrl ()
	getLogger ()
	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...
	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...
	setSubTabs (ilTabsGUI $tabs)
	Set sub tabs. More...
	parseSubscriberTable ()
	Parse table of subscription request. More...
	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 ()

Additional Inherited Members
Protected Attributes inherited from ilMembershipGUI
	$lng = null
	$ctrl = null
	$logger = null
	$tpl
	$access

Detailed Description

Member-tab content.

Author

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

ilCourseMembershipGUI: ilMailMemberSearchGUI, ilUsersGalleryGUI, ilRepositorySearchGUI ilCourseMembershipGUI: ilCourseParticipantsGroupsGUI, ilObjectCustomuserFieldsGUI ilCourseMembershipGUI: ilSessionOverviewGUI ilCourseMembershipGUI: ilMemberExportGUI

Definition at line 18 of file class.ilCourseMembershipGUI.php.

Member Function Documentation

assignMembers()

ilCourseMembershipGUI::assignMembers	(	array	$a_usr_ids,
			$a_type
	)

callback from repository search gui ilRbacSystem $rbacsystem

Parameters

array	$a_usr_ids
int	$a_type	role_id

Returns

bool

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

References $a_type, $ilErr, array, ilMembershipGUI\checkRbacOrPositionAccessBool(), filterUserIdsByRbacOrPositionOfCurrentUser(), ilObjectFactory\getInstanceByObjId(), ilLoggerFactory\getLogger(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, ilUtil\sendFailure(), and ilUtil\sendSuccess().

    {
        global $rbacsystem, $ilErr;

        if (!$this->checkRbacOrPositionAccessBool('manage_members', 'manage_members')) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_read"), $ilErr->FATAL);
        }

        if (!count($a_usr_ids)) {
            ilUtil::sendFailure($this->lng->txt("crs_no_users_selected"), true);
            return false;
        }
        
        $a_usr_ids = $this->filterUserIdsByRbacOrPositionOfCurrentUser($a_usr_ids);

        $added_users = 0;
        foreach ($a_usr_ids as $user_id) {
            if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                continue;
            }
            if ($this->getMembersObject()->isAssigned($user_id)) {
                continue;
            }
            switch ($a_type) {
                case $this->getParentObject()->getDefaultMemberRole():
                    $this->getMembersObject()->add($user_id, IL_CRS_MEMBER);
                    break;
                case $this->getParentObject()->getDefaultTutorRole():
                    $this->getMembersObject()->add($user_id, IL_CRS_TUTOR);
                    break;
                case $this->getParentObject()->getDefaultAdminRole():
                    $this->getMembersObject()->add($user_id, IL_CRS_ADMIN);
                    break;
                default:
                    if (in_array($a_type, $this->getParentObject()->getLocalCourseRoles(true))) {
                        $this->getMembersObject()->add($user_id, IL_CRS_MEMBER);
                        $this->getMembersObject()->updateRoleAssignments($user_id, (array) $a_type);
                    } else {
                        ilLoggerFactory::getLogger('crs')->notice('Can\'t find role with id .' . $a_type . ' to assign users.');
                        ilUtil::sendFailure($this->lng->txt("crs_cannot_find_role"), true);
                        return false;
                    }
                    break;
            }
            $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_ACCEPT_USER, $user_id);

            $this->getParentObject()->checkLPStatusSync($user_id);

            ++$added_users;
        }
        if ($added_users) {
            ilUtil::sendSuccess($this->lng->txt("crs_users_added"), true);
            $this->ctrl->redirect($this, 'participants');
        }
        ilUtil::sendFailure($this->lng->txt("crs_users_already_assigned"), true);
        return false;
    }

Here is the call graph for this function:

deliverCertificate()

ilCourseMembershipGUI::deliverCertificate ( )

protected

Deliver certificate for an user on the member list.

Returns

type

Definition at line 243 of file class.ilCourseMembershipGUI.php.

References ilMembershipGUI\getParentGUI().

    {
        return $this->getParentGUI()->deliverCertificateObject($user_id);
    }

Here is the call graph for this function:

filterUserIdsByRbacOrPositionOfCurrentUser()

ilCourseMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser

(

$a_user_ids

)

Filter user ids by access.

Parameters

int[]

$a_user_ids

Returns

int[]

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

References $GLOBALS, and ilMembershipGUI\getParentObject().

Referenced by assignMembers(), and getAttendanceListUserData().

    {
        return $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId(),
            $a_user_ids
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAttendanceListUserData()

ilCourseMembershipGUI::getAttendanceListUserData

(

$a_user_id

)

Callback from attendance list.

Definition at line 365 of file class.ilCourseMembershipGUI.php.

References filterUserIdsByRbacOrPositionOfCurrentUser().

    {
        if ($this->filterUserIdsByRbacOrPositionOfCurrentUser([$a_user_id])) {
            return $this->member_data[$a_user_id];
        }
        return [];
    }

Here is the call graph for this function:

getDefaultRole()

ilCourseMembershipGUI::getDefaultRole ( )

protected

Returns

int

Definition at line 234 of file class.ilCourseMembershipGUI.php.

References ilMembershipGUI\getParentGUI().

    {
        return $this->getParentGUI()->object->getDefaultMemberRole();
    }

Here is the call graph for this function:

getLocalTypeRole()

ilCourseMembershipGUI::getLocalTypeRole

(

$a_translation = false

)

Todo:

refactor delete

Definition at line 207 of file class.ilCourseMembershipGUI.php.

References ilMembershipGUI\getParentObject().

    {
        return $this->getParentObject()->getLocalCourseRoles($a_translation);
    }

Here is the call graph for this function:

getPrintMemberData()

ilCourseMembershipGUI::getPrintMemberData (   $a_members )

protected

Get print member data.

Parameters

array

$a_members

Definition at line 252 of file class.ilCourseMembershipGUI.php.

References $_SESSION, $failed, ilMembershipGUI\$lng, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ilPrivacySettings\_getInstance(), ilCourseUserData\_getValuesByObjId(), ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), ilLearningProgress\_lookupProgressByObjId(), ilObjUser\_readUsersProfileData(), array, ilDatePresentation\formatDate(), ilObjectLP\getInstance(), ilObjectFactory\getInstanceByObjId(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilDatePresentation\setUseRelativeDates(), ilUtil\sortArray(), and string.

    {
        global $ilAccess,$lng;

        $lng->loadLanguageModule('trac');

        $is_admin = true;
        include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
        $privacy = ilPrivacySettings::_getInstance();

        if ($privacy->enabledCourseAccessTimes()) {
            include_once('./Services/Tracking/classes/class.ilLearningProgress.php');
            $progress = ilLearningProgress::_lookupProgressByObjId($this->getParentObject()->getId());
        }

        include_once './Services/Tracking/classes/class.ilObjUserTracking.php';
        $show_tracking =
            (ilObjUserTracking::_enabledLearningProgress() and ilObjUserTracking::_enabledUserRelatedData());
        if ($show_tracking) {
            include_once('./Services/Object/classes/class.ilObjectLP.php');
            $olp = ilObjectLP::getInstance($this->getParentObject()->getId());
            $show_tracking = $olp->isActive();
        }
        
        if ($show_tracking) {
            include_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
            $completed = ilLPStatusWrapper::_lookupCompletedForObject($this->getParentObject()->getId());
            $in_progress = ilLPStatusWrapper::_lookupInProgressForObject($this->getParentObject()->getId());
            $failed = ilLPStatusWrapper::_lookupFailedForObject($this->getParentObject()->getId());
        }
        
        $profile_data = ilObjUser::_readUsersProfileData($a_members);

        // course defined fields
        include_once('Modules/Course/classes/Export/class.ilCourseUserData.php');
        $cdfs = ilCourseUserData::_getValuesByObjId($this->getParentObject()->getId());

        foreach ($a_members as $member_id) {
            // GET USER OBJ
            if ($tmp_obj = ilObjectFactory::getInstanceByObjId($member_id, false)) {
                // udf
                include_once './Services/User/classes/class.ilUserDefinedData.php';
                $udf_data = new ilUserDefinedData($member_id);
                foreach ($udf_data->getAll() as $field => $value) {
                    list($f, $field_id) = explode('_', $field);
                    $print_member[$member_id]['udf_' . $field_id] = (string) $value;
                }
                
                foreach ((array) $cdfs[$member_id] as $cdf_field => $cdf_value) {
                    $print_member[$member_id]['cdf_' . $cdf_field] = (string) $cdf_value;
                }

                foreach ((array) $profile_data[$member_id] as $field => $value) {
                    $print_member[$member_id][$field] = $value;
                }
                
                $print_member[$member_id]['login'] = $tmp_obj->getLogin();
                $print_member[$member_id]['name'] = $tmp_obj->getLastname() . ', ' . $tmp_obj->getFirstname();

                if ($this->getMembersObject()->isAdmin($member_id)) {
                    $print_member[$member_id]['role'] = $this->lng->txt("il_crs_admin");
                } elseif ($this->getMembersObject()->isTutor($member_id)) {
                    $print_member[$member_id]['role'] = $this->lng->txt("il_crs_tutor");
                } elseif ($this->getMembersObject()->isMember($member_id)) {
                    $print_member[$member_id]['role'] = $this->lng->txt("il_crs_member");
                }
                if ($this->getMembersObject()->isAdmin($member_id) or $this->getMembersObject()->isTutor($member_id)) {
                    if ($this->getMembersObject()->isNotificationEnabled($member_id)) {
                        $print_member[$member_id]['status'] = $this->lng->txt("crs_notify");
                    } else {
                        $print_member[$member_id]['status'] = $this->lng->txt("crs_no_notify");
                    }
                } else {
                    if ($this->getMembersObject()->isBlocked($member_id)) {
                        $print_member[$member_id]['status'] = $this->lng->txt("crs_blocked");
                    } else {
                        $print_member[$member_id]['status'] = $this->lng->txt("crs_unblocked");
                    }
                }
    
                if ($is_admin) {
                    $print_member[$member_id]['passed'] = $this->getMembersObject()->hasPassed($member_id) ?
                                      $this->lng->txt('crs_member_passed') :
                                      $this->lng->txt('crs_member_not_passed');
                }
                if ($privacy->enabledCourseAccessTimes()) {
                    if (isset($progress[$member_id]['ts']) and $progress[$member_id]['ts']) {
                        ilDatePresentation::setUseRelativeDates(false);
                        $print_member[$member_id]['access'] = ilDatePresentation::formatDate(new ilDateTime($progress[$member_id]['ts'], IL_CAL_UNIX));
                        ilDatePresentation::setUseRelativeDates(true);
                    } else {
                        $print_member[$member_id]['access'] = $this->lng->txt('no_date');
                    }
                }
                if ($show_tracking) {
                    if (in_array($member_id, $completed)) {
                        $print_member[$member_id]['progress'] = $this->lng->txt(ilLPStatus::LP_STATUS_COMPLETED);
                    } elseif (in_array($member_id, $in_progress)) {
                        $print_member[$member_id]['progress'] = $this->lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS);
                    } elseif (in_array($member_id, $failed)) {
                        $print_member[$member_id]['progress'] = $this->lng->txt(ilLPStatus::LP_STATUS_FAILED);
                    } else {
                        $print_member[$member_id]['progress'] = $this->lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED);
                    }
                }
            }
        }
        return ilUtil::sortArray($print_member, 'name', $_SESSION['crs_print_order'], false, true);
    }

Here is the call graph for this function:

initEditParticipantTableGUI()

ilCourseMembershipGUI::initEditParticipantTableGUI ( array  $participants )

protected

init edit participants table gui

Parameters

array

$participants

Returns

Definition at line 186 of file class.ilCourseMembershipGUI.php.

References $table, ilMembershipGUI\getParentGUI(), ilMembershipGUI\getParentObject(), and ilMembershipGUI\readMemberData().

    {
        include_once './Modules/Course/classes/class.ilCourseEditParticipantsTableGUI.php';
        $table = new ilCourseEditParticipantsTableGUI($this, $this->getParentObject());
        $table->setTitle($this->lng->txt($this->getParentObject()->getType() . '_header_edit_members'));
        $table->setData($this->getParentGUI()->readMemberData($participants));
        
        return $table;
    }

Here is the call graph for this function:

initParticipantTableGUI()

ilCourseMembershipGUI::initParticipantTableGUI ( )

protected

Returns

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

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ilObjectLP\getInstance(), ilMembershipGUI\getParentObject(), ilObjectActivation\hasTimings(), IL_CRS_VIEW_TIMING, and ilObjCourse\STATUS_DETERMINATION_LP.

    {
        include_once './Services/Tracking/classes/class.ilObjUserTracking.php';
        $show_tracking =
            (ilObjUserTracking::_enabledLearningProgress() && ilObjUserTracking::_enabledUserRelatedData())
        ;
        if ($show_tracking) {
            include_once('./Services/Object/classes/class.ilObjectLP.php');
            $olp = ilObjectLP::getInstance($this->getParentObject()->getId());
            $show_tracking = $olp->isActive();
        }

        include_once('./Services/Object/classes/class.ilObjectActivation.php');
        $timings_enabled =
            (ilObjectActivation::hasTimings($this->getParentObject()->getRefId()) && ($this->getParentObject()->getViewMode() == IL_CRS_VIEW_TIMING))
        ;
        
        
        include_once './Modules/Course/classes/class.ilCourseParticipantsTableGUI.php';
        return new ilCourseParticipantsTableGUI(
            $this,
            $this->getParentObject(),
            $show_tracking,
            $timings_enabled,
            $this->getParentObject()->getStatusDetermination() == ilObjCourse::STATUS_DETERMINATION_LP
        );
    }

Here is the call graph for this function:

initParticipantTemplate()

ilCourseMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

Definition at line 199 of file class.ilCourseMembershipGUI.php.

    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.crs_edit_members.html', 'Modules/Course');
    }

initWaitingList()

ilCourseMembershipGUI::initWaitingList ( )

protected

init waiting list

Returns

ilCourseWaitingList

Definition at line 224 of file class.ilCourseMembershipGUI.php.

References ilMembershipGUI\getParentObject().

    {
        include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
        $wait = new ilCourseWaitingList($this->getParentObject()->getId());
        return $wait;
    }

Here is the call graph for this function:

updateLPFromStatus()

ilCourseMembershipGUI::updateLPFromStatus (   $a_member_id,   $a_passed  )

protected

Update lp from status.

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

References ilMembershipGUI\getParentGUI().

Referenced by updateParticipantsStatus().

    {
        return $this->getParentGUI()->updateLPFromStatus($a_member_id, $a_passed);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateParticipantsStatus()

ilCourseMembershipGUI::updateParticipantsStatus ( )

protected

=> save button in member table

Definition at line 106 of file class.ilCourseMembershipGUI.php.

References $_POST, $ilErr, $ilUser, array, ilMembershipGUI\getMembersObject(), ilUtil\sendSuccess(), and updateLPFromStatus().

    {
        global $ilAccess,$ilErr,$ilUser,$rbacadmin;
        
        $visible_members = (array) $_POST['visible_member_ids'];
        $passed = (array) $_POST['passed'];
        $blocked = (array) $_POST['blocked'];
        $contact = (array) $_POST['contact'];
        $notification = (array) $_POST['notification'];
        
        foreach ($visible_members as $member_id) {
            if ($ilAccess->checkAccess("grade", "", $this->getParentObject()->getRefId())) {
                $this->getMembersObject()->updatePassed($member_id, in_array($member_id, $passed), true);
                $this->updateLPFromStatus($member_id, in_array($member_id, $passed));
            }
            
            if ($this->getMembersObject()->isAdmin($member_id) or $this->getMembersObject()->isTutor($member_id)) {
                // remove blocked
                $this->getMembersObject()->updateBlocked($member_id, 0);
                $this->getMembersObject()->updateNotification($member_id, in_array($member_id, $notification));
                $this->getMembersObject()->updateContact($member_id, in_array($member_id, $contact));
            } else {
                // send notifications => unblocked
                if ($this->getMembersObject()->isBlocked($member_id) && !in_array($member_id, $blocked)) {
                    $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_UNBLOCK_MEMBER, $member_id);
                }
                // => blocked
                if (!$this->getMembersObject()->isBlocked($member_id) && in_array($member_id, $blocked)) {
                    $this->getMembersObject()->sendNotification($this->getMembersObject()->NOTIFY_BLOCK_MEMBER, $member_id);
                }

                // normal member => remove notification, contact
                $this->getMembersObject()->updateNotification($member_id, false);
                $this->getMembersObject()->updateContact($member_id, false);
                $this->getMembersObject()->updateBlocked($member_id, in_array($member_id, $blocked));
            }
        }
            
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'participants');
    }

Here is the call graph for this function:

---

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

• Modules/Course/classes/class.ilCourseMembershipGUI.php