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

Inheritance diagram for ilMailNotification:

Collaboration diagram for ilMailNotification:

Public Member Functions
	__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	SUBJECT_TITLE_LENGTH = 60

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

Detailed Description

Base class for course/group mail notifications.

Version: $Id$

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

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

Constructor & Destructor Documentation

◆ __construct()

ilMailNotification::__construct ( $a_is_personal_workspace = false )

Parameters

bool | false $a_is_personal_workspace

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

References $DIC, ilLanguageFactory\_getLanguage(), and setSender().

     {
         global $DIC;
 
         $this->is_in_wsp = (bool) $a_is_personal_workspace;
 
         $this->setSender(ANONYMOUS_USER_ID);
         $this->language = ilLanguageFactory::_getLanguage($DIC->language()->getDefaultLanguage());
         
         if ($this->is_in_wsp) {
             include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
             include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
             $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 ( $a_body )

protected

Append body text.

Parameters

string $a_body

Returns: string body

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

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

Here is the caller graph for this function:

◆ createPermanentLink()

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

protected

Parameters

array	$a_params
string	$a_append

Returns: string

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

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

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

     {
         include_once './Services/Link/classes/class.ilLink.php';
         
         if ($this->getRefId()) {
             if (!$this->is_in_wsp) {
                 return ilLink::_getLink($this->ref_id, $this->getObjType(), $a_params, $a_append);
             } else {
                 return ilWorkspaceAccessHandler::getGotoLink($this->getRefId(), $this->getObjId(), $a_append);
             }
         } else {
             // Return root
             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 ( )

Returns: array

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

References $additional_info.

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

     {
         return (array) $this->additional_info;
     }

Here is the caller graph for this function:

◆ getAttachments()

ilMailNotification::getAttachments ( )

Get attachments.

Returns: array

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

References $attachments.

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

     {
         return (array) $this->attachments;
     }

Here is the caller graph for this function:

◆ getBlockBorder()

ilMailNotification::getBlockBorder ( )

Get (ascii) block border.

Returns: string

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

Referenced by ilSystemNotification\compose().

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

Here is the caller graph for this function:

◆ getBody()

ilMailNotification::getBody ( )

protected

Returns: string

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

References $body.

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

     {
         return $this->body;
     }

Here is the caller graph for this function:

◆ getLanguage()

ilMailNotification::getLanguage ( )

protected

Returns: ilLanguage

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

References $language.

     {
         return $this->language;
     }

Here is the caller graph for this function:

◆ getLanguageText()

ilMailNotification::getLanguageText ( $a_keyword )

protected

Parameters

string $a_keyword

Returns: string

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

References getLanguage().

     {
         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

Returns: ilMail|null

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

References initMail(), and Monolog\Handler\mail().

     {
         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 ( $a_shorten = false )

protected

Parameters

bool | false $a_shorten

Returns: string

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

References $txt, ilObject\_lookupTitle(), getObjId(), and ilUtil\shortenText().

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

     {
         if (!$this->getObjId()) {
             return '';
         }
         $txt = ilObject::_lookupTitle($this->getObjId());
         if ((bool) $a_shorten) {
             $txt = ilUtil::shortenText($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 ( )

Returns: int

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

References $obj_id.

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

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getObjType()

ilMailNotification::getObjType ( )

Get object type.

Returns

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

References $obj_type.

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

     {
         return $this->obj_type;
     }

Here is the caller graph for this function:

◆ getRecipients()

ilMailNotification::getRecipients ( )

get array of recipients

Returns: array

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

References $recipients.

     {
         return $this->recipients;
     }

Here is the caller graph for this function:

◆ getRefId()

ilMailNotification::getRefId ( )

Returns: int

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

References $ref_id.

Referenced by ilSystemNotification\compose(), createPermanentLink(), ilCourseMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilSystemNotification\sendMail(), and setRefId().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getSender()

ilMailNotification::getSender ( )

get sender of mail

Returns

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

References $sender.

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

     {
         return $this->sender;
     }

Here is the caller graph for this function:

◆ getSubject()

ilMailNotification::getSubject ( )

protected

Returns: string

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

References $subject.

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

     {
         return $this->subject;
     }

Here is the caller graph for this function:

◆ getType()

ilMailNotification::getType ( )

Get notification type.

Returns

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

References $type.

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

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUserLanguage()

ilMailNotification::getUserLanguage ( $a_usr_id )

Get user language.

Parameters

int $a_usr_id

Returns: ilLanguage

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

References $language, and ilLanguageFactory\_getLanguageOfUser().

Referenced by initLanguage().

     {
         $language = ilLanguageFactory::_getLanguageOfUser($a_usr_id);
         $language->loadLanguageModule('mail');
         
         if (sizeof($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 ( $a_usr_id )

protected

Init language.

Parameters

int $a_usr_id

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

References getUserLanguage().

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

     {
         $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 ( $a_code = '' )

protected

Init language by ISO2 code.

Parameters

string $a_code

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

References ilLanguageFactory\_getLanguage().

     {
         $this->language = ilLanguageFactory::_getLanguage($a_code);
         $this->language->loadLanguageModule('mail');
         
         if (sizeof($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

Returns: ilMail

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

References getSender(), and Monolog\Handler\mail().

     {
         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	(	$a_user_id,
		$a_ref_id,
		$a_permission = `"read"`
	)

protected

Check if ref id is accessible for user.

Parameters

int	$a_user_id
int	$a_ref_id
string	$a_permission

Returns: bool

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

References $DIC, and getObjType().

Referenced by ilSystemNotification\compose().

     {
         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;
             }
         } else {
             if (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,
			$a_type,
			$a_parse_recipients = `true`
	)

Parameters

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

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

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

     {
         $recipients = array();
         foreach ($a_rcp as $rcp) {
             if ($a_parse_recipients) {
                 $recipients[] = ilObjUser::_lookupLogin($rcp);
             } else {
                 $recipients[] = $rcp;
             }
         }
         $recipients = implode(',', $recipients);
         $errors = $this->getMail()->sendMail(
             $recipients,
             '',
             '',
             $this->getSubject(),
             $this->getBody(),
             $this->getAttachments(),
             $a_type
         );
         // smeyer: 19.5.16 fixed strlen warning, since $error is of type array
         if (count($errors) > 0) {
             require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
             ilLoggerFactory::getLogger('mail')->dump($errors, ilLogLevel::ERROR);
             //ilLoggerFactory::getLogger('mail')->error($error);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdditionalInformation()

ilMailNotification::setAdditionalInformation ( array $a_info )

Additional information for creating notification mails.

Parameters

array $a_info

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

Referenced by ilTestScoringGUI\saveManScoringParticipantScreen().

     {
         $this->additional_info = $a_info;
     }

Here is the caller graph for this function:

◆ setAttachments()

ilMailNotification::setAttachments ( $a_att )

Set attachments.

Parameters

array $a_att

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

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

     {
         $this->attachments = $a_att;
     }

Here is the caller graph for this function:

◆ setBody()

ilMailNotification::setBody ( $a_body )

protected

Parameters

string $a_body

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

     {
         $this->body = $a_body;
     }

Here is the caller graph for this function:

◆ setLangModules()

ilMailNotification::setLangModules ( array $a_modules )

Set lang modules.

Parameters

array $a_modules

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

Referenced by ilIndividualAssessmentPrimitiveInternalNotificator\__construct().

     {
         $this->lang_modules = $a_modules;
     }

Here is the caller graph for this function:

◆ setLanguage()

ilMailNotification::setLanguage ( $a_language )

protected

Parameters

ilLanguage $a_language

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

Referenced by ilCalendarMailNotification\send().

     {
         $this->language = $a_language;
     }

Here is the caller graph for this function:

◆ setObjId()

ilMailNotification::setObjId ( $a_obj_id )

Parameters

int $a_obj_id

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

References ilObject\_lookupType().

Referenced by setRefId().

     {
         $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 )

Parameters

array $a_rcp

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

Referenced by ilDiskQuotaSummaryNotification\__construct(), ilMailSummaryNotification\__construct(), and ilTestManScoringParticipantNotification\setRecipient().

     {
         $this->recipients = $a_rcp;
     }

Here is the caller graph for this function:

◆ setRefId()

ilMailNotification::setRefId ( $a_id )

Parameters

int $a_id

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

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

Referenced by ilTestManScoringParticipantNotification\__construct().

     {
         if (!$this->is_in_wsp) {
             $this->ref_id = $a_id;
             $obj_id = ilObject::_lookupObjId($this->ref_id);
         } else {
             $this->ref_id = (int) $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 ( $a_usr_id )

Set sender of mail.

Parameters

int $a_usr_id

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

Referenced by __construct(), and ilCalendarMailNotification\__construct().

     {
         $this->sender = $a_usr_id;
     }

Here is the caller graph for this function:

◆ setSubject()

ilMailNotification::setSubject ( $a_subject )

protected

Parameters

string $a_subject

Returns: string body

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

     {
         return $this->subject = $a_subject;
     }

Here is the caller graph for this function:

◆ setType()

ilMailNotification::setType ( $a_type )

Set notification type.

Parameters

int $a_type

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

References $a_type.

     {
         $this->type = $a_type;
     }

◆ userToString()

ilMailNotification::userToString ( $a_usr_id )

protected

Parameters

int $a_usr_id

Returns: string

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

References $name, and ilObjUser\_lookupName().

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

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