Manage participants. More...

Inheritance diagram for ilLearningSequenceParticipants:

Collaboration diagram for ilLearningSequenceParticipants:

Public Member Functions
	__construct (int $obj_id, ilLogger $logger, ilAppEventHandler $app_event_handler, ilSetting $settings)

	add ($usr_id, $role)

	addSubscriber ($usr_id)

	sendNotification ($type, $usr_id, $force_sending_mail=false)
	Send notification mail. More...

Public Member Functions inherited from ilParticipants
	__construct ($a_component_name, $a_ref_id)
	Singleton Constructor. More...

	getObjId ()
	get current obj_id More...

	getType ()
	Get object type. More...

	getNotificationRecipients ()
	Get admin, tutor which have notification enabled. More...

	getCountMembers ()
	Get number of members (not participants) More...

	getCountParticipants ()
	Get number of participants. More...

	getParticipants ()
	Get all participants ids. More...

	getMembers ()
	Get all members ids (admins and tutors are not members) Use get participants to fetch all. More...

	getAdmins ()
	Get all admins ids. More...

	getCountAdmins ()
	Get number of admins. More...

	getTutors ()
	Get all tutors ids. More...

	isAdmin ($a_usr_id)
	is user admin More...

	isTutor ($a_usr_id)
	is user tutor More...

	isMember ($a_usr_id)
	is user member More...

	isAssigned ($a_usr_id)
	check if user is assigned More...

	isLastAdmin ($a_usr_id)
	Check if user is last admin. More...

	getRoles ()
	Get course roles. More...

	getAssignedRoles ($a_usr_id)
	Get assigned roles. More...

	updateRoleAssignments ($a_usr_id, $a_roles)
	Update role assignments. More...

	checkLastAdmin ($a_usr_ids)
	Check if user for deletion are last admins. More...

	isBlocked ($a_usr_id)
	Check if user is blocked. More...

	hasPassed ($a_usr_id)
	Check if user has passed course. More...

	delete ($a_usr_id)
	Drop user from all roles. More...

	updateBlocked ($a_usr_id, $a_blocked)
	Update blocked status. More...

	updateContact ($a_usr_id, $a_contact)
	Update contact setting type $ilDB. More...

	getContacts ()
	get user ids which are confirgured as contact More...

	updateNotification ($a_usr_id, $a_notification)
	Update notification status. More...

	add ($a_usr_id, $a_role)
	Add user to object. More...

	deleteParticipants ($a_user_ids)
	Delete users. More...

	addDesktopItem ($a_usr_id)
	Add desktop item. More...

	dropDesktopItem ($a_usr_id)
	Drop desktop item. More...

	isNotificationEnabled ($a_usr_id)
	check if notification is enabled More...

	isContact ($a_usr_id)
	Check if user is contact. More...

	getAutoGeneratedRoleId ($a_role_type)
	Get role id of auto generated role type. More...

	isGroupingMember ($a_usr_id, $a_field='')
	Check grouping membership. More...

	getSubscribers ()
	get all subscribers More...

	getCountSubscribers ()
	get number of subscribers More...

	getSubscriberData ($a_usr_id)
	get subscriber data More...

	assignSubscribers ($a_usr_ids)
	Assign subscribers. More...

	assignSubscriber ($a_usr_id)
	Assign subscriber. More...

	autoFillSubscribers ()
	Assign subscriber. More...

	addSubscriber ($a_usr_id)
	Add subscriber. More...

	updateSubscriptionTime ($a_usr_id, $a_subtime)
	Update subscription time. More...

	updateSubject ($a_usr_id, $a_subject)
	update subject More...

	deleteSubscriber ($a_usr_id)
	Delete subsciber. More...

	deleteSubscribers ($a_usr_ids)
	Delete subscibers. More...

	isSubscriber ($a_usr_id)
	check if is subscriber More...

	setRoleOrderPosition ($a_user_id)
	Set role order position. More...

Static Public Member Functions
static	_getInstanceByObjId (int $obj_id)

static	getMemberRoles ($ref_id)

static	_isParticipant ($ref_id, $usr_id)

Static Public Member Functions inherited from ilParticipants
static	getInstance ($a_ref_id)
	Get instance by ref_id. More...

