ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilGroupParticipants Class Reference
+ Inheritance diagram for ilGroupParticipants:
+ Collaboration diagram for ilGroupParticipants:

Public Member Functions

 __construct ($a_obj_id)
 Constructor. More...
 
 addSubscriber ($a_usr_id)
 
 sendNotification ($a_type, $a_usr_id)
 Send notification mail. More...
 
- Public Member Functions inherited from ilParticipants
 __construct ($a_component_name, $a_obj_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 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 course. 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...
 
 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...
 

Static Public Member Functions

static _getInstanceByObjId ($a_obj_id)
 Get singleton instance. More...
 
static getMemberRoles ($a_ref_id)
 Get member roles (not auto generated) 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 Public Member Functions inherited from ilParticipants
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 ilRbacReview $rbacreview <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...
 

Data Fields

const COMPONENT_NAME = 'Modules/Group'
 

Static Protected Attributes

static $instances = array()
 

Additional Inherited Members

- Protected Member Functions inherited from ilParticipants
 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 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
 

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

◆ __construct()

ilGroupParticipants::__construct (   $a_obj_id)

Constructor.

protected

Parameters
intobj_id of container

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

49  {
50  $this->type = 'grp';
51  parent::__construct(self::COMPONENT_NAME,$a_obj_id);
52  }

Member Function Documentation

◆ _getInstanceByObjId()

static ilGroupParticipants::_getInstanceByObjId (   $a_obj_id)
static

Get singleton instance.

public

Parameters
intobj_id
Returns
object ilGroupParticipants

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

Referenced by ilGroupEditParticipantsTableGUI\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilCourseParticipantsGroupsGUI\add(), ilObjGroupGUI\addUserObject(), ilSoapGroupAdministration\assignGroupMember(), ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilForumNotification\checkParentNodeTree(), ilObjGroup\cloneObject(), ilObjGroupGUI\confirmDeleteMembersObject(), ilGroupMembershipMailNotification\createGroupStatus(), ilObjGroupGUI\editMembersObject(), ilObjGroupGUI\executeCommand(), ilParticipants\getInstanceByObjId(), ilGroupLP\getMembers(), ilLPStatusCollection\getMembers(), ilMembershipNotifications\getParticipants(), ilMilestoneResponsiblesTableGUI\getParticipantsAndResponsibles(), ilTrQuery\getParticipantsForObject(), ilGroupXMLWriter\ilGroupXMLWriter(), ilObjGroupGUI\initAttendanceList(), ilObjSessionGUI\initContainer(), ilCourseParticipantsGroupsTableGUI\initGroups(), ilMemberExport\initMembers(), ilGroupRegistrationGUI\initParticipants(), ilObjGroup\initParticipants(), ilSoapGroupAdministration\isAssignedToGroup(), ilObjForumGUI\isParentObjectCrsOrGrp(), ilObjGroupGUI\leaveObject(), ilObjGroupAccess\lookupRegistrationInfo(), ilObjGroupGUI\membersObject(), ilGroupParticipantsTableGUI\parse(), ilObjGroupGUI\printMembersOutputObject(), ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), ilObjGroup\register(), ilCourseParticipantsGroupsGUI\remove(), ilObjGroupGUI\saveObject(), ilMailSearchGroupsGUI\showMyGroups(), and ilObjGroupGUI\updateMembersObject().

64  {
65  if(isset(self::$instances[$a_obj_id]) and self::$instances[$a_obj_id])
66  {
67  return self::$instances[$a_obj_id];
68  }
69  return self::$instances[$a_obj_id] = new ilGroupParticipants($a_obj_id);
70  }
+ Here is the caller graph for this function:

◆ _isParticipant()

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

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

References ilParticipants\$ilDB, and $ilLog.

Referenced by ilObjGroupAccess\_checkAccess(), ilStartUpGUI\_checkGoto(), ilObjGroupGUI\executeCommand(), ilObjGroupGUI\getTabs(), and ilObjGroupGUI\initHeaderAction().

127  {
128  global $rbacreview,$ilObjDataCache,$ilDB,$ilLog;
129 
130  $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id,false);
131  return $rbacreview->isAssignedToAtLeastOneGivenRole($a_usr_id, $local_roles);
132  }
+ Here is the caller graph for this function:

◆ addSubscriber()

ilGroupParticipants::addSubscriber (   $a_usr_id)

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

References $ilLog, and ilParticipants\getObjId().

