Base class for course/group mail notifications. More...

Inheritance diagram for ilMailNotification:

Collaboration diagram for ilMailNotification:

Public Member Functions
	__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 ()

Data Fields
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	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
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

Detailed Description

Base class for course/group mail notifications.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilMailNotification::__construct ( bool $a_is_personal_workspace = false )

Reimplemented in ilGroupMembershipMailNotification, ilLMMailNotification, ilCalendarMailNotification, ilMailSummaryNotification, and ilMimeMailNotification.

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

    {
        global $DIC;
        $this->is_in_wsp = $a_is_personal_workspace;
        $this->setSender(ANONYMOUS_USER_ID);
        $this->language = ilLanguageFactory::_getLanguage($DIC->language()->getDefaultLanguage());
 
        if ($this->is_in_wsp) {
            $this->wsp_tree = new ilWorkspaceTree($DIC->user()->getId()); // owner of tree is irrelevant
            $this->wsp_access_handler = new ilWorkspaceAccessHandler($this->wsp_tree);
        }
    }

References $DIC, ilLanguageFactory\_getLanguage(), ANONYMOUS_USER_ID, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and setSender().

Here is the call graph for this function:

Member Function Documentation

◆ appendBody()

ilMailNotification::appendBody ( string $a_body )

protected

Definition at line 98 of file class.ilMailNotification.php.

                                                 : string
    {
        return $this->body .= $a_body;
    }

Here is the caller graph for this function:

◆ createPermanentLink()

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

protected

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

                                                                                       : ?string
    {
        if ($this->getRefId()) {
            if (!$this->is_in_wsp) {
                return ilLink::_getLink($this->ref_id, $this->getObjType(), $a_params, $a_append);
            }
            return ilWorkspaceAccessHandler::getGotoLink($this->getRefId(), $this->getObjId(), $a_append);
        }
        return ilLink::_getLink(ROOT_FOLDER_ID, 'root');
    }

References ilLink\_getLink(), ilWorkspaceAccessHandler\getGotoLink(), getObjId(), getObjType(), getRefId(), and ROOT_FOLDER_ID.

Referenced by ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), and ilSessionMembershipMailNotification\send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalInformation()

ilMailNotification::getAdditionalInformation ( )

Definition at line 218 of file class.ilMailNotification.php.

                                              : array
    {
        return $this->additional_info;
    }

References $additional_info.

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), and ilSessionMembershipMailNotification\send().

Here is the caller graph for this function:

◆ getAttachments()

ilMailNotification::getAttachments ( )

Definition at line 123 of file class.ilMailNotification.php.

                                    : array
    {
        return $this->attachments;
    }

References $attachments.

Referenced by ilCalendarMailNotification\deleteAttachments(), and sendMail().

Here is the caller graph for this function:

◆ getBlockBorder()

ilMailNotification::getBlockBorder ( )

Definition at line 322 of file class.ilMailNotification.php.

                                    : string
    {
        return "----------------------------------------\n";
    }

◆ getBody()

ilMailNotification::getBody ( )

protected

Definition at line 103 of file class.ilMailNotification.php.

                                : string
    {
        return $this->body;
    }

References $body.

Referenced by ilMailSummaryNotification\send(), sendMail(), and ilMimeMailNotification\sendMimeMail().

Here is the caller graph for this function:

◆ getLanguage()

ilMailNotification::getLanguage ( )

protected

Definition at line 169 of file class.ilMailNotification.php.

                                    : ilLanguage
    {
        return $this->language;
    }

References $language.

Here is the caller graph for this function:

◆ getLanguageText()

ilMailNotification::getLanguageText ( string $a_keyword )

protected

Definition at line 174 of file class.ilMailNotification.php.

                                                         : string
    {
        return str_replace('\n', "\n", $this->getLanguage()->txt($a_keyword));
    }

References getLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMail()

ilMailNotification::getMail ( )

protected

Definition at line 264 of file class.ilMailNotification.php.

                                : ilMail
    {
        return is_object($this->mail) ? $this->mail : $this->initMail();
    }

References initMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectTitle()

ilMailNotification::getObjectTitle ( bool $a_shorten = false )

protected

Definition at line 223 of file class.ilMailNotification.php.

                                                              : string
    {
        if (!$this->getObjId()) {
            return '';
        }
        $txt = ilObject::_lookupTitle($this->getObjId());
        if ($a_shorten) {
            $txt = ilStr::shortenTextExtended($txt, self::SUBJECT_TITLE_LENGTH, true);
        }
        return $txt;
    }

References $txt, ilObject\_lookupTitle(), getObjId(), and ilStr\shortenTextExtended().

Referenced by ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), and ilSessionMembershipMailNotification\send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilMailNotification::getObjId ( )

Definition at line 197 of file class.ilMailNotification.php.

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), ilLearningSequenceMembershipMailNotification\createLearningSequenceStatus(), createPermanentLink(), and getObjectTitle().

Here is the caller graph for this function:

◆ getObjType()

ilMailNotification::getObjType ( )

Definition at line 208 of file class.ilMailNotification.php.

                                : string
    {
        return $this->obj_type;
    }

