ilCourseParticipants Class Reference

Inheritance diagram for ilCourseParticipants:

Collaboration diagram for ilCourseParticipants:

Public Member Functions
	updatePassed ($a_usr_id, $a_passed)
	Update passed status.
	sendNotification ($a_type, $a_usr_id)
	sendUnsubscribeNotificationToAdmins ($a_usr_id)
	sendSubscriptionRequestToAdmins ($a_usr_id)
	sendNotificationToAdmins ($a_usr_id)
	__buildStatusBody (&$user_obj)
Public Member Functions inherited from ilParticipants
	getNotificationRecipients ()
	Get admin, tutor which have notification enabled.
	getCountMembers ()
	Get number of members (not participants)
	getCountParticipants ()
	Get number of participants.
	getParticipants ()
	Get all participants ids.
	getMembers ()
	Get all members ids (admins and tutors are not members) Use get participants to fetch all.
	getAdmins ()
	Get all admins ids.
	getTutors ()
	Get all tutors ids.
	isAdmin ($a_usr_id)
	is user admin
	isTutor ($a_usr_id)
	is user tutor
	isMember ($a_usr_id)
	is user member
	isAssigned ($a_usr_id)
	check if user is assigned
	isLastAdmin ($a_usr_id)
	Check if user is last admin.
	getRoles ()
	Get course roles.
	getAssignedRoles ($a_usr_id)
	Get assigned roles.
	updateRoleAssignments ($a_usr_id, $a_roles)
	Update role assignments.
	checkLastAdmin ($a_usr_ids)
	Check if user for deletion are last admins.
	isBlocked ($a_usr_id)
	Check if user is blocked.
	hasPassed ($a_usr_id)
	Check if user has passed course.
	delete ($a_usr_id)
	Drop user from all roles.
	updateBlocked ($a_usr_id, $a_blocked)
	Update blocked status.
	updateNotification ($a_usr_id, $a_notification)
	Update notification status.
	add ($a_usr_id, $a_role)
	Add user to course.
	deleteParticipants ($a_user_ids)
	Delete users.
	addDesktopItem ($a_usr_id)
	Add desktop item.
	dropDesktopItem ($a_usr_id)
	Drop desktop item.
	isNotificationEnabled ($a_usr_id)
	check if notification is enabled
	isGroupingMember ($a_usr_id, $a_field= '')
	Check grouping membership.
	getSubscribers ()
	get all subscribers
	getCountSubscribers ()
	get number of subscribers
	getSubscriberData ($a_usr_id)
	get subscriber data
	assignSubscribers ($a_usr_ids)
	Assign subscribers.
	assignSubscriber ($a_usr_id)
	Assign subscriber.
	autoFillSubscribers ()
	Assign subscriber.
	addSubscriber ($a_usr_id)
	Add subscriber.
	updateSubscriptionTime ($a_usr_id, $a_subtime)
	Update subscription time.
	updateSubject ($a_usr_id, $a_subject)
	update subject
	deleteSubscriber ($a_usr_id)
	Delete subsciber.
	deleteSubscribers ($a_usr_ids)
	Delete subscibers.
	isSubscriber ($a_usr_id)
	check if is subscriber

Static Public Member Functions
static	_getInstanceByObjId ($a_obj_id)
	Get singleton instance.
Static Public Member Functions inherited from ilParticipants
static	_getMembershipByType ($a_usr_id, $a_type)
	get membership by type Get course or group membership
static	_isParticipant ($a_ref_id, $a_usr_id)
	Static function to check if a user is a participant of the container object.
static	_isBlocked ($a_obj_id, $a_usr_id)
	Check if user is blocked.
static	_hasPassed ($a_obj_id, $a_usr_id)
	Check if user has passed course.
static	_deleteAllEntries ($a_obj_id)
	Delete all entries Normally called for course deletion.
static	_deleteUser ($a_usr_id)
	Delete user data.
static	getDefaultMemberRole ($a_ref_id)
static	_isSubscriber ($a_obj_id, $a_usr_id)
	check if user is subscriber

