ILIAS  trunk Revision v12.0_alpha-377-g3641b37b9db
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Attributes
ilCourseMembershipMailNotification Class Reference
+ Inheritance diagram for ilCourseMembershipMailNotification:
+ Collaboration diagram for ilCourseMembershipMailNotification:

Public Member Functions

 __construct ()
 
 forceSendingMail (bool $a_status)
 Force sending mail independent from global setting. More...
 
 send ()
 
- Public Member Functions inherited from ilMailNotification
 __construct (protected bool $is_in_wsp=false)
 
 setType (int $a_type)
 
 getType ()
 
 setSender (int $a_usr_id)
 
 getSender ()
 
 setRecipients (array $a_rcp)
 
 getRecipients ()
 
 setAttachments (array $a_att)
 
 getAttachments ()
 
 setLangModules (array $a_modules)
 
 getUserLanguage (int $a_usr_id)
 
 setRefId (int $a_id)
 
 getRefId ()
 
 getObjId ()
 
 setObjId (int $a_obj_id)
 
 getObjType ()
 
 setAdditionalInformation (array $a_info)
 
 getAdditionalInformation ()
 
 sendMail (array $a_rcp, bool $a_parse_recipients=true)
 
 getBlockBorder ()
 

Data Fields

const TYPE_ADMISSION_MEMBER = 20
 
const TYPE_DISMISS_MEMBER = 21
 
const TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22
 
const TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23
 
const TYPE_STATUS_CHANGED = 24
 
const TYPE_BLOCKED_MEMBER = 25
 
const TYPE_UNBLOCKED_MEMBER = 26
 
const TYPE_UNSUBSCRIBE_MEMBER = 27
 
const TYPE_SUBSCRIBE_MEMBER = 28
 
const TYPE_WAITING_LIST_MEMBER = 29
 
const TYPE_NOTIFICATION_REGISTRATION = 30
 
const TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31
 
const TYPE_NOTIFICATION_UNSUBSCRIBE = 32
 
const TYPE_NOTIFICATION_ADMINS = 33
 
const TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST = 34
 
- Data Fields inherited from ilMailNotification
final const int SUBJECT_TITLE_LENGTH = 60
 

Protected Member Functions

 initMail ()
 @inheritDoc More...
 
 initLanguage (int $a_usr_id)
 
 createCourseStatus (int $a_usr_id)
 
 isNotificationTypeEnabled (int $a_type)
 get setting "mail_crs_member_notification" and excludes types which are not affected by this setting See description of $this->permanent_enabled_notifications More...
 
- Protected Member Functions inherited from ilMailNotification
 setSubject (string $a_subject)
 
 getSubject ()
 
 setBody (string $a_body)
 
 appendBody (string $a_body)
 
 getBody ()
 
 initLanguage (int $a_usr_id)
 
 initLanguageByIso2Code (string $a_code='')
 
 setLanguage (ilLanguage $a_language)
 
 getLanguage ()
 
 getLanguageText (string $a_keyword)
 
 getObjectTitle (bool $a_shorten=false)
 
 initMail ()
 
 getMail ()
 
 createPermanentLink (array $a_params=[], string $a_append='')
 
 userToString (int $a_usr_id)
 
 isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission='read')
 

Protected Attributes

array $permanent_enabled_notifications
 Notifications which are not affected by "mail_crs_member_notification" setting because they addresses admins. More...
 
ilSetting $setting
 
- Protected Attributes inherited from ilMailNotification
int $type
 
int $sender
 
ilMail $mail = null
 
string $subject = ''
 
string $body = ''
 
array $attachments = []
 
ilLanguage $language
 
array $lang_modules = []
 
array $recipients = []
 
int $ref_id
 
int $obj_id = 0
 
string $obj_type = ''
 
array $additional_info = []
 
ilWorkspaceTree $wsp_tree
 
ilWorkspaceAccessHandler $wsp_access_handler
 

Private Attributes

bool $force_sending_mail = false
 

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 25 of file class.ilCourseMembershipMailNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseMembershipMailNotification::__construct ( )

Definition at line 66 of file class.ilCourseMembershipMailNotification.php.

67 {
68 global $DIC;
69
70 $this->setting = $DIC->settings();
71 parent::__construct(false);
72 }
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38
$DIC
global $DIC
Definition: shib_login.php:26

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

+ Here is the call graph for this function:

Member Function Documentation

◆ createCourseStatus()

ilCourseMembershipMailNotification::createCourseStatus ( int  $a_usr_id)
protected

Definition at line 444 of file class.ilCourseMembershipMailNotification.php.

444 : string
445 {
446 $part = ilCourseParticipants::_getInstanceByObjId($this->getObjId());
447
448 $body = $this->getLanguageText('crs_new_status') . "\n";
449 $body .= $this->getLanguageText('role') . ': ';
450
451 if ($part->isAdmin($a_usr_id)) {
452 $body .= $this->getLanguageText('crs_admin') . "\n";
453 } elseif ($part->isTutor($a_usr_id)) {
454 $body .= $this->getLanguageText('crs_tutor') . "\n";
455 } else {
456 $body .= $this->getLanguageText('crs_member') . "\n";
457 }
458
459 if ($part->isAdmin($a_usr_id) || $part->isTutor($a_usr_id)) {
460 $body .= $this->getLanguageText('crs_status') . ': ';
461
462 if ($part->isNotificationEnabled($a_usr_id)) {
463 $body .= $this->getLanguageText('crs_notify') . "\n";
464 } else {
465 $body .= $this->getLanguageText('crs_no_notify') . "\n";
466 }
467 } else {
468 $body .= $this->getLanguageText('crs_access') . ': ';
469
470 if ($part->isBlocked($a_usr_id)) {
471 $body .= $this->getLanguageText('crs_blocked') . "\n";
472 } else {
473 $body .= $this->getLanguageText('crs_unblocked') . "\n";
474 }
475 }
476
477 $body .= $this->getLanguageText('crs_passed') . ': ';
478
479 if ($part->hasPassed($a_usr_id)) {
480 $body .= $this->getLanguageText('yes');
481 } else {
482 $body .= $this->getLanguageText('no');
483 }
484 return $body;
485 }
ilCourseParticipants\_getInstanceByObjId
static _getInstanceByObjId(int $a_obj_id)
Definition: class.ilCourseParticipants.php:40
ilMailNotification\getLanguageText
getLanguageText(string $a_keyword)
Definition: class.ilMailNotification.php:164

References ilMailNotification\$body, ilCourseParticipants\_getInstanceByObjId(), ilMailNotification\getLanguageText(), and ilMailNotification\getObjId().

Referenced by send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ forceSendingMail()

ilCourseMembershipMailNotification::forceSendingMail ( bool  $a_status)

Force sending mail independent from global setting.

Definition at line 94 of file class.ilCourseMembershipMailNotification.php.

94 : void
95 {
96 $this->force_sending_mail = $a_status;
97 }

◆ initLanguage()

ilCourseMembershipMailNotification::initLanguage ( int  $a_usr_id)
protected

Reimplemented from ilMailNotification.

Definition at line 438 of file class.ilCourseMembershipMailNotification.php.

438 : void
439 {
440 parent::initLanguage($a_usr_id);
441 $this->getLanguage()->loadLanguageModule('crs');
442 }

References ilMailNotification\getLanguage().

Referenced by send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initMail()

ilCourseMembershipMailNotification::initMail ( )
protected

@inheritDoc

Reimplemented from ilMailNotification.

Definition at line 77 of file class.ilCourseMembershipMailNotification.php.

77 : ilMail
78 {
79 parent::initMail();
80 $this->mail = $this->mail->withContextParameters([
81 ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
82 ilObject::_lookupObjId($this->getRefId()),
83 ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
84 ''
85 ),
86 ]);
87
88 return $this->mail;
89 }
ilContainer\_lookupContainerSetting
static _lookupContainerSetting(int $a_id, string $a_keyword, ?string $a_default_value=null)
Definition: class.ilContainer.php:253
ilMail\PROP_CONTEXT_SUBJECT_PREFIX
const string PROP_CONTEXT_SUBJECT_PREFIX
Definition: class.ilMail.php:35
ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:940

References ilMailNotification\$mail, ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), ilObjectServiceSettingsGUI\EXTERNAL_MAIL_PREFIX, ilMailNotification\getRefId(), and ilMail\PROP_CONTEXT_SUBJECT_PREFIX.

Referenced by send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isNotificationTypeEnabled()

ilCourseMembershipMailNotification::isNotificationTypeEnabled ( int  $a_type)
protected

get setting "mail_crs_member_notification" and excludes types which are not affected by this setting See description of $this->permanent_enabled_notifications

Definition at line 491 of file class.ilCourseMembershipMailNotification.php.

491 : bool
492 {
493 return
494 $this->force_sending_mail ||
495 $this->setting->get('mail_crs_member_notification', '1') ||
496 in_array($a_type, $this->permanent_enabled_notifications);
497 }

Referenced by send().

+ Here is the caller graph for this function:

◆ send()

ilCourseMembershipMailNotification::send ( )

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

99 : bool
100 {
101 if (
102 $this->getRefId() &&
103 in_array($this->getType(), array(self::TYPE_ADMISSION_MEMBER))) {
104 $obj = ilObjectFactory::getInstanceByRefId($this->getRefId());
105
106 if ($obj->getAutoNotification() == false) {
107 if (!$this->force_sending_mail) {
108 return false;
109 }
110 }
111 }
112 if (!$this->isNotificationTypeEnabled($this->getType())) {
113 return false;
114 }
115 // #11359
116 // parent::send();
117
118 switch ($this->getType()) {
119 case self::TYPE_ADMISSION_MEMBER:
120
121 foreach ($this->getRecipients() as $rcp) {
122 $this->initLanguage($rcp);
123 $this->initMail();
124 $this->setSubject(
125 sprintf($this->getLanguageText('crs_added_member'), $this->getObjectTitle(true))
126 );
127 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
128 $this->appendBody("\n\n");
129 $this->appendBody(
130 sprintf($this->getLanguageText('crs_added_member_body'), $this->getObjectTitle())
131 );
132 $this->appendBody("\n\n");
133 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
134 $this->appendBody("\n\n");
135 $this->appendBody($this->createPermanentLink());
136 $this->getMail()->appendInstallationSignature(true);
137
138 $this->sendMail(array($rcp));
139 }
140 break;
141
142 case self::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:
143
144 foreach ($this->getRecipients() as $rcp) {
145 $this->initLanguage($rcp);
146 $this->initMail();
147 $this->setSubject(
148 sprintf($this->getLanguageText('crs_accept_subscriber'), $this->getObjectTitle(true))
149 );
150 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
151 $this->appendBody("\n\n");
152 $this->appendBody(
153 sprintf($this->getLanguageText('crs_accept_subscriber_body'), $this->getObjectTitle())
154 );
155 $this->appendBody("\n\n");
156 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
157 $this->appendBody("\n\n");
158 $this->appendBody($this->createPermanentLink());
159 $this->getMail()->appendInstallationSignature(true);
160
161 $this->sendMail(array($rcp));
162 }
163 break;
164
165 case self::TYPE_REFUSED_SUBSCRIPTION_MEMBER:
166
167 foreach ($this->getRecipients() as $rcp) {
168 $this->initLanguage($rcp);
169 $this->initMail();
170 $this->setSubject(
171 sprintf($this->getLanguageText('crs_reject_subscriber'), $this->getObjectTitle(true))
172 );
173 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
174 $this->appendBody("\n\n");
175 $this->appendBody(
176 sprintf($this->getLanguageText('crs_reject_subscriber_body'), $this->getObjectTitle())
177 );
178
179 $this->getMail()->appendInstallationSignature(true);
180
181 $this->sendMail(array($rcp));
182 }
183 break;
184
185 case self::TYPE_STATUS_CHANGED:
186 foreach ($this->getRecipients() as $rcp) {
187 $this->initLanguage($rcp);
188 $this->initMail();
189 $this->setSubject(
190 sprintf($this->getLanguageText('crs_status_changed'), $this->getObjectTitle(true))
191 );
192 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
193 $this->appendBody("\n\n");
194 $this->appendBody(
195 sprintf($this->getLanguageText('crs_status_changed_body'), $this->getObjectTitle())
196 );
197
198 $this->appendBody("\n\n");
199 $this->appendBody($this->createCourseStatus($rcp));
200
201 $this->appendBody("\n\n");
202 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
203 $this->appendBody("\n\n");
204 $this->appendBody($this->createPermanentLink());
205
206 $this->getMail()->appendInstallationSignature(true);
207
208 $this->sendMail(array($rcp));
209 }
210 break;
211
212 case self::TYPE_DISMISS_MEMBER:
213
214 foreach ($this->getRecipients() as $rcp) {
215 $this->initLanguage($rcp);
216 $this->initMail();
217 $this->setSubject(
218 sprintf($this->getLanguageText('crs_dismiss_member'), $this->getObjectTitle(true))
219 );
220 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
221 $this->appendBody("\n\n");
222 $this->appendBody(
223 sprintf($this->getLanguageText('crs_dismiss_member_body'), $this->getObjectTitle())
224 );
225 $this->getMail()->appendInstallationSignature(true);
226 $this->sendMail(array($rcp));
227 }
228 break;
229
230 case self::TYPE_BLOCKED_MEMBER:
231
232 foreach ($this->getRecipients() as $rcp) {
233 $this->initLanguage($rcp);
234 $this->initMail();
235 $this->setSubject(
236 sprintf($this->getLanguageText('crs_blocked_member'), $this->getObjectTitle(true))
237 );
238 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
239 $this->appendBody("\n\n");
240 $this->appendBody(
241 sprintf($this->getLanguageText('crs_blocked_member_body'), $this->getObjectTitle())
242 );
243 $this->getMail()->appendInstallationSignature(true);
244 $this->sendMail(array($rcp));
245 }
246 break;
247
248 case self::TYPE_UNBLOCKED_MEMBER:
249
250 foreach ($this->getRecipients() as $rcp) {
251 $this->initLanguage($rcp);
252 $this->initMail();
253 $this->setSubject(
254 sprintf($this->getLanguageText('crs_unblocked_member'), $this->getObjectTitle(true))
255 );
256 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
257 $this->appendBody("\n\n");
258 $this->appendBody(
259 sprintf($this->getLanguageText('crs_unblocked_member_body'), $this->getObjectTitle())
260 );
261
262 $this->appendBody("\n\n");
263 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
264 $this->appendBody("\n\n");
265 $this->appendBody($this->createPermanentLink());
266 $this->getMail()->appendInstallationSignature(true);
267
268 $this->sendMail(array($rcp));
269 }
270 break;
271
272 case self::TYPE_NOTIFICATION_REGISTRATION:
273
274 foreach ($this->getRecipients() as $rcp) {
275 $this->initLanguage($rcp);
276 $this->initMail();
277 $this->setSubject(
278 sprintf($this->getLanguageText('crs_new_subscription'), $this->getObjectTitle(true))
279 );
280 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
281 $this->appendBody("\n\n");
282
283 $info = $this->getAdditionalInformation();
284 $this->appendBody(
285 sprintf(
286 $this->getLanguageText('crs_new_subscription_body'),
287 $this->userToString($info['usr_id']),
288 $this->getObjectTitle()
289 )
290 );
291 $this->appendBody("\n\n");
292 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
293 $this->appendBody("\n\n");
294 $this->appendBody($this->createPermanentLink(array(), 'mem'));
295
296 $this->appendBody("\n\n");
297 $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));
298
299 $this->getMail()->appendInstallationSignature(true);
300 $this->sendMail(array($rcp));
301 }
302 break;
303
304 case self::TYPE_NOTIFICATION_REGISTRATION_REQUEST:
305
306 foreach ($this->getRecipients() as $rcp) {
307 $this->initLanguage($rcp);
308 $this->initMail();
309 $this->setSubject(
310 sprintf($this->getLanguageText('crs_new_subscription_request'), $this->getObjectTitle(true))
311 );
312 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
313 $this->appendBody("\n\n");
314
315 $info = $this->getAdditionalInformation();
316 $this->appendBody(
317 sprintf(
318 $this->getLanguageText('crs_new_subscription_request_body'),
319 $this->userToString($info['usr_id']),
320 $this->getObjectTitle()
321 )
322 );
323 $this->appendBody("\n\n");
324 $this->appendBody($this->getLanguageText('crs_new_subscription_request_body2'));
325 $this->appendBody("\n");
326 $this->appendBody($this->createPermanentLink(array(), 'mem'));
327
328 $this->appendBody("\n\n");
329 $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));
330
331 $this->getMail()->appendInstallationSignature(true);
332 $this->sendMail(array($rcp));
333 }
334 break;
335
336 case self::TYPE_NOTIFICATION_UNSUBSCRIBE:
337
338 foreach ($this->getRecipients() as $rcp) {
339 $this->initLanguage($rcp);
340 $this->initMail();
341 $this->setSubject(
342 sprintf($this->getLanguageText('crs_cancel_subscription'), $this->getObjectTitle(true))
343 );
344 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
345 $this->appendBody("\n\n");
346
347 $info = $this->getAdditionalInformation();
348 $this->appendBody(
349 sprintf(
350 $this->getLanguageText('crs_cancel_subscription_body'),
351 $this->userToString($info['usr_id']),
352 $this->getObjectTitle()
353 )
354 );
355 $this->appendBody("\n\n");
356 $this->appendBody($this->getLanguageText('crs_cancel_subscription_body2'));
357 $this->appendBody("\n\n");
358 $this->appendBody($this->createPermanentLink(array(), 'mem'));
359
360 $this->appendBody("\n\n");
361 $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));
362
363 $this->getMail()->appendInstallationSignature(true);
364 $this->sendMail(array($rcp));
365 }
366 break;
367
368 case self::TYPE_UNSUBSCRIBE_MEMBER:
369 foreach ($this->getRecipients() as $rcp) {
370 $this->initLanguage($rcp);
371 $this->initMail();
372 $this->setSubject(
373 sprintf($this->getLanguageText('crs_unsubscribe_member'), $this->getObjectTitle(true))
374 );
375 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
376 $this->appendBody("\n\n");
377 $this->appendBody(
378 sprintf($this->getLanguageText('crs_unsubscribe_member_body'), $this->getObjectTitle())
379 );
380 $this->appendBody("\n\n");
381 $this->appendBody($this->getLanguageText('crs_unsubscribe_member_explanation'));
382 $this->getMail()->appendInstallationSignature(true);
383 $this->sendMail(array($rcp));
384 }
385 break;
386
387 case self::TYPE_SUBSCRIBE_MEMBER:
388
389 foreach ($this->getRecipients() as $rcp) {
390 $this->initLanguage($rcp);
391 $this->initMail();
392 $this->setSubject(
393 sprintf($this->getLanguageText('crs_subscribe_member'), $this->getObjectTitle(true))
394 );
395 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
396 $this->appendBody("\n\n");
397 $this->appendBody(
398 sprintf($this->getLanguageText('crs_subscribe_member_body'), $this->getObjectTitle())
399 );
400
401 $this->appendBody("\n\n");
402 $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
403 $this->appendBody("\n\n");
404 $this->appendBody($this->createPermanentLink());
405 $this->getMail()->appendInstallationSignature(true);
406
407 $this->sendMail(array($rcp));
408 }
409 break;
410
411 case self::TYPE_WAITING_LIST_MEMBER:
412 foreach ($this->getRecipients() as $rcp) {
413 $this->initLanguage($rcp);
414 $this->initMail();
415 $this->setSubject(
416 sprintf($this->getLanguageText('crs_subscribe_wl'), $this->getObjectTitle(true))
417 );
418
419 $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
420
421 $info = $this->getAdditionalInformation();
422 $this->appendBody("\n\n");
423 $this->appendBody(
424 sprintf(
425 $this->getLanguageText('crs_subscribe_wl_body'),
426 $this->getObjectTitle(),
427 $info['position']
428 )
429 );
430 $this->getMail()->appendInstallationSignature(true);
431 $this->sendMail(array($rcp));
432 }
433 break;
434 }
435 return true;
436 }
ilCourseMembershipMailNotification\isNotificationTypeEnabled
isNotificationTypeEnabled(int $a_type)
get setting "mail_crs_member_notification" and excludes types which are not affected by this setting ...
Definition: class.ilCourseMembershipMailNotification.php:491
ilMailNotification\getObjectTitle
getObjectTitle(bool $a_shorten=false)
Definition: class.ilMailNotification.php:213
ilMailNotification\sendMail
sendMail(array $a_rcp, bool $a_parse_recipients=true)
Definition: class.ilMailNotification.php:225
ilMailNotification\createPermanentLink
createPermanentLink(array $a_params=[], string $a_append='')
Definition: class.ilMailNotification.php:259
ilMailNotification\setSubject
setSubject(string $a_subject)
Definition: class.ilMailNotification.php:73
ilMail\getSalutation
static getSalutation(int $a_usr_id, ?ilLanguage $a_language=null)
Definition: class.ilMail.php:1452
ilObjectFactory\getInstanceByRefId
static getInstanceByRefId(int $ref_id, bool $stop_on_error=true)
get an instance of an Ilias object by reference id
Definition: class.ilObjectFactory.php:141
$info
$info
Definition: entry_point.php:21

References $info, ilMailNotification\appendBody(), createCourseStatus(), ilMailNotification\createPermanentLink(), ilMailNotification\getAdditionalInformation(), ilObjectFactory\getInstanceByRefId(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMailNotification\getObjectTitle(), ilMailNotification\getRecipients(), ilMailNotification\getRefId(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), initMail(), isNotificationTypeEnabled(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, TYPE_ADMISSION_MEMBER, TYPE_BLOCKED_MEMBER, TYPE_DISMISS_MEMBER, TYPE_NOTIFICATION_REGISTRATION, TYPE_NOTIFICATION_REGISTRATION_REQUEST, TYPE_NOTIFICATION_UNSUBSCRIBE, TYPE_REFUSED_SUBSCRIPTION_MEMBER, TYPE_STATUS_CHANGED, TYPE_SUBSCRIBE_MEMBER, TYPE_UNBLOCKED_MEMBER, TYPE_UNSUBSCRIBE_MEMBER, TYPE_WAITING_LIST_MEMBER, and ilMailNotification\userToString().

+ Here is the call graph for this function:

Field Documentation

◆ $force_sending_mail

bool ilCourseMembershipMailNotification::$force_sending_mail = false
private

Definition at line 62 of file class.ilCourseMembershipMailNotification.php.

◆ $permanent_enabled_notifications

array ilCourseMembershipMailNotification::$permanent_enabled_notifications
protected
Initial value:
= array(
self::TYPE_NOTIFICATION_REGISTRATION,
self::TYPE_NOTIFICATION_REGISTRATION_REQUEST,
self::TYPE_NOTIFICATION_UNSUBSCRIBE
)

Notifications which are not affected by "mail_crs_member_notification" setting because they addresses admins.

Definition at line 56 of file class.ilCourseMembershipMailNotification.php.

◆ $setting

ilSetting ilCourseMembershipMailNotification::$setting
protected

Definition at line 64 of file class.ilCourseMembershipMailNotification.php.

◆ TYPE_ACCEPTED_SUBSCRIPTION_MEMBER

const ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22

Definition at line 31 of file class.ilCourseMembershipMailNotification.php.

Referenced by ilMembershipGUI\assignSubscribers(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_ADMISSION_MEMBER

const ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER = 20

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

Referenced by ilMembershipGUI\assignFromWaitingList(), ilCourseMembershipGUI\assignMembers(), ilObjCourse\handleAutoFill(), ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), ilObjCourse\register(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_BLOCKED_MEMBER

const ilCourseMembershipMailNotification::TYPE_BLOCKED_MEMBER = 25

Definition at line 36 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), ilCourseParticipants\sendNotification(), and ilCourseMembershipGUI\updateParticipantsStatus().

◆ TYPE_DISMISS_MEMBER

const ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER = 21

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

Referenced by ilMembershipGUI\deleteParticipants(), ilCourseMembershipGUI\deleteParticipantsWithLinkedCourses(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_NOTIFICATION_ADMINS

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_ADMINS = 33

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

Referenced by ilCourseRegistrationGUI\add(), ilObjCourse\register(), and ilCourseParticipants\sendNotification().

◆ TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST = 34

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

Referenced by ilCourseRegistrationGUI\add(), and ilCourseParticipants\sendNotification().

◆ TYPE_NOTIFICATION_REGISTRATION

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION = 30

Definition at line 44 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), and ilCourseParticipants\sendNotificationToAdmins().

◆ TYPE_NOTIFICATION_REGISTRATION_REQUEST

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31

Definition at line 45 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), and ilCourseParticipants\sendSubscriptionRequestToAdmins().

◆ TYPE_NOTIFICATION_UNSUBSCRIBE

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE = 32

Definition at line 46 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), and ilCourseParticipants\sendUnsubscribeNotificationToAdmins().

◆ TYPE_REFUSED_SUBSCRIPTION_MEMBER

const ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23

Definition at line 32 of file class.ilCourseMembershipMailNotification.php.

Referenced by ilMembershipGUI\refuseFromList(), ilMembershipGUI\refuseSubscribers(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_STATUS_CHANGED

const ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED = 24

Definition at line 34 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), ilCourseParticipants\sendNotification(), and ilMembershipGUI\updateParticipants().

◆ TYPE_SUBSCRIBE_MEMBER

const ilCourseMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER = 28

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

Referenced by ilCourseRegistrationGUI\add(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_UNBLOCKED_MEMBER

const ilCourseMembershipMailNotification::TYPE_UNBLOCKED_MEMBER = 26

Definition at line 37 of file class.ilCourseMembershipMailNotification.php.

Referenced by send(), ilCourseParticipants\sendNotification(), and ilCourseMembershipGUI\updateParticipantsStatus().

◆ TYPE_UNSUBSCRIBE_MEMBER

const ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER = 27

Definition at line 39 of file class.ilCourseMembershipMailNotification.php.

Referenced by ilMembershipBlockGUI\confirmedRemove(), ilObjCourseGUI\performUnsubscribeObject(), send(), and ilCourseParticipants\sendNotification().

◆ TYPE_WAITING_LIST_MEMBER

const ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER = 29

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

Referenced by ilCourseRegistrationGUI\add(), ilObjCourse\register(), send(), and ilCourseParticipants\sendNotification().

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