Base class for course and group participants. More...

Inheritance diagram for ilParticipants:

Collaboration diagram for ilParticipants:

Public Member Functions
	__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	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 ( $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	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
	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
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

Detailed Description

Base class for course and group participants.

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

Version: $Id$

Todo:: move these constants to ilParticipants

Definition at line 30 of file class.ilParticipants.php.

Constructor & Destructor Documentation

◆ __construct()

ilParticipants::__construct	(	string	$a_component_name,
		int	$a_ref_id
	)

Parameters

string	component definition e.g Modules/Course used for event handler
int	ref_id of container

Definition at line 72 of file class.ilParticipants.php.

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), readParticipants(), and readParticipantsStatus().

     {
         global $DIC;
 
         $this->ilDB = $DIC->database();
         $this->lng = $DIC->language();
         $this->logger = $DIC->logger()->mmbr();
         $this->eventHandler = $DIC->event();
         $this->rbacReview = $DIC->rbac()->review();
         $this->rbacAdmin = $DIC->rbac()->admin();
         $this->objectDataCache = $DIC['ilObjDataCache'];
         $this->error = $DIC['ilErr'];
         $this->component = $a_component_name;
         $this->ref_id = $a_ref_id;
         $this->obj_id = ilObject::_lookupObjId($a_ref_id);
         $this->type = ilObject::_lookupType($this->obj_id);
         $this->recommended_content_manager = new ilRecommendedContentManager();
 
         $this->readParticipants();
         $this->readParticipantsStatus();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAllEntries()

static ilParticipants::_deleteAllEntries ( int $a_obj_id )

static

Delete all entries Normally called in case of object deletion.

Definition at line 442 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\manipulate(), and ilDBInterface\quote().

Referenced by ilObjLearningSequence\delete(), ilObjGroup\delete(), ilObjCourse\delete(), and ilSoapCourseAdministration\excludeCourseMember().

                                                            : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "DELETE FROM obj_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
 
         $query = "DELETE FROM il_subscribers " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
 
         $query = 'DELETE FROM crs_waiting_list ' .
             'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $ilDB->manipulate($query);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteUser()

static ilParticipants::_deleteUser ( int $a_usr_id )

static

Delete user data.

Definition at line 463 of file class.ilParticipants.php.

References $DIC, $query, $res, ilWaitingList\_deleteUser(), ilDBInterface\manipulate(), and ilDBInterface\quote().

Referenced by ilObjCourse\_deleteUser().

                                                      : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "DELETE FROM obj_members WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
         $res = $ilDB->manipulate($query);
 
         $query = "DELETE FROM il_subscribers WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
         $res = $ilDB->manipulate($query);
 
         ilCourseWaitingList::_deleteUser($a_usr_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAllSupportContactsOfUser()

static ilParticipants::_getAllSupportContactsOfUser	(	int	$a_usr_id,
		string	$a_type
	)

static

Get all support contacts for a user.

Parameters

int	$a_usr_id	usr_id
string	$a_type	crs or grp

Returns: array array of contacts (keys are usr_id and obj_id)

Todo:

join the two queries or alternatively reuse _getMembershipByType

fix returning fetchAssoc result

Definition at line 1338 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\fetchAssoc(), ilDBInterface\fetchObject(), ilDBInterface\in(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ILIAS\Awareness\User\ProviderCourseContacts\getInitialUserSet().

                                                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // for the first part
 
         // this will also dismiss local roles!
         $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
         $a2 = "AND obd2.title LIKE 'il_" . $a_type . "_mem%' ";
 
         // #14290 - no role folder anymore
         $query = "SELECT DISTINCT obd.obj_id,obr.ref_id FROM rbac_ua ua " .
             "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
             "JOIN object_reference obr ON fa.parent = obr.ref_id " .
             "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
             $j2 .
             "WHERE obd.type = " . $ilDB->quote($a_type, 'text') . " " .
             "AND fa.assign = 'y' " .
             "AND ua.usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             $a2;
 
         $res = $ilDB->query($query);
         $obj_ids = array();
         while ($row = $ilDB->fetchObject($res)) {
             $obj_ids[] = (int) $row->obj_id;
         }
 
         $set = $ilDB->query("SELECT obj_id, usr_id FROM obj_members " .
             " WHERE " . $ilDB->in("obj_id", $obj_ids, false, "integer") .
             " AND contact = " . $ilDB->quote(1, "integer"));
         $res = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             $res[] = $rec;
         }
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getMembershipByType()

static ilParticipants::_getMembershipByType	(	int	$a_usr_id,
		array	$a_type,
		bool	$a_only_member_role = `false`
	)

static

get membership by type Get course or group membership

Parameters

int	$a_usr_id	usr_id
	string[]	$a_type array of object types

Returns: int[]

Definition at line 306 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\concat(), ilDBInterface\fetchObject(), ilDBInterface\in(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilNewsItem\_getNewsItemsOfUser(), ilMailSearchObjectGUI\cancel(), ilDashboardLearningSequenceGUI\getAssignments(), ilPortfolioPageGUI\getCoursesOfUser(), ILIAS\Awareness\User\ProviderMemberships\getInitialUserSet(), ilTestEvaluationData\getParticipants(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilWorkspaceShareTableGUI\initFilter(), ilCalendarCategories\readPDCalendars(), ilCalendarCategories\readReposCalendars(), ilWorkspaceAccessGUI\share(), and ilObjectCopyGUI\showSourceSelectionMembership().

      : array {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $j2 = '';
         $a2 = '';
         // this will also dismiss local roles!
         if ($a_only_member_role) {
             $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
             $a2 = 'AND obd2.title = ' . $ilDB->concat(
                 array(
                         array($ilDB->quote('il_', 'text')),
                         array('obd.type'),
                         array($ilDB->quote('_member_', 'text')),
                         array('obr.ref_id'),
                     ),
                 false
             );
         }
 
         // #14290 - no role folder anymore
         $query = "SELECT DISTINCT obd.obj_id,obr.ref_id FROM rbac_ua ua " .
             "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
             "JOIN object_reference obr ON fa.parent = obr.ref_id " .
             "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
             $j2 .
             "WHERE " . $ilDB->in("obd.type", $a_type, false, "text") . ' ' .
             "AND fa.assign = 'y' " .
             "AND ua.usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             'AND obr.deleted IS NULL ' .
             $a2;
         $res = $ilDB->query($query);
         $ref_ids = [];
         while ($row = $ilDB->fetchObject($res)) {
             $ref_ids[] = (int) $row->obj_id;
         }
         return $ref_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _hasPassed()

static ilParticipants::_hasPassed	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Check if user has passed course.

Definition at line 425 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjCourseAccess\checkCondition(), and ilLPStatusManualByTutor\refreshStatus().

                                                                    : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "SELECT * FROM obj_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND passed = '1'";
         $res = $ilDB->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isBlocked()

static ilParticipants::_isBlocked	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Check if user is blocked.

Definition at line 409 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\query(), and ilDBInterface\quote().

                                                                    : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "SELECT * FROM obj_members " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND blocked = " . $ilDB->quote(1, 'integer');
         $res = $ilDB->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ _isParticipant()

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

static

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

Definition at line 353 of file class.ilParticipants.php.

References $DIC.

Referenced by ilForumModeratorsGUI\detachModeratorRole(), ilMembershipGUI\executeCommand(), ilObjCourseGUI\executeCommand(), ilObjCourseGUI\getTabs(), ilNotification\hasNotification(), and ilObjCourseGUI\initHeaderAction().

                                                                        : 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:

◆ _isSubscriber()

static ilParticipants::_isSubscriber	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Definition at line 1254 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjSessionAccess\_checkAccess(), and ilObjCourseListGUI\getProperties().

                                                                       : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = "SELECT * FROM il_subscribers " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

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

Definition at line 820 of file class.ilParticipants.php.

References deleteSubscriber(), ilWaitingList\deleteUserEntry(), getComponent(), and isAssigned().

Referenced by assignSubscriber().

                                                    : bool
     {
         if ($this->isAssigned($a_usr_id)) {
             return false;
         }
 
         switch ($a_role) {
             case self::IL_LSO_ADMIN:
             case self::IL_GRP_ADMIN:
             case self::IL_CRS_ADMIN:
                 $this->admins[] = $a_usr_id;
                 break;
 
             case self::IL_CRS_TUTOR:
                 $this->tutors[] = $a_usr_id;
                 break;
 
             case self::IL_SESS_MEMBER:
             case self::IL_LSO_MEMBER:
             case self::IL_GRP_MEMBER:
             case self::IL_CRS_MEMBER:
                 $this->members[] = $a_usr_id;
                 break;
 
         }
 
         $this->participants[] = $a_usr_id;
         $this->rbacAdmin->assignUser($this->role_data[$a_role], $a_usr_id);
 
         // Delete subscription request
         $this->deleteSubscriber($a_usr_id);
 
         ilWaitingList::deleteUserEntry($a_usr_id, $this->obj_id);
 
         $this->eventHandler->raise(
             $this->getComponent(),
             "addParticipant",
             array(
                 'obj_id' => $this->obj_id,
                 'usr_id' => $a_usr_id,
                 'role_id' => $a_role
             )
         );
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRecommendation()

ilParticipants::addRecommendation ( int $a_usr_id )

Add desktop item public.

Definition at line 881 of file class.ilParticipants.php.

Referenced by ilCourseParticipants\add(), and ilGroupParticipants\add().

                                                     : void
     {
         // deactivated for now, see discussion at
         // https://docu.ilias.de/goto_docu_wiki_wpage_5620_1357.html
         // $this->recommended_content_manager->addObjectRecommendation($a_usr_id, $this->ref_id);
     }

Here is the caller graph for this function:

◆ addSubscriber()

ilParticipants::addSubscriber ( int $a_usr_id )

Definition at line 1189 of file class.ilParticipants.php.

References $query, and $res.

                                                 : void
     {
         $query = "INSERT INTO il_subscribers (usr_id,obj_id,subject,sub_time) " .
             " VALUES (" .
             $this->ilDB->quote($a_usr_id, 'integer') . "," .
             $this->ilDB->quote($this->obj_id, 'integer') . ", " .
             $this->ilDB->quote('', 'text') . ", " .
             $this->ilDB->quote(time(), 'integer') .
             ")";
         $res = $this->ilDB->manipulate($query);
     }

◆ assignSubscriber()

ilParticipants::assignSubscriber ( int $a_usr_id )

Definition at line 1137 of file class.ilParticipants.php.

References add(), deleteSubscriber(), ilObjectFactory\getInstanceByObjId(), isAssigned(), isSubscriber(), and ILIAS\Repository\lng().

Referenced by assignSubscribers(), and autoFillSubscribers().

                                                    : bool
     {
         $this->error->setMessage("");
         if (!$this->isSubscriber($a_usr_id)) {
             $this->error->appendMessage($this->lng->txt("crs_user_notsubscribed"));
 
             return false;
         }
         if ($this->isAssigned($a_usr_id)) {
             $tmp_obj = ilObjectFactory::getInstanceByObjId($a_usr_id);
             $this->error->appendMessage($tmp_obj->getLogin() . ": " . $this->lng->txt("crs_user_already_assigned"));
 
             return false;
         }
 
         if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($a_usr_id, false)) {
             $this->error->appendMessage($this->lng->txt("crs_user_not_exists"));
             return false;
         }
 
         if ($this instanceof ilCourseParticipants) {
             $this->add($tmp_obj->getId(), self::IL_CRS_MEMBER);
         }
         if ($this instanceof ilGroupParticipants) {
             $this->add($tmp_obj->getId(), self::IL_GRP_MEMBER);
         }
         if ($this instanceof ilLearningSequenceParticipants) {
             $this->add($tmp_obj->getId(), self::IL_LSO_MEMBER);
         }
         if ($this instanceof ilSessionParticipants) {
             $this->register($tmp_obj->getId());
         }
         $this->deleteSubscriber($a_usr_id);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignSubscribers()

ilParticipants::assignSubscribers ( array $a_usr_ids )

Definition at line 1124 of file class.ilParticipants.php.

References $id, and assignSubscriber().

                                                        : bool
     {
         if (!is_array($a_usr_ids) || !count($a_usr_ids)) {
             return false;
         }
         foreach ($a_usr_ids as $id) {
             if (!$this->assignSubscriber($id)) {
                 return false;
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ autoFillSubscribers()

ilParticipants::autoFillSubscribers ( )

Todo:: check and fix notification

Definition at line 1176 of file class.ilParticipants.php.

References assignSubscriber(), and readSubscribers().

                                          : int
     {
         $this->readSubscribers();
         $counter = 0;
         foreach ($this->subscribers as $subscriber) {
             if (!$this->assignSubscriber($subscriber)) {
                 continue;
             }
             ++$counter;
         }
         return $counter;
     }

Here is the call graph for this function:

◆ canSendMailToMembers()

static ilParticipants::canSendMailToMembers	(		$ref_id_or_instance,
		?int	$usr_id = `null`,
		?int	$mail_obj_ref_id = `null`
	)

static

This method was introduced as a band-aid fix for #22764.

Please do not use this anywhere else.

Parameters

int | ilObject $ref_id_or_instance

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

References $DIC, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\int(), ilCourseConstants\MAIL_ALLOWED_ALL, ilObjSession\MAIL_ALLOWED_ALL, and ilObjGroup\MAIL_ALLOWED_ALL.

Referenced by ilMailSearchObjectGUI\cancel(), and ilMailSearchObjectGUI\mailObjects().

      : bool {
         global $DIC;
 
         $access = $DIC->access();
         $rbacsystem = $DIC->rbac()->system();
 
         if (is_null($usr_id)) {
             $usr_id = $DIC->user()->getId();
         }
         if (is_null($mail_obj_ref_id)) {
             $mail_obj_ref_id = (new ilMail($usr_id))->getMailObjectReferenceId();
         }
         if (is_int($ref_id_or_instance)) {
             $ref_id = $ref_id_or_instance;
         } elseif ($ref_id_or_instance instanceof ilObject) {
             $ref_id = (int) $ref_id_or_instance->getRefId();
             if ($ref_id === 0) {
                 $ref_id = array_keys(ilObject::_getAllReferences($ref_id_or_instance->getId()))[0];
             }
         } else {
             return false;
         }
 
         if (
             $access->checkAccess('manage_members', '', $ref_id) &&
             $rbacsystem->checkAccess('internal_mail', $mail_obj_ref_id)
         ) {
             return true;
         }
 
         $part = self::getInstance($ref_id);
         if (!$part->isAssigned($usr_id)) {
             return false;
         }
 
         $object = $ref_id_or_instance;
         if (is_int($ref_id_or_instance)) {
             $object = ilObjectFactory::getInstanceByRefId($ref_id_or_instance);
         }
 
         if ($object instanceof ilObjCourse) {
             return $object->getMailToMembersType() == ilCourseConstants::MAIL_ALLOWED_ALL;
         } elseif ($object instanceof ilObjGroup) {
             return $object->getMailToMembersType() == ilObjGroup::MAIL_ALLOWED_ALL;
         } elseif ($object instanceof ilObjSession) {
             return $object->getMailToMembersType() == ilObjSession::MAIL_ALLOWED_ALL;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkLastAdmin()

ilParticipants::checkLastAdmin ( array $a_usr_ids )

Check if users for deletion are last admins public.

Parameters

int[] array of user ids for deletion

Todo:: fix this and add unit test

Definition at line 677 of file class.ilParticipants.php.

References getAdmins().

                                                     : bool
     {
         foreach ($this->getAdmins() as $admin_id) {
             if (!in_array($admin_id, $a_usr_ids)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ delete()

ilParticipants::delete ( int $a_usr_id )

Drop user from all roles.

Definition at line 712 of file class.ilParticipants.php.

References $query, $res, getComponent(), readParticipants(), and readParticipantsStatus().

                                          : void
     {
         $this->recommended_content_manager->removeObjectRecommendation($a_usr_id, $this->ref_id);
         foreach ($this->roles as $role_id) {
             $this->rbacAdmin->deassignUser($role_id, $a_usr_id);
         }
 
         $query = "DELETE FROM obj_members " .
             "WHERE usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer');
         $res = $this->ilDB->manipulate($query);
 
         $this->readParticipants();
         $this->readParticipantsStatus();
 
         $this->eventHandler->raise(
             $this->getComponent(),
             "deleteParticipant",
             [
                 'obj_id' => $this->obj_id,
                 'usr_id' => $a_usr_id
             ]
         );
     }

Here is the call graph for this function:

◆ deleteParticipants()

ilParticipants::deleteParticipants ( array $a_user_ids )

Parameters

int[]

Definition at line 869 of file class.ilParticipants.php.

                                                          : bool
     {
         foreach ($a_user_ids as $user_id) {
             $this->delete($user_id);
         }
         return true;
     }

◆ deleteSubscriber()

ilParticipants::deleteSubscriber ( int $a_usr_id )

Definition at line 1219 of file class.ilParticipants.php.

References $query, and $res.

Referenced by add(), assignSubscriber(), and readSubscribers().

                                                    : void
     {
         $query = "DELETE FROM il_subscribers " .
             "WHERE usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " ";
         $res = $this->ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ deleteSubscribers()

ilParticipants::deleteSubscribers ( array $a_usr_ids )

Definition at line 1227 of file class.ilParticipants.php.

References $query, $res, and ILIAS\Repository\lng().

                                                        : bool
     {
         if (!count($a_usr_ids)) {
             $this->error->setMessage('');
             $this->error->appendMessage($this->lng->txt("no_usr_ids_given"));
             return false;
         }
         $query = "DELETE FROM il_subscribers " .
             "WHERE " . $this->ilDB->in('usr_id', $a_usr_ids, false, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer');
         $res = $this->ilDB->query($query);
         return true;
     }

Here is the call graph for this function:

◆ getAdmins()

ilParticipants::getAdmins ( )

Get all admins ids.

Returns: int[]

Definition at line 568 of file class.ilParticipants.php.

References $admins.

Referenced by checkLastAdmin(), getCountAdmins(), and isLastAdmin().

                                : array
     {
         return $this->admins;
     }

Here is the caller graph for this function:

◆ getAssignedRoles()

ilParticipants::getAssignedRoles ( int $a_usr_id )

Get assigned roles.

Definition at line 638 of file class.ilParticipants.php.

                                                    : array
     {
         $assigned = [];
         foreach ($this->roles as $role) {
             if ($this->rbacReview->isAssigned($a_usr_id, $role)) {
                 $assigned[] = $role;
             }
         }
         return $assigned;
     }

◆ getAutoGeneratedRoleId()

ilParticipants::getAutoGeneratedRoleId ( int $a_role_type )

Definition at line 904 of file class.ilParticipants.php.

                                                             : int
     {
         if (array_key_exists($a_role_type, $this->role_data)) {
             return $this->role_data[$a_role_type];
         }
         return 0;
     }

◆ getComponent()

ilParticipants::getComponent ( )

protected

Get component name Used for raising events.

Definition at line 151 of file class.ilParticipants.php.

References $component.

Referenced by add(), and delete().

                                      : string
     {
         return $this->component;
     }

Here is the caller graph for this function:

◆ getContacts()

ilParticipants::getContacts ( )

get user ids which are confirgured as contact

Returns: int[]

Definition at line 780 of file class.ilParticipants.php.

References ILIAS\Repository\int().

                                  : array
     {
         $contacts = array();
         foreach ($this->participants_status as $usr_id => $status) {
             if ($status['contact']) {
                 $contacts[] = (int) $usr_id;
             }
         }
         return $contacts;
     }

Here is the call graph for this function:

◆ getCountAdmins()

ilParticipants::getCountAdmins ( )

Definition at line 573 of file class.ilParticipants.php.

References getAdmins().

                                     : int
     {
         return count($this->getAdmins());
     }

Here is the call graph for this function:

◆ getCountMembers()

ilParticipants::getCountMembers ( )

Get number of members (not participants)

Definition at line 532 of file class.ilParticipants.php.

                                      : int
     {
         return count($this->members);
     }

◆ getCountParticipants()

ilParticipants::getCountParticipants ( )

Get number of participants.

Definition at line 540 of file class.ilParticipants.php.

                                           : int
     {
         return count($this->participants);
     }

◆ getCountSubscribers()

ilParticipants::getCountSubscribers ( )

Definition at line 1114 of file class.ilParticipants.php.

References getSubscribers().

                                          : int
     {
         return count($this->getSubscribers());
     }

Here is the call graph for this function:

◆ getDefaultMemberRole()

static ilParticipants::getDefaultMemberRole ( int $a_ref_id )

static

Definition at line 477 of file class.ilParticipants.php.

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilObject\_lookupType().

Referenced by ilStartUpGUI\_checkGoto(), ilCourseRegistrationGUI\add(), ilRepositorySearchGUI\addRole(), ilContainerImporter\finalProcessing(), ilRbacSystem\initMemberView(), ilSkillProfileGUI\saveLocal(), ilContainerGlobalProfiles\setMemberRoleId(), and ilContainerLocalProfiles\setMemberRoleId().

                                                               : int
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
 
         $obj_id = ilObject::_lookupObjId($a_ref_id);
         $type = ilObject::_lookupType($obj_id);
 
         if (!in_array($type, array('crs', 'grp'))) {
             return 0;
         }
 
         $roles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
         foreach ($roles as $role) {
             $title = ilObject::_lookupTitle($role);
             if (strpos($title, ('il_' . $type . '_member')) === 0) {
                 return $role;
             }
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstance()

static ilParticipants::getInstance ( int $a_ref_id )

static

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

References $DIC, $logger, ilObject\_lookupObjId(), ilObject\_lookupType(), ilSessionParticipants\getInstance(), ilLogger\logStack(), and ilLogger\warning().

Referenced by ilSessionParticipantsTableGUI\__construct(), ilEventParticipants\__read(), ilSessionParticipantsTableGUI\collectParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), ilMembershipGUI\executeCommand(), ilConsultationHourUtils\getConsultationHourLinksForRepositoryObject(), ilCourseReferenceLP\getMembers(), ilMembershipGUI\getMembersObject(), ilSessionParticipantsTableGUI\getParentLocalRoles(), ilTrQuery\getParticipantsForObject(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilECSAppEventListener\handleMembership(), ilCourseReferenceAppEventListener\handleReferences(), ilObjGroupGUI\infoScreen(), ilMembershipGUI\initAttendanceList(), ilCourseReferencePathInfo\isReferenceMemberUpdateConfirmationRequired(), ilPDSelectedItemsBlockGUI\manageObject(), ilCourseReferenceDeleteConfirmationTableGUI\readLinkedCourseAssignments(), ilObjSessionGUI\registerObject(), ilObjSessionGUI\showJoinRequestButton(), and ilSessionMembershipGUI\updateMembers().

                                                      : ilParticipants
     {
         global $DIC;
 
         $logger = $DIC->logger()->mmbr();
 
         $obj_id = ilObject::_lookupObjId($a_ref_id);
         $type = ilObject::_lookupType($obj_id);
 
         switch ($type) {
             case 'crs':
             case 'grp':
             case 'lso':
                 return self::getInstanceByObjId($obj_id);
             case 'sess':
                 return ilSessionParticipants::getInstance($a_ref_id);
             default:
                 $logger()->mem()->logStack();
                 $logger()->mem()->warning('Invalid ref_id -> obj_id given: ' . $a_ref_id . ' -> ' . $obj_id);
                 throw new InvalidArgumentException('Invalid obj_id given.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByObjId()

static ilParticipants::getInstanceByObjId ( int $a_obj_id )

static

Get instance by obj type.

Deprecated:: since version 5.4 use getInstance() (ref_id based)

Todo:: remove this method in favour of selff::getInstance

Definition at line 122 of file class.ilParticipants.php.

References $DIC, $logger, ilCourseParticipants\_getInstanceByObjId(), ilSessionParticipants\_getInstanceByObjId(), ilLearningSequenceParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), ilObject\_lookupType(), ilLogger\logStack(), ilLogLevel\WARNING, and ilLogger\warning().

Referenced by ilGroupParticipantsTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilGroupAddToGroupActionGUI\addUser(), ilMailSearchObjectGUI\cancel(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilGroupAddToGroupActionGUI\createGroupAndAddUser(), ilWorkspaceAccessHandler\findSharedObjects(), ilPortfolioAccessHandler\findSharedObjects(), ilContSkillMemberTableGUI\getMembers(), ilLPStatusEvent\getMembers(), ilLPStatusManualByTutor\getMembers(), ilObjCourseGUI\infoScreen(), ilRepositorySearchGUI\listUsers(), ilMembershipGUI\membersMap(), and ilRepositoryObjectResultTableGUI\parseObjectIds().

                                                             : ilParticipants
     {
         global $DIC;
 
         $logger = $DIC->logger()->mmbr();
 
         $type = ilObject::_lookupType($a_obj_id);
         switch ($type) {
             case 'crs':
                 return ilCourseParticipants::_getInstanceByObjId($a_obj_id);
 
             case 'grp':
                 return ilGroupParticipants::_getInstanceByObjId($a_obj_id);
 
             case 'sess':
                 return ilSessionParticipants::_getInstanceByObjId($a_obj_id);
             case 'lso':
                 return ilLearningSequenceParticipants::_getInstanceByObjId($a_obj_id);
             default:
                 $logger()->mmbr()->logStack(ilLogLevel::WARNING);
                 $logger()->mmbr()->warning(': Invalid obj_id given: ' . $a_obj_id);
                 throw new InvalidArgumentException('Invalid obj id given');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembers()

ilParticipants::getMembers ( )

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

Returns: int[]

Definition at line 559 of file class.ilParticipants.php.

References $members.

                                 : array
     {
         return $this->members;
     }

◆ getNotificationRecipients()

ilParticipants::getNotificationRecipients ( )

Get admin, tutor which have notification enabled.

Returns: int[] of user ids

Definition at line 514 of file class.ilParticipants.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), isAdmin(), isTutor(), and ilDBConstants\T_INTEGER.

Referenced by ilLearningSequenceParticipants\sendNotification(), ilGroupParticipants\sendNotification(), ilCourseParticipants\sendNotificationToAdmins(), ilCourseParticipants\sendSubscriptionRequestToAdmins(), and ilCourseParticipants\sendUnsubscribeNotificationToAdmins().

                                                : array
     {
         $query = "SELECT * FROM obj_members " .
             "WHERE notification = 1 " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, ilDBConstants::T_INTEGER) . " ";
         $res = $this->ilDB->query($query);
         $recp = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($this->isAdmin((int) $row->usr_id) || $this->isTutor((int) $row->usr_id)) {
                 $recp[] = (int) $row->usr_id;
             }
         }
         return $recp;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilParticipants::getObjId ( )

Definition at line 500 of file class.ilParticipants.php.

References $obj_id.

Referenced by ilCourseParticipants\addSubscriber(), ilGroupParticipants\addSubscriber(), ilLearningSequenceParticipants\addSubscriber(), and ilSessionParticipants\register().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getParticipants()

ilParticipants::getParticipants ( )

Get all participants ids.

Returns: int[]

Definition at line 549 of file class.ilParticipants.php.

References $participants.

Referenced by isGroupingMember(), and ilSessionParticipants\readParticipantsStatus().

                                      : array
     {
         return $this->participants;
     }

Here is the caller graph for this function:

◆ getRoles()

ilParticipants::getRoles ( )

Get object roles.

Definition at line 630 of file class.ilParticipants.php.

References $roles.

Referenced by updateRoleAssignments().

                               : array
     {
         return $this->roles;
     }

Here is the caller graph for this function:

◆ getSubscriberData()

ilParticipants::getSubscriberData ( int $a_usr_id )

Definition at line 1119 of file class.ilParticipants.php.

References readSubscriberData().

                                                     : array
     {
         return $this->readSubscriberData($a_usr_id);
     }

Here is the call graph for this function:

◆ getSubscribers()

ilParticipants::getSubscribers ( )

get all subscribers int[]

Definition at line 1108 of file class.ilParticipants.php.

References $subscribers, and readSubscribers().

Referenced by getCountSubscribers().

                                     : array
     {
         $this->readSubscribers();
         return $this->subscribers;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTutors()

ilParticipants::getTutors ( )

Get all tutors ids.

Returns: int[]

Definition at line 582 of file class.ilParticipants.php.

References $tutors.

                                : array
     {
         return $this->tutors;
     }

◆ getType()

ilParticipants::getType ( )

Definition at line 505 of file class.ilParticipants.php.

References $type.

Referenced by ilMailMemberSearchDataProvider\__construct().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUserMembershipAssignmentsByType()

static ilParticipants::getUserMembershipAssignmentsByType	(	array	$a_user_ids,
		array	$a_type,
		bool	$a_only_member_roles
	)

static

Get user membership assignments by type.

Definition at line 258 of file class.ilParticipants.php.

References $DIC, $query, $res, ilDBInterface\concat(), ilDBInterface\fetchObject(), ilDBInterface\in(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilTimingsUser\lookupTimings().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $j2 = $a2 = '';
         if ($a_only_member_roles) {
             $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
             $a2 = 'AND obd2.title = ' . $ilDB->concat(
                 array(
                         array($ilDB->quote('il_', 'text')),
                         array('obd.type'),
                         array($ilDB->quote('_member_', 'text')),
                         array('obr.ref_id'),
                     ),
                 false
             );
         }
 
         $query = "SELECT DISTINCT obd.obj_id,obr.ref_id,ua.usr_id FROM rbac_ua ua " .
             "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
             "JOIN object_reference obr ON fa.parent = obr.ref_id " .
             "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
             $j2 .
             "WHERE " . $ilDB->in("obd.type", $a_type, false, "text") .
             "AND fa.assign = 'y' " .
             'AND ' . $ilDB->in('ua.usr_id', $a_user_ids, false, 'integer') . ' ' .
             $a2;
 
         $obj_ids = [];
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $obj_ids[(int) $row->obj_id][] = (int) $row->usr_id;
         }
         return $obj_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasParticipantListAccess()

static ilParticipants::hasParticipantListAccess	(	int	$a_obj_id,
		int	$a_usr_id = `null`
	)

static

Check if (current) user has access to the participant list.

Definition at line 159 of file class.ilParticipants.php.

References $DIC, ilObject\_getAllReferences(), ilObjCourse\lookupShowMembersEnabled(), and ilObjGroup\lookupShowMembersEnabled().

Referenced by ilRepositorySearchGUI\listUsers(), ilRepositoryObjectResultTableGUI\parseObjectIds(), and ilMailSearchGUI\showResults().

                                                                                         : bool
     {
         global $DIC;
 
         $access = $DIC->access();
 
         if (!$a_usr_id) {
             $a_usr_id = $DIC->user()->getId();
         }
 
         // if write access granted => return true
         $refs = ilObject::_getAllReferences($a_obj_id);
         $ref_id = end($refs);
 
         if ($access->checkAccess('manage_members', '', $ref_id)) {
             return true;
         }
         $part = self::getInstance($ref_id);
         if ($part->isAssigned($a_usr_id)) {
             if ($part->getType() === 'crs') {
                 if (!ilObjCourse::lookupShowMembersEnabled($a_obj_id)) {
                     return false;
                 }
             }
             if ($part->getType() === 'grp') {
                 if (!ilObjGroup::lookupShowMembersEnabled($a_obj_id)) {
                     return false;
                 }
             }
             return true;
         }
         // User is not assigned to course/group => no read access
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPassed()

ilParticipants::hasPassed ( int $a_usr_id )

Check if user has passed object.

Definition at line 701 of file class.ilParticipants.php.

                                             : bool
     {
         if (isset($this->participants_status[$a_usr_id])) {
             return (bool) $this->participants_status[$a_usr_id]['passed'];
         }
         return false;
     }

◆ isAdmin()

ilParticipants::isAdmin ( int $a_usr_id )

check if user is admin

Definition at line 590 of file class.ilParticipants.php.

Referenced by ilMembershipGUI\executeCommand(), and getNotificationRecipients().

                                           : bool
     {
         return in_array($a_usr_id, $this->admins);
     }

Here is the caller graph for this function:

◆ isAssigned()

ilParticipants::isAssigned ( int $a_usr_id )

check if user is assigned

Definition at line 614 of file class.ilParticipants.php.

Referenced by add(), and assignSubscriber().

                                              : bool
     {
         return in_array($a_usr_id, $this->participants);
     }

Here is the caller graph for this function:

◆ isBlocked()

ilParticipants::isBlocked ( int $a_usr_id )

Check if user is blocked.

Definition at line 690 of file class.ilParticipants.php.

                                             : bool
     {
         if (isset($this->participants_status[$a_usr_id])) {
             return (bool) $this->participants_status[$a_usr_id]['blocked'];
         }
         return false;
     }

◆ isContact()

ilParticipants::isContact ( int $a_usr_id )

Definition at line 896 of file class.ilParticipants.php.

                                             : bool
     {
         if (isset($this->participants_status[$a_usr_id])) {
             return (bool) $this->participants_status[$a_usr_id]['contact'];
         }
         return false;
     }

◆ isGroupingMember()

ilParticipants::isGroupingMember	(	int	$a_usr_id,
		string	$a_field = `''`
	)

Check membership for.

Definition at line 1045 of file class.ilParticipants.php.

References $query, $res, ilLogLevel\ERROR, ilObjectFactory\getInstanceByObjId(), getParticipants(), and ILIAS\Repository\logger().

                                                                          : bool
     {
         if ($a_field === '') {
             return false;
         }
         // Used for membership limitations -> check membership by given field
         $tmp_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
         if (!$tmp_user instanceof ilObjUser) {
             $this->logger->logStack(ilLogLevel::ERROR);
             throw new DomainException('Invalid user id given: ' . $a_usr_id);
         }
         switch ($a_field) {
             case 'login':
                 $and = "AND login = " . $this->ilDB->quote($tmp_user->getLogin(), 'text') . " ";
                 break;
             case 'email':
                 $and = "AND email = " . $this->ilDB->quote($tmp_user->getEmail(), 'text') . " ";
                 break;
             case 'matriculation':
                 $and = "AND matriculation = " . $this->ilDB->quote($tmp_user->getMatriculation(), 'text') . " ";
                 break;
 
             default:
                 $and = "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " ";
                 break;
         }
 
         if (!$this->getParticipants()) {
             return false;
         }
 
         $query = "SELECT * FROM usr_data ud " .
             "WHERE " . $this->ilDB->in('usr_id', $this->getParticipants(), false, 'integer') . " " .
             $and;
 
         $res = $this->ilDB->query($query);
         return (bool) $res->numRows();
     }

Here is the call graph for this function:

◆ isLastAdmin()

ilParticipants::isLastAdmin ( int $a_usr_id )

Check if user is last admin.

Definition at line 622 of file class.ilParticipants.php.

References getAdmins().

                                               : bool
     {
         return in_array($a_usr_id, $this->getAdmins()) && count($this->getAdmins()) === 1;
     }

Here is the call graph for this function:

◆ isMember()

ilParticipants::isMember ( int $a_usr_id )

is user member

Definition at line 606 of file class.ilParticipants.php.

                                            : bool
     {
         return in_array($a_usr_id, $this->members);
     }

◆ isNotificationEnabled()

ilParticipants::isNotificationEnabled ( int $a_usr_id )

Definition at line 888 of file class.ilParticipants.php.

                                                         : bool
     {
         if (isset($this->participants_status[$a_usr_id])) {
             return (bool) $this->participants_status[$a_usr_id]['notification'];
         }
         return false;
     }

◆ isSubscriber()

ilParticipants::isSubscriber ( int $a_usr_id )

Definition at line 1241 of file class.ilParticipants.php.

References $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by assignSubscriber().

                                                : bool
     {
         $query = "SELECT * FROM il_subscribers " .
             "WHERE usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer');
 
         $res = $this->ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isTutor()

ilParticipants::isTutor ( int $a_usr_id )

is user tutor

Definition at line 598 of file class.ilParticipants.php.

Referenced by getNotificationRecipients().

                                           : bool
     {
         return in_array($a_usr_id, $this->tutors);
     }

Here is the caller graph for this function:

◆ lookupNumberOfMembers()

static ilParticipants::lookupNumberOfMembers ( int $a_ref_id )

static

Lookup number of members.

Definition at line 377 of file class.ilParticipants.php.

References $DIC.

Referenced by ilObjSession\handleAutoFill(), ilObjGroup\handleAutoFill(), and ilObjCourse\handleAutoFill().

                                                                : int
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $has_policies = $rbacreview->getLocalPolicies($a_ref_id);
         if (!$has_policies) {
             return 0;
         }
         $lroles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
         $memberRoles = array();
         foreach ($lroles as $role_id) {
             $title = $ilObjDataCache->lookupTitle($role_id);
             switch (substr($title, 0, 8)) {
                 case 'il_crs_a':
                 case 'il_crs_t':
                 case 'il_grp_a':
                 case 'il_sess_':
                     break;
 
                 default:
                     $memberRoles[] = $role_id;
                     break;
             }
         }
         return $rbacreview->getNumberOfAssignedUsers($memberRoles);
     }

Here is the caller graph for this function:

◆ lookupNumberOfParticipants()

static ilParticipants::lookupNumberOfParticipants ( int $a_ref_id )

static

Lookup the number of participants (crs admins, tutors, members, grp admins, members)

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

References $DIC.

                                                                     : int
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $lroles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
         return $rbacreview->getNumberOfAssignedUsers($lroles);
     }

◆ lookupSubscribers()

static ilParticipants::lookupSubscribers ( int $a_obj_id )

static

Returns: int[]

Definition at line 1087 of file class.ilParticipants.php.

References $DIC, $query, $res, $subscribers, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

                                                            : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $subscribers = array();
         $query = "SELECT usr_id FROM il_subscribers " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "ORDER BY sub_time ";
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $subscribers[] = (int) $row->usr_id;
         }
         return $subscribers;
     }

Here is the call graph for this function:

◆ lookupSubscribersData()

static ilParticipants::lookupSubscribersData ( int $a_obj_id )

static

Parameters

int $a_usr_id

Returns: array<int, array<{time: int, usr_id: int, subject: string}>>

Definition at line 1312 of file class.ilParticipants.php.

References $data, $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilSubscriberTableGUI\readSubscriberData().

                                                                : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'SELECT * FROM il_subscribers ' .
             'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
 
         $data = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $data[$row->usr_id]['time'] = (int) $row->sub_time;
             $data[$row->usr_id]['usr_id'] = (int) $row->usr_id;
             $data[$row->usr_id]['subject'] = (string) $row->subject;
         }
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readParticipants()

ilParticipants::readParticipants ( )

protected

Definition at line 912 of file class.ilParticipants.php.

References $participants.

Referenced by __construct(), delete(), and updateRoleAssignments().

                                          : void
     {
         $this->roles = $this->rbacReview->getRolesOfRoleFolder($this->ref_id, false);
         $this->participants = [];
         $this->members = $this->admins = $this->tutors = [];
 
         $additional_roles = [];
         $auto_generated_roles = [];
         foreach ($this->roles as $role_id) {
             $title = $this->objectDataCache->lookupTitle($role_id);
             switch (substr($title, 0, 8)) {
                 case 'il_crs_m':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_MEMBER;
                     $this->role_data[self::IL_CRS_MEMBER] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->members = array_unique(array_merge($assigned, $this->members));
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_crs_a':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_ADMIN;
                     $this->role_data[self::IL_CRS_ADMIN] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->admins = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_crs_t':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_TUTOR;
                     $this->role_data[self::IL_CRS_TUTOR] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->tutors = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_grp_a':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_ADMIN;
                     $this->role_data[self::IL_GRP_ADMIN] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->admins = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_grp_m':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_MEMBER;
                     $this->role_data[self::IL_GRP_MEMBER] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->members = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_sess_':
                     $this->role_data[self::IL_SESS_MEMBER] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->members = $this->rbacReview->assignedUsers($role_id);
                     break;
 
                 case 'il_lso_m':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_MEMBER;
                     $this->role_data[self::IL_LSO_MEMBER] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->members = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 case 'il_lso_a':
                     $auto_generated_roles[$role_id] = self::IL_ROLE_POSITION_ADMIN;
                     $this->role_data[self::IL_LSO_ADMIN] = $role_id;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->admins = $this->rbacReview->assignedUsers($role_id);
                     $this->role_assignments[$role_id] = $assigned;
                     break;
 
                 default:
                     $additional_roles[$role_id] = $title;
                     $this->participants = array_unique(array_merge(
                         $assigned = $this->rbacReview->assignedUsers($role_id),
                         $this->participants
                     ));
                     $this->members = array_unique(array_merge($assigned, $this->members));
                     $this->role_assignments[$role_id] = $assigned;
                     break;
             }
         }
         asort($auto_generated_roles);
         asort($additional_roles);
         $this->roles_sorted = $auto_generated_roles + $additional_roles;
     }

Here is the caller graph for this function:

◆ readParticipantsStatus()

ilParticipants::readParticipantsStatus ( )

protected

Read status of participants (blocked, notification, passed)

Definition at line 1028 of file class.ilParticipants.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by __construct(), delete(), and updateRoleAssignments().

                                                : void
     {
         $query = "SELECT * FROM obj_members " .
             "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " ";
         $res = $this->ilDB->query($query);
         $this->participants_status = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->participants_status[(int) $row->usr_id]['blocked'] = (bool) $row->blocked;
             $this->participants_status[(int) $row->usr_id]['notification'] = (bool) $row->notification;
             $this->participants_status[(int) $row->usr_id]['passed'] = (bool) $row->passed;
             $this->participants_status[(int) $row->usr_id]['contact'] = (bool) $row->contact;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSubscriberData()

ilParticipants::readSubscriberData ( int $a_usr_id )

protected

Returns: array<{time: int, usr_id: int, subject: string}>

Definition at line 1292 of file class.ilParticipants.php.

References $data, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by getSubscriberData().

                                                         : array
     {
         $query = "SELECT * FROM il_subscribers " .
             "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
             "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer');
 
         $res = $this->ilDB->query($query);
         $data = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $data["time"] = (int) $row->sub_time;
             $data["usr_id"] = (int) $row->usr_id;
             $data['subject'] = (string) $row->subject;
         }
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSubscribers()

ilParticipants::readSubscribers ( )

protected

Todo:: fix performance; check if method is in use

Definition at line 1273 of file class.ilParticipants.php.

References $query, $res, deleteSubscriber(), ilDBConstants\FETCHMODE_OBJECT, ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\int().

Referenced by autoFillSubscribers(), and getSubscribers().

                                         : void
     {
         $this->subscribers = [];
         $query = "SELECT usr_id FROM il_subscribers " .
             "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
             "ORDER BY sub_time ";
 
         $res = $this->ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (!ilObjectFactory::getInstanceByObjId((int) $row->usr_id, false)) {
                 $this->deleteSubscriber((int) $row->usr_id);
             }
             $this->subscribers[] = (int) $row->usr_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRoleOrderPosition()

ilParticipants::setRoleOrderPosition ( int $a_user_id )

Set role order position.

Definition at line 1380 of file class.ilParticipants.php.

                                                         : string
     {
         $counter = 0;
         $sortable_assignments = '9999999999';
         foreach ($this->roles_sorted as $role_id => $trash) {
             if (in_array($a_user_id, (array) $this->role_assignments[$role_id])) {
                 $sortable_assignments = substr_replace($sortable_assignments, '1', $counter, 1);
             }
             ++$counter;
         }
         return $sortable_assignments;
     }

◆ updateBlocked()

ilParticipants::updateBlocked	(	int	$a_usr_id,
		bool	$a_blocked
	)

Update blocked status.

Definition at line 740 of file class.ilParticipants.php.

References $query, $res, and ILIAS\Repository\int().

                                                                  : void
     {
         $this->participants_status[$a_usr_id]['blocked'] = (int) $a_blocked;
         $query = "SELECT * FROM obj_members " .
             "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
             "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer');
         $res = $this->ilDB->query($query);
         if ($res->numRows()) {
             $query = "UPDATE obj_members SET " .
                 "blocked = " . $this->ilDB->quote((int) $a_blocked, 'integer') . " " .
                 "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
                 "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer');
         } else {
             $query = "INSERT INTO obj_members (blocked,obj_id,usr_id,notification,passed) " .
                 "VALUES ( " .
                 $this->ilDB->quote((int) $a_blocked, 'integer') . ", " .
                 $this->ilDB->quote($this->obj_id, 'integer') . ", " .
                 $this->ilDB->quote($a_usr_id, 'integer') . ", " .
                 $this->ilDB->quote(0, 'integer') . ", " .
                 $this->ilDB->quote(0, 'integer') .
                 ") ON DUPLICATE KEY UPDATE blocked = VALUES(blocked)";
         }
         $res = $this->ilDB->manipulate($query);
     }

Here is the call graph for this function:

◆ updateContact()

ilParticipants::updateContact	(	int	$a_usr_id,
		bool	$a_contact
	)

Definition at line 765 of file class.ilParticipants.php.

                                                                  : void
     {
         $this->ilDB->manipulate(
             'UPDATE obj_members SET ' .
             'contact = ' . $this->ilDB->quote($a_contact, 'integer') . ' ' .
             'WHERE obj_id = ' . $this->ilDB->quote($this->obj_id, 'integer') . ' ' .
             'AND usr_id = ' . $this->ilDB->quote($a_usr_id, 'integer')
         );
         $this->participants_status[$a_usr_id]['contact'] = $a_contact;
     }

◆ updateNotification()

ilParticipants::updateNotification	(	int	$a_usr_id,
		bool	$a_notification
	)

Update notification status.

Definition at line 794 of file class.ilParticipants.php.

References $query, and $res.

Referenced by ilLearningSequenceMembershipGUI\updateParticipantsStatus().

                                                                            : void
     {
         $this->participants_status[$a_usr_id]['notification'] = $a_notification;
 
         $query = "SELECT * FROM obj_members " .
             "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
             "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer');
         $res = $this->ilDB->query($query);
         if ($res->numRows()) {
             $query = "UPDATE obj_members SET " .
                 "notification = " . $this->ilDB->quote((int) $a_notification, 'integer') . " " .
                 "WHERE obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " " .
                 "AND usr_id = " . $this->ilDB->quote($a_usr_id, 'integer');
         } else {
             $query = "INSERT INTO obj_members (notification,obj_id,usr_id,passed,blocked) " .
                 "VALUES ( " .
                 $this->ilDB->quote((int) $a_notification, 'integer') . ", " .
                 $this->ilDB->quote($this->obj_id, 'integer') . ", " .
                 $this->ilDB->quote($a_usr_id, 'integer') . ", " .
                 $this->ilDB->quote(0, 'integer') . ", " .
                 $this->ilDB->quote(0, 'integer') .
                 ") ON DUPLICATE KEY UPDATE notification = VALUES(notification)";
         }
         $res = $this->ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ updateRoleAssignments()

ilParticipants::updateRoleAssignments	(	$a_usr_id,
		$a_roles
	)

Update role assignments public.

Parameters

int	usr_id
int[]	array of new roles

Definition at line 655 of file class.ilParticipants.php.

References getRoles(), readParticipants(), and readParticipantsStatus().

                                                               : void
     {
         foreach ($this->getRoles() as $role_id) {
             if ($this->rbacReview->isAssigned($a_usr_id, $role_id)) {
                 if (!in_array($role_id, $a_roles)) {
                     $this->rbacAdmin->deassignUser($role_id, $a_usr_id);
                 }
             } elseif (in_array($role_id, $a_roles)) {
                 $this->rbacAdmin->assignUser($role_id, $a_usr_id);
             }
         }
         $this->rbacReview->clearCaches();
         $this->readParticipants();
         $this->readParticipantsStatus();
     }

Here is the call graph for this function:

◆ updateSubject()

ilParticipants::updateSubject	(	int	$a_usr_id,
		string	$a_subject
	)

Definition at line 1210 of file class.ilParticipants.php.

References $query, and $res.

                                                                    : void
     {
         $query = "UPDATE il_subscribers " .
             "SET subject = " . $this->ilDB->quote($a_subject, 'text') . " " .
             "WHERE usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " ";
         $res = $this->ilDB->manipulate($query);
     }

◆ updateSubscriptionTime()

ilParticipants::updateSubscriptionTime	(	int	$a_usr_id,
		int	$a_subtime
	)

Definition at line 1201 of file class.ilParticipants.php.

References $query, and $res.

                                                                          : void
     {
         $query = "UPDATE il_subscribers " .
             "SET sub_time = " . $this->ilDB->quote($a_subtime, 'integer') . " " .
             "WHERE usr_id = " . $this->ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $this->ilDB->quote($this->obj_id, 'integer') . " ";
         $res = $this->ilDB->manipulate($query);
     }

Field Documentation

◆ $admins

array ilParticipants::$admins = []

protected

Definition at line 56 of file class.ilParticipants.php.

Referenced by getAdmins().

◆ $component

string ilParticipants::$component = ''

protected

Definition at line 44 of file class.ilParticipants.php.

Referenced by getComponent().

◆ $error

ilErrorHandling ilParticipants::$error

protected

Definition at line 65 of file class.ilParticipants.php.

◆ $eventHandler

ilAppEventHandler ilParticipants::$eventHandler

protected

Definition at line 58 of file class.ilParticipants.php.

◆ $ilDB

ilDBInterface ilParticipants::$ilDB

protected

Definition at line 62 of file class.ilParticipants.php.

Referenced by ilCourseParticipants\_updatePassed(), ilCourseParticipants\getDateTimeOfPassed(), and ilCourseParticipants\getPassedUsersForObjects().

◆ $lng

ilLanguage ilParticipants::$lng

protected

Definition at line 63 of file class.ilParticipants.php.

◆ $logger

ilLogger ilParticipants::$logger

protected

Definition at line 64 of file class.ilParticipants.php.

Referenced by ilLearningSequenceParticipants\__construct(), ilLearningSequenceParticipants\_getInstanceByObjId(), getInstance(), and getInstanceByObjId().

◆ $members

array ilParticipants::$members = []

protected

Definition at line 54 of file class.ilParticipants.php.

Referenced by getMembers().

◆ $obj_id

int ilParticipants::$obj_id = 0

protected

Definition at line 46 of file class.ilParticipants.php.

Referenced by ilLearningSequenceParticipants\_getInstanceByObjId(), ilSessionParticipants\_isParticipant(), and getObjId().

◆ $objectDataCache

ilObjectDataCache ilParticipants::$objectDataCache

protected

Definition at line 61 of file class.ilParticipants.php.

◆ $participants

array ilParticipants::$participants = []

protected

Definition at line 52 of file class.ilParticipants.php.

Referenced by getParticipants(), and readParticipants().

◆ $participants_status

array ilParticipants::$participants_status = []

protected

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

◆ $rbacAdmin

ilRbacAdmin ilParticipants::$rbacAdmin

protected

Definition at line 60 of file class.ilParticipants.php.

◆ $rbacReview

ilRbacReview ilParticipants::$rbacReview

protected

Definition at line 59 of file class.ilParticipants.php.

◆ $recommended_content_manager

ilRecommendedContentManager ilParticipants::$recommended_content_manager

protected

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

◆ $ref_id

int ilParticipants::$ref_id = 0

protected

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

◆ $role_assignments

array ilParticipants::$role_assignments = []

protected

Definition at line 51 of file class.ilParticipants.php.

◆ $role_data

array ilParticipants::$role_data = []

protected

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

◆ $roles

array ilParticipants::$roles = []

protected

Definition at line 48 of file class.ilParticipants.php.

Referenced by ilCourseParticipants\getMemberRoles(), ilGroupParticipants\getMemberRoles(), ilLearningSequenceParticipants\getMemberRoles(), and getRoles().

◆ $roles_sorted

array ilParticipants::$roles_sorted = []

protected

Definition at line 50 of file class.ilParticipants.php.

◆ $subscribers

array ilParticipants::$subscribers = []

protected

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

Referenced by getSubscribers(), and lookupSubscribers().

◆ $tutors

array ilParticipants::$tutors = []

protected

Definition at line 55 of file class.ilParticipants.php.

Referenced by getTutors().

◆ $type

string ilParticipants::$type = ''

protected

Definition at line 47 of file class.ilParticipants.php.

Referenced by getType().

◆ IL_CRS_ADMIN

const ilParticipants::IL_CRS_ADMIN = 1

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

Referenced by ilParticipant\add(), ilObjCourseGUI\afterSave(), ilSoapCourseAdministration\assignCourseMember(), ilCourseMembershipGUI\assignMembers(), ilParticipant\checkLastAdmin(), ilObjCourse\cloneObject(), ilSoapCourseAdministration\excludeCourseMember(), ilECSMappingUtils\getRoleMappingInfo(), ilSoapObjectAdministration\getXMLTree(), ilCourseXMLParser\handleAdmin(), ilECSCmsCourseMemberCommandQueueHandler\lookupRole(), ilMemberExport\readCourseData(), ilParticipant\readParticipant(), and ilMemberExport\write().

◆ IL_CRS_MEMBER

const ilParticipants::IL_CRS_MEMBER = 2

Definition at line 34 of file class.ilParticipants.php.

Referenced by ilParticipant\add(), ilCourseRegistrationGUI\add(), ilSoapCourseAdministration\assignCourseMember(), ilMembershipGUI\assignFromWaitingList(), ilCourseMembershipGUI\assignMembers(), ilSoapCourseAdministration\excludeCourseMember(), ilECSMappingUtils\getRoleMappingInfo(), ilObjCourse\handleAutoFill(), ilCourseXMLParser\handleMember(), ilCourseReferenceAppEventListener\handleReferences(), ilECSCmsCourseMemberCommandQueueHandler\lookupRole(), ilMemberExport\readCourseData(), ilParticipant\readParticipant(), and ilMemberExport\write().

◆ IL_CRS_TUTOR

const ilParticipants::IL_CRS_TUTOR = 3

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

Referenced by ilParticipant\add(), ilSoapCourseAdministration\assignCourseMember(), ilCourseMembershipGUI\assignMembers(), ilSoapCourseAdministration\excludeCourseMember(), ilECSMappingUtils\getRoleMappingInfo(), ilCourseXMLParser\handleTutor(), ilECSCmsCourseMemberCommandQueueHandler\lookupRole(), ilMemberExport\readCourseData(), ilParticipant\readParticipant(), and ilMemberExport\write().

◆ IL_GRP_ADMIN

const ilParticipants::IL_GRP_ADMIN = 4

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

Referenced by ilParticipant\add(), ilObjGroupGUI\afterSave(), ilGroupMembershipGUI\assignMembers(), ilGroupXMLParser\assignMembers(), ilParticipant\checkLastAdmin(), ilECSMappingUtils\getRoleMappingInfo(), ilSoapGroupAdministration\groupExists(), ilECSCmsCourseMemberCommandQueueHandler\lookupRole(), ilObjGroup\read(), ilMemberExport\readCourseData(), ilParticipant\readParticipant(), and ilMemberExport\write().

◆ IL_GRP_MEMBER

const ilParticipants::IL_GRP_MEMBER = 5

Definition at line 36 of file class.ilParticipants.php.

Referenced by ilCourseParticipantsGroupsGUI\add(), ilParticipant\add(), ilGroupRegistrationGUI\add(), ilGroupAddToGroupActionGUI\addUser(), ilMembershipGUI\assignFromWaitingList(), ilGroupMembershipGUI\assignMembers(), ilGroupXMLParser\assignMembers(), ilGroupAddToGroupActionGUI\createGroupAndAddUser(), ilECSMappingUtils\getRoleMappingInfo(), ilSoapGroupAdministration\groupExists(), ilObjGroup\handleAutoFill(), ilECSAppEventListener\handleMembership(), ilECSCmsCourseMemberCommandQueueHandler\lookupRole(), ilMemberExport\readCourseData(), ilParticipant\readParticipant(), ilMembershipRegistrationCodeUtils\useCode(), and ilMemberExport\write().

◆ IL_LSO_ADMIN

const ilParticipants::IL_LSO_ADMIN = 7

Definition at line 38 of file class.ilParticipants.php.

Referenced by ilObjLearningSequenceGUI\afterSave(), and ilLearningSequenceMembershipGUI\assignMembers().

◆ IL_LSO_MEMBER

const ilParticipants::IL_LSO_MEMBER = 8

Definition at line 39 of file class.ilParticipants.php.

Referenced by ilLearningSequenceMembershipGUI\assignMembers().

◆ IL_ROLE_POSITION_ADMIN

const ilParticipants::IL_ROLE_POSITION_ADMIN = 1

Definition at line 40 of file class.ilParticipants.php.

◆ IL_ROLE_POSITION_MEMBER

const ilParticipants::IL_ROLE_POSITION_MEMBER = 3

Definition at line 42 of file class.ilParticipants.php.

◆ IL_ROLE_POSITION_TUTOR

const ilParticipants::IL_ROLE_POSITION_TUTOR = 2

Definition at line 41 of file class.ilParticipants.php.

◆ IL_SESS_MEMBER

const ilParticipants::IL_SESS_MEMBER = 6

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

Referenced by ilSessionParticipants\register(), and ilSessionMembershipGUI\updateMembers().

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

Services/Membership/classes/class.ilParticipants.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAllEntries()

◆ _deleteUser()

◆ _getAllSupportContactsOfUser()

◆ _getMembershipByType()

◆ _hasPassed()

◆ _isBlocked()

◆ _isParticipant()

◆ _isSubscriber()

◆ add()

◆ addRecommendation()

◆ addSubscriber()

◆ assignSubscriber()

◆ assignSubscribers()

◆ autoFillSubscribers()

◆ canSendMailToMembers()

◆ checkLastAdmin()

◆ delete()

◆ deleteParticipants()

◆ deleteSubscriber()

◆ deleteSubscribers()

◆ getAdmins()

◆ getAssignedRoles()

◆ getAutoGeneratedRoleId()

◆ getComponent()

◆ getContacts()

◆ getCountAdmins()

◆ getCountMembers()

◆ getCountParticipants()

◆ getCountSubscribers()

◆ getDefaultMemberRole()

◆ getInstance()

◆ getInstanceByObjId()

◆ getMembers()

◆ getNotificationRecipients()

◆ getObjId()

◆ getParticipants()

◆ getRoles()

◆ getSubscriberData()

◆ getSubscribers()

◆ getTutors()

◆ getType()

◆ getUserMembershipAssignmentsByType()

◆ hasParticipantListAccess()

◆ hasPassed()

◆ isAdmin()

◆ isAssigned()

◆ isBlocked()

◆ isContact()

◆ isGroupingMember()

◆ isLastAdmin()

◆ isMember()

◆ isNotificationEnabled()

◆ isSubscriber()

◆ isTutor()

◆ lookupNumberOfMembers()

◆ lookupNumberOfParticipants()

◆ lookupSubscribers()

◆ lookupSubscribersData()

◆ readParticipants()

◆ readParticipantsStatus()

◆ readSubscriberData()

◆ readSubscribers()

◆ setRoleOrderPosition()

◆ updateBlocked()

◆ updateContact()

◆ updateNotification()

◆ updateRoleAssignments()

◆ updateSubject()

◆ updateSubscriptionTime()

Field Documentation

◆ $admins