ilGroupMembershipMailNotification Class Reference

Inheritance diagram for ilGroupMembershipMailNotification:

Collaboration diagram for ilGroupMembershipMailNotification:

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_type, $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
	initLanguage ($a_usr_id)
	Add language module crs. More...
	createGroupStatus ($a_usr_id)
	Get course status body. More...
	isNotificationTypeEnabled ($a_type)
	get setting "mail_grp_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_grp_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.ilGroupMembershipMailNotification.php.

Constructor & Destructor Documentation

__construct()

ilGroupMembershipMailNotification::__construct

(

)

Definition at line 54 of file class.ilGroupMembershipMailNotification.php.

    {
        parent::__construct();
    }

Member Function Documentation

createGroupStatus()

ilGroupMembershipMailNotification::createGroupStatus (   $a_usr_id )

protected

Get course status body.

Parameters

int

$a_usr_id

Returns

string

Definition at line 380 of file class.ilGroupMembershipMailNotification.php.

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

Referenced by send().

    {
        $part = ilGroupParticipants::_getInstanceByObjId($this->getObjId());
        
        $body = $this->getLanguageText('grp_new_status') . "\n";
        $body .= $this->getLanguageText('role') . ': ';
        
        
        if ($part->isAdmin($a_usr_id)) {
            $body .= $this->getLanguageText('il_grp_admin') . "\n";
        } else {
            $body .= $this->getLanguageText('il_grp_member') . "\n";
        }

        if ($part->isAdmin($a_usr_id)) {
            $body .= $this->getLanguageText('grp_notification') . ': ';
            
            if ($part->isNotificationEnabled($a_usr_id)) {
                $body .= $this->getLanguageText('grp_notify_on') . "\n";
            } else {
                $body .= $this->getLanguageText('grp_notify_off') . "\n";
            }
        }
        return $body;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

forceSendingMail()

ilGroupMembershipMailNotification::forceSendingMail

(

$a_status

)

Force sending mail independent from global setting.

Parameters

type

$a_status

Definition at line 63 of file class.ilGroupMembershipMailNotification.php.

    {
        $this->force_sending_mail = $a_status;
    }

initLanguage()

ilGroupMembershipMailNotification::initLanguage (   $a_usr_id )

protected

Add language module crs.

Parameters

object

$a_usr_id

Returns

Definition at line 369 of file class.ilGroupMembershipMailNotification.php.

References ilMailNotification\getLanguage().

Referenced by send().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isNotificationTypeEnabled()

ilGroupMembershipMailNotification::isNotificationTypeEnabled (   $a_type )

protected

get setting "mail_grp_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 413 of file class.ilGroupMembershipMailNotification.php.

References $a_type, and $ilSetting.

Referenced by send().

    {
        global $ilSetting;

        return
            $this->force_sending_mail ||
            $ilSetting->get('mail_grp_member_notification', true) ||
            in_array($a_type, $this->permanent_enabled_notifications);
    }

Here is the caller graph for this function:

send()

ilGroupMembershipMailNotification::send

(

)

Send notifications.

Returns

Definition at line 74 of file class.ilGroupMembershipMailNotification.php.

References $GLOBALS, $info, ilMailNotification\appendBody(), array, createGroupStatus(), ilMailNotification\createPermanentLink(), ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMailNotification\getObjectTitle(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), isNotificationTypeEnabled(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), and ilMailNotification\userToString().

    {
        if (!$this->isNotificationTypeEnabled($this->getType())) {
            $GLOBALS['DIC']->logger()->grp()->info('Membership mail disabled globally.');
            return false;
        }
        // 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('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), array('system'));
                }
                break;
                
            case self::TYPE_DISMISS_MEMBER:
                
                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), array('system'));
                }
                break;
                
                
            case self::TYPE_NOTIFICATION_REGISTRATION:
                
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_notification_reg_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_bod'),
                            $this->userToString($info['usr_id']),
                            $this->getObjectTitle()
                        )
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('grp_mail_permanent_link'));
                    $this->appendBody("\n\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), array('system'));
                }
                break;
                
            case self::TYPE_UNSUBSCRIBE_MEMBER:
                
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_unsubscribe_member_sub'), $this->getObjectTitle(true))
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf($this->getLanguageText('grp_mail_unsubscribe_member_bod'), $this->getObjectTitle())
                    );
                    $this->getMail()->appendInstallationSignature(true);
                    $this->sendMail(array($rcp), array('system'));
                }
                break;
                
            case self::TYPE_NOTIFICATION_UNSUBSCRIBE:

                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_notification_unsub_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_unsub_bod'),
                            $this->userToString($info['usr_id']),
                            $this->getObjectTitle()
                        )
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('grp_mail_notification_unsub_bod2'));
                    $this->appendBody("\n\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), array('system'));
                }
                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), array('system'));
                }
                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), array('system'));
                }
                break;

            case self::TYPE_REFUSED_SUBSCRIPTION_MEMBER:

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

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

            case self::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER:

                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_sub_acc_sub'), $this->getObjectTitle(true))
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf($this->getLanguageText('grp_mail_sub_acc_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), array('system'));
                }
                break;
                
            case self::TYPE_WAITING_LIST_MEMBER:
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_wl_sub'), $this->getObjectTitle(true))
                    );
                    
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    
                    $info = $this->getAdditionalInformation();
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf(
                            $this->getLanguageText('grp_mail_wl_bod'),
                            $this->getObjectTitle(),
                            $info['position']
                        )
                    );
                    $this->getMail()->appendInstallationSignature(true);
                    $this->sendMail(array($rcp), array('system'));
                }
                break;
                
                
            case self::TYPE_STATUS_CHANGED:
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf($this->getLanguageText('grp_mail_status_sub'), $this->getObjectTitle(true))
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf($this->getLanguageText('grp_mail_status_bod'), $this->getObjectTitle())
                    );
                    
                    $this->appendBody("\n\n");
                    $this->appendBody($this->createGroupStatus($rcp));

                    $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), array('system'));
                }
                break;

        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$force_sending_mail

