ILIAS  trunk Revision v12.0_alpha-1540-g00f839d5fa1
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 @access public. More...
 
 checkLastAdmin (array $a_usr_ids)
 Check if users for deletion are last admins @access 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 @access 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 25 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 34 of file class.ilCourseParticipants.php.

35 {
36 // ref based constructor
37 $refs = ilObject::_getAllReferences($a_obj_id);
38 parent::__construct(self::COMPONENT_NAME, array_pop($refs));
39 }
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:833
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38

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

+ Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjId()

static ilCourseParticipants::_getInstanceByObjId ( int  $a_obj_id)
static

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

41 : ilCourseParticipants
42 {
43 if (isset(self::$instances[$a_obj_id]) && self::$instances[$a_obj_id]) {
44 return self::$instances[$a_obj_id];
45 }
46 return self::$instances[$a_obj_id] = new ilCourseParticipants($a_obj_id);
47 }

Referenced by ilCourseXMLParser\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilCourseObjectiveResult\__updatePassed(), ilObjCourseAccess\_checkAccess(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGUI\afterImport(), ilSoapCourseAdministration\assignCourseMember(), ilCourseMembershipMailNotification\createCourseStatus(), ilSoapCourseAdministration\excludeCourseMember(), ilObjCourseGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilUserImportParser\getCourseMembersObjectForRole(), ilCalendarBlockGUI\getHTML(), ilParticipants\getInstanceByObjId(), ilCourseLP\getMembers(), ilLPStatusCollection\getMembers(), ilLPStatusObjectives\getMembers(), ilMembershipNotifications\getParticipants(), ilCourseParticipantsGroupsTableDataRetrieval\init(), ilObjSessionGUI\initContainer(), ilObjCourse\initCourseMembersObject(), ilMemberExport\initMembers(), ilCourseRegistrationGUI\initParticipants(), ilObjForum\parentParticipants(), ilCalendarCategories\readAllConsultationHoursCalendarOfContainer(), ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), and ilObjCourse\register().

+ 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 103 of file class.ilCourseParticipants.php.

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

Referenced by ilCourseAppEventListener\handleEvent().

+ Here is the caller graph for this function:

◆ add()

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

Reimplemented from ilParticipants.

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

49 : bool
50 {
51 if (parent::add($a_usr_id, $a_role)) {
52 $this->addRecommendation($a_usr_id);
53 return true;
54 }
55 return false;
56 }
ilParticipants\addRecommendation
addRecommendation(int $a_usr_id)
Add desktop item @access public.
Definition: class.ilParticipants.php:878

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

+ Here is the call graph for this function:

◆ addSubscriber()

ilCourseParticipants::addSubscriber ( int  $a_usr_id)

Reimplemented from ilParticipants.

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

80 : void
81 {
82 parent::addSubscriber($a_usr_id);
83 $this->eventHandler->raise(
84 "components/ILIAS/Course",
85 'addSubscriber',
86 array(
87 'obj_id' => $this->getObjId(),
88 'usr_id' => $a_usr_id
89 )
90 );
91 }

References ilParticipants\getObjId().

+ Here is the call graph for this function:

◆ getDateTimeOfPassed()

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

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

311 : string
312 {
313 global $DIC;
314
315 $ilDB = $DIC->database();
316 $sql = "SELECT origin_ts FROM obj_members" .
317 " WHERE usr_id = " . $ilDB->quote($a_usr_id, "integer") .
318 " AND obj_id = " . $ilDB->quote($a_obj_id, "integer") .
319 " AND passed = " . $ilDB->quote(1, "integer");
320 $res = $ilDB->query($sql);
321 $res = $ilDB->fetchAssoc($res);
322 if (($res["origin_ts"] ?? 0) > 0) {
323 return date("Y-m-d H:i:s", $res["origin_ts"]);
324 }
325 return '';
326 }

References $DIC, $ilDB, and $res.

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

+ Here is the caller graph for this function:

◆ getMemberRoles()

static ilCourseParticipants::getMemberRoles ( int  $a_ref_id)
static

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

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

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

