ilLearningSequenceMembershipMailNotification Class Reference

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

Inheritance diagram for ilLearningSequenceMembershipMailNotification:

Collaboration diagram for ilLearningSequenceMembershipMailNotification:

Public Member Functions
	__construct (ilLogger $logger, ilSetting $settings)
	forceSendingMail (bool $status)
	send ()
Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=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_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
final const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initLanguage (int $usr_id)
	createLearningSequenceStatus (int $usr_id)
	isNotificationTypeEnabled (int $type)
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
array	$permanent_enabled_notifications
	Notifications which are not affected by "mail_grp_member_notification" setting because they addresses admins. More...
ilLogger	$logger
ilSetting	$settings
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 = []
ilWorkspaceTree	$wsp_tree
ilWorkspaceAccessHandler	$wsp_access_handler

Private Attributes
bool	$force_sending_mail = false

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

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

Constructor & Destructor Documentation

__construct()

ilLearningSequenceMembershipMailNotification::__construct	(	ilLogger	$logger,
		ilSetting	$settings
	)

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

References $logger, $settings, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

    {
        parent::__construct();

        $this->logger = $logger;
        $this->settings = $settings;
    }

Here is the call graph for this function:

Member Function Documentation

createLearningSequenceStatus()

ilLearningSequenceMembershipMailNotification::createLearningSequenceStatus ( int  $usr_id )

protected

Definition at line 388 of file class.ilLearningSequenceMembershipMailNotification.php.

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

Referenced by send().

                                                                : string
    {
        $part = ilLearningSequenceParticipants::_getInstanceByObjId($this->getObjId());
        $body = $this->getLanguageText('lso_new_status') . "\n";
        $body .= $this->getLanguageText('role') . ': ';

        if ($part->isAdmin($usr_id)) {
            $body .= $this->getLanguageText('il_lso_admin') . "\n";
        } else {
            $body .= $this->getLanguageText('il_lso_member') . "\n";
        }

        if ($part->isAdmin($usr_id)) {
            $body .= $this->getLanguageText('lso_notification') . ': ';

            if ($part->isNotificationEnabled($usr_id)) {
                $body .= $this->getLanguageText('lso_notify_on') . "\n";
            } else {
                $body .= $this->getLanguageText('lso_notify_off') . "\n";
            }
        }

        return $body;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

forceSendingMail()

ilLearningSequenceMembershipMailNotification::forceSendingMail

(

bool

$status

)

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

                                                  : void
    {
        $this->force_sending_mail = $status;
    }

initLanguage()

ilLearningSequenceMembershipMailNotification::initLanguage ( int  $usr_id )

protected

Definition at line 382 of file class.ilLearningSequenceMembershipMailNotification.php.

References ilMailNotification\getLanguage().

Referenced by send().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isNotificationTypeEnabled()

ilLearningSequenceMembershipMailNotification::isNotificationTypeEnabled ( int  $type )

protected

Definition at line 413 of file class.ilLearningSequenceMembershipMailNotification.php.

References ILIAS\Repository\settings().

Referenced by send().

                                                           : bool
    {
        return (
            $this->force_sending_mail ||
            $this->settings->get('mail_lso_member_notification', "true") ||
            in_array($type, $this->permanent_enabled_notifications)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilLearningSequenceMembershipMailNotification::send

(

)

Definition at line 67 of file class.ilLearningSequenceMembershipMailNotification.php.

References ilMailNotification\appendBody(), createLearningSequenceStatus(), ilMailNotification\createPermanentLink(), ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMailNotification\getObjectTitle(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), isNotificationTypeEnabled(), ILIAS\Repository\logger(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), and ilMailNotification\userToString().

                          : bool
    {
        if (!$this->isNotificationTypeEnabled($this->getType())) {
            $this->logger->info('Membership mail disabled globally.');
            return false;
        }

        switch ($this->getType()) {
            case self::TYPE_ADMISSION_MEMBER:
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(sprintf(
                        $this->getLanguageText('lso_mail_admission_new_sub'),
                        $this->getObjectTitle(true)
                    ));
                    $this->setBody(ilMail::getSalutation(
                        $rcp,
                        $this->getLanguage()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('lso_mail_admission_new_bod'),
                        $this->getObjectTitle()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText('lso_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('lso_mail_dismiss_sub'),
                        $this->getObjectTitle(true)
                    ));
                    $this->setBody(ilMail::getSalutation(
                        $rcp,
                        $this->getLanguage()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('lso_mail_dismiss_bod'),
                        $this->getObjectTitle()
                    ));
                    $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('lso_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('lso_mail_notification_reg_bod'),
                        $this->userToString($info['usr_id']),
                        $this->getObjectTitle()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText('lso_mail_permanent_link')
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->createPermanentLink(array(), '_mem')
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText(
                        'lso_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('lso_mail_unsubscribe_member_sub'),
                        $this->getObjectTitle(true)
                    ));
                    $this->setBody(ilMail::getSalutation(
                        $rcp,
                        $this->getLanguage()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('lso_mail_unsubscribe_member_bod'),
                        $this->getObjectTitle()
                    ));
                    $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('lso_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('lso_mail_notification_unsub_bod'),
                        $this->userToString($info['usr_id']),
                        $this->getObjectTitle()
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText(
                            'lso_mail_notification_unsub_bod2'
                        )
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->createPermanentLink(
                        array(),
                        '_mem'
                    ));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText(
                            'lso_notification_explanation_admin'
                        )
                    );
                    $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('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));
                }
                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));
                }
                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));
                }
                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->createLearningSequenceStatus((int) $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));
                }
                break;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$force_sending_mail

