Inheritance diagram for ilForumMailNotification:

Collaboration diagram for ilForumMailNotification:

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

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

	send ()

	isCronjob ()

	setIsCronjob (bool $is_cronjob)

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_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

Data Fields inherited from ilMailNotification
final const int	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initMail ()

	setSubject (string $a_subject)

	appendAttachments ()

	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')

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

	getPostMessage ()

	sendMailWithAttachments (string $subjectLanguageId, int $userId, string $customText, string $action, string $date='')

	sendMailWithoutAttachments (string $subjectLanguageId, int $userId, string $customText, string $action, ?string $date=null)

	createMail (string $subject, int $userId, string $customText, string $action, ?string $date)

	addMailSubject (string $subject)

	createMailDate (string $date)

	addLinkToMail ()

Private Attributes
const string	PERMANENT_LINK_POST = 'PL_Post'

const string	PERMANENT_LINK_FORUM = 'PL_Forum'

bool	$is_cronjob = false

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

Detailed Description

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilForumMailNotification::__construct	(	private readonly ilForumNotificationMailData	$provider,
		private readonly ilLogger	$logger
	)

Definition at line 39 of file class.ilForumMailNotification.php.

      {
        parent::__construct(false);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ addLinkToMail()

ilForumMailNotification::addLinkToMail ( )

private

Definition at line 418 of file class.ilForumMailNotification.php.

                                    : void
    {
        $this->appendBody($this->getPermanentLink());
        $this->appendBody(ilMail::_getInstallationSignature());
    }

References ilMail\_getInstallationSignature().

Here is the call graph for this function:

◆ addMailSubject()

ilForumMailNotification::addMailSubject ( string $subject )

private

Definition at line 386 of file class.ilForumMailNotification.php.

                                                    : void
    {
        $this->initMail();
 
        $container_text = '';
        if ($this->provider->providesClosestContainer()) {
            $container_text = ' (' .
                $this->getLanguageText('obj_' . $this->provider->closestContainer()->getType()) .
                ' "' . $this->provider->closestContainer()->getTitle() . '")';
        }
 
        $this->setSubject(
            sprintf(
                $this->getLanguageText($subject),
                $this->provider->getForumTitle(),
                $container_text,
                $this->provider->getThreadTitle()
            )
        );
    }

◆ appendAttachments()

ilForumMailNotification::appendAttachments ( )

protected

Definition at line 72 of file class.ilForumMailNotification.php.

                                          : void
    {
        if ($this->provider->getAttachments() !== []) {
            $this->logger->debug('Adding attachments ...');
            foreach ($this->provider->getAttachments() as $attachment) {
                $this->appendBody($this->getLanguageText('attachment') . ': ' . $attachment . "\n");
            }
            $this->appendBody("\n------------------------------------------------------------\n");
            $this->setAttachments($this->provider->getAttachments());
        }
    }

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

Here is the call graph for this function:

◆ createMail()

ilForumMailNotification::createMail	(	string	$subject,
		int	$userId,
		string	$customText,
		string	$action,
		?string	$date
	)

private

Definition at line 331 of file class.ilForumMailNotification.php.

     : void {
        if (is_string($date)) {
            $date = $this->createMailDate($date);
        }
 
        $this->addMailSubject($subject);
 
        $this->setBody(ilMail::getSalutation($userId, $this->getLanguage()));
        $this->appendBody("\n\n");
        $this->appendBody($customText);
        $this->appendBody("\n\n");
        $this->appendBody($this->getLanguageText('forum') . ': ' . $this->provider->getForumTitle());
        $this->appendBody("\n\n");
        if ($this->provider->providesClosestContainer()) {
            $this->appendBody(
                $this->getLanguageText('frm_noti_obj_' . $this->provider->closestContainer()->getType()) . ': ' .
                $this->provider->closestContainer()->getTitle()
            );
            $this->appendBody("\n\n");
        }
        $this->appendBody($this->getLanguageText('thread') . ': ' . $this->provider->getThreadTitle());
        $this->appendBody("\n\n");
        $this->appendBody(
            $this->getLanguageText($action) . ": \n------------------------------------------------------------\n"
        );
 
        $this->appendBody(
            $this->getLanguageText('author') . ': ' . $this->provider->getPostUserName($this->getLanguage())
        );
        $this->appendBody("\n");
        if (is_string($date) && $date !== '') {
            $this->appendBody($this->getLanguageText('date') . ': ' . $date);
            $this->appendBody("\n");
        }
        $this->appendBody($this->getLanguageText('subject') . ': ' . $this->provider->getPostTitle());
        $this->appendBody("\n");
        $this->appendBody($this->getLanguageText('frm_noti_message'));
        $this->appendBody("\n");
 
        $message = strip_tags($this->getPostMessage());
 
        if ($this->provider->isPostCensored()) {
            $message = $this->provider->getCensorshipComment();
        }
 
        $this->appendBody($message . "\n");
        $this->appendBody("------------------------------------------------------------\n");
    }

◆ createMailDate()

ilForumMailNotification::createMailDate ( string $date )

private

Definition at line 407 of file class.ilForumMailNotification.php.

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

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

Here is the call graph for this function:

◆ getPermanentLink()

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

private

Definition at line 243 of file class.ilForumMailNotification.php.

                                                                             : 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 = implode('_', [
                $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,
            rtrim(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'),
            rtrim(ilUtil::_getHttpPath(), '/') . '/?client_id=' . CLIENT_ID
        ) . "\n\n";
 
        $this->logger->debug(
            sprintf(
                'Link built: %s',
                $posting_link
            )
        );
 
        return $posting_link;
    }

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

Here is the call graph for this function:

◆ getPostMessage()

ilForumMailNotification::getPostMessage ( )

private

Definition at line 289 of file class.ilForumMailNotification.php.

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

◆ initLanguage()

ilForumMailNotification::initLanguage ( int $a_usr_id )

protected

Reimplemented from ilMailNotification.

Definition at line 227 of file class.ilForumMailNotification.php.

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

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

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMail()

ilForumMailNotification::initMail ( )

protected

Reimplemented from ilMailNotification.

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

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

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

Here is the call graph for this function:

◆ isCronjob()

ilForumMailNotification::isCronjob ( )

Definition at line 233 of file class.ilForumMailNotification.php.

                               : bool
    {
        return $this->is_cronjob;
    }

References $is_cronjob.

◆ send()

ilForumMailNotification::send ( )

Definition at line 84 of file class.ilForumMailNotification.php.

                          : 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);
 
        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()
                    );
                    $this->sendMailWithoutAttachments(
                        '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()
                    );
                    $this->sendMailWithAttachments('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');
                    $this->sendMailWithAttachments('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');
                    $this->sendMailWithAttachments('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()
                    );
                    $this->sendMailWithAttachments(
                        'frm_noti_subject_upt_post',
                        (int) $rcp,
                        $customText,
                        'content_post_updated',
                        $this->provider->getPostUpdate()
                    );
                }
                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()
                    );
                    $this->sendMailWithAttachments(
                        'frm_noti_subject_cens_post',
                        (int) $rcp,
                        $customText,
                        'content_censored_post',
                        $this->provider->getPostCensoredDate()
                    );
                }
                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())
                    );
                    $this->sendMailWithAttachments(
                        'frm_noti_subject_uncens_post',
                        (int) $rcp,
                        $customText,
                        'forums_the_post',
                        $this->provider->getPostCensoredDate()
                    );
                }
                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()
                    );
                    $this->sendMailWithoutAttachments(
                        'frm_noti_subject_del_post',
                        (int) $rcp,
                        $customText,
                        'content_deleted_post'
                    );
                }
                break;
        }
 
        ilDatePresentation::setLanguage($lng);
        ilDatePresentation::setUseRelativeDates($date_type);
 
        return true;
    }

