ILIAS  trunk Revision v11.0_alpha-1749-g1a06bdef097
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
ilCourseParticipants Class Reference
+ Inheritance diagram for ilCourseParticipants:
+ Collaboration diagram for ilCourseParticipants:

Public Member Functions

 __construct (int $a_obj_id)
 
 add (int $a_usr_id, int $a_role)
 
 addSubscriber (int $a_usr_id)
 
 updatePassed (int $a_usr_id, bool $a_passed, bool $a_manual=false, bool $a_no_origin=false)
 
 getPassedInfo (int $a_usr_id)
 
 sendNotification (int $a_type, int $a_usr_id, bool $a_force_sending_mail=false)
 
 sendUnsubscribeNotificationToAdmins (int $a_usr_id)
 
 sendSubscriptionRequestToAdmins (int $a_usr_id)
 
 sendNotificationToAdmins (int $a_usr_id)
 
- Public Member Functions inherited from ilParticipants
 __construct (string $a_component_name, int $a_ref_id)
 
 getObjId ()
 
 getType ()
 
 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 ()
 
 getTutors ()
 Get all tutors ids. More...
 
 isAdmin (int $a_usr_id)
 check if user is admin More...
 
 isTutor (int $a_usr_id)
 is user tutor More...
 
 isMember (int $a_usr_id)
 is user member More...
 
 isAssigned (int $a_usr_id)
 check if user is assigned More...
 
 isLastAdmin (int $a_usr_id)
 Check if user is last admin. More...
 
 getRoles ()
 Get object roles. More...
 
 getAssignedRoles (int $a_usr_id)
 Get assigned roles. More...
 
 updateRoleAssignments ($a_usr_id, $a_roles)
 Update role assignments public. More...
 
 checkLastAdmin (array $a_usr_ids)
 Check if users for deletion are last admins public. More...
 
 isBlocked (int $a_usr_id)
 Check if user is blocked. More...
 
 hasPassed (int $a_usr_id)
 Check if user has passed object. More...
 
 delete (int $a_usr_id)
 Drop user from all roles. More...
 
 updateBlocked (int $a_usr_id, bool $a_blocked)
 Update blocked status. More...
 
 updateContact (int $a_usr_id, bool $a_contact)
 
 getContacts ()
 get user ids which are confirgured as contact More...
 
 updateNotification (int $a_usr_id, bool $a_notification)
 Update notification status. More...
 
 add (int $a_usr_id, int $a_role)
 
 deleteParticipants (array $a_user_ids)
 
 addRecommendation (int $a_usr_id)
 Add desktop item public. More...
 
 isNotificationEnabled (int $a_usr_id)
 
 isContact (int $a_usr_id)
 
 getAutoGeneratedRoleId (int $a_role_type)
 
 isGroupingMember (int $a_usr_id, string $a_field='')
 Check membership for. More...
 
 getSubscribers ()
 get all subscribers int[] More...
 
 getCountSubscribers ()
 
 getSubscriberData (int $a_usr_id)
 
 assignSubscribers (array $a_usr_ids)
 
 assignSubscriber (int $a_usr_id)
 
 autoFillSubscribers ()
 
 addSubscriber (int $a_usr_id)
 
 updateSubscriptionTime (int $a_usr_id, int $a_subtime)
 
 updateSubject (int $a_usr_id, string $a_subject)
 
 deleteSubscriber (int $a_usr_id)
 
 deleteSubscribers (array $a_usr_ids)
 
 isSubscriber (int $a_usr_id)
 
 setRoleOrderPosition (int $a_user_id)
 Set role order position. More...
 

Static Public Member Functions

static _getInstanceByObjId (int $a_obj_id)
 
static getMemberRoles (int $a_ref_id)
 
static _updatePassed (int $a_obj_id, int $a_usr_id, bool $a_passed, bool $a_manual=false, bool $a_no_origin=false)
 
static getDateTimeOfPassed (int $a_obj_id, int $a_usr_id)
 
static getPassedUsersForObjects (array $a_obj_ids, array $a_usr_ids)
 
- Static Public Member Functions inherited from ilParticipants
static getInstance (int $a_ref_id)
 
static getInstanceByObjId (int $a_obj_id)
 Get instance by obj type. More...
 
static hasParticipantListAccess (int $a_obj_id, ?int $a_usr_id=null)
 Check if (current) user has access to the participant list. More...
 
