Inheritance diagram for ilParticipants:

Collaboration diagram for ilParticipants:

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

	getObjId ()
	get current obj_id More...

	getType ()
	Get object type. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

	getRoles ()
	Get course roles. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	getSubscribers ()
	get all subscribers More...

	getCountSubscribers ()
	get number of subscribers More...

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

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

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

	autoFillSubscribers ()
	Assign subscriber. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static	getDefaultMemberRole ($a_ref_id)

static	lookupSubscribers ($a_obj_id)

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

static	lookupSubscribersData ($a_obj_id)

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

Protected Member Functions
	getComponent ()
	Get component name Used for raising events. More...

	readParticipants ()
	Read participants. More...

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

	readSubscribers ()
	read subscribers More...

	readSubscriberData ($a_usr_id)
	read subscribers More...

Protected Attributes
	$component = ''

	$obj_id = 0

	$type = ''

	$ref_id = 0

	$roles = array()

	$role_data = array()

	$roles_sorted = []

	$role_assignments = []

	$participants = array()

	$participants_status = array()

	$members = array()

	$tutors = array()

	$admins = array()

	$subscribers = array()

	$ilDB

	$lng

	$logger = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilParticipants::__construct	(	$a_component_name,
		$a_ref_id
	)

Singleton Constructor.

@access public

Parameters

string	component definition e.g Modules/Course
int	obj_id of container

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

    {
        $this->ilDB = $GLOBALS['DIC']->database();
        $this->lng = $GLOBALS['DIC']->language();
        $this->logger = $GLOBALS['DIC']->logger()->mem();
     
        $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->readParticipants();
        $this->readParticipantsStatus();
    }

References $GLOBALS, ilObject\_lookupObjId(), ilObject\_lookupType(), readParticipants(), and readParticipantsStatus().

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAllEntries()

static ilParticipants::_deleteAllEntries ( $a_obj_id )

static

Delete all entries Normally called for course deletion.

@access public

Parameters

int obj_id

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

    {
        global $ilDB;
 
        $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);
 
        return true;
    }

References $ilDB, $query, and $res.

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

Here is the caller graph for this function:

◆ _deleteUser()

static ilParticipants::_deleteUser ( $a_usr_id )

static

Delete user data.

@access public

Parameters

int user id

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

    {
        global $ilDB;
 
        $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);
 
        include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
        ilCourseWaitingList::_deleteUser($a_usr_id);
    }

References $ilDB, $query, $res, and ilWaitingList\_deleteUser().

Referenced by ilObjCourse\_deleteUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAllSupportContactsOfUser()

static ilParticipants::_getAllSupportContactsOfUser	(	$a_usr_id,
		$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)

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

    {
        global $ilDB;
 
        // todo: join the two queries or alternatively reuse _getMembershipByType
        // 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[] = $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;
    }

References $a_type, $ilDB, $query, $res, and $row.

Referenced by ilAwarenessUserProviderCourseContacts\getInitialUserSet().

Here is the caller graph for this function:

◆ _getMembershipByType()

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

static

get membership by type Get course or group membership

@access public

Parameters

int	$a_usr_id	usr_id
string \| array	$a_type	crs or grp \| array of strings
bool	$a_only_member_role

Returns

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

    {
        global $ilDB;
 
        if (!is_array($a_type)) {
            $a_type = array($a_type);
        }
 
        // 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') . " " .
            $a2;
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ref_ids[] = $row->obj_id;
        }
        
        return $ref_ids ? $ref_ids : array();
    }

References $a_type, $ilDB, $query, $res, and $row.

