Session participation handling. More...

Inheritance diagram for ilSessionParticipants:

Collaboration diagram for ilSessionParticipants:

Public Member Functions
	__construct (int $a_ref_id)

	getEventParticipants ()

	checkLastAdmin (array $a_usr_ids)
	no last admin restrictions for sessions More...

	add (int $a_usr_id, int $a_role=0)
	Add user to session member role. More...

	register (int $a_usr_id)

	unregister (int $a_usr_id)

	sendNotification (int $a_type, int $a_usr_id, bool $a_force_email=false)

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 @access public. More...

	checkLastAdmin (array $a_usr_ids)
	Check if users for deletion are last admins @access 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 @access 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 $a_obj_id)

static	getInstance (int $a_ref_id)

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 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/Session'

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 Member Functions
	readParticipantsStatus ()
	Read status of participants (blocked, notification, passed) More...

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)

Protected Attributes
ilEventParticipants	$event_part

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 = []

Detailed Description

Session participation handling.

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

Version: $Id$

\

Definition at line 29 of file class.ilSessionParticipants.php.

Constructor & Destructor Documentation

◆ __construct()

ilSessionParticipants::__construct ( int $a_ref_id )

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

    {
        $this->event_part = new ilEventParticipants(ilObject::_lookupObjId($a_ref_id));
        parent::__construct(self::COMPONENT_NAME, $a_ref_id);
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ilObject\_lookupObjId().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjId()

static ilSessionParticipants::_getInstanceByObjId ( int $a_obj_id )

static

Definition at line 43 of file class.ilSessionParticipants.php.

                                                             : ilSessionParticipants
    {
        $refs = ilObject::_getAllReferences($a_obj_id);
        return self::getInstance(array_pop($refs));
    }

References ilObject\_getAllReferences(), and getInstance().

Referenced by ilParticipants\getInstanceByObjId(), ilObjSession\handleAutoFill(), and ilObjSession\initParticipants().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isParticipant()

static ilSessionParticipants::_isParticipant	(	int	$a_ref_id,
		int	$a_usr_id
	)

static

Static function to check if a user is a participant of the container object.

Reimplemented from ilParticipants.

Definition at line 71 of file class.ilSessionParticipants.php.

                                                                       : bool
    {
        $obj_id = ilObject::_lookupObjId($a_ref_id);
        return ilEventParticipants::_isRegistered($a_usr_id, $obj_id);
    }

References ilParticipants\$obj_id, ilEventParticipants\_isRegistered(), and ilObject\_lookupObjId().

Here is the call graph for this function:

◆ add()

ilSessionParticipants::add	(	int	$a_usr_id,
		int	$a_role = `0`
	)

Add user to session member role.

Additionally the status registered or participated must be set manually

Reimplemented from ilParticipants.

Definition at line 91 of file class.ilSessionParticipants.php.

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

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

Referenced by register().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkLastAdmin()

ilSessionParticipants::checkLastAdmin ( array $a_usr_ids )

no last admin restrictions for sessions

Parameters

int[] $a_usr_ids

Reimplemented from ilParticipants.

Definition at line 66 of file class.ilSessionParticipants.php.

                                                    : bool
    {
        return false;
    }

◆ getEventParticipants()

ilSessionParticipants::getEventParticipants ( )

Definition at line 57 of file class.ilSessionParticipants.php.

                                          : ilEventParticipants
    {
        return $this->event_part;
    }

References $event_part.

Referenced by readParticipantsStatus(), register(), and unregister().

Here is the caller graph for this function:

◆ getInstance()

static ilSessionParticipants::getInstance ( int $a_ref_id )

static

Reimplemented from ilParticipants.

Definition at line 49 of file class.ilSessionParticipants.php.

                                                     : ilSessionParticipants
    {
        if (isset(self::$instances[$a_ref_id]) && self::$instances[$a_ref_id] instanceof self) {
            return self::$instances[$a_ref_id];
        }
        return self::$instances[$a_ref_id] = new self($a_ref_id);
    }

Referenced by _getInstanceByObjId(), ilParticipants\getInstance(), ilObjSessionListGUI\getProperties(), ilObjSessionAccess\isRegistrationLimitExceeded(), and ilObjSessionGUI\unregisterObject().

Here is the caller graph for this function:

◆ readParticipantsStatus()

ilSessionParticipants::readParticipantsStatus ( )

protected

Read status of participants (blocked, notification, passed)

Reimplemented from ilParticipants.

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

                                               : void
    {
        $this->participants_status = [];
        foreach ($this->getEventParticipants()->getParticipants() as $mem_uid => $info) {
            $this->participants_status[$mem_uid]['blocked'] = false;
            $this->participants_status[$mem_uid]['notification_enabled'] = (bool) $info['notification_enabled'];
            $this->participants_status[$mem_uid]['passed'] = false;
            $this->participants_status[$mem_uid]['contact'] = (bool) $info['contact'];
        }
    }

References $info, getEventParticipants(), and ilParticipants\getParticipants().

Here is the call graph for this function:

◆ register()

ilSessionParticipants::register ( int $a_usr_id )

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

                                           : bool
    {
        $this->logger->debug('Registering user: ' . $a_usr_id . ' for session: ' . $this->getObjId());
        $this->add($a_usr_id, ilParticipants::IL_SESS_MEMBER);
        // in any (already participant since status attended) case register user.
        $this->getEventParticipants()->register($a_usr_id);
        return true;
    }

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

Here is the call graph for this function:

◆ sendNotification()

ilSessionParticipants::sendNotification	(	int	$a_type,
		int	$a_usr_id,
		bool	$a_force_email = `false`
	)

Definition at line 118 of file class.ilSessionParticipants.php.

                                                                                             : void
    {
        $mail = new ilSessionMembershipMailNotification();
 
        switch ($a_type) {
            case ilSessionMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:
                $mail->setType(ilSessionMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
                $mail->setRefId($this->ref_id);
                $mail->setRecipients([$a_usr_id]);
                $mail->send();
                break;
 
            default:
                $this->logger->warning('Invalid notfication type given: ' . $a_type);
                $this->logger->logStack(ilLogLevel::WARNING);
                break;
        }
    }

References ILIAS\Repository\logger(), ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, and ilLogLevel\WARNING.

Here is the call graph for this function:

◆ unregister()

ilSessionParticipants::unregister ( int $a_usr_id )

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

                                             : bool
    {
        // participated users are not dropped from role
        if (!$this->getEventParticipants()->hasParticipated($a_usr_id)) {
            $this->delete($a_usr_id);
        }
        $this->getEventParticipants()->unregister($a_usr_id);
        return true;
    }

References getEventParticipants().

Here is the call graph for this function:

Field Documentation

◆ $event_part

ilEventParticipants ilSessionParticipants::$event_part

protected

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

Referenced by getEventParticipants().

◆ $instances

array ilSessionParticipants::$instances = []

staticprotected

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

◆ COMPONENT_NAME

const ilSessionParticipants::COMPONENT_NAME = 'components/ILIAS/Session'

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

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

components/ILIAS/Session/classes/class.ilSessionParticipants.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstanceByObjId()

◆ _isParticipant()

◆ add()

◆ checkLastAdmin()

◆ getEventParticipants()

◆ getInstance()

◆ readParticipantsStatus()

◆ register()

◆ sendNotification()

◆ unregister()

Field Documentation

◆ $event_part

◆ $instances

◆ COMPONENT_NAME