static	getInstanceByObjId ($a_obj_id)
	Get instance by obj type. More...

static	hasParticipantListAccess ($a_obj_id, $a_usr_id=null)
	Check if (current) user has access to the participant list. More...

static	getUserMembershipAssignmentsByType ($a_user_ids, $a_type, $a_only_member_roles)
	Get user membership assignments by type. More...

static	_getMembershipByType ($a_usr_id, $a_type, $a_only_member_role=false)
	get membership by type Get course or group membership More...

static	_isParticipant ($a_ref_id, $a_usr_id)
	Static function to check if a user is a participant of the container object. More...

static	lookupNumberOfParticipants ($a_ref_id)
	Lookup the number of participants (crs admins, tutors, members, grp admins, members) More...

static	lookupNumberOfMembers ($a_ref_id)
	Lookup number of members ilRbacReview $rbacreview <type> $ilObjDataCache. More...

static	_isBlocked ($a_obj_id, $a_usr_id)
	Check if user is blocked. More...

static	_hasPassed ($a_obj_id, $a_usr_id)
	Check if user has passed course. More...

static	_deleteAllEntries ($a_obj_id)
	Delete all entries Normally called for course deletion. More...

static	_deleteUser ($a_usr_id)
	Delete user data. More...

static	getDefaultMemberRole ($a_ref_id)

static	lookupSubscribers ($a_obj_id)

static	_isSubscriber ($a_obj_id, $a_usr_id)
	check if user is subscriber More...

static	lookupSubscribersData ($a_obj_id)

static	_getAllSupportContactsOfUser ($a_usr_id, $a_type)
	Get all support contacts for a user. More...

Data Fields
const	COMPONENT_NAME = 'Modules/LearningSequence'

Static Protected Attributes
static	$instances

Additional Inherited Members
Protected Member Functions inherited from ilParticipants
	getComponent ()
	Get component name Used for raising events. More...

	readParticipants ()
	Read participants. More...

	readParticipantsStatus ()
	Read status of participants (blocked, notification, passed) More...

	readSubscribers ()
	read subscribers More...

	readSubscriberData ($a_usr_id)
	read subscribers More...

Protected Attributes inherited from ilParticipants
	$component = ''

	$obj_id = 0

	$type = ''

	$ref_id = 0

	$roles = array()

	$role_data = array()

	$roles_sorted = []

	$role_assignments = []

	$participants = array()

	$participants_status = array()

	$members = array()

	$tutors = array()

	$admins = array()

	$subscribers = array()

	$ilDB

	$lng

	$logger = null

Detailed Description

Manage participants.

Author: Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e (refactor to psr-12 as far as possible)

Definition at line 10 of file class.ilLearningSequenceParticipants.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceParticipants::__construct	(	int	$obj_id,
		ilLogger	$logger,
		ilAppEventHandler	$app_event_handler,
		ilSetting	$settings
	)

Definition at line 19 of file class.ilLearningSequenceParticipants.php.

References ilParticipants\$logger, ilObject\_getAllReferences(), and settings().

       {
         $refs = ilObject::_getAllReferences($obj_id);
         parent::__construct(self::COMPONENT_NAME, array_pop($refs));
 
         $this->logger = $logger;
         $this->app_event_handler = $app_event_handler;
         $this->settings = $settings;
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjId()

static ilLearningSequenceParticipants::_getInstanceByObjId ( int $obj_id )

static

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

References $DIC, ilParticipants\$logger, and ilParticipants\$obj_id.

Referenced by ilLearningSequenceMembershipMailNotification\createLearningSequenceStatus(), ilParticipants\getInstanceByObjId(), and ilLPStatusCollection\getMembers().

                                                             : ilLearningSequenceParticipants
     {
         global $DIC;
 
         $logger = $DIC["ilLoggerFactory"]->getRootLogger();
         $app_event_handler = $DIC['ilAppEventHandler'];
         $settings = $DIC["ilSetting"];
 
         if (isset(self::$instances[$obj_id]) and self::$instances[$obj_id]) {
             return self::$instances[$obj_id];
         }
 
         return self::$instances[$obj_id] = new ilLearningSequenceParticipants(
             $obj_id,
             $logger,
             $app_event_handler,
             $settings
         );
     }

Here is the caller graph for this function:

◆ _isParticipant()

static ilLearningSequenceParticipants::_isParticipant	(	$ref_id,
		$usr_id
	)

static

Definition at line 77 of file class.ilLearningSequenceParticipants.php.

References $DIC, and ilParticipants\$ref_id.

Referenced by ilObjLearningSequenceGUI\checkLPAccess().

                                                             : bool
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $local_roles = $rbacreview->getRolesOfRoleFolder($ref_id, false);
 
         return $rbacreview->isAssignedToAtLeastOneGivenRole($usr_id, $local_roles);
     }

