ilMailNotification Class Reference

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

)

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

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

    {
        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);
        }
    }

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.

Referenced by ilForumMailNotification\addLinkToMail(), ilCalendarMailNotification\appendAppointmentDetails(), ilForumMailNotification\appendAttachments(), ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilForumMailNotification\createMail(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilMailSummaryNotification\send(), ilLMMailNotification\send(), ilExerciseMailNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilCalendarMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), and ilTestMailNotification\sendSimpleNotification().

                                                 : 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.

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

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

                                                                                       : ?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');
    }

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.

References $additional_info.

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), and ilCourseMembershipMailNotification\send().

                                              : array
    {
        return $this->additional_info;
    }

Here is the caller graph for this function:

getAttachments()

ilMailNotification::getAttachments

(

)

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

References $attachments.

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

                                    : array
    {
        return $this->attachments;
    }

Here is the caller graph for this function:

getBlockBorder()

ilMailNotification::getBlockBorder

(

)

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

Referenced by ilSystemNotification\compose().

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

Here is the caller graph for this function:

getBody()

ilMailNotification::getBody ( )

protected

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

References $body.

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

                                : string
    {
        return $this->body;
    }

Here is the caller graph for this function:

getLanguage()

ilMailNotification::getLanguage ( )

protected

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

References $language.

Referenced by ilTestManScoringParticipantNotification\__construct(), ilTestManScoringParticipantNotification\buildBody(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\buildFolderTitle(), ilSystemNotification\compose(), ilForumMailNotification\createMail(), ilForumMailEventNotificationSender\createMailBodyText(), getLanguageText(), ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ilMimeMailNotification\initLanguage(), ilLMMailNotification\initLanguage(), ilRegistrationMailNotification\initLanguage(), ilExerciseMailNotification\initLanguage(), ilSessionMembershipMailNotification\initLanguage(), ilLearningSequenceMembershipMailNotification\initLanguage(), ilGroupMembershipMailNotification\initLanguage(), ilCourseMembershipMailNotification\initLanguage(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\initLanguageByIso2Code(), ilMimeMailNotification\initLanguageByIso2Code(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilMailSummaryNotification\send(), ilLMMailNotification\send(), ilExerciseMailNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilCalendarMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

                                    : ilLanguage
    {
        return $this->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.

References getLanguage().

Referenced by ilForumMailNotification\addMailSubject(), ilForumMailNotification\appendAttachments(), ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilSystemNotification\compose(), ilForumMailEventNotificationSender\createAttachmentText(), ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), ilLearningSequenceMembershipMailNotification\createLearningSequenceStatus(), ilForumMailNotification\createMail(), ilForumMailEventNotificationSender\createMailBodyText(), ilForumMailEventNotificationSender\createSubjectText(), ilForumMailNotification\getPermanentLink(), ilForumMailEventNotificationSender\getPermanentLink(), ilRegistrationMailNotification\send(), ilMailSummaryNotification\send(), ilLMMailNotification\send(), ilExerciseMailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilForumMailEventNotificationSender\send(), ilCalendarMailNotification\send(), ilForumMailNotification\send(), ilGroupMembershipMailNotification\send(), and ilCourseMembershipMailNotification\send().

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

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.

References initMail().

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

                                : ilMail
    {
        return is_object($this->mail) ? $this->mail : $this->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.

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

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

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

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.

References $obj_id.

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

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getObjType()

ilMailNotification::getObjType

(

)

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

References $obj_type.

Referenced by ilSystemNotification\compose(), createPermanentLink(), and isRefIdAccessible().

                                : string
    {
        return $this->obj_type;
    }

Here is the caller graph for this function:

getRecipients()

ilMailNotification::getRecipients

(

)

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

References $recipients.

Referenced by ilTestManScoringParticipantNotification\getRecipient(), ilTestManScoringParticipantNotification\send(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilLMMailNotification\send(), ilExerciseMailNotification\send(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilForumMailEventNotificationSender\send(), ilCalendarMailNotification\send(), ilForumMailNotification\send(), ilGroupMembershipMailNotification\send(), and ilCourseMembershipMailNotification\send().

                                   : array
    {
        return $this->recipients;
    }

Here is the caller graph for this function:

getRefId()

ilMailNotification::getRefId

(

)

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

References $ref_id.

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

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getSender()

ilMailNotification::getSender

(

)

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

References $sender.

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

                               : int
    {
        return $this->sender;
    }

Here is the caller graph for this function:

getSubject()

ilMailNotification::getSubject ( )

protected

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

References $subject.

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

                                   : string
    {
        return $this->subject;
    }

Here is the caller graph for this function:

getType()

ilMailNotification::getType

(

)

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

References $type.

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

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

getUserLanguage()

ilMailNotification::getUserLanguage

(

int

$a_usr_id

)

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

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

Referenced by initLanguage().

                                                  : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initLanguage()

ilMailNotification::initLanguage ( int  $a_usr_id )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

initLanguageByIso2Code()

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

protected

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

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

                                                                  : 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);
            }
        }
    }

Here is the call graph for this function:

initMail()

ilMailNotification::initMail ( )

protected

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

References getSender().

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

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

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.

References $DIC, and getObjType().

Referenced by ilSystemNotification\compose().

                                                                                                      : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendMail()

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

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

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

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

                                                                           : 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);
        }
    }

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.

