Inheritance diagram for ilMailEventNotificationSender:

Collaboration diagram for ilMailEventNotificationSender:

Public Member Functions
	__construct (ilForumNotificationMailData $provider, \ilLogger $logger)
	ilForumMailNotification constructor. More...

	sendMail (array $a_rcp, $a_parse_recipients=true)

	send ()

	isCronjob ()

	setIsCronjob ($is_cronjob)

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_THREAD_DELETED = 54

const	TYPE_POST_NEW = 60

const	TYPE_POST_ACTIVATION = 61

const	TYPE_POST_UPDATED = 62

const	TYPE_POST_CENSORED = 63

const	TYPE_POST_DELETED = 64

const	TYPE_POST_ANSWERED = 65

const	TYPE_POST_UNCENSORED = 66

const	PERMANENT_LINK_POST = 'PL_Post'

const	PERMANENT_LINK_FORUM = 'PL_Forum'

Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initMail ()

	setSubject ($a_subject)

	initLanguage ($a_usr_id)

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
	$is_cronjob = false

	$provider

	$logger

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 Member Functions
	getPermanentLink ($type=self::PERMANENT_LINK_POST)

	getSecurePostMessage ()

	createMailValueObjectsWithAttachments (string $subjectLanguageId, int $recipientUserId, string $customText, string $action, string $date='')
	Add body and send mail with attachments. More...

	createMailValueObjectWithoutAttachments (string $subjectLanguageId, int $recipientUserId, string $customText, string $action, string $date='')
	Add body and send mail without attachments. More...

	createMailBodyText (string $subject, int $userId, string $customText, string $action, string $date)

	createAttachmentText ()

	createAttachmentLinkText ()

	addMailSubject (string $subject)

	createMailDate (string $date)

	createSubjectText (string $subject)

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 7 of file class.ilMailEventNotificationSender.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailEventNotificationSender::__construct	(	ilForumNotificationMailData	$provider,
		\ilLogger	$logger
	)

ilForumMailNotification constructor.

Parameters

ilForumNotificationMailData	$provider
ilLogger	$logger

