Inheritance diagram for ilForumMailEventNotificationSender:

Collaboration diagram for ilForumMailEventNotificationSender:

Public Member Functions
	__construct (ilForumNotificationMailData $provider, ilLogger $logger)

	sendMail (array $a_rcp, bool $a_parse_recipients=true)

	send ()

	isCronjob ()

	setIsCronjob (bool $is_cronjob)

Public Member Functions inherited from ilMailNotification
	__construct (bool $a_is_personal_workspace=false)

	setType (int $a_type)

	getType ()

	setSender (int $a_usr_id)

	getSender ()

	setRecipients (array $a_rcp)

	getRecipients ()

	setAttachments (array $a_att)

	getAttachments ()

	setLangModules (array $a_modules)

	getUserLanguage (int $a_usr_id)

	setRefId (int $a_id)

	getRefId ()

	getObjId ()

	setObjId (int $a_obj_id)

	getObjType ()

	setAdditionalInformation (array $a_info)

	getAdditionalInformation ()

	sendMail (array $a_rcp, bool $a_parse_recipients=true)

	getBlockBorder ()

Protected Member Functions
	initMail ()

	setSubject (string $a_subject)

	initLanguage (int $a_usr_id)

Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)

	getSubject ()

	setBody (string $a_body)

	appendBody (string $a_body)

	getBody ()

	initLanguage (int $a_usr_id)

	initLanguageByIso2Code (string $a_code='')

	setLanguage (ilLanguage $a_language)

	getLanguage ()

	getLanguageText (string $a_keyword)

	getObjectTitle (bool $a_shorten=false)

	initMail ()

	getMail ()

	createPermanentLink (array $a_params=[], string $a_append='')

	userToString (int $a_usr_id)

	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission="read")

Protected Attributes
ilForumNotificationMailData	$provider

ilLogger	$logger

bool	$is_cronjob = false

Protected Attributes inherited from ilMailNotification
int	$type

int	$sender

ilMail	$mail = null

string	$subject = ''

string	$body = ''

array	$attachments = []

ilLanguage	$language

array	$lang_modules = []

array	$recipients = []

int	$ref_id

int	$obj_id = 0

string	$obj_type = ''

array	$additional_info = []

bool	$is_in_wsp

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

Private Member Functions
	getPermanentLink (string $type=self::PERMANENT_LINK_POST)

	getPostMessage ()

	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)

Private Attributes
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'

Additional Inherited Members
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumMailEventNotificationSender::__construct	(	ilForumNotificationMailData	$provider,
		ilLogger	$logger
	)

Definition at line 41 of file class.ilForumMailEventNotificationSender.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addMailSubject()

ilForumMailEventNotificationSender::addMailSubject ( string $subject )

private

Definition at line 483 of file class.ilForumMailEventNotificationSender.php.

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

Referenced by createMailBodyText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAttachmentLinkText()

ilForumMailEventNotificationSender::createAttachmentLinkText ( )

private

Definition at line 475 of file class.ilForumMailEventNotificationSender.php.

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