References $obj_type.

Referenced by createPermanentLink().

Here is the caller graph for this function:

◆ getRecipients()

ilMailNotification::getRecipients ( )

Definition at line 113 of file class.ilMailNotification.php.

                                   : array
    {
        return $this->recipients;
    }

References $recipients.

Here is the caller graph for this function:

◆ getRefId()

ilMailNotification::getRefId ( )

Definition at line 192 of file class.ilMailNotification.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by createPermanentLink(), ilCourseMembershipMailNotification\initMail(), ilGroupMembershipMailNotification\initMail(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCalendarMailNotification\send(), and setRefId().

Here is the caller graph for this function:

◆ getSender()

ilMailNotification::getSender ( )

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

                               : int
    {
        return $this->sender;
    }

References $sender.

Referenced by ilCalendarMailNotification\addAttachment(), ilCalendarMailNotification\deleteAttachments(), and initMail().

Here is the caller graph for this function:

◆ getSubject()

ilMailNotification::getSubject ( )

protected

Definition at line 88 of file class.ilMailNotification.php.

                                   : string
    {
        return $this->subject;
    }

References $subject.

Referenced by ilMailSummaryNotification\send(), sendMail(), and ilMimeMailNotification\sendMimeMail().

Here is the caller graph for this function:

◆ getType()

ilMailNotification::getType ( )

Definition at line 64 of file class.ilMailNotification.php.

                             : int
    {
        return $this->type;
    }

References $type.

Referenced by ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilForumMailNotification\send(), ilForumMailEventNotificationSender\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilRegistrationMailNotification\send(), and ilSessionMembershipMailNotification\send().

Here is the caller graph for this function:

◆ getUserLanguage()

ilMailNotification::getUserLanguage ( int $a_usr_id )

Definition at line 138 of file class.ilMailNotification.php.

                                                  : ilLanguage
    {
        $language = ilLanguageFactory::_getLanguageOfUser($a_usr_id);
        $language->loadLanguageModule('mail');
 
        if (count($this->lang_modules)) {
            foreach ($this->lang_modules as $lmod) {
                $language->loadLanguageModule($lmod);
            }
        }
 
        return $language;
    }

References $language, ilLanguageFactory\_getLanguageOfUser(), and ilLanguage\loadLanguageModule().

Referenced by initLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguage()

ilMailNotification::initLanguage ( int $a_usr_id )

protected

Reimplemented in ilCourseMembershipMailNotification, ilExerciseMailNotification, ilForumMailNotification, ilForumMailEventNotificationSender, ilGroupMembershipMailNotification, ilLMMailNotification, ilSessionMembershipMailNotification, ilMimeMailNotification, ilRegistrationMailNotification, ilCronDeleteInactiveUserReminderMailNotification, and ilLearningSequenceMembershipMailNotification.

Definition at line 133 of file class.ilMailNotification.php.

                                                  : void
    {
        $this->language = $this->getUserLanguage($a_usr_id);
    }

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

Referenced by ilTestManScoringParticipantNotification\__construct(), ilCalendarMailNotification\send(), ilMailSummaryNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguageByIso2Code()

ilMailNotification::initLanguageByIso2Code ( string $a_code = '' )

protected

Reimplemented in ilMimeMailNotification, and ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification.

Definition at line 152 of file class.ilMailNotification.php.

                                                                  : void
    {
        $this->language = ilLanguageFactory::_getLanguage($a_code);
        $this->language->loadLanguageModule('mail');
 
        if (count($this->lang_modules)) {
            foreach ($this->lang_modules as $lmod) {
                $this->language->loadLanguageModule($lmod);
            }
        }
    }

References ilLanguageFactory\_getLanguage(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ initMail()

ilMailNotification::initMail ( )

protected

Reimplemented in ilCourseMembershipMailNotification, ilForumMailNotification, ilForumMailEventNotificationSender, and ilGroupMembershipMailNotification.

Definition at line 259 of file class.ilMailNotification.php.

                                 : ilMail
    {
        return $this->mail = new ilMail($this->getSender());
    }

References getSender().

Referenced by ilTestManScoringParticipantNotification\__construct(), getMail(), ilExerciseMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilSessionMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRefIdAccessible()

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

protected

Definition at line 288 of file class.ilMailNotification.php.

                                                                                                      : bool
    {
        global $DIC;
 
        // no given permission == accessible
 
        if (!$this->is_in_wsp) {
            if (trim($a_permission) &&
                !$DIC->access()->checkAccessOfUser(
                    $a_user_id,
                    $a_permission,
                    "",
                    $a_ref_id,
                    $this->getObjType()
                )) {
                return false;
            }
        } elseif (
            trim($a_permission) &&
            !$this->wsp_access_handler->checkAccessOfUser(
                $this->wsp_tree,
                $a_user_id,
                $a_permission,
                "",
                $a_ref_id,
                $this->getObjType()
            )
        ) {
            return false;
        }
 
        return true;
    }

References $DIC.

◆ sendMail()

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

Reimplemented in ilForumMailNotification, and ilForumMailEventNotificationSender.

Definition at line 235 of file class.ilMailNotification.php.

                                                                           : void
    {
        $recipients = [];
        foreach ($a_rcp as $rcp) {
            if ($a_parse_recipients) {
                $recipients[] = ilObjUser::_lookupLogin((int) $rcp);
            } else {
                $recipients[] = $rcp;
            }
        }
        $recipients = implode(',', $recipients);
        $errors = $this->getMail()->enqueue(
            $recipients,
            '',
            '',
            $this->getSubject(),
            $this->getBody(),
            $this->getAttachments()
        );
        if (count($errors) > 0) {
            ilLoggerFactory::getLogger('mail')->dump($errors, ilLogLevel::ERROR);
        }
    }

References $errors, $recipients, ilObjUser\_lookupLogin(), ilLogLevel\ERROR, getAttachments(), getBody(), ilLoggerFactory\getLogger(), getMail(), and getSubject().

Referenced by ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilTestManScoringParticipantNotification\send(), ilCalendarMailNotification\send(), ilRegistrationMailNotification\send(), ilSessionMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdditionalInformation()

ilMailNotification::setAdditionalInformation ( array $a_info )

Definition at line 213 of file class.ilMailNotification.php.

                                                           : void
    {
        $this->additional_info = $a_info;
    }

◆ setAttachments()

ilMailNotification::setAttachments ( array $a_att )

Definition at line 118 of file class.ilMailNotification.php.

                                                : void
    {
        $this->attachments = $a_att;
    }

Referenced by ilCalendarMailNotification\addAttachment(), ilForumMailNotification\appendAttachments(), and ilTestMailNotification\sendAdvancedNotification().

Here is the caller graph for this function:

◆ setBody()

ilMailNotification::setBody ( string $a_body )

protected

Definition at line 93 of file class.ilMailNotification.php.

                                              : void
    {
        $this->body = $a_body;
    }

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilSessionMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

Here is the caller graph for this function:

◆ setLangModules()

ilMailNotification::setLangModules ( array $a_modules )

Definition at line 128 of file class.ilMailNotification.php.

                                                    : void
    {
        $this->lang_modules = $a_modules;
    }

Referenced by ilIndividualAssessmentPrimitiveInternalNotificator\__construct().

Here is the caller graph for this function:

◆ setLanguage()

ilMailNotification::setLanguage ( ilLanguage $a_language )

protected

Definition at line 164 of file class.ilMailNotification.php.

                                                          : void
    {
        $this->language = $a_language;
    }

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

Referenced by ilCalendarMailNotification\send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjId()

ilMailNotification::setObjId ( int $a_obj_id )

Definition at line 202 of file class.ilMailNotification.php.

                                           : void
    {
        $this->obj_id = $a_obj_id;
        $this->obj_type = ilObject::_lookupType($this->obj_id);
    }

References ilObject\_lookupType().

Referenced by setRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRecipients()

ilMailNotification::setRecipients ( array $a_rcp )

Definition at line 108 of file class.ilMailNotification.php.

                                               : void
    {
        $this->recipients = $a_rcp;
    }

Referenced by ilMailSummaryNotification\send(), and ilTestManScoringParticipantNotification\setRecipient().

Here is the caller graph for this function:

◆ setRefId()

ilMailNotification::setRefId ( int $a_id )

Definition at line 179 of file class.ilMailNotification.php.

                                       : void
    {
        if (!$this->is_in_wsp) {
            $this->ref_id = $a_id;
            $obj_id = ilObject::_lookupObjId($this->ref_id);
        } else {
            $this->ref_id = $a_id;
            $obj_id = $this->wsp_tree->lookupObjectId($this->getRefId());
        }
 
        $this->setObjId($obj_id);
    }

References $obj_id, ilObject\_lookupObjId(), getRefId(), and setObjId().

Referenced by ilTestManScoringParticipantNotification\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSender()

ilMailNotification::setSender ( int $a_usr_id )

Definition at line 69 of file class.ilMailNotification.php.

                                            : void
    {
        $this->sender = $a_usr_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setSubject()

ilMailNotification::setSubject ( string $a_subject )

protected

Reimplemented in ilForumMailNotification, ilForumMailEventNotificationSender, and ilMimeMailNotification.

Definition at line 79 of file class.ilMailNotification.php.

                                                    : string
    {
        if (ilStr::strLen($a_subject) > 255) {
            $a_subject = ilStr::subStr($a_subject, 0, 255);
        }
 
        return $this->subject = $a_subject;
    }

References ilStr\strLen(), and ilStr\subStr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

ilMailNotification::setType ( int $a_type )

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

                                        : void
    {
        $this->type = $a_type;
    }

◆ userToString()

ilMailNotification::userToString ( int $a_usr_id )

protected

Definition at line 280 of file class.ilMailNotification.php.

                                                  : string
    {
        $name = ilObjUser::_lookupName($a_usr_id);
        return ($name['title'] ? $name['title'] . ' ' : '') .
            ($name['firstname'] ? $name['firstname'] . ' ' : '') .
            ($name['lastname'] ? $name['lastname'] . ' ' : '');
    }