ILIAS
Release_4_4_x_branch Revision 61816
|
Base class for course/group mail notifications. More...
Public Member Functions | |
__construct ($a_is_personal_workspace=false) | |
Constructor. | |
setType ($a_type) | |
Set notification type. | |
getType () | |
Get notification type. | |
setSender ($a_usr_id) | |
Set sender of mail. | |
getSender () | |
get sender of mail | |
setRecipients ($a_rcp) | |
set mail recipients | |
getRecipients () | |
get array of recipients | |
setAttachments ($a_att) | |
Set attachments. | |
getAttachments () | |
Get attachments. | |
setLangModules (array $a_modules) | |
Set lang modules. | |
getUserLanguage ($a_usr_id) | |
Get user language. | |
setRefId ($a_id) | |
Set ref id. | |
getRefId () | |
get reference id | |
getObjId () | |
get object id | |
setObjId ($a_obj_id) | |
set obj id | |
getObjType () | |
Get object type. | |
setAdditionalInformation ($a_info) | |
Additional information for creating notification mails. | |
getAdditionalInformation () | |
Get additional information for generating notification mails. | |
sendMail ($a_rcp, $a_type, $a_parse_recipients=true) | |
Send Mail. | |
getBlockBorder () | |
Get (ascii) block border. |
Data Fields | |
const | SUBJECT_TITLE_LENGTH = 60 |
Protected Member Functions | |
setSubject ($a_subject) | |
Set mail subject. | |
getSubject () | |
Get mail subject. | |
setBody ($a_body) | |
Set mail body. | |
appendBody ($a_body) | |
Append body text. | |
getBody () | |
Get body. | |
initLanguage ($a_usr_id) | |
Init language. | |
initLanguageByIso2Code ($a_code= '') | |
Init language by ISO2 code. | |
setLanguage ($a_language) | |
A language. | |
getLanguage () | |
get language object | |
getLanguageText ($a_keyword) | |
Replace new lines. | |
getObjectTitle ($a_shorten=false) | |
Get object title. | |
initMail () | |
Init mail. | |
getMail () | |
Get mail object. | |
createPermanentLink ($a_params=array(), $a_append= '') | |
Create a permanent link for an object. | |
userToString ($a_usr_id) | |
Utility function. | |
isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read") | |
Check if ref id is accessible for user. |
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 |
Base class for course/group mail notifications.
Definition at line 16 of file class.ilMailNotification.php.
ilMailNotification::__construct | ( | $a_is_personal_workspace = false | ) |
Constructor.
bool | $a_is_personal_workspace |
Definition at line 49 of file class.ilMailNotification.php.
References $ilUser, $lng, ilLanguageFactory\_getLanguage(), and setSender().
|
protected |
Append body text.
string | $a_body |
Definition at line 139 of file class.ilMailNotification.php.
Referenced by ilCalendarMailNotification\appendAppointmentDetails(), ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
|
protected |
Create a permanent link for an object.
Definition at line 431 of file class.ilMailNotification.php.
References ilLink\_getLink(), ilWorkspaceAccessHandler\getGotoLink(), getObjId(), getObjType(), and getRefId().
Referenced by ilSystemNotification\compose(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().
ilMailNotification::getAdditionalInformation | ( | ) |
Get additional information for generating notification mails.
Definition at line 348 of file class.ilMailNotification.php.
References $additional_info.
Referenced by ilTestManScoringParticipantNotification\buildBody(), ilTestManScoringParticipantNotification\buildSubject(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), and ilGroupMembershipMailNotification\send().
ilMailNotification::getAttachments | ( | ) |
Get attachments.
Definition at line 185 of file class.ilMailNotification.php.
References $attachments.
Referenced by ilCalendarMailNotification\deleteAttachments(), and sendMail().
ilMailNotification::getBlockBorder | ( | ) |
Get (ascii) block border.
Definition at line 503 of file class.ilMailNotification.php.
Referenced by ilSystemNotification\compose().
|
protected |
Get body.
Definition at line 148 of file class.ilMailNotification.php.
References $body.
Referenced by ilPaymentNotification\send(), ilMailSummaryNotification\send(), sendMail(), and ilMimeMailNotification\sendMimeMail().
|
protected |
get language object
Definition at line 261 of file class.ilMailNotification.php.
References $language.
Referenced by ilTestManScoringParticipantNotification\__construct(), ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), getLanguageText(), ilMimeMailNotification\initLanguage(), ilRegistrationMailNotification\initLanguage(), ilExerciseMailNotification\initLanguage(), ilGroupMembershipMailNotification\initLanguage(), ilCourseMembershipMailNotification\initLanguage(), ilMimeMailNotification\initLanguageByIso2Code(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
|
protected |
Replace new lines.
string | $a_keyword |
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(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().
|
protected |
Get mail object.
Definition at line 422 of file class.ilMailNotification.php.
References initMail().
Referenced by ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), sendMail(), and ilTestMailNotification\sendSimpleNotification().
|
protected |
Get object title.
bool | shorten title |
Definition at line 358 of file class.ilMailNotification.php.
References ilObject\_lookupTitle(), getObjId(), and ilUtil\shortenText().
Referenced by ilSystemNotification\compose(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().
ilMailNotification::getObjId | ( | ) |
get object id
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().
ilMailNotification::getObjType | ( | ) |
Get object type.
Definition at line 329 of file class.ilMailNotification.php.
References $obj_type.
Referenced by ilSystemNotification\compose(), createPermanentLink(), and isRefIdAccessible().
ilMailNotification::getRecipients | ( | ) |
get array of recipients
Definition at line 167 of file class.ilMailNotification.php.
References $recipients.
Referenced by ilTestManScoringParticipantNotification\getRecipient(), ilTestManScoringParticipantNotification\send(), ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().
ilMailNotification::getRefId | ( | ) |
get reference id
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().
ilMailNotification::getSender | ( | ) |
get sender of mail
Definition at line 100 of file class.ilMailNotification.php.
References $sender.
Referenced by ilCalendarMailNotification\addAttachment(), ilCalendarMailNotification\deleteAttachments(), and initMail().
|
protected |
Get mail subject.
Definition at line 119 of file class.ilMailNotification.php.
References $subject.
Referenced by ilPaymentNotification\send(), ilMailSummaryNotification\send(), sendMail(), and ilMimeMailNotification\sendMimeMail().
ilMailNotification::getType | ( | ) |
Get notification type.
Definition at line 81 of file class.ilMailNotification.php.
References $type.
Referenced by ilRegistrationMailNotification\send(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilExerciseMailNotification\send(), and ilCalendarMailNotification\send().
ilMailNotification::getUserLanguage | ( | $a_usr_id | ) |
Get user language.
int | $a_usr_id |
Definition at line 214 of file class.ilMailNotification.php.
References $language, and ilLanguageFactory\_getLanguageOfUser().
Referenced by initLanguage().
|
protected |
Init language.
int | $a_usr_id |
Reimplemented in ilCourseMembershipMailNotification, ilGroupMembershipMailNotification, ilExerciseMailNotification, ilRegistrationMailNotification, and ilMimeMailNotification.
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().
|
protected |
Init language by ISO2 code.
string | $a_code |
Reimplemented in ilMimeMailNotification.
Definition at line 234 of file class.ilMailNotification.php.
References ilLanguageFactory\_getLanguage().
|
protected |
Init mail.
Definition at line 413 of file class.ilMailNotification.php.
References getSender().
Referenced by ilTestManScoringParticipantNotification\__construct(), ilSystemNotification\compose(), getMail(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
|
protected |
Check if ref id is accessible for user.
int | $a_user_id | |
int | $a_ref_id | |
string | $a_permission |
Definition at line 474 of file class.ilMailNotification.php.
References getObjType().
Referenced by ilSystemNotification\compose().
ilMailNotification::sendMail | ( | $a_rcp, | |
$a_type, | |||
$a_parse_recipients = true |
|||
) |
Send Mail.
array | recipients |
array | mail type (one 'normal', 'system', 'email') |
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(), ilCourseMembershipMailNotification\send(), ilGroupMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
ilMailNotification::setAdditionalInformation | ( | $a_info | ) |
Additional information for creating notification mails.
array | $a_info |
Definition at line 339 of file class.ilMailNotification.php.
Referenced by ilTestScoringGUI\saveManScoringParticipantScreen().
ilMailNotification::setAttachments | ( | $a_att | ) |
Set attachments.
array | $a_att |
Definition at line 176 of file class.ilMailNotification.php.
Referenced by ilCalendarMailNotification\addAttachment(), and ilTestMailNotification\sendAdvancedNotification().
|
protected |
Set mail body.
string | $a_body |
Definition at line 129 of file class.ilMailNotification.php.
Referenced by ilTestManScoringParticipantNotification\buildBody(), ilSystemNotification\compose(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
ilMailNotification::setLangModules | ( | array | $a_modules | ) |
Set lang modules.
array | $a_modules |
Definition at line 194 of file class.ilMailNotification.php.
|
protected |
A language.
ilLanguage | $a_language |
Definition at line 252 of file class.ilMailNotification.php.
Referenced by ilCalendarMailNotification\send().
ilMailNotification::setObjId | ( | $a_obj_id | ) |
set obj id
Definition at line 319 of file class.ilMailNotification.php.
References ilObject\_lookupType().
Referenced by setRefId().
ilMailNotification::setRecipients | ( | $a_rcp | ) |
set mail recipients
array | $a_rcp | user ids |
Definition at line 158 of file class.ilMailNotification.php.
Referenced by ilDiskQuotaSummaryNotification\__construct(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), and ilTestManScoringParticipantNotification\setRecipient().
ilMailNotification::setRefId | ( | $a_id | ) |
Set ref id.
int | $a_id |
Definition at line 281 of file class.ilMailNotification.php.
References $obj_id, ilObject\_lookupObjId(), getRefId(), and setObjId().
Referenced by ilTestManScoringParticipantNotification\__construct().
ilMailNotification::setSender | ( | $a_usr_id | ) |
Set sender of mail.
int | $a_usr_id |
Definition at line 91 of file class.ilMailNotification.php.
Referenced by __construct(), and ilCalendarMailNotification\__construct().
|
protected |
Set mail subject.
string | $a_subject |
Definition at line 110 of file class.ilMailNotification.php.
Referenced by ilTestManScoringParticipantNotification\buildSubject(), ilSystemNotification\compose(), ilPaymentNotification\send(), ilMailSummaryNotification\send(), ilRegistrationMailNotification\send(), ilGroupMembershipMailNotification\send(), ilCourseMembershipMailNotification\send(), ilDiskQuotaSummaryNotification\send(), ilExerciseMailNotification\send(), ilCalendarMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), and ilTestMailNotification\sendSimpleNotification().
ilMailNotification::setType | ( | $a_type | ) |
Set notification type.
int | $a_type |
Definition at line 72 of file class.ilMailNotification.php.
|
protected |
Utility function.
int | $a_usr_id |
Definition at line 458 of file class.ilMailNotification.php.
References ilObjUser\_lookupName().
Referenced by ilCourseMembershipMailNotification\send(), and ilGroupMembershipMailNotification\send().
|
protected |
Definition at line 38 of file class.ilMailNotification.php.
Referenced by getAdditionalInformation().
|
protected |
Definition at line 27 of file class.ilMailNotification.php.
Referenced by getAttachments().
|
protected |
Definition at line 25 of file class.ilMailNotification.php.
Referenced by ilSystemNotification\composeAndGetMessage(), ilCourseMembershipMailNotification\createCourseStatus(), ilGroupMembershipMailNotification\createGroupStatus(), and getBody().
|
protected |
Definition at line 40 of file class.ilMailNotification.php.
|
protected |
Definition at line 30 of file class.ilMailNotification.php.
|
protected |
Definition at line 29 of file class.ilMailNotification.php.
Referenced by getLanguage(), and getUserLanguage().
|
protected |
Definition at line 23 of file class.ilMailNotification.php.
Referenced by ilMailSummaryNotification\send().
|
protected |
Definition at line 35 of file class.ilMailNotification.php.
Referenced by getObjId(), and setRefId().
|
protected |
Definition at line 36 of file class.ilMailNotification.php.
Referenced by getObjType().
|
protected |
Definition at line 32 of file class.ilMailNotification.php.
Referenced by getRecipients(), and sendMail().
|
protected |
Definition at line 34 of file class.ilMailNotification.php.
Referenced by ilSystemNotification\compose(), and getRefId().
|
protected |
Definition at line 21 of file class.ilMailNotification.php.
Referenced by getSender(), and ilMailSummaryNotification\send().
|
protected |
Definition at line 24 of file class.ilMailNotification.php.
Referenced by getSubject().
|
protected |
Definition at line 20 of file class.ilMailNotification.php.
Referenced by getType().
|
protected |
Definition at line 42 of file class.ilMailNotification.php.
|
protected |
Definition at line 41 of file class.ilMailNotification.php.
const ilMailNotification::SUBJECT_TITLE_LENGTH = 60 |
Definition at line 18 of file class.ilMailNotification.php.