d2/d48/class_8ilCourseMembershipMailNotification_8php_source.html

 <?php

 declare(strict_types=0);
 class ilCourseMembershipMailNotification extends ilMailNotification
 {
     // v Notifications affect members & co. v
     public const TYPE_ADMISSION_MEMBER = 20;
     public const TYPE_DISMISS_MEMBER = 21;

     public const TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22;
     public const TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23;

     public const TYPE_STATUS_CHANGED = 24;

     public const TYPE_BLOCKED_MEMBER = 25;
     public const TYPE_UNBLOCKED_MEMBER = 26;

     public const TYPE_UNSUBSCRIBE_MEMBER = 27;
     public const TYPE_SUBSCRIBE_MEMBER = 28;
     public const TYPE_WAITING_LIST_MEMBER = 29;

     // v Notifications affect admins v
     public const TYPE_NOTIFICATION_REGISTRATION = 30;
     public const TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31;
     public const TYPE_NOTIFICATION_UNSUBSCRIBE = 32;

     public const TYPE_NOTIFICATION_ADMINS = 33;
     public const TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST = 34;

     protected array $permanent_enabled_notifications = array(
         self::TYPE_NOTIFICATION_REGISTRATION,
         self::TYPE_NOTIFICATION_REGISTRATION_REQUEST,
         self::TYPE_NOTIFICATION_UNSUBSCRIBE
     );

     private bool $force_sending_mail = false;

     protected ilSetting $setting;

     public function __construct()
     {
         global $DIC;

         $this->setting = $DIC->settings();
         parent::__construct(false);
     }

     protected function initMail(): ilMail
     {
         parent::initMail();
         $this->mail = $this->mail->withContextParameters([
             ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
                 ilObject::_lookupObjId($this->getRefId()),
                 ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
                 ''
             ),
         ]);

         return $this->mail;
     }

     public function forceSendingMail(bool $a_status): void
     {
         $this->force_sending_mail = $a_status;
     }

     public function send(): bool
     {
         if (
             $this->getRefId() &&
             in_array($this->getType(), array(self::TYPE_ADMISSION_MEMBER))) {
             $obj = ilObjectFactory::getInstanceByRefId($this->getRefId());

             if ($obj->getAutoNotification() == false) {
                 if (!$this->force_sending_mail) {
                     return false;
                 }
             }
         }
         if (!$this->isNotificationTypeEnabled($this->getType())) {
             return false;
         }
         // #11359
         // parent::send();

         switch ($this->getType()) {
             case self::TYPE_ADMISSION_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_added_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_added_member_body'), $this->getObjectTitle())
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());
                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_accept_subscriber'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_accept_subscriber_body'), $this->getObjectTitle())
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());
                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_REFUSED_SUBSCRIPTION_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_reject_subscriber'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_reject_subscriber_body'), $this->getObjectTitle())
                     );

                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_STATUS_CHANGED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_status_changed'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_status_changed_body'), $this->getObjectTitle())
                     );

                     $this->appendBody("\n\n");
                     $this->appendBody($this->createCourseStatus($rcp));

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());

                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_DISMISS_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_dismiss_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_dismiss_member_body'), $this->getObjectTitle())
                     );
                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_BLOCKED_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_blocked_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_blocked_member_body'), $this->getObjectTitle())
                     );
                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_UNBLOCKED_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_unblocked_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_unblocked_member_body'), $this->getObjectTitle())
                     );

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());
                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_NOTIFICATION_REGISTRATION:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_new_subscription'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");

                     $info = $this->getAdditionalInformation();
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('crs_new_subscription_body'),
                             $this->userToString($info['usr_id']),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink(array(), 'mem'));

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));

                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_NOTIFICATION_REGISTRATION_REQUEST:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_new_subscription_request'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");

                     $info = $this->getAdditionalInformation();
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('crs_new_subscription_request_body'),
                             $this->userToString($info['usr_id']),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_new_subscription_request_body2'));
                     $this->appendBody("\n");
                     $this->appendBody($this->createPermanentLink(array(), 'mem'));

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));

                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_NOTIFICATION_UNSUBSCRIBE:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_cancel_subscription'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");

                     $info = $this->getAdditionalInformation();
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('crs_cancel_subscription_body'),
                             $this->userToString($info['usr_id']),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_cancel_subscription_body2'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink(array(), 'mem'));

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_notification_explanation_admin'));

                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_UNSUBSCRIBE_MEMBER:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_unsubscribe_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_unsubscribe_member_body'), $this->getObjectTitle())
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_unsubscribe_member_explanation'));
                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_SUBSCRIBE_MEMBER:

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_subscribe_member'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('crs_subscribe_member_body'), $this->getObjectTitle())
                     );

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('crs_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());
                     $this->getMail()->appendInstallationSignature(true);

                     $this->sendMail(array($rcp));
                 }
                 break;

             case self::TYPE_WAITING_LIST_MEMBER:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('crs_subscribe_wl'), $this->getObjectTitle(true))
                     );

                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));

                     $info = $this->getAdditionalInformation();
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('crs_subscribe_wl_body'),
                             $this->getObjectTitle(),
                             $info['position']
                         )
                     );
                     $this->getMail()->appendInstallationSignature(true);
                     $this->sendMail(array($rcp));
                 }
                 break;
         }
         return true;
     }

     protected function initLanguage(int $a_usr_id): void
     {
         parent::initLanguage($a_usr_id);
         $this->getLanguage()->loadLanguageModule('crs');
     }

     protected function createCourseStatus(int $a_usr_id): string
     {
         $part = ilCourseParticipants::_getInstanceByObjId($this->getObjId());

         $body = $this->getLanguageText('crs_new_status') . "\n";
         $body .= $this->getLanguageText('role') . ': ';

         if ($part->isAdmin($a_usr_id)) {
             $body .= $this->getLanguageText('crs_admin') . "\n";
         } elseif ($part->isTutor($a_usr_id)) {
             $body .= $this->getLanguageText('crs_tutor') . "\n";
         } else {
             $body .= $this->getLanguageText('crs_member') . "\n";
         }

         if ($part->isAdmin($a_usr_id) || $part->isTutor($a_usr_id)) {
             $body .= $this->getLanguageText('crs_status') . ': ';

             if ($part->isNotificationEnabled($a_usr_id)) {
                 $body .= $this->getLanguageText('crs_notify') . "\n";
             } else {
                 $body .= $this->getLanguageText('crs_no_notify') . "\n";
             }
         } else {
             $body .= $this->getLanguageText('crs_access') . ': ';

             if ($part->isBlocked($a_usr_id)) {
                 $body .= $this->getLanguageText('crs_blocked') . "\n";
             } else {
                 $body .= $this->getLanguageText('crs_unblocked') . "\n";
             }
         }

         $body .= $this->getLanguageText('crs_passed') . ': ';

         if ($part->hasPassed($a_usr_id)) {
             $body .= $this->getLanguageText('yes');
         } else {
             $body .= $this->getLanguageText('no');
         }
         return $body;
     }

     protected function isNotificationTypeEnabled(int $a_type): bool
     {
         return
             $this->force_sending_mail ||
             $this->setting->get('mail_crs_member_notification', '1') ||
             in_array($a_type, $this->permanent_enabled_notifications);
     }
 }