Here is the caller graph for this function:

◆ add()

ilLearningSequenceParticipants::add	(	$usr_id,
		$role
	)

Definition at line 87 of file class.ilLearningSequenceParticipants.php.

References add(), and ilParticipants\addDesktopItem().

Referenced by ilObjLearningSequenceGUI\afterSave().

                                         : bool
     {
         if (parent::add($usr_id, $role)) {
             $this->addDesktopItem($usr_id);
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSubscriber()

ilLearningSequenceParticipants::addSubscriber ( $usr_id )

Definition at line 97 of file class.ilLearningSequenceParticipants.php.

References ilParticipants\getObjId().

     {
         parent::addSubscriber($usr_id);
 
         $this->log->lso()->info('Raise new event: Modules/LearningSequence addSubscriber.');
         $this->app_event_handler->raise(
             "Modules/LearningSequence",
             'addSubscriber',
             array(
                 'obj_id' => $this->getObjId(),
                 'usr_id' => $usr_id
             )
         );
     }

Here is the call graph for this function:

◆ getMemberRoles()

static ilLearningSequenceParticipants::getMemberRoles ( $ref_id )

static

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

References $DIC, ilParticipants\$ref_id, ilParticipants\$roles, $title, and ilObject\_lookupTitle().

                                                    : array
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $lrol = $rbacreview->getRolesOfRoleFolder($ref_id, false);
 
         $roles = array();
         foreach ($lrol as $role) {
             $title = ilObject::_lookupTitle($role);
 
             switch (substr($title, 0, 8)) {
                 case 'il_lso_a':
                 case 'il_lso_m':
                     $roles[$role] = $role;
                     // no break
                 default:
                     break;
             }
         }
 
         return $roles;
     }

Here is the call graph for this function:

◆ sendNotification()

ilLearningSequenceParticipants::sendNotification	(	$type,
		$usr_id,
		$force_sending_mail = `false`
	)

Send notification mail.

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

                                                                                   : bool
     {
         $mail = new ilLearningSequenceMembershipMailNotification($this->logger, $this->settings);
         $mail->forceSendingMail($force_sending_mail);
 
         switch ($type) {
             case ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_DISMISS_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_DISMISS_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION);
                 $mail->setAdditionalInformation(array('usr_id' => $usr_id));
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients($this->getNotificationRecipients());
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE);
                 $mail->setAdditionalInformation(array('usr_id' => $usr_id));
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients($this->getNotificationRecipients());
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST);
                 $mail->setAdditionalInformation(array('usr_id' => $usr_id));
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients($this->getNotificationRecipients());
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
             case ilLearningSequenceMembershipMailNotification::TYPE_STATUS_CHANGED:
                 $mail->setType(ilLearningSequenceMembershipMailNotification::TYPE_STATUS_CHANGED);
                 $mail->setRefId($this->ref_id);
                 $mail->setRecipients(array($usr_id));
                 $mail->send();
                 break;
         }
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $instances

ilLearningSequenceParticipants::$instances

staticprotected

Definition at line 17 of file class.ilLearningSequenceParticipants.php.

◆ COMPONENT_NAME

const ilLearningSequenceParticipants::COMPONENT_NAME = 'Modules/LearningSequence'

Definition at line 12 of file class.ilLearningSequenceParticipants.php.

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

Modules/LearningSequence/classes/Members/class.ilLearningSequenceParticipants.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstanceByObjId()

◆ _isParticipant()

◆ add()

◆ addSubscriber()

◆ getMemberRoles()

◆ sendNotification()

Field Documentation

◆ $instances

◆ COMPONENT_NAME