ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilMailNotification Class Reference

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.

48 {
49 global $lng, $ilUser;
50
51 $this->is_in_wsp = (bool)$a_is_personal_workspace;
52
53 $this->setSender(ANONYMOUS_USER_ID);
54 $this->language = ilLanguageFactory::_getLanguage($lng->getDefaultLanguage());
55
56 if($this->is_in_wsp)
57 {
58 include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
59 include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
60 $this->wsp_tree = new ilWorkspaceTree($ilUser->getId()); // owner of tree is irrelevant
61 $this->wsp_access_handler = new ilWorkspaceAccessHandler($this->wsp_tree);
62 }
63 }
static _getLanguage($a_lang_key='')
Get langauge object.
setSender($a_usr_id)
Set sender of mail.
Access handler for personal workspace.
Tree handler for personal workspace.
global $lng
Definition: privfeed.php:40
global $ilUser
Definition: imgupload.php:15

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

+ Here is the call graph for this function:

Member Function Documentation

◆ appendBody()

◆ createPermanentLink()

ilMailNotification::createPermanentLink (   $a_params = array(),
  $a_append = '' 
)
protected
Parameters
array$a_params
string$a_append
Returns
string

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

409 {
410 include_once './Services/Link/classes/class.ilLink.php';
411
412 if($this->getRefId())
413 {
414 if(!$this->is_in_wsp)
415 {
416 return ilLink::_getLink($this->ref_id,$this->getObjType(),$a_params,$a_append);
417 }
418 else
419 {
420 return ilWorkspaceAccessHandler::getGotoLink($this->getRefId(), $this->getObjId(), $a_append);
421 }
422 }
423 else
424 {
425 // Return root
426 return ilLink::_getLink(ROOT_FOLDER_ID,'root');
427 }
428 }
static getGotoLink($a_node_id, $a_obj_id, $a_additional=null)

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getAdditionalInformation()

◆ getAttachments()

ilMailNotification::getAttachments ( )

Get attachments

Returns
array

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

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

References $attachments.

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

+ Here is the caller graph for this function:

◆ getBlockBorder()

ilMailNotification::getBlockBorder ( )

Get (ascii) block border.

Returns
string

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

480 {
481 return "----------------------------------------\n";
482 }

◆ getBody()

ilMailNotification::getBody ( )
protected
Returns
string

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

140 {
141 return $this->body;
142 }

References $body.

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

+ Here is the caller graph for this function:

◆ getLanguage()

ilMailNotification::getLanguage ( )
protected
Returns
ilLanguage

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

References $language.

