d6/d35/class_8ilSessionMembershipMailNotification_8php_source.html

 <?php

 declare(strict_types=1);

 class ilSessionMembershipMailNotification extends ilMailNotification
 {
     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_BLOCKED_MEMBER = 25;
     public const TYPE_UNBLOCKED_MEMBER = 26;

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

     public const TYPE_NOTIFICATION_REGISTRATION = 30;
     public const TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31;
     public const TYPE_NOTIFICATION_UNSUBSCRIBE = 32;

     public const TYPE_ENTER_NOTIFICATION = 100;
     public const TYPE_REGISTER_NOTIFICATION = 101;
     public const TYPE_UNREGISTER_NOTIFICATION = 102;

     protected ilSetting $setting;

     public function __construct()
     {
         global $DIC;

         $this->setting = $DIC->settings();

         parent::__construct();
     }

     public function send(int $userId = 0): ?bool
     {
         $ilSetting = $this->setting;

         // parent::send();

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

                 // automatic mails about status change disabled
                 if (!$ilSetting->get('mail_grp_member_notification')) {
                     return null;
                 }

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('grp_mail_admission_new_sub'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('grp_mail_admission_new_bod'), $this->getObjectTitle())
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('grp_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:

                 // automatic mails about status change disabled
                 if (!$ilSetting->get('mail_grp_member_notification')) {
                     return null;
                 }

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf($this->getLanguageText('grp_mail_dismiss_sub'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('grp_mail_dismiss_bod'), $this->getObjectTitle())
                     );
                     $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('grp_mail_subscribe_member_sub'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('grp_mail_subscribe_member_bod'), $this->getObjectTitle())
                     );

                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('grp_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_REQUEST:

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

                     $info = $this->getAdditionalInformation();
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('grp_mail_notification_reg_req_bod'),
                             $this->userToString($info['usr_id']),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('grp_mail_notification_reg_req_bod2'));
                     $this->appendBody("\n");
                     $this->appendBody($this->createPermanentLink([], '_mem'));

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

                     $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('sess_mail_sub_dec_sub'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('sess_mail_sub_dec_bod'), $this->getObjectTitle())
                     );

                     $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('sess_mail_sub_acc_sub'), $this->getObjectTitle(true))
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf($this->getLanguageText('sess_mail_sub_acc_bod'), $this->getObjectTitle())
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('sess_mail_permanent_link'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink());
                     $this->getMail()->appendInstallationSignature(true);

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

             case self::TYPE_ENTER_NOTIFICATION:
                 if (0 === $userId) {
                     throw new ilException('No user id given');
                 }

                 $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                 if (!($userObject instanceof \ilObjUser)) {
                     throw new ilException(sprintf('User with ID "%s" does not exist.', $userId));
                 }

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf(
                             $this->getLanguageText('session_mail_subject_entered'),
                             $userObject->getFullname(),
                             $this->getObjectTitle(true)
                         )
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('entered_notification'),
                             $userObject->getFullname(),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('sess_mail_permanent_link_participants'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink([], '_part'));
                     $this->getMail()->appendInstallationSignature(true);

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

             case self::TYPE_REGISTER_NOTIFICATION:
                 if (0 === $userId) {
                     throw new ilException('No user id given');
                 }

                 $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                 if (!($userObject instanceof \ilObjUser)) {
                     throw new ilException(sprintf('User with ID "%s" does not exist.', $userId));
                 }

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf(
                             $this->getLanguageText('session_mail_subject_registered'),
                             $userObject->getFullname(),
                             $this->getObjectTitle(true)
                         )
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('register_notification'),
                             $userObject->getFullname(),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('sess_mail_permanent_link_participants'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink([], '_part'));
                     $this->getMail()->appendInstallationSignature(true);

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

             case self::TYPE_UNREGISTER_NOTIFICATION:
                 if (0 === $userId) {
                     throw new ilException('No user id given');
                 }

                 $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                 if (!($userObject instanceof \ilObjUser)) {
                     throw new ilException(sprintf('User with ID "%s" does not exist.', $userId));
                 }

                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $this->initMail();
                     $this->setSubject(
                         sprintf(
                             $this->getLanguageText('session_mail_subject_deletion'),
                             $userObject->getFullname(),
                             $this->getObjectTitle(true)
                         )
                     );
                     $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                     $this->appendBody("\n\n");
                     $this->appendBody(
                         sprintf(
                             $this->getLanguageText('deletion_notification'),
                             $userObject->getFullname(),
                             $this->getObjectTitle()
                         )
                     );
                     $this->appendBody("\n\n");
                     $this->appendBody($this->getLanguageText('sess_mail_permanent_link_participants'));
                     $this->appendBody("\n\n");
                     $this->appendBody($this->createPermanentLink([], '_part'));
                     $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('sess');
     }
 }
