ilGroupParticipants Class Reference

Inheritance diagram for ilGroupParticipants:

Collaboration diagram for ilGroupParticipants:

Static Public Member Functions
static	_getInstanceByObjId ($a_obj_id)
	Get singleton instance.
static	_isParticipant ($a_ref_id, $a_usr_id)
	Static function to check if a user is a participant of the container object.
Static Public Member Functions inherited from ilParticipants
static	_getMembershipByType ($a_usr_id, $a_type)
	get membership by type Get course or group membership
static	_isBlocked ($a_obj_id, $a_usr_id)
	Check if user is blocked.
static	_hasPassed ($a_obj_id, $a_usr_id)
	Check if user has passed course.
static	_deleteAllEntries ($a_obj_id)
	Delete all entries Normally called for course deletion.
static	_deleteUser ($a_usr_id)
	Delete user data.
static	_isSubscriber ($a_obj_id, $a_usr_id)
	check if user is subscriber

Protected Member Functions
	__construct ($a_obj_id)
	Constructor.
Protected Member Functions inherited from ilParticipants
	readSubscribers ()
	read subscribers
	readSubscriberData ($a_usr_id)
	read subscribers

Static Protected Attributes
static	$instances = array()

Additional Inherited Members
Public Member Functions inherited from ilParticipants
	getNotificationRecipients ()
	Get admin, tutor which have notification enabled.
	getCountMembers ()
	Get number of members (not participants)
	getCountParticipants ()
	Get number of participants.
	getParticipants ()
	Get all participants ids.
	getMembers ()
	Get all members ids (admins and tutors are not members) Use get participants to fetch all.
	getAdmins ()
	Get all admins ids.
	getTutors ()
	Get all tutors ids.
	isAdmin ($a_usr_id)
	is user admin
	isTutor ($a_usr_id)
	is user tutor
	isMember ($a_usr_id)
	is user member
	isAssigned ($a_usr_id)
	check if user is assigned
	getRoles ()
	Get course roles.
	getAssignedRoles ($a_usr_id)
	Get assigned roles.
	updateRoleAssignments ($a_usr_id, $a_roles)
	Update role assignments.
	checkLastAdmin ($a_usr_ids)
	Check if user for deletion are last admins.
	isBlocked ($a_usr_id)
	Check if user is blocked.
	hasPassed ($a_usr_id)
	Check if user has passed course.
	delete ($a_usr_id)
	Drop user from all roles.
	updateBlocked ($a_usr_id, $a_blocked)
	Update blocked status.
	updateNotification ($a_usr_id, $a_notification)
	Update notification status.
	add ($a_usr_id, $a_role)
	Add user to course.
	deleteParticipants ($a_user_ids)
	Delete users.
	addDesktopItem ($a_usr_id)
	Add desktop item.
	dropDesktopItem ($a_usr_id)
	Drop desktop item.
	isNotificationEnabled ($a_usr_id)
	check if notification is enabled
	isGroupingMember ($a_usr_id, $a_field= '')
	Check grouping membership.
	getSubscribers ()
	get all subscribers
	getCountSubscribers ()
	get number of subscribers
	getSubscriberData ($a_usr_id)
	get subscriber data
	assignSubscribers ($a_usr_ids)
	Assign subscribers.
	assignSubscriber ($a_usr_id)
	Assign subscriber.
	autoFillSubscribers ()
	Assign subscriber.
	addSubscriber ($a_usr_id)
	Add subscriber.
	updateSubscriptionTime ($a_usr_id, $a_subtime)
	Update subscription time.
	updateSubject ($a_usr_id, $a_subject)
	update subject
	deleteSubscriber ($a_usr_id)
	Delete subsciber.
	deleteSubscribers ($a_usr_ids)
	Delete subscibers.
	isSubscriber ($a_usr_id)
	check if is subscriber
Protected Attributes inherited from ilParticipants
	$obj_id = 0
	$type = ''
	$ref_id = 0
	$roles = array()
	$role_data = array()
	$participants = array()
	$participants_status = array()
	$members = array()
	$tutors = array()
	$admins = array()
	$subscribers = array()
	$ilDB
	$lng

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilGroupParticipants::__construct (   $a_obj_id )

protected

Constructor.

protected

Parameters

int	obj_id of container

Reimplemented from ilParticipants.

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

        {
                $this->type = 'grp';
                parent::__construct($a_obj_id);
        }

Member Function Documentation

static ilGroupParticipants::_getInstanceByObjId (   $a_obj_id )

static

Get singleton instance.

public

Parameters

int

obj_id

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

Referenced by ilGroupXMLParser\__assignMembers(), ilGroupEditParticipantsTableGUI\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilSoapGroupAdministration\assignGroupMember(), ilObjGroup\cloneObject(), ilGroupXMLWriter\ilGroupXMLWriter(), ilGroupRegistrationGUI\initParticipants(), ilObjGroup\initParticipants(), ilSoapGroupAdministration\isAssignedToGroup(), ilObjGroupGUI\membersObject(), ilObjGroupGUI\saveObject(), and ilMailSearchGroupsGUI\showMyGroups().

        {
                if(isset(self::$instances[$a_obj_id]) and self::$instances[$a_obj_id])
                {
                        return self::$instances[$a_obj_id];
                }
                return self::$instances[$a_obj_id] = new ilGroupParticipants($a_obj_id);
        }

Here is the caller graph for this function:

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

static

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

public

Parameters

int	ref_id
int	user id

Reimplemented from ilParticipants.

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

References ilParticipants\$ilDB, $ilLog, and $title.

Referenced by ilObjGroupAccess\_checkAccess().

        {
                global $rbacreview,$ilObjDataCache,$ilDB,$ilLog;

                $rolf = $rbacreview->getRoleFolderOfObject($a_ref_id);
                if(!isset($rolf['ref_id']) or !$rolf['ref_id'])
                {
                        $title = $ilObjDataCache->lookupTitle($ilObjDataCache->lookupObjId($a_ref_id));
                        $ilLog->write(__METHOD__.': Found object without role folder. Ref_id: '.$a_ref_id.', title: '.$title);
                        $ilLog->logStack();
                        
                        return false;
                }
                $local_roles = $rbacreview->getRolesOfRoleFolder($rolf["ref_id"],false);
                
        return $rbacreview->isAssignedToAtLeastOneGivenRole($a_usr_id, $local_roles);
        }

Here is the caller graph for this function:

Field Documentation

ilGroupParticipants::$instances = array()

staticprotected

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

---

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

• Modules/Group/classes/class.ilGroupParticipants.php