ilMailNotification\getLanguage
getLanguage()
Definition: class.ilMailNotification.php:164

ilMailNotification

ilMailNotification\getType
getType()
Definition: class.ilMailNotification.php:63

ilCourseMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE
const TYPE_NOTIFICATION_UNSUBSCRIBE
Definition: class.ilCourseMembershipMailNotification.php:46

ilCourseMembershipMailNotification\$setting
ilSetting $setting
Definition: class.ilCourseMembershipMailNotification.php:64

ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER
const TYPE_ADMISSION_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:28

ilMailNotification\appendBody
appendBody(string $a_body)
Definition: class.ilMailNotification.php:97

ilCourseMembershipMailNotification\initLanguage
initLanguage(int $a_usr_id)
Definition: class.ilCourseMembershipMailNotification.php:438

ilCourseMembershipMailNotification\TYPE_STATUS_CHANGED
const TYPE_STATUS_CHANGED
Definition: class.ilCourseMembershipMailNotification.php:34

ilCourseMembershipMailNotification\TYPE_BLOCKED_MEMBER
const TYPE_BLOCKED_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:36

ilCourseMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER
const TYPE_ACCEPTED_SUBSCRIPTION_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:31

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

ilCourseMembershipMailNotification\TYPE_WAITING_LIST_MEMBER
const TYPE_WAITING_LIST_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:41

ilMailNotification\sendMail
sendMail(array $a_rcp, bool $a_parse_recipients=true)
Definition: class.ilMailNotification.php:230

ilMailNotification\$mail
ilMail $mail
Definition: class.ilMailNotification.php:32

ilCourseMembershipMailNotification\createCourseStatus
createCourseStatus(int $a_usr_id)
Definition: class.ilCourseMembershipMailNotification.php:444