Protected Member Functions
	__construct ($a_obj_id)
	Singleton constructor.
Protected Member Functions inherited from ilParticipants
	readSubscribers ()
	read subscribers
	readSubscriberData ($a_usr_id)
	read subscribers

Static Protected Attributes
static	$instances = array()

Additional Inherited Members
Protected Attributes inherited from ilParticipants
	$obj_id = 0
	$type = ''
	$ref_id = 0
	$roles = array()
	$role_data = array()
	$participants = array()
	$participants_status = array()
	$members = array()
	$tutors = array()
	$admins = array()
	$subscribers = array()
	$ilDB
	$lng

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

ilCourseParticipants::__construct (   $a_obj_id )

protected

Singleton constructor.

protected

Parameters

int	obj_id of container

Reimplemented from ilParticipants.

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

        {
                $this->type = 'crs';
                
                $this->NOTIFY_DISMISS_SUBSCRIBER = 1;
                $this->NOTIFY_ACCEPT_SUBSCRIBER = 2;
                $this->NOTIFY_DISMISS_MEMBER = 3;
                $this->NOTIFY_BLOCK_MEMBER = 4;
                $this->NOTIFY_UNBLOCK_MEMBER = 5;
                $this->NOTIFY_ACCEPT_USER = 6;
                $this->NOTIFY_ADMINS = 7;
                $this->NOTIFY_STATUS_CHANGED = 8;
                $this->NOTIFY_SUBSCRIPTION_REQUEST = 9;
                
                $this->NOTIFY_REGISTERED = 10;
                $this->NOTIFY_UNSUBSCRIBE = 11;
                $this->NOTIFY_WAITING_LIST = 12; 
                
                parent::__construct($a_obj_id);
        }

Member Function Documentation

ilCourseParticipants::__buildStatusBody

(

&

$user_obj

)

Definition at line 282 of file class.ilCourseParticipants.php.

References ilParticipants\$ilDB, ilParticipants\hasPassed(), ilParticipants\isAdmin(), ilParticipants\isBlocked(), ilParticipants\isMember(), ilParticipants\isNotificationEnabled(), and ilParticipants\isTutor().

        {
                global $ilDB;

                $body = $this->lng->txt('crs_status_changed_body')."\n";
                $body .= $this->lng->txt('login').': '.$user_obj->getLogin()."\n";
                $body .= $this->lng->txt('role').': ';

                if($this->isAdmin($user_obj->getId()))
                {
                        $body .= $this->lng->txt('crs_admin')."\n";
                }
                if($this->isTutor($user_obj->getId()))
                {
                        $body .= $this->lng->txt('crs_tutor')."\n";
                }
                if($this->isMember($user_obj->getId()))
                {
                        $body .= $this->lng->txt('crs_member')."\n";
                }
                $body .= $this->lng->txt('status').': ';
                
                if($this->isNotificationEnabled($user_obj->getId()))
                {
                        $body .= $this->lng->txt("crs_notify")."\n";
                }
                else
                {
                        $body .= $this->lng->txt("crs_no_notify")."\n";
                }
                if($this->isBlocked($user_obj->getId()))
                {
                        $body .= $this->lng->txt("crs_blocked")."\n";
                }
                else
                {
                        $body .= $this->lng->txt("crs_unblocked")."\n";
                }
                $passed = $this->hasPassed($user_obj->getId()) ? $this->lng->txt('yes') : $this->lng->txt('no');
                $body .= $this->lng->txt('crs_passed').': '.$passed."\n";

                return $body;
        }

Here is the call graph for this function:

static ilCourseParticipants::_getInstanceByObjId (   $a_obj_id )

static

Get singleton instance.

public

Parameters

int

obj_id

Definition at line 74 of file class.ilCourseParticipants.php.