static canSendMailToMembers (int|ilObject $ref_id_or_instance, ?int $usr_id=null, ?int $mail_obj_ref_id=null)
 This method was introduced as a band-aid fix for #22764. More...
 
static getUserMembershipAssignmentsByType (array $a_user_ids, array $a_type, bool $a_only_member_roles)
 Get user membership assignments by type. More...
 
static _getMembershipByType (int $a_usr_id, array $a_type, bool $a_only_member_role=false)
 get membership by type Get course or group membership More...
 
static _isParticipant (int $a_ref_id, int $a_usr_id)
 Static function to check if a user is a participant of the container object. More...
 
static lookupNumberOfParticipants (int $a_ref_id)
 Lookup the number of participants (crs admins, tutors, members, grp admins, members) More...
 
static lookupNumberOfMembers (int $a_ref_id)
 Lookup number of members. More...
 
static _isBlocked (int $a_obj_id, int $a_usr_id)
 Check if user is blocked. More...
 
static _hasPassed (int $a_obj_id, int $a_usr_id)
 Check if user has passed course. More...
 
static _deleteAllEntries (int $a_obj_id)
 Delete all entries Normally called in case of object deletion. More...
 
static _deleteUser (int $a_usr_id)
 Delete user data. More...
 
static getDefaultMemberRole (int $a_ref_id)
 
static lookupSubscribers (int $a_obj_id)
 
static _isSubscriber (int $a_obj_id, int $a_usr_id)
 
static lookupSubscribersData (int $a_obj_id)
 
static _getAllSupportContactsOfUser (int $a_usr_id, string $a_type)
 Get all support contacts for a user. More...
 

Protected Attributes

const COMPONENT_NAME = 'components/ILIAS/Course'
 
- Protected Attributes inherited from ilParticipants
string $component = ''
 
int $ref_id = 0
 
int $obj_id = 0
 
string $type = ''
 
array $roles = []
 
array $role_data = []
 
array $roles_sorted = []
 
array $role_assignments = []
 
array $participants = []
 
array $participants_status = []
 
array $members = []
 
array $tutors = []
 
array $admins = []
 
array $subscribers = []
 
ilAppEventHandler $eventHandler
 
ilRbacReview $rbacReview
 
ilRbacAdmin $rbacAdmin
 
ilObjectDataCache $objectDataCache
 
ilDBInterface $ilDB
 
ilLanguage $lng
 
ilLogger $logger
 
ilErrorHandling $error
 
ilRecommendedContentManager $recommended_content_manager
 

Static Protected Attributes

static array $instances = []
 

Additional Inherited Members

- Data Fields inherited from ilParticipants
const IL_CRS_ADMIN = 1
 
const IL_CRS_TUTOR = 3
 
const IL_CRS_MEMBER = 2
 
const IL_GRP_ADMIN = 4
 
const IL_GRP_MEMBER = 5
 
const IL_SESS_MEMBER = 6
 
const IL_LSO_ADMIN = 7
 
const IL_LSO_MEMBER = 8
 
const IL_ROLE_POSITION_ADMIN = 1
 
const IL_ROLE_POSITION_TUTOR = 2
 
const IL_ROLE_POSITION_MEMBER = 3
 
- Protected Member Functions inherited from ilParticipants
 getComponent ()
 Get component name Used for raising events. More...
 
 readParticipants ()
 
 readParticipantsStatus ()
 Read status of participants (blocked, notification, passed) More...
 
 readSubscribers ()
 
 readSubscriberData (int $a_usr_id)
 

Detailed Description

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om \

Definition at line 24 of file class.ilCourseParticipants.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseParticipants::__construct ( int  $a_obj_id)
Todo:
get rid of these pseude constants

Definition at line 33 of file class.ilCourseParticipants.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilObject\_getAllReferences().

34  {
35  // ref based constructor
36  $refs = ilObject::_getAllReferences($a_obj_id);
37  parent::__construct(self::COMPONENT_NAME, array_pop($refs));
38  }
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:809
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
+ Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjId()

static ilCourseParticipants::_getInstanceByObjId ( int  $a_obj_id)
static

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