Referenced by ilNewsItem\_getNewsItemsOfUser(), ilPortfolioPageGUI\getCoursesOfUser(), ilAwarenessUserProviderMemberships\getInitialUserSet(), ilCourseVerificationTableGUI\getItems(), ilPDSelectedItemsBlockMembershipsProvider\getObjectsByMembership(), ilTestEvaluationData\getParticipants(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilWorkspaceShareTableGUI\initFilter(), ilCalendarCategories\readPDCalendars(), ilCalendarCategories\readReposCalendars(), ilWorkspaceAccessGUI\share(), and ilObjectCopyGUI\showSourceSelectionMembership().

Here is the caller graph for this function:

◆ _hasPassed()

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

static

Check if user has passed course.

@access public

Parameters

int	obj_id
int	user id

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

    {
        global $ilDB;
 
        $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 $res->numRows() ? true : false;
    }

References $ilDB, $query, and $res.

Referenced by ilObjCourseAccess\checkCondition().

Here is the caller graph for this function:

◆ _isBlocked()

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

static

Check if user is blocked.

@access public

Parameters

int	course id
int	usr_id

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

    {
        global $ilDB;
 
        $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 $res->numRows() ? true : false;
    }

References $ilDB, $query, and $res.

◆ _isParticipant()

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

static

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

@access public

Parameters

int	ref_id
int	user id

Reimplemented in ilGroupParticipants, and ilSessionParticipants.

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

    {
        global $rbacreview;
 
        $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        
        return $rbacreview->isAssignedToAtLeastOneGivenRole($a_usr_id, $local_roles);
    }

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

Here is the caller graph for this function:

◆ _isSubscriber()

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

static

check if user is subscriber

@access public

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

    {
        global $ilDB;
 
        $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;
    }

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

Referenced by ilObjCourseListGUI\getProperties(), and ilMembershipTest\testSubscription().

Here is the caller graph for this function:

◆ add()

ilParticipants::add	(	$a_usr_id,
		$a_role
	)

Add user to object.

@access public

Parameters

int	user id
int	role IL_CRS_ADMIN \|\| IL_CRS_TUTOR \|\| IL_CRS_MEMBER

Reimplemented in ilCourseParticipants, ilGroupParticipants, and ilSessionParticipants.

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

    {
        global $rbacadmin,$ilLog,$ilAppEventHandler;
        
        if ($this->isAssigned($a_usr_id)) {
            return false;
        }
        
        switch ($a_role) {
            case IL_CRS_ADMIN:
                $this->admins[] = $a_usr_id;
                break;
 
            case IL_CRS_TUTOR:
                $this->tutors[] = $a_usr_id;
                break;
 
            case IL_CRS_MEMBER:
                $this->members[] = $a_usr_id;
                break;
                
            case IL_GRP_ADMIN:
                $this->admins[] = $a_usr_id;
                break;
                
            case IL_GRP_MEMBER:
                $this->members[] = $a_usr_id;
                break;
            
            case IL_SESS_MEMBER:
                $this->members[] = $a_usr_id;
                break;
        }
        
        $this->participants[] = $a_usr_id;
        $rbacadmin->assignUser($this->role_data[$a_role], $a_usr_id);
        
        // Delete subscription request
        $this->deleteSubscriber($a_usr_id);
        
        include_once './Services/Membership/classes/class.ilWaitingList.php';
        ilWaitingList::deleteUserEntry($a_usr_id, $this->obj_id);
 
        $ilLog->write(__METHOD__ . ': Raise new event: ' . $this->getComponent() . ' addParticipant');
        $ilAppEventHandler->raise(
            $this->getComponent(),
            "addParticipant",
            array(
                    'obj_id' => $this->obj_id,
                    'usr_id' => $a_usr_id,
                    'role_id' => $a_role)
        );
        return true;
    }

References $ilLog, deleteSubscriber(), ilWaitingList\deleteUserEntry(), getComponent(), IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, IL_GRP_MEMBER, IL_SESS_MEMBER, and isAssigned().

Referenced by assignSubscriber().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDesktopItem()

ilParticipants::addDesktopItem ( $a_usr_id )

Add desktop item.

@access public

Parameters

int usr_id

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

    {
        if (!ilObjUser::_isDesktopItem($a_usr_id, $this->ref_id, $this->type)) {
            ilObjUser::_addDesktopItem($a_usr_id, $this->ref_id, $this->type);
        }
        return true;
    }

References ilObjUser\_addDesktopItem(), and ilObjUser\_isDesktopItem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSubscriber()

ilParticipants::addSubscriber ( $a_usr_id )

Add subscriber.

@access public

Reimplemented in ilCourseParticipants, and ilGroupParticipants.

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

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

References $ilDB, $query, and $res.

◆ assignSubscriber()

ilParticipants::assignSubscriber ( $a_usr_id )

Assign subscriber.

@access public

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

    {
        global $ilErr;
        
        $ilErr->setMessage("");
        if (!$this->isSubscriber($a_usr_id)) {
            $ilErr->appendMessage($this->lng->txt("crs_user_notsubscribed"));
 
            return false;
        }
        if ($this->isAssigned($a_usr_id)) {
            $tmp_obj = ilObjectFactory::getInstanceByObjId($a_usr_id);
            $ilErr->appendMessage($tmp_obj->getLogin() . ": " . $this->lng->txt("crs_user_already_assigned"));
 
            return false;
        }
 
        if (!$tmp_obj =&ilObjectFactory::getInstanceByObjId($a_usr_id)) {
            $ilErr->appendMessage($this->lng->txt("crs_user_not_exists"));
 
            return false;
        }
 
        // TODO: must be group or course member role
        if ($this instanceof ilCourseParticipants) {
            $this->add($tmp_obj->getId(), IL_CRS_MEMBER);
        }
        if ($this instanceof ilGroupParticipants) {
            $this->add($tmp_obj->getId(), IL_GRP_MEMBER);
        }
        if ($this instanceof ilSessionParticipants) {
            $this->register($tmp_obj->getId());
        }
        $this->deleteSubscriber($a_usr_id);
        return true;
    }

References $ilErr, add(), deleteSubscriber(), ilObjectFactory\getInstanceByObjId(), IL_CRS_MEMBER, IL_GRP_MEMBER, isAssigned(), and isSubscriber().

Referenced by assignSubscribers(), and autoFillSubscribers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignSubscribers()

ilParticipants::assignSubscribers ( $a_usr_ids )

Assign subscribers.

@access public

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

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

References $id, and assignSubscriber().

Here is the call graph for this function:

◆ autoFillSubscribers()

ilParticipants::autoFillSubscribers ( )

Assign subscriber.

@access public

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

    {
        $this->readSubscribers();
 
        $counter = 0;
        foreach ($this->subscribers as $subscriber) {
            if (!$this->assignSubscriber($subscriber)) {
                continue;
            } else {
                // TODO: notification
                #$this->sendNotification($this->NOTIFY_ACCEPT_SUBSCRIBER,$subscriber);
            }
            ++$counter;
        }
 
        return $counter;
    }

References $counter, assignSubscriber(), and readSubscribers().

Here is the call graph for this function:

◆ checkLastAdmin()

ilParticipants::checkLastAdmin ( $a_usr_ids )

Check if user for deletion are last admins.

@access public

Parameters

array array of user ids for deletion

Reimplemented in ilSessionParticipants.

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

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

References getAdmins().

Here is the call graph for this function:

◆ delete()

ilParticipants::delete ( $a_usr_id )

Drop user from all roles.

@access public

Parameters

int usr_id

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

    {
        global $rbacadmin,$ilDB;
        
        $this->dropDesktopItem($a_usr_id);
        foreach ($this->roles as $role_id) {
            $rbacadmin->deassignUser($role_id, $a_usr_id);
        }
        
        $query = "DELETE FROM obj_members " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer');
        $res = $ilDB->manipulate($query);
        
        $this->readParticipants();
        $this->readParticipantsStatus();
        
        $GLOBALS['ilAppEventHandler']->raise(
            $this->getComponent(),
            "deleteParticipant",
            array(
                    'obj_id' => $this->obj_id,
                    'usr_id' => $a_usr_id)
        );
        
        return true;
    }

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

Here is the call graph for this function:

◆ deleteParticipants()

ilParticipants::deleteParticipants ( $a_user_ids )

Delete users.

@access public

Parameters

array user ids

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

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

◆ deleteSubscriber()

ilParticipants::deleteSubscriber ( $a_usr_id )

Delete subsciber.

@access public

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

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

References $ilDB, $query, and $res.

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

Here is the caller graph for this function:

◆ deleteSubscribers()

ilParticipants::deleteSubscribers ( $a_usr_ids )

Delete subscibers.

@access public

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

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

References $ilDB, $ilErr, $query, and $res.

◆ dropDesktopItem()

ilParticipants::dropDesktopItem ( $a_usr_id )

Drop desktop item.

@access public

Parameters

int usr_id

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

    {
        if (ilObjUser::_isDesktopItem($a_usr_id, $this->ref_id, $this->type)) {
            ilObjUser::_dropDesktopItem($a_usr_id, $this->ref_id, $this->type);
        }
 
        return true;
    }

References ilObjUser\_dropDesktopItem(), and ilObjUser\_isDesktopItem().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdmins()

ilParticipants::getAdmins ( )

Get all admins ids.

@access public

Returns: array array of user ids

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

    {
        return $this->admins ? $this->admins : array();
    }

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

Here is the caller graph for this function:

◆ getAssignedRoles()

ilParticipants::getAssignedRoles ( $a_usr_id )

Get assigned roles.

@access public

Parameters

int user_id

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

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

◆ getAutoGeneratedRoleId()

ilParticipants::getAutoGeneratedRoleId ( $a_role_type )

Get role id of auto generated role type.

Parameters

type $a_role_type

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

    {
        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 149 of file class.ilParticipants.php.

    {
        return $this->component;
    }

References $component.

Referenced by add(), and delete().

Here is the caller graph for this function:

◆ getContacts()

ilParticipants::getContacts ( )

get user ids which are confirgured as contact

Returns: array

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

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

◆ getCountAdmins()

ilParticipants::getCountAdmins ( )

Get number of admins.

Returns

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

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

References getAdmins().

Here is the call graph for this function:

◆ getCountMembers()

ilParticipants::getCountMembers ( )

Get number of members (not participants)

@access public

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

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

◆ getCountParticipants()

ilParticipants::getCountParticipants ( )

Get number of participants.

@access public

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

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

◆ getCountSubscribers()

ilParticipants::getCountSubscribers ( )

get number of subscribers

@access public

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

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

References getSubscribers().

Here is the call graph for this function:

◆ getDefaultMemberRole()

static ilParticipants::getDefaultMemberRole ( $a_ref_id )

static

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

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

References $ilCtrl, $obj_id, $roles, $title, $type, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilObject\_lookupType().

Referenced by ilStartUpGUI\_checkGoto(), ilCourseRegistrationGUI\add(), and ilRbacSystem\initMemberView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstance()

static ilParticipants::getInstance ( $a_ref_id )

static

Get instance by ref_id.

Parameters

int $a_ref_id

Returns: ilParticipants

Reimplemented in ilSessionParticipants.

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

    {
        $obj_id = ilObject::_lookupObjId($a_ref_id);
        $type = ilObject::_lookupType($obj_id);
        
        switch ($type) {
            case 'crs':
            case 'grp':
                return self::getInstanceByObjId($obj_id);
                
            case 'sess':
                include_once './Modules/Session/classes/class.ilSessionParticipants.php';
                return ilSessionParticipants::getInstance($a_ref_id);
                
            default:
                $GLOBALS['DIC']->logger()->mem()->logStack();
                $GLOBALS['DIC']->logger()->mem()->warning('Invalid ref_id -> obj_id given: ' . $a_ref_id . ' -> ' . $obj_id);
                throw new \InvalidArgumentException('Invalid obj_id given.');
        }
    }

References $GLOBALS, $obj_id, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ilSessionParticipants\getInstance(), and getInstanceByObjId().

Referenced by ilSessionParticipantsTableGUI\__construct(), ilSessionParticipantsTableGUI\collectParticipants(), ilSessionParticipantsTableGUI\getParentLocalRoles(), ilTrQuery\getParticipantsForObject(), hasParticipantListAccess(), ilObjSessionGUI\registerObject(), ilObjSessionGUI\showJoinRequestButton(), and ilSessionMembershipGUI\updateMembers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByObjId()

static ilParticipants::getInstanceByObjId ( $a_obj_id )

static

Get instance by obj type.

Parameters

int $a_obj_id

Returns: ilParticipants

Exceptions

InvalidArgumentException

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

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

    {
        $type = ilObject::_lookupType($a_obj_id);
        switch ($type) {
            case 'crs':
                include_once './Modules/Course/classes/class.ilCourseParticipants.php';
                return ilCourseParticipants::_getInstanceByObjId($a_obj_id);
                
            case 'grp':
                include_once './Modules/Group/classes/class.ilGroupParticipants.php';
                return ilGroupParticipants::_getInstanceByObjId($a_obj_id);
                
            case 'sess':
                include_once './Modules/Session/classes/class.ilSessionParticipants.php';
                return ilSessionParticipants::_getInstanceByObjId($a_obj_id);
                
            default:
                $GLOBALS['ilLog']->logStack();
                $GLOBALS['ilLog']->write(__METHOD__ . ': Invalid obj_id given: ' . $a_obj_id);
                throw new InvalidArgumentException('Invalid obj id given');
        }
    }

References $GLOBALS, $type, ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), ilSessionParticipants\_getInstanceByObjId(), and ilObject\_lookupType().

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

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.

@access public

Returns: array array of user ids

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

    {
        return $this->members ? $this->members : array();
    }

Referenced by ilSessionParticipants\readParticipantsStatus().

Here is the caller graph for this function:

◆ getNotificationRecipients()

ilParticipants::getNotificationRecipients ( )

Get admin, tutor which have notification enabled.

@access public

Returns: array array of user ids

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

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

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and isAdmin().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilParticipants::getObjId ( )

get current obj_id

Returns: type

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

    {
        return $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

◆ getParticipants()

ilParticipants::getParticipants ( )

Get all participants ids.

@access public

Returns: array array of user ids

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

    {
        return $this->participants ? $this->participants : array();
    }

Referenced by isGroupingMember().

Here is the caller graph for this function:

◆ getRoles()

ilParticipants::getRoles ( )

Get course roles.

@access public

Parameters

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

    {
        return $this->roles ? $this->roles : array();
    }

Referenced by updateRoleAssignments().

Here is the caller graph for this function:

◆ getSubscriberData()

ilParticipants::getSubscriberData ( $a_usr_id )

get subscriber data

@access public

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

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

References readSubscriberData().

Here is the call graph for this function:

◆ getSubscribers()

ilParticipants::getSubscribers ( )

get all subscribers

@access public

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

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

References $subscribers, and readSubscribers().

Referenced by getCountSubscribers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTutors()

ilParticipants::getTutors ( )

Get all tutors ids.

@access public

Returns: array array of user ids

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

    {
        return $this->tutors ? $this->tutors : array();
    }

◆ getType()

ilParticipants::getType ( )

Get object type.

Returns: string obj_type

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

    {
        return $this->type;
    }

References $type.

◆ hasParticipantListAccess()

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

static

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

Parameters

int	$a_obj
int	$a_usr_id

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

    {
        global $DIC;
 
        $access = $DIC->access();
 
        if (!$a_usr_id) {
            $a_usr_id = $GLOBALS['ilUser']->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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPassed()

ilParticipants::hasPassed ( $a_usr_id )

Check if user has passed course.

@access public

Parameters

int user_id

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

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

Referenced by ilCourseParticipants\__buildStatusBody().

Here is the caller graph for this function:

◆ isAdmin()

ilParticipants::isAdmin ( $a_usr_id )

is user admin

@access public

Parameters

int usr_id

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

    {
        return in_array($a_usr_id, $this->admins) ? true : false;
    }

Referenced by ilCourseParticipants\__buildStatusBody(), and getNotificationRecipients().

Here is the caller graph for this function:

◆ isAssigned()

ilParticipants::isAssigned ( $a_usr_id )

check if user is assigned

@access public

Parameters

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

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

Referenced by add(), and assignSubscriber().

Here is the caller graph for this function:

◆ isBlocked()

ilParticipants::isBlocked ( $a_usr_id )

Check if user is blocked.

@access public

Parameters

int user_id

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

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

Referenced by ilCourseParticipants\__buildStatusBody().

Here is the caller graph for this function:

◆ isContact()

ilParticipants::isContact ( $a_usr_id )

Check if user is contact.

Parameters

int usr_id

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

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

◆ isGroupingMember()

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

Check grouping membership.

@access public

Parameters

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

    {
        global $rbacreview,$ilObjDataCache,$ilDB;
 
        // Used for membership limitations -> check membership by given field
        if ($a_field) {
            include_once './Services/User/classes/class.ilObjUser.php';
 
            $tmp_user =&ilObjectFactory::getInstanceByObjId($a_usr_id);
            switch ($a_field) {
                case 'login':
                    $and = "AND login = " . $ilDB->quote($tmp_user->getLogin(), 'text') . " ";
                    break;
                case 'email':
                    $and = "AND email = " . $ilDB->quote($tmp_user->getEmail(), 'text') . " ";
                    break;
                case 'matriculation':
                    $and = "AND matriculation = " . $ilDB->quote($tmp_user->getMatriculation(), 'text') . " ";
                    break;
 
                default:
                    $and = "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
                    break;
            }
            
            if (!$this->getParticipants()) {
                return false;
            }
 
            $query = "SELECT * FROM usr_data ud " .
                "WHERE " . $ilDB->in('usr_id', $this->getParticipants(), false, 'integer') . " " .
                $and;
 
            $res = $ilDB->query($query);
            return $res->numRows() ? true : false;
        }
    }

References $ilDB, $query, $res, ilObjectFactory\getInstanceByObjId(), and getParticipants().

Here is the call graph for this function:

◆ isLastAdmin()

ilParticipants::isLastAdmin ( $a_usr_id )

Check if user is last admin.

Parameters

int $a_usr_id

Returns: bool

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

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

References getAdmins().

Here is the call graph for this function:

◆ isMember()

ilParticipants::isMember ( $a_usr_id )

is user member

@access public

Parameters

int usr_id

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

    {
        return in_array($a_usr_id, $this->members) ? true : false;
    }

Referenced by ilCourseParticipants\__buildStatusBody().

Here is the caller graph for this function:

◆ isNotificationEnabled()

ilParticipants::isNotificationEnabled ( $a_usr_id )

check if notification is enabled

@access public

Parameters

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

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

Referenced by ilCourseParticipants\__buildStatusBody().

Here is the caller graph for this function:

◆ isSubscriber()

ilParticipants::isSubscriber ( $a_usr_id )

check if is subscriber

@access public

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

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

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

Referenced by assignSubscriber().

Here is the caller graph for this function:

◆ isTutor()

ilParticipants::isTutor ( $a_usr_id )

is user tutor

@access public

Parameters

int usr_id

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

    {
        return in_array($a_usr_id, $this->tutors) ? true : false;
    }

Referenced by ilCourseParticipants\__buildStatusBody().

Here is the caller graph for this function:

◆ lookupNumberOfMembers()

static ilParticipants::lookupNumberOfMembers ( $a_ref_id )

static

Lookup number of members @global ilRbacReview $rbacreview @global <type> $ilObjDataCache.

Parameters

<type> $a_ref_id

Returns: int

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

    {
        global $rbacreview, $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':
                    break;
 
                default:
                    $memberRoles[] = $role_id;
                    break;
            }
        }
        return $rbacreview->getNumberOfAssignedUsers($memberRoles);
    }

References $title.

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

Here is the caller graph for this function:

◆ lookupNumberOfParticipants()

static ilParticipants::lookupNumberOfParticipants ( $a_ref_id )

static

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

@global ilRbacReview $rbacreview

Parameters

int $a_ref_id

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

    {
        global $rbacreview;
 
        $lroles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        return $rbacreview->getNumberOfAssignedUsers($lroles);
    }

◆ lookupSubscribers()

static ilParticipants::lookupSubscribers ( $a_obj_id )

static

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

    {
        global $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[] = $row->usr_id;
        }
        return $subscribers;
    }

References $ilDB, $query, $res, $row, $subscribers, and ilDBConstants\FETCHMODE_OBJECT.

◆ lookupSubscribersData()

static ilParticipants::lookupSubscribersData ( $a_obj_id )

static

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

    {
        global $ilDB;
 
        $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'] = $row->sub_time;
            $data[$row->usr_id]['usr_id'] = $row->usr_id;
            $data[$row->usr_id]['subject'] = $row->subject;
        }
        return $data;
    }

