Inheritance diagram for ilSessionMembershipMailNotification:

Collaboration diagram for ilSessionMembershipMailNotification:

Public Member Functions
	__construct ()

	send ($userId='')
	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_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 ($a_usr_id)
	Add language module crs. 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...

Additional Inherited Members
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

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.ilSessionMembershipMailNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilSessionMembershipMailNotification::__construct ( )

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

    {
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ initLanguage()

ilSessionMembershipMailNotification::initLanguage ( $a_usr_id )

protected

Add language module crs.

Parameters

object $a_usr_id

Returns

Reimplemented from ilMailNotification.

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

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

References ilMailNotification\getLanguage().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ilSessionMembershipMailNotification::send ( $userId = '' )

Send notifications.

Returns

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

    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
 
        // parent::send();
        
        switch ($this->getType()) {
            case self::TYPE_ADMISSION_MEMBER:
 
                // automatic mails about status change disabled
                if (!$ilSetting->get('mail_grp_member_notification', false)) {
                    return;
                }
                
                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', false)) {
                    return;
                }
                
                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(array(), '_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 ('' === $userId) {
                    throw new ilException('No user id given');
                }
 
                $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                if (!$userObject || !($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), array('system'));
                }
                break;
 
            case self::TYPE_REGISTER_NOTIFICATION:
                if ('' === $userId) {
                    throw new ilException('No user id given');
                }
 
                $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                if (!$userObject || !($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), array('system'));
                }
                break;
 
            case self::TYPE_UNREGISTER_NOTIFICATION:
                if ('' === $userId) {
                    throw new ilException('No user id given');
                }
 
                $userObject = ilObjectFactory::getInstanceByObjId($userId, false);
                if (!$userObject || !($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), array('system'));
                }
                break;
        }
        return true;
    }