Referenced by ilCourseEditParticipantsTableGUI\__construct(), ilCourseXMLParser\__construct(), ilCourseObjectiveResult\__updatePassed(), ilObjCourseAccess\_checkAccess(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGUI\afterImport(), ilSoapCourseAdministration\assignCourseMember(), ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilCourseMembershipMailNotification\createCourseStatus(), ilSoapCourseAdministration\excludeCourseMember(), ilObjGroupGUI\executeCommand(), ilObjCourseGUI\executeCommand(), ilUserImportParser\getCourseMembersObjectForRole(), ilCalendarBlockGUI\getHTML(), ilParticipants\getInstanceByObjId(), ilCourseParticipantsGroupsTableGUI\getItems(), ilCourseLP\getMembers(), ilLPStatusObjectives\getMembers(), ilLPStatusCollection\getMembers(), ilNotification\getNotificationsForObject(), ilMembershipNotifications\getParticipants(), ilForumSettingsGUI\getParticipants(), ilBadgeHandler\getUserIds(), ilObjSessionGUI\initContainer(), ilObjCourse\initCourseMembersObject(), ilMemberExport\initMembers(), ilCourseRegistrationGUI\initParticipants(), ilCalendarCategories\readAllConsultationHoursCalendarOfContainer(), ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), and ilObjCourse\register().

40  : ilCourseParticipants
41  {
42  if (isset(self::$instances[$a_obj_id]) && self::$instances[$a_obj_id]) {
43  return self::$instances[$a_obj_id];
44  }
45  return self::$instances[$a_obj_id] = new ilCourseParticipants($a_obj_id);
46  }
+ Here is the caller graph for this function:

◆ _updatePassed()

static ilCourseParticipants::_updatePassed ( int  $a_obj_id,
int  $a_usr_id,
bool  $a_passed,
bool  $a_manual = false,
bool  $a_no_origin = false 
)
static

Definition at line 102 of file class.ilCourseParticipants.php.