Referenced by createMailValueObjectsWithAttachments().

                                                : string
     {
         $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()

ilForumMailEventNotificationSender::createAttachmentText ( )

private

Definition at line 461 of file class.ilForumMailEventNotificationSender.php.

References ilMailNotification\getLanguageText(), and ILIAS\Repository\logger().

Referenced by createMailValueObjectsWithAttachments().

                                            : string
     {
         $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()

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

private

Definition at line 414 of file class.ilForumMailEventNotificationSender.php.

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

Referenced by createMailValueObjectsWithAttachments(), and createMailValueObjectWithoutAttachments().

      : string {
         $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";
         if ($this->provider->providesClosestContainer()) {
             $body .= $this->getLanguageText('obj_' . $this->provider->closestContainer()->getType()) . ": " . $this->provider->closestContainer()->getTitle();
             $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->getPostMessage());
 
         if ($this->provider->isPostCensored()) {
             $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()

ilForumMailEventNotificationSender::createMailDate ( string $date )

private

Definition at line 490 of file class.ilForumMailEventNotificationSender.php.

References ilDatePresentation\formatDate(), IL_CAL_DATETIME, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ilDatePresentation\setLanguage().

Referenced by createMailBodyText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailValueObjectsWithAttachments()

ilForumMailEventNotificationSender::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	$date	- date to be added in mail

Returns: ilMailValueObject

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

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

Referenced by send().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMailValueObjectWithoutAttachments()

ilForumMailEventNotificationSender::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	$date	- date to be added in mail

Returns: ilMailValueObject

Definition at line 384 of file class.ilForumMailEventNotificationSender.php.

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

Referenced by send().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSubjectText()

ilForumMailEventNotificationSender::createSubjectText ( string $subject )

private

Definition at line 501 of file class.ilForumMailEventNotificationSender.php.

References ilMailNotification\getLanguageText().

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

                                                        : string
     {
         $container_text = '';
         if ($this->provider->providesClosestContainer()) {
             $container_text = " (" . $this->getLanguageText('frm_noti_obj_' . $this->provider->closestContainer()->getType()) .
                 " \"" . $this->provider->closestContainer()->getTitle() . "\")";
         }
 
         return sprintf(
             $this->getLanguageText($subject),
             $this->provider->getForumTitle(),
             $container_text,
             $this->provider->getThreadTitle()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPermanentLink()

ilForumMailEventNotificationSender::getPermanentLink ( string $type = self::PERMANENT_LINK_POST )

private

Definition at line 279 of file class.ilForumMailEventNotificationSender.php.

References $DIC, ilMailNotification\$type, ilUtil\_getHttpPath(), CLIENT_ID, ilMailNotification\getLanguageText(), and ILIAS\Repository\logger().

Referenced by createAttachmentLinkText().

                                                                              : string
     {
         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
         ));
 
         $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:

◆ getPostMessage()

ilForumMailEventNotificationSender::getPostMessage ( )

private

Definition at line 315 of file class.ilForumMailEventNotificationSender.php.

Referenced by createMailBodyText().

                                      : string
     {
         $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);
             return preg_replace("/<\/p([^>]*)>/i", '', $pos_message);
         }
 
         return $pos_message;
     }

Here is the caller graph for this function:

◆ initLanguage()

ilForumMailEventNotificationSender::initLanguage ( int $a_usr_id )

protected

Definition at line 263 of file class.ilForumMailEventNotificationSender.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by send().

                                                   : void
     {
         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()

ilForumMailEventNotificationSender::initMail ( )

protected

Definition at line 48 of file class.ilForumMailEventNotificationSender.php.

References ilMailNotification\$mail, and ILIAS\Repository\logger().

Referenced by addMailSubject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCronjob()

ilForumMailEventNotificationSender::isCronjob ( )

Definition at line 269 of file class.ilForumMailEventNotificationSender.php.

References $is_cronjob.

                                : bool
     {
         return $this->is_cronjob;
     }

◆ send()

ilForumMailEventNotificationSender::send ( )

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

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

                           : bool
     {
         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 = [];
 
         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,
                         $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,
                         $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,
                         $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,
                         $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,
                         $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,
                         $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,
                         $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,
                         $customText,
                         'content_deleted_post'
                     );
                 }
                 break;
         }
 
         $contextId = ilMailFormCall::getContextId();
         if (null === $contextId) {
             $contextId = '';
         }
 
         $contextParameters = ilMailFormCall::getContextParameters();
 
         $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()

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

Definition at line 56 of file class.ilForumMailEventNotificationSender.php.

References ILIAS\Repository\logger().

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

Here is the call graph for this function:

◆ setIsCronjob()

ilForumMailEventNotificationSender::setIsCronjob ( bool $is_cronjob )

Definition at line 274 of file class.ilForumMailEventNotificationSender.php.

References $is_cronjob.

                                                   : void
     {
         $this->is_cronjob = $is_cronjob;
     }

◆ setSubject()

ilForumMailEventNotificationSender::setSubject ( string $a_subject )

protected

Definition at line 66 of file class.ilForumMailEventNotificationSender.php.

References ILIAS\Repository\logger().

Referenced by addMailSubject().

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