Inheritance diagram for ilForumMailNotification:

Collaboration diagram for ilForumMailNotification:

Public Member Functions

__construct (ilForumNotificationMailData $provider, \ilLogger $logger)

ilForumMailNotification constructor. More...

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

Parameters

array	$a_rcp
string	$a_type	('normal', 'system', 'email')
bool \| true	$a_parse_recipients

More...

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_type, $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 ()

Returns: ilMail

More...

setSubject ($a_subject)

Parameters

string $a_subject

Returns: string body

More...

appendAttachments ()

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
	getSecurePostMessage ()

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

ilForumMailNotification constructor.

Parameters

ilForumNotificationMailData	$provider
ilLogger	$logger

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

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

References $logger, and $provider.

Member Function Documentation

◆ appendAttachments()

ilForumMailNotification::appendAttachments ( )

protected

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

        {
                if (count($this->provider->getAttachments()) > 0) {
                        $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(), and ilMailNotification\setAttachments().

Here is the call graph for this function:

◆ getSecurePostMessage()

ilForumMailNotification::getSecurePostMessage ( )

private

Returns: string

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

        {
                $pos_message = $this->provider->getPostMessage();
                if(strip_tags($pos_message) != $pos_message)
                {
                        $pos_message = preg_replace("/\n/i", "", $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);
        }

◆ initLanguage()

ilForumMailNotification::initLanguage ( $a_usr_id )

protected

Parameters

int $a_usr_id

Reimplemented from ilMailNotification.

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

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

◆ initMail()

ilForumMailNotification::initMail ( )

protected

Returns: ilMail

Reimplemented from ilMailNotification.

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

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

References ilMailNotification\$mail.

◆ isCronjob()

ilForumMailNotification::isCronjob ( )

Returns: boolean

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

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

References $is_cronjob.

◆ sendMail()

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

Parameters

array	$a_rcp
string	$a_type	('normal', 'system', 'email')
bool \| true	$a_parse_recipients

Reimplemented from ilMailNotification.

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

        {
                $this->logger->debug('Delegating notification transport to mail service ...');
                parent::sendMail($a_rcp, $a_type, $a_parse_recipients);
                $this->logger->debug('Notification transport delegated');
        }

References $a_type.

◆ setIsCronjob()

ilForumMailNotification::setIsCronjob ( $is_cronjob )

Parameters

boolean $is_cronjob

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

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

References $is_cronjob.

◆ setSubject()

ilForumMailNotification::setSubject ( $a_subject )

protected

Parameters

string $a_subject

Returns: string body

Reimplemented from ilMailNotification.

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

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