This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSessionMembershipMailNotification:

Collaboration diagram for ilSessionMembershipMailNotification:

Public Member Functions
	__construct ()

	send (int $userId=0)

Public Member Functions inherited from ilMailNotification
	__construct (bool $a_is_personal_workspace=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_BLOCKED_MEMBER = 25

const	TYPE_UNBLOCKED_MEMBER = 26

const	TYPE_UNSUBSCRIBE_MEMBER = 27

const	TYPE_SUBSCRIBE_MEMBER = 28

const	TYPE_NOTIFICATION_REGISTRATION = 30

const	TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31

const	TYPE_NOTIFICATION_UNSUBSCRIBE = 32

const	TYPE_ENTER_NOTIFICATION = 100

const	TYPE_REGISTER_NOTIFICATION = 101

const	TYPE_UNREGISTER_NOTIFICATION = 102

Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initLanguage (int $a_usr_id)

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
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 = []

bool	$is_in_wsp

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSessionMembershipMailNotification::__construct ( )

Definition at line 53 of file class.ilSessionMembershipMailNotification.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ initLanguage()

ilSessionMembershipMailNotification::initLanguage ( int $a_usr_id )

protected

Definition at line 339 of file class.ilSessionMembershipMailNotification.php.

References ilMailNotification\getLanguage().

Referenced by send().

                                                   : void
     {
         parent::initLanguage($a_usr_id);
         $this->getLanguage()->loadLanguageModule('sess');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ilSessionMembershipMailNotification::send ( int $userId = 0 )

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

                                          : ?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;
     }