References $data, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSubscriberTableGUI\readSubscriberData().

Here is the caller graph for this function:

◆ readParticipants()

ilParticipants::readParticipants ( )

protected

Read participants.

@access private

Parameters

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

    {
        global $rbacreview,$ilObjDataCache,$ilLog;
        
        $GLOBALS['rbacreview']->clearCaches();
        $this->roles = $rbacreview->getRolesOfRoleFolder($this->ref_id, false);
 
        $users = array();
        $this->participants = array();
        $this->members = $this->admins = $this->tutors = array();
 
        $additional_roles = [];
        $auto_generated_roles = [];
        foreach ($this->roles as $role_id) {
            $title = $ilObjDataCache->lookupTitle($role_id);
            switch (substr($title, 0, 8)) {
                case 'il_crs_m':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_MEMBER;
                    $this->role_data[IL_CRS_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $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] = IL_ROLE_POSITION_ADMIN;
                    $this->role_data[IL_CRS_ADMIN] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->admins = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
        
                case 'il_crs_t':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_TUTOR;
                    $this->role_data[IL_CRS_TUTOR] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->tutors = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                    
                case 'il_grp_a':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_ADMIN;
                    $this->role_data[IL_GRP_ADMIN] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->admins = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                    
                case 'il_grp_m':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_MEMBER;
                    $this->role_data[IL_GRP_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                
                case 'il_sess_':
                    $this->role_data[IL_SESS_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = $rbacreview->assignedUsers($role_id);
                    break;
                    
                
                default:
                    $additional_roles[$role_id] = $title;
                    $this->participants = array_unique(array_merge($assigned = $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;
    }

References $GLOBALS, $ilLog, $title, $users, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, IL_GRP_MEMBER, IL_ROLE_POSITION_ADMIN, IL_ROLE_POSITION_MEMBER, IL_ROLE_POSITION_TUTOR, and IL_SESS_MEMBER.

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

Here is the caller graph for this function:

◆ readParticipantsStatus()

ilParticipants::readParticipantsStatus ( )

protected

Read status of participants (blocked, notification, passed)

@access private

Parameters

Reimplemented in ilSessionParticipants.

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

    {
        global $ilDB;
        
        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $this->participants_status = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->participants_status[$row->usr_id]['blocked'] = $row->blocked;
            $this->participants_status[$row->usr_id]['notification']  = $row->notification;
            $this->participants_status[$row->usr_id]['passed'] = $row->passed;
            // cognos-blu-patch: begin
            $this->participants_status[$row->usr_id]['contact'] = $row->contact;
            // cognos-blu-patch: end
        }
    }

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

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

Here is the caller graph for this function:

◆ readSubscriberData()

ilParticipants::readSubscriberData ( $a_usr_id )

protected

read subscribers

@access protected

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

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

References $data, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilDB\query().

Referenced by getSubscriberData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSubscribers()

ilParticipants::readSubscribers ( )

protected

read subscribers

@access protected

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

    {
        global $ilDB;
 
        $this->subscribers = array();
 
        $query = "SELECT usr_id FROM il_subscribers " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
            "ORDER BY sub_time ";
 
        $res = $this->ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            // DELETE SUBSCRIPTION IF USER HAS BEEN DELETED
            if (!ilObjectFactory::getInstanceByObjId($row->usr_id, false)) {
                $this->deleteSubscriber($row->usr_id);
            }
            $this->subscribers[] = $row->usr_id;
        }
        return true;
    }

References $ilDB, $query, $res, $row, deleteSubscriber(), ilDBConstants\FETCHMODE_OBJECT, ilObjectFactory\getInstanceByObjId(), and ilDB\query().

Referenced by autoFillSubscribers(), and getSubscribers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRoleOrderPosition()

ilParticipants::setRoleOrderPosition ( $a_user_id )

Set role order position.

Parameters

int $a_user_id

Returns: string

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

    {
        $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;
    }

References $counter.

◆ updateBlocked()

ilParticipants::updateBlocked	(	$a_usr_id,
		$a_blocked
	)

Update blocked status.

@access public

Parameters

int	usr_id
bool	blocked

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

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

References $ilDB, $query, and $res.

◆ updateContact()

ilParticipants::updateContact	(	$a_usr_id,
		$a_contact
	)

Update contact setting @global type $ilDB.

Parameters

type	$a_usr_id
type	$a_contact

Returns: boolean

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

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

References $ilDB.

◆ updateNotification()

ilParticipants::updateNotification	(	$a_usr_id,
		$a_notification
	)

Update notification status.

@access public

Parameters

int	usr_id
bool	passed

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

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

References $ilDB, $query, and $res.

◆ updateRoleAssignments()

ilParticipants::updateRoleAssignments	(	$a_usr_id,
		$a_roles
	)

Update role assignments.

@access public

Parameters

int	usr_id
array	array of new roles

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

    {
        global $rbacreview,$rbacadmin;
        
        $roles = $a_roles ? $a_roles : array();
        
        foreach ($this->getRoles() as $role_id) {
            if ($rbacreview->isAssigned($a_usr_id, $role_id)) {
                if (!in_array($role_id, $roles)) {
                    $rbacadmin->deassignUser($role_id, $a_usr_id);
                }
            } else {
                if (in_array($role_id, $roles)) {
                    $rbacadmin->assignUser($role_id, $a_usr_id);
                }
            }
        }
        $rbacreview->clearCaches();
        $this->readParticipants();
        $this->readParticipantsStatus();
    }

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

Here is the call graph for this function:

◆ updateSubject()

ilParticipants::updateSubject	(	$a_usr_id,
		$a_subject
	)

update subject

@access public

Parameters

return

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

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

References $ilDB, $query, and $res.

◆ updateSubscriptionTime()

ilParticipants::updateSubscriptionTime	(	$a_usr_id,
		$a_subtime
	)

Update subscription time.

@access public

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

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

References $ilDB, $query, and $res.

Field Documentation

◆ $admins

ilParticipants::$admins = array()

protected

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

◆ $component

ilParticipants::$component = ''

protected

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

Referenced by getComponent().

◆ $ilDB

ilParticipants::$ilDB

protected

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

Referenced by ilCourseParticipants\__buildStatusBody(), _deleteAllEntries(), _deleteUser(), _getAllSupportContactsOfUser(), _getMembershipByType(), _hasPassed(), _isBlocked(), ilGroupParticipants\_isParticipant(), _isSubscriber(), addSubscriber(), delete(), deleteSubscriber(), deleteSubscribers(), ilCourseParticipants\getDateTimeOfPassed(), getNotificationRecipients(), ilCourseParticipants\getPassedInfo(), ilCourseParticipants\getPassedUsersForObjects(), isGroupingMember(), isSubscriber(), lookupSubscribers(), lookupSubscribersData(), readParticipantsStatus(), readSubscriberData(), readSubscribers(), ilCourseParticipants\sendNotificationToAdmins(), ilCourseParticipants\sendSubscriptionRequestToAdmins(), ilCourseParticipants\sendUnsubscribeNotificationToAdmins(), updateBlocked(), updateContact(), updateNotification(), updateSubject(), and updateSubscriptionTime().

◆ $lng

ilParticipants::$lng

protected

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

◆ $logger

ilParticipants::$logger = null

protected

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

◆ $members

ilParticipants::$members = array()

protected

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

◆ $obj_id

ilParticipants::$obj_id = 0

protected

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

Referenced by ilSessionParticipants\_isParticipant(), getDefaultMemberRole(), getInstance(), and getObjId().

◆ $participants

ilParticipants::$participants = array()

protected

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

◆ $participants_status

ilParticipants::$participants_status = array()

protected

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

◆ $ref_id

ilParticipants::$ref_id = 0

protected

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

Referenced by hasParticipantListAccess().

◆ $role_assignments

ilParticipants::$role_assignments = []

protected

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

◆ $role_data

ilParticipants::$role_data = array()

protected

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

◆ $roles

ilParticipants::$roles = array()

protected

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

Referenced by getDefaultMemberRole(), ilCourseParticipants\getMemberRoles(), ilGroupParticipants\getMemberRoles(), and updateRoleAssignments().

◆ $roles_sorted

ilParticipants::$roles_sorted = []

protected

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

◆ $subscribers

ilParticipants::$subscribers = array()

protected

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

Referenced by getSubscribers(), and lookupSubscribers().

◆ $tutors

ilParticipants::$tutors = array()

protected

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

◆ $type

ilParticipants::$type = ''

protected

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

Referenced by getDefaultMemberRole(), getInstance(), getInstanceByObjId(), and getType().

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

Services/Membership/classes/class.ilParticipants.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAllEntries()

◆ _deleteUser()

◆ _getAllSupportContactsOfUser()

◆ _getMembershipByType()

◆ _hasPassed()

◆ _isBlocked()

◆ _isParticipant()

◆ _isSubscriber()

◆ add()

◆ addDesktopItem()

◆ addSubscriber()

◆ assignSubscriber()

◆ assignSubscribers()

◆ autoFillSubscribers()

◆ checkLastAdmin()

◆ delete()

◆ deleteParticipants()

◆ deleteSubscriber()

◆ deleteSubscribers()

◆ dropDesktopItem()

◆ getAdmins()

◆ getAssignedRoles()

◆ getAutoGeneratedRoleId()

◆ getComponent()

◆ getContacts()

◆ getCountAdmins()

◆ getCountMembers()

◆ getCountParticipants()

◆ getCountSubscribers()

◆ getDefaultMemberRole()

◆ getInstance()

◆ getInstanceByObjId()

◆ getMembers()

◆ getNotificationRecipients()

◆ getObjId()

◆ getParticipants()

◆ getRoles()

◆ getSubscriberData()

◆ getSubscribers()

◆ getTutors()

◆ getType()

◆ 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

◆ $component

◆ $ilDB