ilGroupMembershipMailNotification::$force_sending_mail = false

private

Definition at line 46 of file class.ilGroupMembershipMailNotification.php.

$permanent_enabled_notifications

array ilGroupMembershipMailNotification::$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_grp_member_notification" setting because they addresses admins.

Definition at line 40 of file class.ilGroupMembershipMailNotification.php.

TYPE_ACCEPTED_SUBSCRIPTION_MEMBER

const ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22

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

Referenced by ilMembershipGUI\assignFromWaitingList(), ilMembershipGUI\assignSubscribers(), ilObjGroup\handleAutoFill(), and ilGroupParticipants\sendNotification().

TYPE_ADMISSION_MEMBER

const ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER = 20

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

Referenced by ilCourseParticipantsGroupsGUI\add(), ilGroupAddToGroupActionGUI\addUser(), ilGroupMembershipGUI\assignMembers(), ilGroupAddToGroupActionGUI\createGroupAndAddUser(), ilObjGroup\register(), and ilGroupParticipants\sendNotification().

TYPE_BLOCKED_MEMBER

const ilGroupMembershipMailNotification::TYPE_BLOCKED_MEMBER = 25

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

TYPE_DISMISS_MEMBER

const ilGroupMembershipMailNotification::TYPE_DISMISS_MEMBER = 21

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

Referenced by ilMembershipGUI\deleteParticipants(), ilCourseParticipantsGroupsGUI\remove(), and ilGroupParticipants\sendNotification().

TYPE_NOTIFICATION_REGISTRATION

const ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION = 30

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

Referenced by ilGroupRegistrationGUI\add(), ilObjGroup\register(), and ilGroupParticipants\sendNotification().

TYPE_NOTIFICATION_REGISTRATION_REQUEST

const ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31

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

Referenced by ilGroupRegistrationGUI\add(), and ilGroupParticipants\sendNotification().

TYPE_NOTIFICATION_UNSUBSCRIBE

const ilGroupMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE = 32

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

Referenced by ilPDSelectedItemsBlockGUI\confirmedUnsubscribe(), ilGroupParticipants\sendNotification(), and ilObjGroupGUI\unsubscribeObject().

TYPE_REFUSED_SUBSCRIPTION_MEMBER

const ilGroupMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23

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

Referenced by ilMembershipGUI\refuseFromList(), ilMembershipGUI\refuseSubscribers(), and ilGroupParticipants\sendNotification().

TYPE_STATUS_CHANGED

const ilGroupMembershipMailNotification::TYPE_STATUS_CHANGED = 24

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

Referenced by ilGroupParticipants\sendNotification().

TYPE_SUBSCRIBE_MEMBER

const ilGroupMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER = 28

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

Referenced by ilGroupRegistrationGUI\add(), and ilGroupParticipants\sendNotification().

TYPE_UNBLOCKED_MEMBER

const ilGroupMembershipMailNotification::TYPE_UNBLOCKED_MEMBER = 26

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

TYPE_UNSUBSCRIBE_MEMBER

const ilGroupMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER = 27

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

Referenced by ilPDSelectedItemsBlockGUI\confirmedUnsubscribe(), ilGroupParticipants\sendNotification(), and ilObjGroupGUI\unsubscribeObject().

TYPE_WAITING_LIST_MEMBER

const ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER = 29

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

Referenced by ilGroupRegistrationGUI\add(), ilObjGroup\register(), and ilGroupParticipants\sendNotification().

---

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

• Modules/Group/classes/class.ilGroupMembershipMailNotification.php