Inheritance diagram for ilSessionParticipants:

Collaboration diagram for ilSessionParticipants:

Public Member Functions
	__construct ($a_obj_id)
	Constructor.
	getEventParticipants ()
	readParticipants ()
	read Participants
	readParticipantsStatus ()
	read participant status
	add ($a_usr_id)
	Add user.
	delete ($a_usr_id)
	Unregister user.
Public Member Functions inherited from ilParticipants
	__construct ($a_component_name, $a_obj_id)
	Singleton Constructor.
	getObjId ()
	get current obj_id
	getType ()
	Get object type.
	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.
	getCountAdmins ()
	Get number of admins.
	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
	isLastAdmin ($a_usr_id)
	Check if user is last admin.
	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.
	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

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	getInstanceByObjId ($a_obj_id)
	Get instance by obj type.
static	hasParticipantListAccess ($a_obj_id, $a_usr_id=null)
	Check if (current) user has access to the participant list.
static	_getMembershipByType ($a_usr_id, $a_type, $a_only_member_role=false)
	get membership by type Get course or group membership
static	lookupNumberOfParticipants ($a_ref_id)
	Lookup the number of participants (crs admins, tutors, members, grp admins, members)
static	lookupNumberOfMembers ($a_ref_id)
	Lookup number of members ilRbacReview $rbacreview <type> $ilObjDataCache.
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	getDefaultMemberRole ($a_ref_id)
static	lookupSubscribers ($a_obj_id)
static	_isSubscriber ($a_obj_id, $a_usr_id)
	check if user is subscriber
static	lookupSubscribersData ($a_obj_id)

Data Fields
const	COMPONENT_NAME = 'Modules/Session'

Protected Attributes
	$event_part = null
Protected Attributes inherited from ilParticipants
	$component = ''
	$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

Static Protected Attributes
static	$instances = array()

Additional Inherited Members
Protected Member Functions inherited from ilParticipants
	getComponent ()
	Get component name Used for raising events.
	readSubscribers ()
	read subscribers
	readSubscriberData ($a_usr_id)
	read subscribers

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 37 of file class.ilSessionParticipants.php.

Constructor & Destructor Documentation

ilSessionParticipants::__construct ( $a_obj_id )

Constructor.

protected

Parameters

int	obj_id of container

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

        {
                $this->type = 'sess';
                $this->event_part = new ilEventParticipants($a_obj_id);
                parent::__construct(self::COMPONENT_NAME,$a_obj_id);
                
        }

Member Function Documentation

static ilSessionParticipants::_getInstanceByObjId ( $a_obj_id )

static

Get singleton instance.

public

Parameters

int obj_id

Returns: object ilGroupParticipants

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

Referenced by ilParticipants\getInstanceByObjId().

        {
                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 ilSessionParticipants($a_obj_id);
        }

Here is the caller graph for this function:

static ilSessionParticipants::_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 94 of file class.ilSessionParticipants.php.

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

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

Here is the call graph for this function:

ilSessionParticipants::add ( $a_usr_id )

Add user.

Parameters

type $a_usr_id

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

References getEventParticipants().

        {
                $this->getEventParticipants()->register($a_usr_id);
        }

Here is the call graph for this function:

ilSessionParticipants::delete ( $a_usr_id )

Unregister user.

Parameters

type $a_usr_id

Reimplemented from ilParticipants.

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

References getEventParticipants().

        {
                $this->getEventParticipants()->unregister($a_usr_id);
        }

Here is the call graph for this function:

ilSessionParticipants::getEventParticipants ( )

Returns: ilEventParticipants

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

References $event_part.

Referenced by add(), delete(), and readParticipants().

        {
                return $this->event_part;
        }

Here is the caller graph for this function:

ilSessionParticipants::readParticipants ( )

read Participants

Reimplemented from ilParticipants.

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

References getEventParticipants().

        {
                $this->participants = $this->members = $this->getEventParticipants()->getRegistered();
        }

Here is the call graph for this function:

ilSessionParticipants::readParticipantsStatus ( )

read participant status

Reimplemented from ilParticipants.

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

References ilParticipants\getMembers().

        {
                $this->participants_status = array();
                foreach($this->getMembers() as $mem_uid)
                {
                        $this->participants_status[$mem_uid]['blocked'] = FALSE;
                        $this->participants_status[$mem_uid]['notification'] = FALSE;
                        $this->participants_status[$mem_uid]['passed'] = FALSE;
                }
        }