Referenced by ilTestManScoringParticipantNotification\__construct(), ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), getLanguageText(), ilMailCronOrphanedMailsNotification\getOrphandMailsBody(), ilCourseMembershipMailNotification\initLanguage(), ilExerciseMailNotification\initLanguage(), ilGroupMembershipMailNotification\initLanguage(), ilLMMailNotification\initLanguage(), ilSessionMembershipMailNotification\initLanguage(), ilMimeMailNotification\initLanguage(), ilRegistrationMailNotification\initLanguage(), ilMailCronOrphanedMailsNotification\initLanguageByIso2Code(), ilMimeMailNotification\initLanguageByIso2Code(), ilCronDeleteInactiveUserReminderMailNotification\initLanguageByIso2Code(), ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilCalendarMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilMailCronOrphanedMailsNotification\send(), ilMailSummaryNotification\send(), ilPaymentNotification\send(), ilRegistrationMailNotification\send(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().

+ Here is the caller graph for this function:

◆ getLanguageText()

◆ getMail()

◆ getObjectTitle()

ilMailNotification::getObjectTitle (   $a_shorten = false)
protected
Parameters
bool | false$a_shorten
Returns
string

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

337 {
338 if(!$this->getObjId())
339 {
340 return '';
341 }
343 if((bool)$a_shorten)
344 {
345 $txt = ilUtil::shortenText($txt, self::SUBJECT_TITLE_LENGTH,true);
346 }
347 return $txt;
348 }
static _lookupTitle($a_id)
lookup object title
static shortenText($a_str, $a_len, $a_dots=false, $a_next_blank=false, $a_keep_extension=false)
shorten a string to given length.
$txt
Definition: error.php:12

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getObjId()

◆ getObjType()

ilMailNotification::getObjType ( )

Get object type.

Returns

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

References $obj_type.

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

+ Here is the caller graph for this function:

◆ getRecipients()

◆ getRefId()

ilMailNotification::getRefId ( )

◆ getSender()

ilMailNotification::getSender ( )

get sender of mail

Returns

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

References $sender.

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

+ Here is the caller graph for this function:

◆ getSubject()

ilMailNotification::getSubject ( )
protected
Returns
string

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

References $subject.

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

+ Here is the caller graph for this function:

◆ getType()

◆ getUserLanguage()

ilMailNotification::getUserLanguage (   $a_usr_id)

Get user language.

Parameters
int$a_usr_id
Returns
ilLanguage

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

204 {
206 $language->loadLanguageModule('mail');
207
208 if(sizeof($this->lang_modules))
209 {
210 foreach($this->lang_modules as $lmod)
211 {
212 $language->loadLanguageModule($lmod);
213 }
214 }
215
216 return $language;
217 }
static _getLanguageOfUser($a_usr_id)
Get language object of user.

References $language, and ilLanguageFactory\_getLanguageOfUser().

Referenced by initLanguage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initLanguage()

◆ initLanguageByIso2Code()

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

Init language by ISO2 code.

Parameters
string$a_code

Reimplemented in ilMailCronOrphanedMailsNotification, ilMimeMailNotification, and ilCronDeleteInactiveUserReminderMailNotification.

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

224 {
225 $this->language = ilLanguageFactory::_getLanguage($a_code);
226 $this->language->loadLanguageModule('mail');
227
228 if(sizeof($this->lang_modules))
229 {
230 foreach($this->lang_modules as $lmod)
231 {
232 $this->language->loadLanguageModule($lmod);
233 }
234 }
235 }

References ilLanguageFactory\_getLanguage().

+ Here is the call graph for this function:

◆ initMail()

◆ 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 450 of file class.ilMailNotification.php.

451 {
452 global $ilAccess;
453
454 // no given permission == accessible
455
456 if(!$this->is_in_wsp)
457 {
458 if(trim($a_permission) &&
459 !$ilAccess->checkAccessOfUser($a_user_id, $a_permission, "", $a_ref_id, $this->getObjType()))
460 {
461 return false;
462 }
463 }
464 else
465 {
466 if(trim($a_permission) &&
467 !$this->wsp_access_handler->checkAccessOfUser($this->wsp_tree, $a_user_id, $a_permission, "", $a_ref_id, $this->getObjType()))
468 {
469 return false;
470 }
471 }
472 return true;
473 }

Referenced by ilSystemNotification\compose().

+ 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

Reimplemented in ilSystemNotification.

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

356 {
357 $recipients = array();
358 foreach($a_rcp as $rcp)
359 {
360 if($a_parse_recipients)
361 {
363 }
364 else
365 {
366 $recipients[] = $rcp;
367 }
368 }
369 $recipients = implode(',',$recipients);
370 $error = $this->getMail()->sendMail(
372 '',
373 '',
374 $this->getSubject(),
375 $this->getBody(),
376 $this->getAttachments(),
377 $a_type
378 );
379
380 if(strlen($error))
381 {
382 require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
383 ilLoggerFactory::getLogger('mail')->error($error);
384 }
385 }
static getLogger($a_component_id)
Get component logger.
static _lookupLogin($a_user_id)
lookup login

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

Referenced by ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), ilGroupMembershipMailNotification\send(), ilLMMailNotification\send(), ilSessionMembershipMailNotification\send(), ilTestManScoringParticipantNotification\send(), ilCalendarMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilRegistrationMailNotification\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)

Additional information for creating notification mails.

Parameters
array$a_info

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

320 {
321 $this->additional_info = $a_info;
322 }

◆ setAttachments()

ilMailNotification::setAttachments (   $a_att)

Set attachments

Parameters
array$a_att

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