References $DIC, ilParticipants\$ilDB, $res, ilDBInterface\fetchAssoc(), ilDBInterface\manipulate(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilCourseAppEventListener\handleEvent().

108  : void {
109  global $DIC;
110 
111  $ilDB = $DIC['ilDB'];
112  $ilUser = $DIC['ilUser'];
113  $ilAppEventHandler = $DIC->event();
114 
115  // #11600
116  $origin = -1;
117  if ($a_manual) {
118  $origin = $ilUser->getId();
119  }
120 
121  $query = "SELECT passed FROM obj_members " .
122  "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
123  "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
124  $res = $ilDB->query($query);
125  $update_query = '';
126  if ($res->numRows()) {
127  // #9284 - only needs updating when status has changed
128  $old = $ilDB->fetchAssoc($res);
129  if ((int) $old["passed"] !== (int) $a_passed) {
130  $update_query = "UPDATE obj_members SET " .
131  "passed = " . $ilDB->quote($a_passed, 'integer') . ", " .
132  "origin = " . $ilDB->quote($origin, 'integer') . ", " .
133  "origin_ts = " . $ilDB->quote(time(), 'integer') . " " .
134  "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
135  "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
136  }
137  } else {
138  // when member is added we should not set any date
139  // see ilObjCourse::checkLPStatusSync()
140  if ($a_no_origin && !$a_passed) {
141  $origin = 0;
142  $origin_ts = 0;
143  } else {
144  $origin_ts = time();
145  }
146 
147  $update_query = "INSERT INTO obj_members (passed,obj_id,usr_id,notification,blocked,origin,origin_ts) " .
148  "VALUES ( " .
149  $ilDB->quote((int) $a_passed, 'integer') . ", " .
150  $ilDB->quote($a_obj_id, 'integer') . ", " .
151  $ilDB->quote($a_usr_id, 'integer') . ", " .
152  $ilDB->quote(0, 'integer') . ", " .
153  $ilDB->quote(0, 'integer') . ", " .
154  $ilDB->quote($origin, 'integer') . ", " .
155  $ilDB->quote($origin_ts, 'integer') . ")
156  ON DUPLICATE KEY UPDATE
157  passed = VALUES(passed),
158  origin = VALUES(origin),
159  origin_ts = VALUES(origin_ts)
160  ";
161  }
162  if (strlen($update_query)) {
163  $ilDB->manipulate($update_query);
164  if ($a_passed) {
165  $ilAppEventHandler->raise('components/ILIAS/Course', 'participantHasPassedCourse', array(
166  'obj_id' => $a_obj_id,
167  'usr_id' => $a_usr_id,
168  ));
169  }
170  }
171  }
$res
$res
Definition: ltiservices.php:66
ilDBInterface\fetchAssoc
fetchAssoc(ilDBStatement $statement)
ilDBInterface\quote
quote($value, string $type)
$DIC
global $DIC
Definition: shib_login.php:22
ilDBInterface\query
query(string $query)
Run a (read-only) Query on the database.
ilDBInterface\manipulate
manipulate(string $query)
Run a (write) Query on the database.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ add()

ilCourseParticipants::add ( int  $a_usr_id,
int  $a_role 
)

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

References ILIAS\UI\examples\Symbol\Glyph\Add\add(), and ilParticipants\addRecommendation().

48  : bool
49  {
50  if (parent::add($a_usr_id, $a_role)) {
51  $this->addRecommendation($a_usr_id);
52  return true;
53  }
54  return false;
55  }
ILIAS\UI\examples\Symbol\Glyph\Add\add
add()
description: > Example for rendring an add glyph.
Definition: add.php:41
ilParticipants\addRecommendation
addRecommendation(int $a_usr_id)
Add desktop item public.
Definition: class.ilParticipants.php:879
+ Here is the call graph for this function:

◆ addSubscriber()

ilCourseParticipants::addSubscriber ( int  $a_usr_id)

Definition at line 79 of file class.ilCourseParticipants.php.

References ilParticipants\getObjId().

79  : void
80  {
81  parent::addSubscriber($a_usr_id);
82  $this->eventHandler->raise(
83  "components/ILIAS/Course",
84  'addSubscriber',
85  array(
86  'obj_id' => $this->getObjId(),
87  'usr_id' => $a_usr_id
88  )
89  );
90  }
+ Here is the call graph for this function:

◆ getDateTimeOfPassed()

static ilCourseParticipants::getDateTimeOfPassed ( int  $a_obj_id,
int  $a_usr_id 
)
static

Definition at line 310 of file class.ilCourseParticipants.php.

References $DIC, ilParticipants\$ilDB, $res, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ILIAS\Course\Certificate\CertificateParticipantsHelper\getDateTimeOfPassed().

310  : string
311  {
312  global $DIC;
313 
314  $ilDB = $DIC->database();
315  $sql = "SELECT origin_ts FROM obj_members" .
316  " WHERE usr_id = " . $ilDB->quote($a_usr_id, "integer") .
317  " AND obj_id = " . $ilDB->quote($a_obj_id, "integer") .
318  " AND passed = " . $ilDB->quote(1, "integer");
319  $res = $ilDB->query($sql);
320  $res = $ilDB->fetchAssoc($res);
321  if (($res["origin_ts"] ?? 0) > 0) {
322  return date("Y-m-d H:i:s", $res["origin_ts"]);
323  }
324  return '';
325  }
$res
$res
Definition: ltiservices.php:66
ilDBInterface\fetchAssoc
fetchAssoc(ilDBStatement $statement)
ilDBInterface\quote
quote($value, string $type)
$DIC
global $DIC
Definition: shib_login.php:22
ilDBInterface\query
query(string $query)
Run a (read-only) Query on the database.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMemberRoles()

static ilCourseParticipants::getMemberRoles ( int  $a_ref_id)
static

Definition at line 57 of file class.ilCourseParticipants.php.

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

57  : array
58  {
59  global $DIC;
60 
61  $rbacreview = $DIC['rbacreview'];
62  $lrol = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
63  $roles = array();
64  foreach ($lrol as $role) {
65  $title = ilObject::_lookupTitle($role);
66  switch (substr($title, 0, 8)) {
67  case 'il_crs_a':
68  case 'il_crs_t':
69  case 'il_crs_m':
70  continue 2;
71 
72  default:
73  $roles[$role] = $role;
74  }
75  }
76  return $roles;
77  }
ilObject\_lookupTitle
static _lookupTitle(int $obj_id)
Definition: class.ilObject.php:830
$DIC
global $DIC
Definition: shib_login.php:22
+ Here is the call graph for this function:

◆ getPassedInfo()

ilCourseParticipants::getPassedInfo ( int  $a_usr_id)

Definition at line 173 of file class.ilCourseParticipants.php.

References IL_CAL_UNIX, ILIAS\Repository\int(), and null.

173  : ?array
174  {
175  $sql = "SELECT origin, origin_ts" .
176  " FROM obj_members" .
177  " WHERE obj_id = " . $this->ilDB->quote($this->obj_id, "integer") .
178  " AND usr_id = " . $this->ilDB->quote($a_usr_id, "integer");
179  $set = $this->ilDB->query($sql);
180  $row = $this->ilDB->fetchAssoc($set);
181  if ($row && $row["origin"]) {
182  return [
183  "user_id" => (int) $row["origin"],
184  "timestamp" => new ilDateTime((int) $row["origin_ts"], IL_CAL_UNIX)
185  ];
186  }
187  return null;
188  }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
null
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
Definition: shib_logout.php:142
+ Here is the call graph for this function:

◆ getPassedUsersForObjects()

static ilCourseParticipants::getPassedUsersForObjects ( array  $a_obj_ids,
array  $a_usr_ids 
)
static

Definition at line 327 of file class.ilCourseParticipants.php.

References $DIC, ilParticipants\$ilDB, $res, ilDBInterface\fetchAssoc(), ilDBInterface\in(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

327  : array
328  {
329  global $DIC;
330 
331  $ilDB = $DIC->database();
332  $sql = "SELECT usr_id,obj_id FROM obj_members" .
333  " WHERE " . $ilDB->in("usr_id", $a_usr_ids, false, "integer") .
334  " AND " . $ilDB->in("obj_id", $a_obj_ids, false, "integer") .
335  " AND passed = " . $ilDB->quote(1, "integer");
336  $set = $ilDB->query($sql);
337  $res = [];
338  while ($row = $ilDB->fetchAssoc($set)) {
339  $row['usr_id'] = (int) $row['usr_id'];
340  $row['obj_id'] = (int) $row['obj_id'];
341  $res[] = $row;
342  }
343  return $res;
344  }
$res
$res
Definition: ltiservices.php:66
ilDBInterface\fetchAssoc
fetchAssoc(ilDBStatement $statement)
ilDBInterface\quote
quote($value, string $type)
$DIC
global $DIC
Definition: shib_login.php:22
ilDBInterface\query
query(string $query)
Run a (read-only) Query on the database.
ilDBInterface\in
in(string $field, array $values, bool $negate=false, string $type="")
+ Here is the call graph for this function:

◆ sendNotification()

ilCourseParticipants::sendNotification ( int  $a_type,
int  $a_usr_id,
bool  $a_force_sending_mail = false 
)

Definition at line 190 of file class.ilCourseParticipants.php.

References sendNotificationToAdmins(), sendSubscriptionRequestToAdmins(), ilCourseMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilCourseMembershipMailNotification\TYPE_BLOCKED_MEMBER, ilCourseMembershipMailNotification\TYPE_DISMISS_MEMBER, ilCourseMembershipMailNotification\TYPE_NOTIFICATION_ADMINS, ilCourseMembershipMailNotification\TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST, ilCourseMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilCourseMembershipMailNotification\TYPE_STATUS_CHANGED, ilCourseMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, ilCourseMembershipMailNotification\TYPE_UNBLOCKED_MEMBER, ilCourseMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and ilCourseMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

190  : void
191  {
192  $mail = new ilCourseMembershipMailNotification();
193  $mail->forceSendingMail($a_force_sending_mail);
194 
195  switch ($a_type) {
196  case ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER:
197  $mail->setType(ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER);
198  $mail->setRefId($this->ref_id);
199  $mail->setRecipients(array($a_usr_id));
200  $mail->send();
201  break;
202 
203  case ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:
204  $mail->setType(ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER);
205  $mail->setRefId($this->ref_id);
206  $mail->setRecipients(array($a_usr_id));
207  $mail->send();
208  break;
209 
210  case ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER:
211  $mail->setType(ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER);
212  $mail->setRefId($this->ref_id);
213  $mail->setRecipients(array($a_usr_id));
214  $mail->send();
215  break;
216 
217  case ilCourseMembershipMailNotification::TYPE_BLOCKED_MEMBER:
218  $mail->setType(ilCourseMembershipMailNotification::TYPE_BLOCKED_MEMBER);
219  $mail->setRefId($this->ref_id);
220  $mail->setRecipients(array($a_usr_id));
221  $mail->send();
222  break;
223 
224  case ilCourseMembershipMailNotification::TYPE_UNBLOCKED_MEMBER:
225  $mail->setType(ilCourseMembershipMailNotification::TYPE_UNBLOCKED_MEMBER);
226  $mail->setRefId($this->ref_id);
227  $mail->setRecipients(array($a_usr_id));
228  $mail->send();
229  break;
230 
231  case ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER:
232  $mail->setType(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER);
233  $mail->setRefId($this->ref_id);
234  $mail->setRecipients(array($a_usr_id));
235  $mail->send();
236  break;
237 
238  case ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED:
239  $mail->setType(ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED);
240  $mail->setRefId($this->ref_id);
241  $mail->setRecipients(array($a_usr_id));
242  $mail->send();
243  break;
244 
245  case ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER:
246  $mail->setType(ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER);
247  $mail->setRefId($this->ref_id);
248  $mail->setRecipients(array($a_usr_id));
249  $mail->send();
250  break;
251 
252  case ilCourseMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER:
253  $mail->setType(ilCourseMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER);
254  $mail->setRefId($this->ref_id);
255  $mail->setRecipients(array($a_usr_id));
256  $mail->send();
257  break;
258 
259  case ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER:
260  $wl = new ilCourseWaitingList($this->obj_id);
261  $pos = $wl->getPosition($a_usr_id);
262 
263  $mail->setType(ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER);
264  $mail->setRefId($this->ref_id);
265  $mail->setRecipients(array($a_usr_id));
266  $mail->setAdditionalInformation(array('position' => $pos));
267  $mail->send();
268  break;
269 
270  case ilCourseMembershipMailNotification::TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST:
271  $this->sendSubscriptionRequestToAdmins($a_usr_id);
272  break;
273 
274  case ilCourseMembershipMailNotification::TYPE_NOTIFICATION_ADMINS:
275  $this->sendNotificationToAdmins($a_usr_id);
276  break;
277  }
278  }
ilCourseParticipants\sendSubscriptionRequestToAdmins
sendSubscriptionRequestToAdmins(int $a_usr_id)
Definition: class.ilCourseParticipants.php:290
+ Here is the call graph for this function:

◆ sendNotificationToAdmins()

ilCourseParticipants::sendNotificationToAdmins ( int  $a_usr_id)

Definition at line 300 of file class.ilCourseParticipants.php.

References ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION.

Referenced by sendNotification().

300  : void
301  {
302  $mail = new ilCourseMembershipMailNotification();
303  $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION);
304  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
305  $mail->setRefId($this->ref_id);
306  $mail->setRecipients($this->getNotificationRecipients());
307  $mail->send();
308  }
ilParticipants\getNotificationRecipients
getNotificationRecipients()
Get admin, tutor which have notification enabled.
Definition: class.ilParticipants.php:513
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendSubscriptionRequestToAdmins()

ilCourseParticipants::sendSubscriptionRequestToAdmins ( int  $a_usr_id)

Definition at line 290 of file class.ilCourseParticipants.php.

References ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST.

Referenced by sendNotification().

290  : void
291  {
292  $mail = new ilCourseMembershipMailNotification();
293  $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST);
294  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
295  $mail->setRefId($this->ref_id);
296  $mail->setRecipients($this->getNotificationRecipients());
297  $mail->send();
298  }
ilParticipants\getNotificationRecipients
getNotificationRecipients()
Get admin, tutor which have notification enabled.
Definition: class.ilParticipants.php:513
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendUnsubscribeNotificationToAdmins()

ilCourseParticipants::sendUnsubscribeNotificationToAdmins ( int  $a_usr_id)

Definition at line 280 of file class.ilCourseParticipants.php.

References ilParticipants\getNotificationRecipients(), and ilCourseMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE.

280  : void
281  {
282  $mail = new ilCourseMembershipMailNotification();
283  $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE);
284  $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
285  $mail->setRefId($this->ref_id);
286  $mail->setRecipients($this->getNotificationRecipients());
287  $mail->send();
288  }
ilParticipants\getNotificationRecipients
getNotificationRecipients()
Get admin, tutor which have notification enabled.
Definition: class.ilParticipants.php:513
+ Here is the call graph for this function:

◆ updatePassed()

ilCourseParticipants::updatePassed ( int  $a_usr_id,
bool  $a_passed,
bool  $a_manual = false,
bool  $a_no_origin = false 
)

Definition at line 92 of file class.ilCourseParticipants.php.

97  : void {
98  $this->participants_status[$a_usr_id]['passed'] = $a_passed;
99  self::_updatePassed($this->obj_id, $a_usr_id, $a_passed, $a_manual, $a_no_origin);
100  }

Field Documentation

◆ $instances

array ilCourseParticipants::$instances = []
staticprotected

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

◆ COMPONENT_NAME

const ilCourseParticipants::COMPONENT_NAME = 'components/ILIAS/Course'
protected

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

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