100  {
101  global $ilAppEventHandler, $ilLog;
102 
103  parent::addSubscriber($a_usr_id);
104 
105  $ilLog->write(__METHOD__.': Raise new event: Modules/Group addSubscriber');
106  $ilAppEventHandler->raise(
107  "Modules/Group",
108  'addSubscriber',
109  array(
110  'obj_id' => $this->getObjId(),
111  'usr_id' => $a_usr_id
112  )
113  );
114  }
getObjId()
get current obj_id
+ Here is the call graph for this function:

◆ getMemberRoles()

static ilGroupParticipants::getMemberRoles (   $a_ref_id)
static

Get member roles (not auto generated)

Parameters
int$a_ref_id

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

References ilParticipants\$roles, and ilObject\_lookupTitle().

Referenced by ilObjGroupGUI\membersObject().

77  {
78  global $rbacreview;
79 
80  $lrol = $rbacreview->getRolesOfRoleFolder($a_ref_id,false);
81 
82  $roles = array();
83  foreach($lrol as $role)
84  {
85  $title = ilObject::_lookupTitle($role);
86  switch(substr($title,0,8))
87  {
88  case 'il_grp_a':
89  case 'il_grp_m':
90  continue;
91 
92  default:
93  $roles[$role] = $role;
94  }
95  }
96  return $roles;
97  }
static _lookupTitle($a_id)
lookup object title
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendNotification()

ilGroupParticipants::sendNotification (   $a_type,
  $a_usr_id 
)

Send notification mail.

Parameters
int$a_type
int$a_usr_id
Returns

Definition at line 140 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.

141  {
142  include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
143  switch($a_type)
144  {
146 
147  $mail = new ilGroupMembershipMailNotification();
149  $mail->setRefId($this->ref_id);
150  $mail->setRecipients(array($a_usr_id));
151  $mail->send();
152  break;
153 
155 
156  $mail = new ilGroupMembershipMailNotification();
158  $mail->setRefId($this->ref_id);
159  $mail->setRecipients(array($a_usr_id));
160  $mail->send();
161  break;
162 
164 
165  $mail = new ilGroupMembershipMailNotification();
167  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
168  $mail->setRefId($this->ref_id);
169  $mail->setRecipients($this->getNotificationRecipients());
170  $mail->send();
171  break;
172 
174 
175  $mail = new ilGroupMembershipMailNotification();
177  $mail->setRefId($this->ref_id);
178  $mail->setRecipients(array($a_usr_id));
179  $mail->send();
180  break;
181 
183 
184  $mail = new ilGroupMembershipMailNotification();
186  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
187  $mail->setRefId($this->ref_id);
188  $mail->setRecipients($this->getNotificationRecipients());
189  $mail->send();
190  break;
191 
193 
194  $mail = new ilGroupMembershipMailNotification();
196  $mail->setRefId($this->ref_id);
197  $mail->setRecipients(array($a_usr_id));
198  $mail->send();
199  break;
200 
202 
203  $mail = new ilGroupMembershipMailNotification();
205  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
206  $mail->setRefId($this->ref_id);
207  $mail->setRecipients($this->getNotificationRecipients());
208  $mail->send();
209  break;
210 
212 
213  $mail = new ilGroupMembershipMailNotification();
215  $mail->setRefId($this->ref_id);
216  $mail->setRecipients(array($a_usr_id));
217  $mail->send();
218  break;
219 
221 
222  $mail = new ilGroupMembershipMailNotification();
224  $mail->setRefId($this->ref_id);
225  $mail->setRecipients(array($a_usr_id));
226  $mail->send();
227  break;
228 
230 
231  include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
232  $wl = new ilGroupWaitingList($this->obj_id);
233  $pos = $wl->getPosition($a_usr_id);
234 
235  $mail = new ilGroupMembershipMailNotification();
237  $mail->setRefId($this->ref_id);
238  $mail->setRecipients(array($a_usr_id));
239  $mail->setAdditionalInformation(array('position' => $pos));
240  $mail->send();
241  break;
242 
244 
245  $mail = new ilGroupMembershipMailNotification();
247  $mail->setRefId($this->ref_id);
248  $mail->setRecipients(array($a_usr_id));
249  $mail->send();
250  break;
251 
252 
253  }
254  return true;
255  }
Waiting list for groups.
getNotificationRecipients()
Get admin, tutor which have notification enabled.
+ Here is the call graph for this function:

Field Documentation

◆ $instances

ilGroupParticipants::$instances = array()
staticprotected

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

◆ COMPONENT_NAME

const ilGroupParticipants::COMPONENT_NAME = 'Modules/Group'

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


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