ilMailNotification\getLanguage
getLanguage()
Definition: class.ilMailNotification.php:169

ilSessionMembershipMailNotification\__construct
__construct()
Definition: class.ilSessionMembershipMailNotification.php:53

ilSessionMembershipMailNotification\TYPE_UNREGISTER_NOTIFICATION
const TYPE_UNREGISTER_NOTIFICATION
Definition: class.ilSessionMembershipMailNotification.php:49

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

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

ilException

ilSessionMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST
const TYPE_NOTIFICATION_REGISTRATION_REQUEST
Definition: class.ilSessionMembershipMailNotification.php:44

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

ilSessionMembershipMailNotification\TYPE_DISMISS_MEMBER
const TYPE_DISMISS_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:31

ilSessionMembershipMailNotification
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilSessionMembershipMailNotification.php:28

ilSessionMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER
const TYPE_SUBSCRIBE_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:41

ilSessionMembershipMailNotification\TYPE_BLOCKED_MEMBER
const TYPE_BLOCKED_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:37

ilSessionMembershipMailNotification\send
send(int $userId=0)
Definition: class.ilSessionMembershipMailNotification.php:62

ilSessionMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER
const TYPE_UNSUBSCRIBE_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:40

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

$DIC
global $DIC
Definition: feed.php:28

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

ilMailNotification
Base class for course/group mail notifications.
Definition: class.ilMailNotification.php:26

ilObjUser

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

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

ilSessionMembershipMailNotification\initLanguage
initLanguage(int $a_usr_id)
Definition: class.ilSessionMembershipMailNotification.php:339

ilSessionMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION
const TYPE_NOTIFICATION_REGISTRATION
Definition: class.ilSessionMembershipMailNotification.php:43

ilSessionMembershipMailNotification\TYPE_REGISTER_NOTIFICATION
const TYPE_REGISTER_NOTIFICATION
Definition: class.ilSessionMembershipMailNotification.php:48

ilSessionMembershipMailNotification\TYPE_ADMISSION_MEMBER
const TYPE_ADMISSION_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:30

ilSessionMembershipMailNotification\$setting
ilSetting $setting
Definition: class.ilSessionMembershipMailNotification.php:51

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

ilSessionMembershipMailNotification\TYPE_ENTER_NOTIFICATION
const TYPE_ENTER_NOTIFICATION
Definition: class.ilSessionMembershipMailNotification.php:47

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

ilObjectFactory\getInstanceByObjId
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:84

ilSessionMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER
const TYPE_REFUSED_SUBSCRIPTION_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:34

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

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

$ilSetting
global $ilSetting
Definition: privfeed.php:17

ilSessionMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER
const TYPE_ACCEPTED_SUBSCRIPTION_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:33

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

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

ilSessionMembershipMailNotification\TYPE_UNBLOCKED_MEMBER
const TYPE_UNBLOCKED_MEMBER
Definition: class.ilSessionMembershipMailNotification.php:38

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

ilSessionMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE
const TYPE_NOTIFICATION_UNSUBSCRIBE
Definition: class.ilSessionMembershipMailNotification.php:45

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

ilSetting