References $DIC, $ilSetting, $lng, ilMailNotification\getLanguageText(), ilMailNotification\getRecipients(), ilMailNotification\getType(), initLanguage(), ILIAS\Repository\logger(), sendMailWithAttachments(), sendMailWithoutAttachments(), ilDatePresentation\setLanguage(), ilDatePresentation\setUseRelativeDates(), TYPE_POST_ACTIVATION, TYPE_POST_ANSWERED, TYPE_POST_CENSORED, TYPE_POST_DELETED, TYPE_POST_NEW, TYPE_POST_UNCENSORED, TYPE_POST_UPDATED, TYPE_THREAD_DELETED, and ilDatePresentation\useRelativeDates().

Here is the call graph for this function:

◆ sendMail()

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

Reimplemented from ilMailNotification.

Definition at line 53 of file class.ilForumMailNotification.php.

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

References ILIAS\Repository\logger().

Here is the call graph for this function:

◆ sendMailWithAttachments()

ilForumMailNotification::sendMailWithAttachments	(	string	$subjectLanguageId,
		int	$userId,
		string	$customText,
		string	$action,
		string	$date = `''`
	)

private

Definition at line 306 of file class.ilForumMailNotification.php.

     : void {
        $this->createMail($subjectLanguageId, $userId, $customText, $action, $date);
        $this->appendAttachments();
        $this->addLinkToMail();
        $this->sendMail([$userId]);
    }

Referenced by send().

Here is the caller graph for this function:

◆ sendMailWithoutAttachments()

ilForumMailNotification::sendMailWithoutAttachments	(	string	$subjectLanguageId,
		int	$userId,
		string	$customText,
		string	$action,
		?string	$date = `null`
	)

private

Definition at line 319 of file class.ilForumMailNotification.php.

     : void {
        $this->createMail($subjectLanguageId, $userId, $customText, $action, $date);
        $this->addLinkToMail();
        $this->sendMail([$userId]);
    }

Referenced by send().

Here is the caller graph for this function:

◆ setIsCronjob()

ilForumMailNotification::setIsCronjob ( bool $is_cronjob )

Definition at line 238 of file class.ilForumMailNotification.php.

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

References $is_cronjob.

◆ setSubject()

ilForumMailNotification::setSubject ( string $a_subject )

protected

Reimplemented from ilMailNotification.

Definition at line 65 of file class.ilForumMailNotification.php.

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