+ Here is the call graph for this function:

◆ getPassedInfo()

ilCourseParticipants::getPassedInfo ( int  $a_usr_id)

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

174 : ?array
175 {
176 $sql = "SELECT origin, origin_ts" .
177 " FROM obj_members" .
178 " WHERE obj_id = " . $this->ilDB->quote($this->obj_id, "integer") .
179 " AND usr_id = " . $this->ilDB->quote($a_usr_id, "integer");
180 $set = $this->ilDB->query($sql);
181 $row = $this->ilDB->fetchAssoc($set);
182 if ($row && $row["origin"]) {
183 return [
184 "user_id" => (int) $row["origin"],
185 "timestamp" => new ilDateTime((int) $row["origin_ts"], IL_CAL_UNIX)
186 ];
187 }
188 return null;
189 }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:43

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

+ Here is the call graph for this function:

◆ getPassedUsersForObjects()

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

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

328 : array
329 {
330 global $DIC;
331
332 $ilDB = $DIC->database();
333 $sql = "SELECT usr_id,obj_id FROM obj_members" .
334 " WHERE " . $ilDB->in("usr_id", $a_usr_ids, false, "integer") .
335 " AND " . $ilDB->in("obj_id", $a_obj_ids, false, "integer") .
336 " AND passed = " . $ilDB->quote(1, "integer");
337 $set = $ilDB->query($sql);
338 $res = [];
339 while ($row = $ilDB->fetchAssoc($set)) {
340 $row['usr_id'] = (int) $row['usr_id'];
341 $row['obj_id'] = (int) $row['obj_id'];
342 $res[] = $row;
343 }
344 return $res;
345 }
ilDBInterface\in
in(string $field, array $values, bool $negate=false, string $type="")

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

+ 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 191 of file class.ilCourseParticipants.php.

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

References 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.

◆ sendNotificationToAdmins()

ilCourseParticipants::sendNotificationToAdmins ( int  $a_usr_id)

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

301 : void
302 {
303 $mail = new ilCourseMembershipMailNotification();
304 $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION);
305 $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
306 $mail->setRefId($this->ref_id);
307 $mail->setRecipients($this->getNotificationRecipients());
308 $mail->send();
309 }
ilParticipants\getNotificationRecipients
getNotificationRecipients()
Get admin, tutor which have notification enabled.
Definition: class.ilParticipants.php:512

References ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION.

◆ sendSubscriptionRequestToAdmins()

ilCourseParticipants::sendSubscriptionRequestToAdmins ( int  $a_usr_id)

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

291 : void
292 {
293 $mail = new ilCourseMembershipMailNotification();
294 $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST);
295 $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
296 $mail->setRefId($this->ref_id);
297 $mail->setRecipients($this->getNotificationRecipients());
298 $mail->send();
299 }

References ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST.

◆ sendUnsubscribeNotificationToAdmins()

ilCourseParticipants::sendUnsubscribeNotificationToAdmins ( int  $a_usr_id)

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

281 : void
282 {
283 $mail = new ilCourseMembershipMailNotification();
284 $mail->setType(ilCourseMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE);
285 $mail->setAdditionalInformation(array('usr_id' => $a_usr_id));
286 $mail->setRefId($this->ref_id);
287 $mail->setRecipients($this->getNotificationRecipients());
288 $mail->send();
289 }

References ilCourseMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE.

◆ updatePassed()

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

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

98 : void {
99 $this->participants_status[$a_usr_id]['passed'] = $a_passed;
100 self::_updatePassed($this->obj_id, $a_usr_id, $a_passed, $a_manual, $a_no_origin);
101 }
ilCourseParticipants\_updatePassed
static _updatePassed(int $a_obj_id, int $a_usr_id, bool $a_passed, bool $a_manual=false, bool $a_no_origin=false)
Definition: class.ilCourseParticipants.php:103

Field Documentation

◆ $instances

array ilCourseParticipants::$instances = []
staticprotected

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

◆ COMPONENT_NAME

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

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

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