ilCourseMembershipMailNotification\TYPE_DISMISS_MEMBER
const TYPE_DISMISS_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:29

ilMailNotification\$body
string $body
Definition: class.ilMailNotification.php:34

ilMail\PROP_CONTEXT_SUBJECT_PREFIX
const PROP_CONTEXT_SUBJECT_PREFIX
Definition: class.ilMail.php:34

ilCourseMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER
const TYPE_REFUSED_SUBSCRIPTION_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:32

ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST
const TYPE_NOTIFICATION_REGISTRATION_REQUEST
Definition: class.ilCourseMembershipMailNotification.php:45

ilCourseMembershipMailNotification\TYPE_UNBLOCKED_MEMBER
const TYPE_UNBLOCKED_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:37

ilMailNotification\getObjId
getObjId()
Definition: class.ilMailNotification.php:192

ilCourseMembershipMailNotification\TYPE_NOTIFICATION_ADMINS
const TYPE_NOTIFICATION_ADMINS
Definition: class.ilCourseMembershipMailNotification.php:48

ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:923

ilMailNotification\userToString
userToString(int $a_usr_id)
Definition: class.ilMailNotification.php:275

ilMailNotification\getAdditionalInformation
getAdditionalInformation()
Definition: class.ilMailNotification.php:213

ilObjectServiceSettingsGUI\EXTERNAL_MAIL_PREFIX
const EXTERNAL_MAIL_PREFIX
Definition: class.ilObjectServiceSettingsGUI.php:57

ilCourseMembershipMailNotification
Definition: class.ilCourseMembershipMailNotification.php:25

ilMail

ilCourseMembershipMailNotification\__construct
__construct()
Definition: class.ilCourseMembershipMailNotification.php:66

ilCourseParticipants\_getInstanceByObjId
static _getInstanceByObjId(int $a_obj_id)
Definition: class.ilCourseParticipants.php:40

ilMail\getSalutation
static getSalutation(int $a_usr_id, ?ilLanguage $a_language=null)
Definition: class.ilMail.php:1386

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

ilCourseMembershipMailNotification\forceSendingMail
forceSendingMail(bool $a_status)
Force sending mail independent from global setting.
Definition: class.ilCourseMembershipMailNotification.php:94

$DIC
global $DIC
Definition: shib_login.php:22

ilCourseMembershipMailNotification\TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST
const TYPE_NOTIFICATION_ADMINS_REGISTRATION_REQUEST
Definition: class.ilCourseMembershipMailNotification.php:49

ilMailNotification\getLanguageText
getLanguageText(string $a_keyword)
Definition: class.ilMailNotification.php:169

ilMailNotification\getRefId
getRefId()
Definition: class.ilMailNotification.php:187

ilCourseMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION
const TYPE_NOTIFICATION_REGISTRATION
Definition: class.ilCourseMembershipMailNotification.php:44

ilMailNotification\getRecipients
getRecipients()
Definition: class.ilMailNotification.php:112

ilCourseMembershipMailNotification\$force_sending_mail
bool $force_sending_mail
Definition: class.ilCourseMembershipMailNotification.php:62

ilMailNotification\getObjectTitle
getObjectTitle(bool $a_shorten=false)
Definition: class.ilMailNotification.php:218

ilMailNotification\createPermanentLink
createPermanentLink(array $a_params=[], string $a_append='')
Definition: class.ilMailNotification.php:264

ilCourseMembershipMailNotification\initMail
initMail()
Definition: class.ilCourseMembershipMailNotification.php:77

ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37

ilMailNotification\setBody
setBody(string $a_body)
Definition: class.ilMailNotification.php:92

ilCourseMembershipMailNotification\send
send()
Definition: class.ilCourseMembershipMailNotification.php:99

ilMailNotification\setSubject
setSubject(string $a_subject)
Definition: class.ilMailNotification.php:78

ilMailNotification\getMail
getMail()
Definition: class.ilMailNotification.php:259

ilContainer\_lookupContainerSetting
static _lookupContainerSetting(int $a_id, string $a_keyword, ?string $a_default_value=null)
Definition: class.ilContainer.php:254

ilCourseMembershipMailNotification\$permanent_enabled_notifications
array $permanent_enabled_notifications
Notifications which are not affected by "mail_crs_member_notification" setting because they addresses...
Definition: class.ilCourseMembershipMailNotification.php:56

ilCourseMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER
const TYPE_UNSUBSCRIBE_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:39

ilSetting

ilCourseMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER
const TYPE_SUBSCRIBE_MEMBER
Definition: class.ilCourseMembershipMailNotification.php:40