166 {
167 $this->attachments = $a_att;
168 }

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

+ Here is the caller graph for this function:

◆ setBody()

◆ setLangModules()

ilMailNotification::setLangModules ( array  $a_modules)

Set lang modules.

Parameters
array$a_modules

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

184 {
185 $this->lang_modules = $a_modules;
186 }

◆ setLanguage()

ilMailNotification::setLanguage (   $a_language)
protected
Parameters
ilLanguage$a_language

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

241 {
242 $this->language = $a_language;
243 }

Referenced by ilCalendarMailNotification\send().

+ Here is the caller graph for this function:

◆ setObjId()

ilMailNotification::setObjId (   $a_obj_id)
Parameters
int$a_obj_id

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

301 {
302 $this->obj_id = $a_obj_id;
303 $this->obj_type = ilObject::_lookupType($this->obj_id);
304 }
static _lookupType($a_id, $a_reference=false)
lookup object type

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)
Parameters
array$a_rcp

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

148 {
149 $this->recipients = $a_rcp;
150 }

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

+ Here is the caller graph for this function:

◆ setRefId()

ilMailNotification::setRefId (   $a_id)
Parameters
int$a_id

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

266 {
267 if(!$this->is_in_wsp)
268 {
269 $this->ref_id = $a_id;
270 $obj_id = ilObject::_lookupObjId($this->ref_id);
271 }
272 else
273 {
274 $this->ref_id = (int)$a_id;
275 $obj_id = $this->wsp_tree->lookupObjectId($this->getRefId());
276 }
277
278 $this->setObjId($obj_id);
279 }
static _lookupObjId($a_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 (   $a_usr_id)

Set sender of mail.

Parameters
int$a_usr_id

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

88 {
89 $this->sender = $a_usr_id;
90 }

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

+ Here is the caller graph for this function:

◆ setSubject()

◆ setType()

ilMailNotification::setType (   $a_type)

Set notification type.

Parameters
int$a_type

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

70 {
71 $this->type = $a_type;
72 }

◆ userToString()

ilMailNotification::userToString (   $a_usr_id)
protected
Parameters
int$a_usr_id
Returns
string

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

435 {
436 $name = ilObjUser::_lookupName($a_usr_id);
437 return ($name['title'] ? $name['title'].' ' : '').
438 ($name['firstname'] ? $name['firstname'].' ' : '').
439 ($name['lastname'] ? $name['lastname'].' ' : '');
440 }
static _lookupName($a_user_id)
lookup user name

References ilObjUser\_lookupName().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $additional_info

ilMailNotification::$additional_info = array()
protected

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

Referenced by getAdditionalInformation().

◆ $attachments

ilMailNotification::$attachments = array()
protected

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

Referenced by getAttachments().

◆ $body

◆ $is_in_wsp

ilMailNotification::$is_in_wsp
protected

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

◆ $lang_modules

ilMailNotification::$lang_modules = array()
protected

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

◆ $language

ilMailNotification::$language = null
protected

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

Referenced by getLanguage(), and getUserLanguage().

◆ $mail

ilMailNotification::$mail = null
protected

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

Referenced by ilMailSummaryNotification\send().

◆ $obj_id

ilMailNotification::$obj_id = null
protected

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

Referenced by getObjId(), and setRefId().

◆ $obj_type

ilMailNotification::$obj_type = null
protected

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

Referenced by getObjType().

◆ $recipients

ilMailNotification::$recipients = array()
protected

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

Referenced by getRecipients(), and sendMail().

◆ $ref_id

ilMailNotification::$ref_id = null
protected

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

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

◆ $sender

ilMailNotification::$sender = null
protected

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

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

◆ $subject

ilMailNotification::$subject = ''
protected

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

Referenced by getSubject().

◆ $type

ilMailNotification::$type = null
protected

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

Referenced by getType().

◆ $wsp_access_handler

ilMailNotification::$wsp_access_handler
protected

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

◆ $wsp_tree

ilMailNotification::$wsp_tree
protected

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

◆ SUBJECT_TITLE_LENGTH

const ilMailNotification::SUBJECT_TITLE_LENGTH = 60

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


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