ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
ilGroupParticipants Class Reference
+ Inheritance diagram for ilGroupParticipants:
+ Collaboration diagram for ilGroupParticipants:

Public Member Functions

 sendNotification ($a_type, $a_usr_id)
 Send notification mail.
- 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
 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.
 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

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 getDefaultMemberRole ($a_ref_id)
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

- 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
intobj_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
intobj_id
Returns
object ilGroupParticipants

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

Referenced by ilGroupXMLParser\__assignMembers(), ilGroupEditParticipantsTableGUI\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilSoapGroupAdministration\assignGroupMember(), ilObjGroup\cloneObject(), ilObjGroupGUI\confirmDeleteMembersObject(), ilGroupMembershipMailNotification\createGroupStatus(), ilMilestoneResponsiblesTableGUI\getParticipantsAndResponsibles(), ilGroupXMLWriter\ilGroupXMLWriter(), ilGroupRegistrationGUI\initParticipants(), ilObjGroup\initParticipants(), ilSoapGroupAdministration\isAssignedToGroup(), ilRepositorySearchGUI\listUsers(), ilObjGroupGUI\membersObject(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilObjGroupGUI\saveObject(), ilMailSearchGroupsGUI\showMyGroups(), and ilObjGroupGUI\updateMembersObject().

{
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
intref_id
intuser id

Reimplemented from ilParticipants.

Definition at line 78 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:

ilGroupParticipants::sendNotification (   $a_type,
  $a_usr_id 
)

Send notification mail.

Parameters
int$a_type
int$a_usr_id
Returns

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

References ilParticipants\getNotificationRecipients(), ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE, ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilGroupMembershipMailNotification\TYPE_STATUS_CHANGED, ilGroupMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, ilGroupMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

{
include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
switch($a_type)
{
case ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION);
$mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
$mail->setRefId($this->ref_id);
$mail->setRecipients($this->getNotificationRecipients());
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE);
$mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
$mail->setRefId($this->ref_id);
$mail->setRecipients($this->getNotificationRecipients());
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST);
$mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
$mail->setRefId($this->ref_id);
$mail->setRecipients($this->getNotificationRecipients());
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER:
include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
$wl = new ilGroupWaitingList($this->obj_id);
$pos = $wl->getPosition($a_usr_id);
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->setAdditionalInformation(array('position' => $pos));
$mail->send();
break;
case ilGroupMembershipMailNotification::TYPE_STATUS_CHANGED:
$mail = new ilGroupMembershipMailNotification();
$mail->setType(ilGroupMembershipMailNotification::TYPE_STATUS_CHANGED);
$mail->setRefId($this->ref_id);
$mail->setRecipients(array($a_usr_id));
$mail->send();
break;
}
return true;
}

+ Here is the call 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: