ILIAS  release_7 Revision v7.30-3-g800a261c036
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 ($a_status)
 Force sending mail independent from global setting. More...
 
 send ()
 Send notifications. More...
 
- Public Member Functions inherited from ilMailNotification
 __construct ($a_is_personal_workspace=false)
 
 setType ($a_type)
 Set notification type. More...
 
 getType ()
 Get notification type. More...
 
 setSender ($a_usr_id)
 Set sender of mail. More...
 
 getSender ()
 get sender of mail More...
 
 setRecipients (array $a_rcp)
 
 getRecipients ()
 get array of recipients More...
 
 setAttachments ($a_att)
 Set attachments. More...
 
 getAttachments ()
 Get attachments. More...
 
 setLangModules (array $a_modules)
 Set lang modules. More...
 
 getUserLanguage ($a_usr_id)
 Get user language. More...
 
 setRefId ($a_id)
 
 getRefId ()
 
 getObjId ()
 
 setObjId ($a_obj_id)
 
 getObjType ()
 Get object type. More...
 
 setAdditionalInformation (array $a_info)
 Additional information for creating notification mails. More...
 
 getAdditionalInformation ()
 
 sendMail (array $a_rcp, $a_parse_recipients=true)
 
 getBlockBorder ()
 Get (ascii) block border. More...
 

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
 
- Data Fields inherited from ilMailNotification
const SUBJECT_TITLE_LENGTH = 60
 

Protected Member Functions

 initMail ()
 
 initLanguage ($a_usr_id)
 Add language module crs. More...
 
 createCourseStatus ($a_usr_id)
 Get course status body. More...
 
 isNotificationTypeEnabled ($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 ($a_subject)
 
 getSubject ()
 
 setBody ($a_body)
 
 appendBody ($a_body)
 Append body text. More...
 
 getBody ()
 
 initLanguage ($a_usr_id)
 Init language. More...
 
 initLanguageByIso2Code ($a_code='')
 Init language by ISO2 code. More...
 
 setLanguage ($a_language)
 
 getLanguage ()
 
 getLanguageText ($a_keyword)
 
 getObjectTitle ($a_shorten=false)
 
 initMail ()
 
 getMail ()
 
 createPermanentLink ($a_params=array(), $a_append='')
 
 userToString ($a_usr_id)
 
 isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
 Check if ref id is accessible for user. More...
 

Protected Attributes

 $permanent_enabled_notifications
 Notifications which are not affected by "mail_crs_member_notification" setting because they addresses admins. More...
 
- Protected Attributes inherited from ilMailNotification
 $type = null
 
 $sender = null
 
 $mail = null
 
 $subject = ''
 
 $body = ''
 
 $attachments = array()
 
 $language = null
 
 $lang_modules = array()
 
 $recipients = array()
 
 $ref_id = null
 
 $obj_id = null
 
 $obj_type = null
 
 $additional_info = array()
 
 $is_in_wsp
 
 $wsp_tree
 
 $wsp_access_handler
 

Private Attributes

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseMembershipMailNotification::__construct ( )

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

References ILIAS\GlobalScreen\Provider\__construct().

53  {
54  parent::__construct();
55  }
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:40
+ Here is the call graph for this function:

Member Function Documentation

◆ createCourseStatus()

ilCourseMembershipMailNotification::createCourseStatus (   $a_usr_id)
protected

Get course status body.

Parameters
int$a_usr_id
Returns
string

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

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

Referenced by send().

448  {
449  $part = ilCourseParticipants::_getInstanceByObjId($this->getObjId());
450 
451  $body = $this->getLanguageText('crs_new_status') . "\n";
452  $body .= $this->getLanguageText('role') . ': ';
453 
454 
455  if ($part->isAdmin($a_usr_id)) {
456  $body .= $this->getLanguageText('crs_admin') . "\n";
457  } elseif ($part->isTutor($a_usr_id)) {
458  $body .= $this->getLanguageText('crs_tutor') . "\n";
459  } else {
460  $body .= $this->getLanguageText('crs_member') . "\n";
461  }
462 
463  if ($part->isAdmin($a_usr_id) or $part->isTutor($a_usr_id)) {
464  $body .= $this->getLanguageText('crs_status') . ': ';
465 
466  if ($part->isNotificationEnabled($a_usr_id)) {
467  $body .= $this->getLanguageText('crs_notify') . "\n";
468  } else {
469  $body .= $this->getLanguageText('crs_no_notify') . "\n";
470  }
471  } else {
472  $body .= $this->getLanguageText('crs_access') . ': ';
473 
474  if ($part->isBlocked($a_usr_id)) {
475  $body .= $this->getLanguageText('crs_blocked') . "\n";
476  } else {
477  $body .= $this->getLanguageText('crs_unblocked') . "\n";
478  }
479  }
480 
481  $body .= $this->getLanguageText('crs_passed') . ': ';
482 
483  if ($part->hasPassed($a_usr_id)) {
484  $body .= $this->getLanguageText('yes');
485  } else {
486  $body .= $this->getLanguageText('no');
487  }
488  return $body;
489  }
ilCourseParticipants\_getInstanceByObjId
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
Definition: class.ilCourseParticipants.php:77
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ forceSendingMail()

ilCourseMembershipMailNotification::forceSendingMail (   $a_status)

Force sending mail independent from global setting.

Parameters
type$a_status

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

79  {
80  $this->force_sending_mail = $a_status;
81  }

◆ initLanguage()

ilCourseMembershipMailNotification::initLanguage (   $a_usr_id)
protected

Add language module crs.

Parameters
object$a_usr_id
Returns

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

References ilMailNotification\getLanguage().

Referenced by send().

437  {
438  parent::initLanguage($a_usr_id);
439  $this->getLanguage()->loadLanguageModule('crs');
440  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initMail()

ilCourseMembershipMailNotification::initMail ( )
protected

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

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

Referenced by send().

60  : ilMail
61  {
62  parent::initMail();
63  $this->mail = $this->mail->withContextParameters([
64  ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
65  ilObject::_lookupObjId($this->getRefId()),
66  ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
67  ''
68  ),
69  ]);
70 
71  return $this->mail;
72  }
ilMail\PROP_CONTEXT_SUBJECT_PREFIX
const PROP_CONTEXT_SUBJECT_PREFIX
Definition: class.ilMail.php:13
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1110
ilContainer\_lookupContainerSetting
static _lookupContainerSetting($a_id, $a_keyword, $a_default_value=null)
Lookup a container setting.
Definition: class.ilContainer.php:395
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isNotificationTypeEnabled()

ilCourseMembershipMailNotification::isNotificationTypeEnabled (   $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

Parameters
int$a_type
Returns
bool

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

References $DIC, and $ilSetting.

Referenced by send().

499  {
500  global $DIC;
501 
502  $ilSetting = $DIC['ilSetting'];
503 
504  return
505  $this->force_sending_mail ||
506  $ilSetting->get('mail_crs_member_notification', true) ||
507  in_array($a_type, $this->permanent_enabled_notifications);
508  }
$DIC
global $DIC
Definition: goto.php:24
$ilSetting
global $ilSetting
Definition: privfeed.php:17
+ Here is the caller graph for this function:

◆ send()

ilCourseMembershipMailNotification::send ( )

Send notifications.

Returns

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

References 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(), and ilMailNotification\userToString().

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

Field Documentation

◆ $force_sending_mail

ilCourseMembershipMailNotification::$force_sending_mail = false
private

Definition at line 46 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 40 of file class.ilCourseMembershipMailNotification.php.

◆ TYPE_ACCEPTED_SUBSCRIPTION_MEMBER

const ilCourseMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_ADMISSION_MEMBER

const ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER = 20

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_BLOCKED_MEMBER

const ilCourseMembershipMailNotification::TYPE_BLOCKED_MEMBER = 25

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_DISMISS_MEMBER

const ilCourseMembershipMailNotification::TYPE_DISMISS_MEMBER = 21

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_NOTIFICATION_REGISTRATION

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION = 30

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

Referenced by ilCourseParticipants\sendNotificationToAdmins().

◆ TYPE_NOTIFICATION_REGISTRATION_REQUEST

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31

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

Referenced by ilCourseParticipants\sendSubscriptionRequestToAdmins().

◆ TYPE_NOTIFICATION_UNSUBSCRIBE

const ilCourseMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE = 32

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

Referenced by ilCourseParticipants\sendUnsubscribeNotificationToAdmins().

◆ TYPE_REFUSED_SUBSCRIPTION_MEMBER

const ilCourseMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_STATUS_CHANGED

const ilCourseMembershipMailNotification::TYPE_STATUS_CHANGED = 24

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_SUBSCRIBE_MEMBER

const ilCourseMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER = 28

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_UNBLOCKED_MEMBER

const ilCourseMembershipMailNotification::TYPE_UNBLOCKED_MEMBER = 26

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_UNSUBSCRIBE_MEMBER

const ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER = 27

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

Referenced by ilCourseParticipants\sendNotification().

◆ TYPE_WAITING_LIST_MEMBER

const ilCourseMembershipMailNotification::TYPE_WAITING_LIST_MEMBER = 29

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

Referenced by ilCourseParticipants\sendNotification().

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