Referenced by ilTestScoringGUI\saveManScoringParticipantScreen().

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

Here is the caller graph for this function:

setAttachments()

ilMailNotification::setAttachments

(

array

$a_att

)

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

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

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

Here is the caller graph for this function:

setBody()

ilMailNotification::setBody ( string  $a_body )

protected

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

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilForumMailNotification\createMail(), ilRegistrationMailNotification\send(), ilMailSummaryNotification\send(), ilLMMailNotification\send(), ilExerciseMailNotification\send(), ilSessionMembershipMailNotification\send(), ilLearningSequenceMembershipMailNotification\send(), ilIndividualAssessmentPrimitiveInternalNotificator\send(), ilCalendarMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail(), and ilTestMailNotification\sendSimpleNotification().

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

Here is the caller graph for this function:

setLangModules()

ilMailNotification::setLangModules

(

array

$a_modules

)

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

Referenced by ilIndividualAssessmentPrimitiveInternalNotificator\__construct().

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

Here is the caller graph for this function:

setLanguage()

ilMailNotification::setLanguage ( ilLanguage  $a_language )

protected

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

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

Referenced by ilCalendarMailNotification\send().

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

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.

References ilObject\_lookupType().

Referenced by setRefId().

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

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.

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

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

Here is the caller graph for this function:

setRefId()

ilMailNotification::setRefId

(

int

$a_id

)

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

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

Referenced by ilTestManScoringParticipantNotification\__construct().

                                       : 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);
    }

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.

Referenced by __construct().

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

Here is the caller graph for this function:

setSubject()

ilMailNotification::setSubject ( string  $a_subject )

protected

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

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

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

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

        return $this->subject = $a_subject;
    }

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.

References $name, and ilObjUser\_lookupName().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$additional_info

array ilMailNotification::$additional_info = []

protected

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

Referenced by getAdditionalInformation().

$attachments

array ilMailNotification::$attachments = []

protected

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

Referenced by getAttachments().

$body

string ilMailNotification::$body = ''

protected

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

Referenced by ilSystemNotification\composeAndGetMessage(), ilForumMailEventNotificationSender\createAttachmentLinkText(), ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), ilLearningSequenceMembershipMailNotification\createLearningSequenceStatus(), ilForumMailEventNotificationSender\createMailBodyText(), getBody(), and ilCronDeleteInactiveUserReminderMailNotification\send().

$is_in_wsp

bool ilMailNotification::$is_in_wsp

protected

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

$lang_modules

array ilMailNotification::$lang_modules = []

protected

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

$language

ilLanguage ilMailNotification::$language

protected

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

Referenced by getLanguage(), and getUserLanguage().

$mail

ilMail ilMailNotification::$mail = null

protected

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

Referenced by ilForumMailNotification\initMail(), ilForumMailEventNotificationSender\initMail(), ilGroupMembershipMailNotification\initMail(), ilCourseMembershipMailNotification\initMail(), and ilMailSummaryNotification\send().

$obj_id

int ilMailNotification::$obj_id = 0

protected

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

Referenced by getObjId().

$obj_type

string ilMailNotification::$obj_type = ''

protected

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

Referenced by getObjType().

$recipients

array ilMailNotification::$recipients = []

protected

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

Referenced by getRecipients().

$ref_id

int ilMailNotification::$ref_id

protected

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

Referenced by ilSystemNotification\compose(), and getRefId().

$sender

int ilMailNotification::$sender

protected

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

Referenced by getSender(), and ilMailSummaryNotification\send().

$subject

string ilMailNotification::$subject = ''

protected

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

Referenced by getSubject(), and ilIndividualAssessmentPrimitiveInternalNotificator\send().

$type

int ilMailNotification::$type

protected

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

Referenced by ilForumMailNotification\getPermanentLink(), ilForumMailEventNotificationSender\getPermanentLink(), and getType().

$wsp_access_handler

ilWorkspaceAccessHandler ilMailNotification::$wsp_access_handler

protected

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

$wsp_tree

ilWorkspaceTree ilMailNotification::$wsp_tree

protected

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

SUBJECT_TITLE_LENGTH

const ilMailNotification::SUBJECT_TITLE_LENGTH = 60

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

---

The documentation for this class was generated from the following file:

• Services/Mail/classes/class.ilMailNotification.php