bool ilLearningSequenceMembershipMailNotification::$force_sending_mail = false

private

Definition at line 52 of file class.ilLearningSequenceMembershipMailNotification.php.

$logger

ilLogger ilLearningSequenceMembershipMailNotification::$logger

protected

Definition at line 50 of file class.ilLearningSequenceMembershipMailNotification.php.

Referenced by __construct().

$permanent_enabled_notifications

array ilLearningSequenceMembershipMailNotification::$permanent_enabled_notifications

protected

Initial value:

= [
        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 44 of file class.ilLearningSequenceMembershipMailNotification.php.

$settings

ilSetting ilLearningSequenceMembershipMailNotification::$settings

protected

Definition at line 51 of file class.ilLearningSequenceMembershipMailNotification.php.

Referenced by __construct().

TYPE_ACCEPTED_SUBSCRIPTION_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER = 22

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

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_ADMISSION_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER = 20

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

Referenced by ilLearningSequenceMembershipGUI\assignMembers(), and ilLearningSequenceParticipants\sendNotification().

TYPE_BLOCKED_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_BLOCKED_MEMBER = 25

Definition at line 29 of file class.ilLearningSequenceMembershipMailNotification.php.

TYPE_DISMISS_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_DISMISS_MEMBER = 21

Definition at line 25 of file class.ilLearningSequenceMembershipMailNotification.php.

Referenced by ilMembershipGUI\deleteParticipants(), and ilLearningSequenceParticipants\sendNotification().

TYPE_NOTIFICATION_REGISTRATION

const ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION = 30

Definition at line 36 of file class.ilLearningSequenceMembershipMailNotification.php.

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_NOTIFICATION_REGISTRATION_REQUEST

const ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST = 31

Definition at line 37 of file class.ilLearningSequenceMembershipMailNotification.php.

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_NOTIFICATION_UNSUBSCRIBE

const ilLearningSequenceMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE = 32

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

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_REFUSED_SUBSCRIPTION_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_REFUSED_SUBSCRIPTION_MEMBER = 23

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

Referenced by ilMembershipGUI\refuseSubscribers(), and ilLearningSequenceParticipants\sendNotification().

TYPE_STATUS_CHANGED

const ilLearningSequenceMembershipMailNotification::TYPE_STATUS_CHANGED = 24

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

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_SUBSCRIBE_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER = 28

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

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_UNBLOCKED_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_UNBLOCKED_MEMBER = 26

Definition at line 30 of file class.ilLearningSequenceMembershipMailNotification.php.

TYPE_UNSUBSCRIBE_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER = 27

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

Referenced by ilLearningSequenceParticipants\sendNotification().

TYPE_WAITING_LIST_MEMBER

const ilLearningSequenceMembershipMailNotification::TYPE_WAITING_LIST_MEMBER = 29

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

---

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

• Modules/LearningSequence/classes/Members/class.ilLearningSequenceMembershipMailNotification.php