Referenced by ilCourseEditParticipantsTableGUI\__construct(), ilMemberExport\__construct(), ilLPStatusManualByTutor\__getCourseInProgress(), ilLPStatusManual\__getCourseInProgress(), ilObjCourseGUI\__showWaitingList(), ilCourseObjectiveResult\__updatePassed(), ilObjCourseAccess\_checkAccess(), ilObjCourseGrouping\_checkGroupingDependencies(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilLPStatusObjectives\_getInProgress(), ilLPStatusCollection\_getInProgress(), ilLPStatusManual\_getNotAttempted(), ilLPStatusObjectives\_getNotAttempted(), ilLPStatusEvent\_getNotAttempted(), ilLPStatusCollection\_getNotAttempted(), ilLPStatusManualByTutor\_getNotAttempted(), ilFeedbackGUI\_isRequiredFeedbackOnLogin(), ilSoapCourseAdministration\assignCourseMember(), ilDataLoader\assignUsersAsCourseMembers(), ilFeedback\canVote(), ilCourseMembershipMailNotification\createCourseStatus(), ilObjSessionGUI\eventsListObject(), ilSoapCourseAdministration\excludeCourseMember(), ilSessionOverviewGUI\exportCSV(), ilUserImportParser\getCourseMembersObjectForRole(), ilObjCourseListGUI\getProperties(), ilCourseXMLParser\ilCourseXMLParser(), ilObjCourse\initCourseMemberObject(), ilCourseRegistrationGUI\initParticipants(), ilSoapCourseAdministration\isAssignedToCourse(), ilSessionOverviewGUI\listSessions(), ilRepositorySearchGUI\listUsers(), ilObjSessionGUI\membersObject(), ilObjCourseGUI\membersObject(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilObjSessionGUI\printAttendanceListObject(), ilObjSessionGUI\printViewMembersObject(), ilPurchase\purchase(), ilMailSearchCoursesGUI\showMyCourses(), ilMembershipTest\testSubscription(), ilObjSessionGUI\updateMembersObject(), and ilObjCourseGUI\updateMembersObject().

        {
                if(isset(self::$instances[$a_obj_id]) and self::$instances[$a_obj_id])
                {
                        return self::$instances[$a_obj_id];
                }
                return self::$instances[$a_obj_id] = new ilCourseParticipants($a_obj_id);
        }

Here is the caller graph for this function:

ilCourseParticipants::sendNotification	(		$a_type,
			$a_usr_id
	)

Definition at line 132 of file class.ilCourseParticipants.php.

References sendNotificationToAdmins(), sendSubscriptionRequestToAdmins(), ilCourseMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilCourseMembershipMailNotification\TYPE_BLOCKED_MEMBER, ilCourseMembershipMailNotification\TYPE_DISMISS_MEMBER, ilCourseMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_STATUS_CHANGED, ilCourseMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, ilCourseMembershipMailNotification\TYPE_UNBLOCKED_MEMBER, ilCourseMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and ilCourseMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

        {
                include_once './Modules/Course/classes/class.ilCourseMembershipMailNotification.php';
                
                global $ilObjDataCache,$ilUser;
        
                switch($a_type)
                {
                        case $this->NOTIFY_DISMISS_SUBSCRIBER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);   
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;
                                
                        case $this->NOTIFY_ACCEPT_SUBSCRIBER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);  
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;                          

                        case $this->NOTIFY_DISMISS_MEMBER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER);        
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();
                                break;

                        case $this->NOTIFY_BLOCK_MEMBER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_BLOCKED_MEMBER);        
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();
                                break;
                                
                        case $this->NOTIFY_UNBLOCK_MEMBER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_UNBLOCKED_MEMBER);      
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();
                                break;

                        case $this->NOTIFY_ACCEPT_USER:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER);      
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;

                        case $this->NOTIFY_STATUS_CHANGED:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED);        
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;
                                
                        case $this->NOTIFY_UNSUBSCRIBE:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER);    
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;
                                
                        case $this->NOTIFY_REGISTERED:
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER);      
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->send();                          
                                break;

                        case $this->NOTIFY_WAITING_LIST:
                                include_once('./Modules/Course/classes/class.ilCourseWaitingList.php');
                                $wl = new ilCourseWaitingList($this->obj_id);
                                $pos = $wl->getPosition($a_usr_id);
                                        
                                $mail = new ilCourseMembershipMailNotification();
                                $mail->setType(ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER);   
                                $mail->setRefId($this->ref_id);
                                $mail->setRecipients(array($a_usr_id));
                                $mail->setAdditionalInformation(array('position' => $pos));
                                $mail->send();
                                break;

                        case $this->NOTIFY_SUBSCRIPTION_REQUEST:
                                $this->sendSubscriptionRequestToAdmins($a_usr_id);
                                break;

                        case $this->NOTIFY_ADMINS:
                                $this->sendNotificationToAdmins($a_usr_id);
                                return true;
                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilCourseParticipants::sendNotificationToAdmins

