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)
	Constructor. More...

	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 ($a_rcp)
	set mail recipients More...

	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)
	Set ref id. More...

	getRefId ()
	get reference id More...

	getObjId ()
	get object id More...

	setObjId ($a_obj_id)
	set obj id More...

	getObjType ()
	Get object type. More...

	setAdditionalInformation ($a_info)
	Additional information for creating notification mails. More...

	getAdditionalInformation ()
	Get additional information for generating notification mails. More...

	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail. More...

	getBlockBorder ()
	Get (ascii) block border. More...

Data Fields
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	setSubject ($a_subject)
	Set mail subject. More...

	getSubject ()
	Get mail subject. More...

	setBody ($a_body)
	Set mail body. More...

	appendBody ($a_body)
	Append body text. More...

	getBody ()
	Get body. More...

	initLanguage ($a_usr_id)
	Init language. More...

	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...

	setLanguage ($a_language)
	A language. More...

	getLanguage ()
	get language object More...

	getLanguageText ($a_keyword)
	Replace new lines. More...

	getObjectTitle ($a_shorten=false)
	Get object title. More...

	initMail ()
	Init mail. More...

	getMail ()
	Get mail object. More...

	createPermanentLink ($a_params=array(), $a_append='')
	Create a permanent link for an object. More...

	userToString ($a_usr_id)
	Utility function. More...

	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 )

Constructor.

Parameters

bool $a_is_personal_workspace

Returns

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

References $ilUser, $lng, ilLanguageFactory\_getLanguage(), and setSender().

         {
                 global $lng, $ilUser;
                 
                 $this->is_in_wsp = (bool)$a_is_personal_workspace;
 
                 $this->setSender(ANONYMOUS_USER_ID);
                 $this->language = ilLanguageFactory::_getLanguage($lng->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($ilUser->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 139 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

Create a permanent link for an object.

Returns

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

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

Referenced by ilSystemNotification\compose(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\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 ( )

Get additional information for generating notification mails.

Returns

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

References $additional_info.

Referenced by ilRegistrationMimeMailNotification\__construct(), ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilRegistrationMailNotification\send(), ilSessionMembershipMailNotification\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 185 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 503 of file class.ilMailNotification.php.

Referenced by ilSystemNotification\compose().

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

Here is the caller graph for this function:

◆ getBody()

ilMailNotification::getBody ( )

protected

Get body.

Returns: string

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

References $body.

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

         {
                 return $this->body;
         }

Here is the caller graph for this function:

◆ getLanguage()

ilMailNotification::getLanguage ( )

protected

get language object

Returns: ilLanguage

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

References $language.

         {
                 return $this->language;
         }

Here is the caller graph for this function:

◆ getLanguageText()

ilMailNotification::getLanguageText ( $a_keyword )

protected

Replace new lines.

Parameters

string $a_keyword

Returns

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

References getLanguage().

Referenced by ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilSystemNotification\compose(), ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().

         {
                 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

Get mail object.

Returns

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

References initMail().

         {
                 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

Get object title.

Parameters

bool	shorten title

Returns

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

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

Referenced by ilSystemNotification\compose(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\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 ( )

get object id

Returns

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

References $obj_id.

Referenced by ilSystemNotification\compose(), ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), 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 329 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

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

References $recipients.

         {
                 return $this->recipients;
         }

Here is the caller graph for this function:

◆ getRefId()

ilMailNotification::getRefId ( )

get reference id

Returns

Definition at line 301 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 100 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

Get mail subject.

Returns: string

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

References $subject.

Referenced by ilPaymentNotification\send(), ilMailSummaryNotification\send(), 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 81 of file class.ilMailNotification.php.

References $type.

Referenced by ilRegistrationMimeMailNotification\__construct(), ilRegistrationMailNotification\send(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\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 214 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 203 of file class.ilMailNotification.php.

References getUserLanguage().

Referenced by ilTestManScoringParticipantNotification\__construct(), ilSystemNotification\compose(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilDiskQuotaSummaryNotification\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 234 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

Init mail.

Returns

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

References getSender().

         {
                 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 474 of file class.ilMailNotification.php.

References getObjType().

Referenced by ilSystemNotification\compose().

         {
                 global $ilAccess;
                 
                 // no given permission == accessible
                 
                 if(!$this->is_in_wsp)
                 {                                                                                               
                         if(trim($a_permission) &&
                                 !$ilAccess->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	(	$a_rcp,
		$a_type,
		$a_parse_recipients = `true`
	)

Send Mail.

Parameters

array	recipients
array	mail type (one 'normal', 'system', 'email')

Returns

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

References $GLOBALS, $recipients, ilObjUser\_lookupLogin(), getAttachments(), getBody(), getMail(), and getSubject().

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

         {
                 $recipients = array();
                 foreach($a_rcp as $rcp)
                 {
                         if($a_parse_recipients)
                         {
                                 $recipients[] = ilObjUser::_lookupLogin($rcp);
                         }
                         else
                         {
                                 $recipients[] = $rcp;
                         }
                 }
                 $recipients = implode(',',$recipients);
                 $error = $this->getMail()->sendMail(
                         $recipients,
                         '',
                         '',
                         $this->getSubject(),
                         $this->getBody(),
                         $this->getAttachments(),
                         $a_type
                 );
 
                 if(strlen($error))
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.': '.$error);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdditionalInformation()

ilMailNotification::setAdditionalInformation ( $a_info )

Additional information for creating notification mails.

Parameters

array $a_info

Returns

Definition at line 339 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 176 of file class.ilMailNotification.php.

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

         {
                 $this->attachments = $a_att;
         }

Here is the caller graph for this function:

◆ setBody()

ilMailNotification::setBody ( $a_body )

protected

Set mail body.

Parameters

string $a_body

Returns

Definition at line 129 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 194 of file class.ilMailNotification.php.

         {
                 $this->lang_modules = $a_modules;
         }       

◆ setLanguage()

ilMailNotification::setLanguage ( $a_language )

protected

A language.

Parameters

ilLanguage $a_language

Definition at line 252 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 )

set obj id

Returns

Definition at line 319 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 ( $a_rcp )

set mail recipients

Parameters

array $a_rcp user ids

Returns

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

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

         {
                 $this->recipients = $a_rcp;
         }

Here is the caller graph for this function:

◆ setRefId()

ilMailNotification::setRefId ( $a_id )

Set ref id.

Parameters

int $a_id

Returns

Definition at line 281 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

Returns

Definition at line 91 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

Set mail subject.

Parameters

string $a_subject

Returns: string body

Definition at line 110 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

Returns

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

         {
                 $this->type = $a_type;
         }

◆ userToString()

ilMailNotification::userToString ( $a_usr_id )

protected

Utility function.

Parameters

int $a_usr_id

Returns

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

References ilObjUser\_lookupName().

Referenced by ilSessionMembershipMailNotification\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'].' ' : '');
         }