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 (int $a_usr_id, int $a_role)

	addSubscriber (int $a_usr_id)

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

Public Member Functions inherited from ilParticipants
	__construct (string $a_component_name, int $a_ref_id)

	getObjId ()

	getType ()

	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 ()

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

	isAdmin (int $a_usr_id)
	check if user is admin More...

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

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

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

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

	getRoles ()
	Get object roles. More...

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

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

	checkLastAdmin (array $a_usr_ids)
	Check if users for deletion are last admins public. More...

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

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

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

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

	updateContact (int $a_usr_id, bool $a_contact)

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

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

	add (int $a_usr_id, int $a_role)

	deleteParticipants (array $a_user_ids)

	addRecommendation (int $a_usr_id)
	Add desktop item public. More...

	isNotificationEnabled (int $a_usr_id)

	isContact (int $a_usr_id)

	getAutoGeneratedRoleId (int $a_role_type)

	isGroupingMember (int $a_usr_id, string $a_field='')
	Check membership for. More...

	getSubscribers ()
	get all subscribers int[] More...

	getCountSubscribers ()

	getSubscriberData (int $a_usr_id)

	assignSubscribers (array $a_usr_ids)

	assignSubscriber (int $a_usr_id)

	autoFillSubscribers ()

	addSubscriber (int $a_usr_id)

	updateSubscriptionTime (int $a_usr_id, int $a_subtime)

	updateSubject (int $a_usr_id, string $a_subject)

	deleteSubscriber (int $a_usr_id)

	deleteSubscribers (array $a_usr_ids)

	isSubscriber (int $a_usr_id)

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

Static Public Member Functions
static	_getInstanceByObjId (int $obj_id)

static	getMemberRoles (int $ref_id)

static	_isParticipant (int $a_ref_id, int $a_usr_id)

Static Public Member Functions inherited from ilParticipants
static	getInstance (int $a_ref_id)

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

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

static	canSendMailToMembers (int\|ilObject $ref_id_or_instance, ?int $usr_id=null, ?int $mail_obj_ref_id=null)
	This method was introduced as a band-aid fix for #22764. More...

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

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

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

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

static	lookupNumberOfMembers (int $a_ref_id)
	Lookup number of members. More...

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

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

static	_deleteAllEntries (int $a_obj_id)
	Delete all entries Normally called in case of object deletion. More...

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

static	getDefaultMemberRole (int $a_ref_id)

static	lookupSubscribers (int $a_obj_id)

static	_isSubscriber (int $a_obj_id, int $a_usr_id)

static	lookupSubscribersData (int $a_obj_id)

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

Data Fields
const	COMPONENT_NAME = 'components/ILIAS/LearningSequence'

Data Fields inherited from ilParticipants
const	IL_CRS_ADMIN = 1

const	IL_CRS_TUTOR = 3

const	IL_CRS_MEMBER = 2

const	IL_GRP_ADMIN = 4

const	IL_GRP_MEMBER = 5

const	IL_SESS_MEMBER = 6

const	IL_LSO_ADMIN = 7

const	IL_LSO_MEMBER = 8

const	IL_ROLE_POSITION_ADMIN = 1

const	IL_ROLE_POSITION_TUTOR = 2

const	IL_ROLE_POSITION_MEMBER = 3

Protected Attributes
ilAppEventHandler	$app_event_handler

ilSetting	$settings

Protected Attributes inherited from ilParticipants
string	$component = ''

int	$ref_id = 0

int	$obj_id = 0

string	$type = ''

array	$roles = []

array	$role_data = []

array	$roles_sorted = []

array	$role_assignments = []

array	$participants = []

array	$participants_status = []

array	$members = []

array	$tutors = []

array	$admins = []

array	$subscribers = []

ilAppEventHandler	$eventHandler

ilRbacReview	$rbacReview

ilRbacAdmin	$rbacAdmin

ilObjectDataCache	$objectDataCache

ilDBInterface	$ilDB

ilLanguage	$lng

ilLogger	$logger

ilErrorHandling	$error

ilRecommendedContentManager	$recommended_content_manager

Static Protected Attributes
static array	$instances

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

	readParticipants ()

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

	readSubscribers ()

	readSubscriberData (int $a_usr_id)

Detailed Description

Manage participants.

Definition at line 24 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 35 of file class.ilLearningSequenceParticipants.php.

References $app_event_handler, ilParticipants\$logger, $settings, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_getAllReferences(), ILIAS\Repository\logger(), and ILIAS\Repository\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 49 of file class.ilLearningSequenceParticipants.php.

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

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

                                                            : ilLearningSequenceParticipants
     {
         global $DIC;
 
         $logger = $DIC["ilLoggerFactory"]->getRootLogger();
         $app_event_handler = $DIC['ilAppEventHandler'];
         $settings = $DIC["ilSetting"];
 
         if (isset(self::$instances[$obj_id]) && 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	(	int	$a_ref_id,
		int	$a_usr_id
	)

static

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

References $DIC.

Referenced by ilObjLearningSequenceGUI\checkLPAccess().

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

Here is the caller graph for this function:

◆ add()

ilLearningSequenceParticipants::add	(	int	$a_usr_id,
		int	$a_role
	)

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

References ILIAS\UI\examples\Symbol\Glyph\Add\add().

Referenced by ilObjLearningSequenceGUI\afterSave().

                                                    : bool
     {
         return parent::add($a_usr_id, $a_role);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSubscriber()

ilLearningSequenceParticipants::addSubscriber ( int $a_usr_id )

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

References ilParticipants\getObjId(), and ILIAS\Repository\logger().

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

Here is the call graph for this function:

◆ getMemberRoles()

static ilLearningSequenceParticipants::getMemberRoles ( int $ref_id )

static

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

References $DIC, ilParticipants\$roles, 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	(	int	$type,
		int	$usr_id,
		bool	$force_sending_mail = `false`
	)

Send notification mail.

Definition at line 126 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

◆ $app_event_handler

ilAppEventHandler ilLearningSequenceParticipants::$app_event_handler

protected

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

Referenced by __construct().

◆ $instances

array ilLearningSequenceParticipants::$instances

staticprotected

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

◆ $settings

ilSetting ilLearningSequenceParticipants::$settings

protected

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

Referenced by __construct().

◆ COMPONENT_NAME

const ilLearningSequenceParticipants::COMPONENT_NAME = 'components/ILIAS/LearningSequence'

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

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

components/ILIAS/LearningSequence/classes/Members/class.ilLearningSequenceParticipants.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstanceByObjId()

◆ _isParticipant()

◆ add()

◆ addSubscriber()

◆ getMemberRoles()

◆ sendNotification()

Field Documentation

◆ $app_event_handler

◆ $instances

◆ $settings

◆ COMPONENT_NAME