(

$a_usr_id

)

Definition at line 267 of file class.ilCourseParticipants.php.

References ilParticipants\$ilDB, ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION.

Referenced by sendNotification().

        {
                global $ilDB,$ilObjDataCache;
                
                include_once './Modules/Course/classes/class.ilCourseMembershipMailNotification.php';
                $mail = new ilCourseMembershipMailNotification();
                $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION);
                $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
                $mail->setRefId($this->ref_id);
                $mail->setRecipients($this->getNotificationRecipients());
                $mail->send();                  
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseParticipants::sendSubscriptionRequestToAdmins

(

$a_usr_id

)

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

References ilParticipants\$ilDB, ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST.

Referenced by sendNotification().

        {
                global $ilDB,$ilObjDataCache;
                
                include_once './Modules/Course/classes/class.ilCourseMembershipMailNotification.php';
                $mail = new ilCourseMembershipMailNotification();
                $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST);
                $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
                $mail->setRefId($this->ref_id);
                $mail->setRecipients($this->getNotificationRecipients());
                $mail->send();
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseParticipants::sendUnsubscribeNotificationToAdmins

(

$a_usr_id

)

Definition at line 237 of file class.ilCourseParticipants.php.

References ilParticipants\$ilDB, ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE.

        {
                global $ilDB,$ilObjDataCache;
                
                include_once './Modules/Course/classes/class.ilCourseMembershipMailNotification.php';
                $mail = new ilCourseMembershipMailNotification();
                $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE);
                $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
                $mail->setRefId($this->ref_id);
                $mail->setRecipients($this->getNotificationRecipients());
                $mail->send();
                return true;
        }

Here is the call graph for this function:

ilCourseParticipants::updatePassed	(		$a_usr_id,
			$a_passed
	)

Update passed status.

public

Parameters

int	usr_id
bool	passed

Definition at line 94 of file class.ilCourseParticipants.php.

References ilParticipants\$ilDB, $query, and $res.

        {
                global $ilDB;
                
                $this->participants_status[$a_usr_id]['passed'] = (int) $a_passed;

                $query = "SELECT * FROM crs_members ".
                "WHERE obj_id = ".$ilDB->quote($this->obj_id,'integer')." ".
                "AND usr_id = ".$ilDB->quote($a_usr_id,'integer');
                $res = $ilDB->query($query);
                if($res->numRows())
                {
                        $query = "UPDATE crs_members SET ".
                                "passed = ".$ilDB->quote((int) $a_passed,'integer')." ".
                                "WHERE obj_id = ".$ilDB->quote($this->obj_id,'integer')." ".
                                "AND usr_id = ".$ilDB->quote($a_usr_id,'integer');
                }
                else
                {
                        $query = "INSERT INTO crs_members (passed,obj_id,usr_id,notification,blocked) ".
                                "VALUES ( ".
                                $ilDB->quote((int) $a_passed,'integer').", ".
                                $ilDB->quote($this->obj_id,'integer').", ".
                                $ilDB->quote($a_usr_id,'integer').", ".
                                $ilDB->quote(0,'integer').", ".
                                $ilDB->quote(0,'integer')." ".
                                ")";
                        
                }
                $res = $ilDB->manipulate($query);
                return true;
        
        }

Field Documentation

ilCourseParticipants::$instances = array()

staticprotected

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

---

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

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