Definition at line 49 of file class.ilMailEventNotificationSender.php.

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

     {
         parent::__construct(false);
         $this->provider = $provider;
         $this->logger = $logger;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addMailSubject()

ilMailEventNotificationSender::addMailSubject ( string $subject )

private

Parameters

string $subject

Definition at line 545 of file class.ilMailEventNotificationSender.php.

References createSubjectText(), initMail(), and setSubject().

Referenced by createMailBodyText().

     {
         $this->initMail();
 
         $this->setSubject($this->createSubjectText($subject));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAttachmentLinkText()

ilMailEventNotificationSender::createAttachmentLinkText ( )

private

Definition at line 533 of file class.ilMailEventNotificationSender.php.

References ilMailNotification\$body, ilMail\_getInstallationSignature(), and getPermanentLink().

Referenced by createMailValueObjectsWithAttachments().

     {
         $body = $this->getPermanentLink();
         $body .= ilMail::_getInstallationSignature();
 
         return $body;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAttachmentText()

ilMailEventNotificationSender::createAttachmentText ( )

private

Definition at line 519 of file class.ilMailEventNotificationSender.php.

References ilMailNotification\getLanguageText().

Referenced by createMailValueObjectsWithAttachments().

     {
         $attachmentText = '';
         if (count($this->provider->getAttachments()) > 0) {
             $this->logger->debug('Adding attachments ...');
             foreach ($this->provider->getAttachments() as $attachment) {
                 $attachmentText .= $this->getLanguageText('attachment') . ": " . $attachment . "\n";
             }
             $attachmentText .= "\n------------------------------------------------------------\n";
         }
 
         return $attachmentText;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailBodyText()

ilMailEventNotificationSender::createMailBodyText	(	string	$subject,
		int	$userId,
		string	$customText,
		string	$action,
		string	$date
	)

private

Definition at line 476 of file class.ilMailEventNotificationSender.php.

References ilMailNotification\$body, $message, addMailSubject(), createMailDate(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMail\getSalutation(), and getSecurePostMessage().

Referenced by createMailValueObjectsWithAttachments(), and createMailValueObjectWithoutAttachments().

       {
         $date = $this->createMailDate($date);
 
         $this->addMailSubject($subject);
 
         $body = ilMail::getSalutation($userId, $this->getLanguage());
 
         $body .= "\n\n";
         $body .= $customText;
         $body .= "\n\n";
         $body .= $this->getLanguageText('forum') . ": " . $this->provider->getForumTitle();
         $body .= "\n\n";
         $body .= $this->getLanguageText('thread') . ": " . $this->provider->getThreadTitle();
         $body .= "\n\n";
         $body .= $this->getLanguageText($action) . ": \n------------------------------------------------------------\n";
 
         $body .= $this->getLanguageText('author') . ": " . $this->provider->getPostUserName($this->getLanguage());
         $body .= "\n";
         $body .= $this->getLanguageText('date') . ": " . $date;
         $body .= "\n";
         $body .= $this->getLanguageText('subject') . ": " . $this->provider->getPostTitle();
         $body .= "\n";
         $body .= $this->getLanguageText('frm_noti_message');
         $body .= "\n";
 
         $message = strip_tags($this->getSecurePostMessage());
 
         if ($this->provider->getPostCensored() == 1) {
             $message = $this->provider->getCensorshipComment();
         }
 
         $body .= $message . "\n";
         $body .= "------------------------------------------------------------\n";
 
         return $body;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailDate()

ilMailEventNotificationSender::createMailDate ( string $date )

private

Parameters

string $date

Returns: string

Exceptions

ilDateTimeException

Definition at line 559 of file class.ilMailEventNotificationSender.php.

References ilDatePresentation\formatDate(), IL_CAL_DATETIME, language(), and ilDatePresentation\setLanguage().

Referenced by createMailBodyText().

                                                   : string
     {
         ilDatePresentation::setLanguage($this->language);
 
         if ($date === '') {
             $date = $this->provider->getPostDate();
         }
 
         $date = ilDatePresentation::formatDate(new ilDateTime($date, IL_CAL_DATETIME));
 
         return $date;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailValueObjectsWithAttachments()

ilMailEventNotificationSender::createMailValueObjectsWithAttachments	(	string	$subjectLanguageId,
		int	$recipientUserId,
		string	$customText,
		string	$action,
		string	$date = `''`
	)

private

Add body and send mail with attachments.

Parameters

string	$subjectLanguageId	- Language id of subject
int	$recipientUserId	- id of the user recipient of the mail
string	$customText	- mail text after salutation
string	$action	- Language id of action
string \| null	$date	- date to be added in mail

Returns: ilMailValueObject

Definition at line 396 of file class.ilMailEventNotificationSender.php.

References ilObjUser\_lookupLogin(), createAttachmentLinkText(), createAttachmentText(), createMailBodyText(), and createSubjectText().

Referenced by send().

       {
         $subjectText = $this->createSubjectText($subjectLanguageId);
 
         $bodyText = $this->createMailBodyText(
             $subjectLanguageId,
             $recipientUserId,
             $customText,
             $action,
             $date
         );
 
         $attachmentText = $this->createAttachmentText();
         $bodyText .= $attachmentText;
 
         $attachmentText = $this->createAttachmentLinkText();
         $bodyText .= $attachmentText;
 
         $mailObject = new ilMailValueObject(
             '',
             ilObjUser::_lookupLogin($recipientUserId),
             '',
             '',
             $subjectText,
             $bodyText,
             $this->provider->getAttachments(),
             false,
             false
         );
 
         return $mailObject;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailValueObjectWithoutAttachments()

ilMailEventNotificationSender::createMailValueObjectWithoutAttachments	(	string	$subjectLanguageId,
		int	$recipientUserId,
		string	$customText,
		string	$action,
		string	$date = `''`
	)

private

Add body and send mail without attachments.

Parameters

string	$subjectLanguageId	- Language id of subject
int	$recipientUserId
string	$customText	- mail text after salutation
string	$action	- Language id of action
string \| null	$date	- date to be added in mail

Returns: ilMailValueObject

Definition at line 444 of file class.ilMailEventNotificationSender.php.

References ilObjUser\_lookupLogin(), createMailBodyText(), and createSubjectText().

Referenced by send().

       {
         $subjectText = $this->createSubjectText($subjectLanguageId);
 
         $bodyText = $this->createMailBodyText(
             $subjectLanguageId,
             $recipientUserId,
             $customText,
             $action,
             $date
         );
 
         $mailObject = new ilMailValueObject(
             '',
             ilObjUser::_lookupLogin($recipientUserId),
             '',
             '',
             $subjectText,
             $bodyText,
             [],
             false,
             false
         );
 
         return $mailObject;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSubjectText()

ilMailEventNotificationSender::createSubjectText ( string $subject )

private

Parameters

string $subject

Returns: string

Definition at line 576 of file class.ilMailEventNotificationSender.php.

References ilMailNotification\getLanguageText().

Referenced by addMailSubject(), createMailValueObjectsWithAttachments(), and createMailValueObjectWithoutAttachments().

                                                         : string
     {
         return sprintf(
             $this->getLanguageText($subject),
             $this->provider->getForumTitle(),
             $this->provider->getThreadTitle()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPermanentLink()

ilMailEventNotificationSender::getPermanentLink ( $type = self::PERMANENT_LINK_POST )

private

Parameters

string $type

Returns: string

Definition at line 316 of file class.ilMailEventNotificationSender.php.

References $DIC, ilMailNotification\$type, ilUtil\_getHttpPath(), ilMailNotification\getLanguageText(), and isCronjob().

Referenced by createAttachmentLinkText().

     {
         global $DIC;
         $ilClientIniFile = $DIC['ilClientIniFile'];
 
         if ($type == self::PERMANENT_LINK_FORUM) {
             $language_text = $this->getLanguageText("forums_notification_show_frm");
             $forum_parameters = $this->provider->getRefId();
         } else {
             $language_text = $this->getLanguageText("forums_notification_show_post");
             $forum_parameters = $this->provider->getRefId() . "_" . $this->provider->getThreadId() . "_" . $this->provider->getPostId();
         }
 
         $this->logger->debug(sprintf(
             'Building permanent with parameters %s',
             $forum_parameters
         ));
 
         if ($this->isCronjob()) {
             $posting_link = sprintf(
                 $language_text,
                 ilUtil::_getHttpPath() . "/goto.php?target=frm_" . $forum_parameters . '&client_id=' . CLIENT_ID
             ) . "\n\n";
 
             $posting_link .= sprintf(
                 $this->getLanguageText("forums_notification_intro"),
                 $ilClientIniFile->readVariable("client", "name"),
                 ilUtil::_getHttpPath() . '/?client_id=' . CLIENT_ID
             ) . "\n\n";
         } else {
             $posting_link = sprintf(
                 $language_text,
                 ilUtil::_getHttpPath() . "/goto.php?target=frm_" . $forum_parameters . '&client_id=' . CLIENT_ID
             ) . "\n\n";
 
             $posting_link .= sprintf(
                 $this->getLanguageText("forums_notification_intro"),
                 $ilClientIniFile->readVariable("client", "name"),
                 ilUtil::_getHttpPath() . '/?client_id=' . CLIENT_ID
             ) . "\n\n";
         }
 
         $this->logger->debug(sprintf(
             'Link built: %s',
             $posting_link
         ));
 
         return $posting_link;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSecurePostMessage()

ilMailEventNotificationSender::getSecurePostMessage ( )

private

Returns: string

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

Referenced by createMailBodyText().

     {
         $pos_message = $this->provider->getPostMessage();
         if (strip_tags($pos_message) != $pos_message) {
             $pos_message = preg_replace("/\n/i", "", $pos_message);
             $pos_message = preg_replace("/<li([^>]*)>/i", "\n<li$1>", $pos_message);
             $pos_message = preg_replace("/<\/ul([^>]*)>(?!\s*?(<p|<ul))/i", "</ul$1>\n", $pos_message);
             $pos_message = preg_replace("/<br(\s*)(\/?)>/i", "\n", $pos_message);
             $pos_message = preg_replace("/<p([^>]*)>/i", "\n\n", $pos_message);
             $pos_message = preg_replace("/<\/p([^>]*)>/i", '', $pos_message);
 
             return $pos_message;
         }
 
         return strip_tags($pos_message);
     }

Here is the caller graph for this function:

◆ initLanguage()

ilMailEventNotificationSender::initLanguage ( $a_usr_id )

protected

Parameters

int $a_usr_id

Definition at line 290 of file class.ilMailEventNotificationSender.php.

References language().

Referenced by send().

     {
         parent::initLanguage($a_usr_id);
         $this->language->loadLanguageModule('forum');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMail()

ilMailEventNotificationSender::initMail ( )

protected

Definition at line 59 of file class.ilMailEventNotificationSender.php.

References ilMailNotification\$mail.

Referenced by addMailSubject().

     {
         $mail = parent::initMail();
         $this->logger->debug('Initialized mail service');
 
         return $mail;
     }

Here is the caller graph for this function:

◆ isCronjob()

ilMailEventNotificationSender::isCronjob ( )

Returns: boolean

Definition at line 299 of file class.ilMailEventNotificationSender.php.

References $is_cronjob.

Referenced by getPermanentLink().

     {
         return (bool) $this->is_cronjob;
     }

Here is the caller graph for this function:

◆ send()

ilMailEventNotificationSender::send ( )

Returns: bool

Exceptions

ilException

Definition at line 95 of file class.ilMailEventNotificationSender.php.

References $DIC, $ilSetting, $lng, createMailValueObjectsWithAttachments(), createMailValueObjectWithoutAttachments(), ilMailFormCall\getContextId(), ilMailFormCall\getContextParameters(), ilMailNotification\getLanguageText(), ilMailNotification\getRecipients(), ilMailNotification\getType(), initLanguage(), ilDatePresentation\setLanguage(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

     {
         global $DIC;
         $ilSetting = $DIC->settings();
         $lng = $DIC->language();
 
         if (!$ilSetting->get('forum_notification', 0)) {
             $this->logger->debug('Forum notifications are globally disabled');
 
             return false;
         }
 
         if (!$this->getRecipients()) {
             $this->logger->debug('No notification recipients, nothing to do');
 
             return false;
         }
 
         $lng->loadLanguageModule('forum');
 
         $date_type = ilDatePresentation::useRelativeDates();
         ilDatePresentation::setUseRelativeDates(false);
 
         $mailObjects = array();
 
         switch ($this->getType()) {
             case self::TYPE_THREAD_DELETED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('thread_deleted_by'),
                         $this->provider->getDeletedBy(),
                         $this->provider->getForumTitle()
                     );
 
                     $mailObjects[] = $this->createMailValueObjectWithoutAttachments(
                         'frm_noti_subject_del_thread',
                         (int) $rcp,
                         (string) $customText,
                         'content_deleted_thread'
                     );
                 }
                 break;
 
             case self::TYPE_POST_NEW:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('frm_noti_new_post'),
                         $this->provider->getForumTitle()
                     );
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_new_post',
                         (int) $rcp,
                         (string) $customText,
                         'new_post'
                     );
                 }
                 break;
 
             case self::TYPE_POST_ACTIVATION:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = $this->getLanguageText('forums_post_activation_mail');
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_act_post',
                         (int) $rcp,
                         (string) $customText,
                         'new_post'
                     );
                 }
                 break;
 
             case self::TYPE_POST_ANSWERED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = $this->getLanguageText('forum_post_replied');
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_answ_post',
                         (int) $rcp,
                         (string) $customText,
                         'new_post'
                     );
                 }
                 break;
 
             case self::TYPE_POST_UPDATED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('post_updated_by'),
                         $this->provider->getPostUpdateUserName($this->getLanguage()),
                         $this->provider->getForumTitle()
                     );
                     $date = $this->provider->getPostUpdate();
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_upt_post',
                         (int) $rcp,
                         (string) $customText,
                         'content_post_updated',
                         $date
                     );
                 }
                 break;
 
             case self::TYPE_POST_CENSORED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('post_censored_by'),
                         $this->provider->getPostUpdateUserName($this->getLanguage()),
                         $this->provider->getForumTitle()
                     );
                     $date = $this->provider->getPostCensoredDate();
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_cens_post',
                         (int) $rcp,
                         (string) $customText,
                         'content_censored_post',
                         $date
                     );
                 }
                 break;
 
             case self::TYPE_POST_UNCENSORED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('post_uncensored_by'),
                         $this->provider->getPostUpdateUserName($this->getLanguage())
                     );
                     $date = $this->provider->getPostCensoredDate();
 
                     $mailObjects[] = $this->createMailValueObjectsWithAttachments(
                         'frm_noti_subject_uncens_post',
                         (int) $rcp,
                         (string) $customText,
                         'forums_the_post',
                         $date
                     );
                 }
                 break;
 
             case self::TYPE_POST_DELETED:
                 foreach ($this->getRecipients() as $rcp) {
                     $this->initLanguage($rcp);
                     $customText = sprintf(
                         $this->getLanguageText('post_deleted_by'),
                         $this->provider->getDeletedBy(),
                         $this->provider->getForumTitle()
                     );
 
                     $mailObjects[] = $this->createMailValueObjectWithoutAttachments(
                         'frm_noti_subject_del_post',
                         (int) $rcp,
                         (string) $customText,
                         'content_deleted_post'
                     );
                 }
                 break;
         }
 
         $contextId = \ilMailFormCall::getContextId();
         if (null === $contextId) {
             $contextId = '';
         }
 
         $contextParameters = ilMailFormCall::getContextParameters();
         if (is_array($contextParameters)) {
             $contextParameters = array();
         }
 
         $processor = new ilMassMailTaskProcessor();
 
         $processor->run(
             $mailObjects,
             ANONYMOUS_USER_ID,
             $contextId,
             $contextParameters
         );
 
         ilDatePresentation::setLanguage($lng);
         ilDatePresentation::setUseRelativeDates($date_type);
 
         return true;
     }

Here is the call graph for this function:

◆ sendMail()

ilMailEventNotificationSender::sendMail	(	array	$a_rcp,
			$a_parse_recipients = `true`
	)

Definition at line 70 of file class.ilMailEventNotificationSender.php.

     {
         $this->logger->debug(sprintf(
             'Delegating notification transport to mail service for recipient "%s" ...',
             $a_rcp
         ));
         parent::sendMail($a_rcp, $a_parse_recipients);
         $this->logger->debug('Notification transport delegated');
     }

◆ setIsCronjob()

ilMailEventNotificationSender::setIsCronjob ( $is_cronjob )

Parameters

boolean $is_cronjob

Definition at line 307 of file class.ilMailEventNotificationSender.php.

References $is_cronjob.

     {
         $this->is_cronjob = (bool) $is_cronjob;
     }

◆ setSubject()

ilMailEventNotificationSender::setSubject ( $a_subject )

protected

Definition at line 83 of file class.ilMailEventNotificationSender.php.

Referenced by addMailSubject().

     {
         $value = parent::setSubject($a_subject);
         $this->logger->debug(sprintf('Setting subject to: %s', $a_subject));
 
         return $value;
     }