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

Wrapper classes for system notifications. More...

+ Inheritance diagram for ilSystemNotification:
+ Collaboration diagram for ilSystemNotification:

Public Member Functions

 setSubjectLangId ($a_lang_id)
 Set subject lang id. More...
 
 setIntroductionLangId ($a_lang_id)
 Set introduction lang id. More...
 
 setIntroductionDirect ($a_text)
 Set introduction text. More...
 
 setTaskLangId ($a_lang_id)
 Set task lang id. More...
 
 setReasonLangId ($a_lang_id)
 Set reason lang id. More...
 
 setGotoLangId ($a_lang_id)
 Set goto lang id. More...
 
 setChangedByUserId ($a_id)
 Set changed by user id. More...
 
 addAdditionalInfo ($a_lang_id, $a_value, $a_multiline=false, $a_lang_direct=false)
 Add additional information. More...
 
 sendMail (array $a_user_ids, $a_goto_additional=null, $a_permission="read")
 Send notification(s) More...
 
 compose ($a_user_id, $a_goto_additional=null, $a_permission="read", $a_append_signature_direct=false)
 Compose notification to single recipient. More...
 
 composeAndGetMessage ($a_user_id, $a_goto_additional=null, $a_permission="read", $a_append_signature_direct=false)
 Compose notification to single recipient. More...
 
- Public Member Functions inherited from ilMailNotification
 __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...
 

Protected Member Functions

 composeAndSendMail ($a_user_id, $a_goto_additional=null, $a_permission="read")
 Send notification to single recipient. More...
 
- Protected Member Functions inherited from ilMailNotification
 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

 $subject_lang_id
 
 $introduction
 
 $introduction_direct
 
 $task
 
 $reason
 
 $additional
 
 $goto_caption
 
 $changed_by
 
 $all_ref_ids
 
- Protected Attributes inherited from ilMailNotification
 $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
 

Additional Inherited Members

- Data Fields inherited from ilMailNotification
const SUBJECT_TITLE_LENGTH = 60
 

Detailed Description

Wrapper classes for system notifications.

See also
FeatureWiki/Guidelines/System Notification Guideline
Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Id
class.ilObjExerciseGUI.php 24003 2010-05-26 14:35:42Z akill

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

Member Function Documentation

◆ addAdditionalInfo()

ilSystemNotification::addAdditionalInfo (   $a_lang_id,
  $a_value,
  $a_multiline = false,
  $a_lang_direct = false 
)

Add additional information.

Parameters
string$a_lang_id
mixed$a_value
bool$a_multiline
bool$a_lang_direct

Definition at line 108 of file class.ilSystemNotification.php.

109 {
110 $this->additional[$a_lang_id] = array(trim($a_value), (bool)$a_multiline, (bool)$a_lang_direct);
111 }

◆ compose()

ilSystemNotification::compose (   $a_user_id,
  $a_goto_additional = null,
  $a_permission = "read",
  $a_append_signature_direct = false 
)

Compose notification to single recipient.

Parameters
mixed$a_rcp
string$a_goto_additional
string$a_permission
bool$a_append_signature_direct
Returns
bool

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

184 {
185 $this->initLanguage($a_user_id);
186 $this->initMail();
187
188 $this->setSubject(
189 sprintf($this->getLanguageText($this->subject_lang_id), $this->getObjectTitle(true))
190 );
191
192 $this->setBody(ilMail::getSalutation($a_user_id, $this->getLanguage()));
193 $this->appendBody("\n\n");
194
195 if($this->introduction)
196 {
197 $this->appendBody($this->getLanguageText($this->introduction));
198 $this->appendBody("\n\n");
199 }
200
201 if($this->introduction_direct)
202 {
203 $this->appendBody($this->introduction_direct);
204 $this->appendBody("\n\n");
205 }
206
207 if($this->task)
208 {
209 $this->appendBody($this->getLanguageText($this->task));
210 $this->appendBody("\n\n");
211 }
212
213 // details table
214 if($this->getObjId())
215 {
216 $this->appendBody($this->getLanguageText("obj_".$this->getObjType()).": ".
217 $this->getObjectTitle()."\n");
218 }
219 if(sizeof($this->additional))
220 {
221 foreach($this->additional as $lang_id => $item)
222 {
223 $caption = "";
224 if($lang_id)
225 {
226 $caption = (!$item[2])
227 ? $this->getLanguageText($lang_id)
228 : $lang_id;
229 }
230 if(!$item[1])
231 {
232 if($caption)
233 {
234 $caption .= ": ";
235 }
236 $this->appendBody($caption.$item[0]."\n");
237 }
238 else
239 {
240 if($caption)
241 {
242 $caption .= "\n";
243 }
244 $this->appendBody("\n".$caption.
245 $this->getBlockBorder().
246 $item[0]."\n".
247 $this->getBlockBorder()."\n");
248 }
249 }
250 }
251 $this->body = trim($this->body);
252 $this->appendBody("\n\n");
253
254 if($this->changed_by)
255 {
256 $this->appendBody($this->getLanguageText("system_notification_installation_changed_by").": ".
257 ilUserUtil::getNamePresentation($this->changed_by));
258 $this->appendBody("\n\n");
259 }
260
261 if($this->getObjId())
262 {
263 // try to find accessible ref_id
264 if(!$this->getRefId() && $this->all_ref_ids)
265 {
266 $find_ref_id = true;
267 foreach($this->all_ref_ids as $ref_id)
268 {
269 if($this->isRefIdAccessible($a_user_id, $ref_id, $a_permission))
270 {
271 $this->ref_id = $ref_id;
272 break;
273 }
274 }
275 }
276
277 // check if initially given ref_id is accessible for current recipient
278 if($this->getRefId() &&
279 !$find_ref_id &&
280 !$this->isRefIdAccessible($a_user_id, $this->getRefId(), $a_permission))
281 {
282 return false;
283 }
284
285 $goto = $this->createPermanentLink(array(), $a_goto_additional);
286 if($goto)
287 {
288 $this->appendBody($this->getLanguageText($this->goto_caption).": ".
289 $goto);
290 $this->appendBody("\n\n");
291 }
292
293 if($find_ref_id)
294 {
295 $this->ref_id = null;
296 }
297 }
298
299 if($this->reason)
300 {
301 $this->appendBody($this->getLanguageText($this->reason));
302 $this->appendBody("\n\n");
303 }
304
305 $this->appendBody(ilMail::_getAutoGeneratedMessageString($this->language));
306
307 // signature will append new lines
308 $this->body = trim($this->body);
309
310 if(!$a_append_signature_direct)
311 {
312 $this->getMail()->appendInstallationSignature(true);
313 }
314 else
315 {
317 }
318
319 return true;
320 }
appendBody($a_body)
Append body text.
initLanguage($a_usr_id)
Init language.
getObjectTitle($a_shorten=false)
createPermanentLink($a_params=array(), $a_append='')
isRefIdAccessible($a_user_id, $a_ref_id, $a_permission="read")
Check if ref id is accessible for user.
static getSalutation($a_usr_id, $a_language=null)
Get salutation.
static _getInstallationSignature()
Static getter for the installation signature.
static _getAutoGeneratedMessageString($lang=null)
get auto generated info string
static getNamePresentation($a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false)
Default behaviour is:

References ilMailNotification\$ref_id, ilMail\_getAutoGeneratedMessageString(), ilMail\_getInstallationSignature(), ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilUserUtil\getNamePresentation(), ilMailNotification\getObjectTitle(), ilMailNotification\getObjId(), ilMailNotification\getObjType(), ilMailNotification\getRefId(), ilMail\getSalutation(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\isRefIdAccessible(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

Referenced by composeAndGetMessage(), and composeAndSendMail().

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

◆ composeAndGetMessage()

ilSystemNotification::composeAndGetMessage (   $a_user_id,
  $a_goto_additional = null,
  $a_permission = "read",
  $a_append_signature_direct = false 
)

Compose notification to single recipient.

Parameters
mixed$a_user_id
string$a_goto_additional
string$a_permission
bool$a_append_signature_direct
Returns
string

Definition at line 349 of file class.ilSystemNotification.php.

350 {
351 if($this->compose($a_user_id, $a_goto_additional, $a_permission, $a_append_signature_direct))
352 {
353 return $this->body;
354 }
355 }
compose($a_user_id, $a_goto_additional=null, $a_permission="read", $a_append_signature_direct=false)
Compose notification to single recipient.

References ilMailNotification\$body, and compose().

+ Here is the call graph for this function:

◆ composeAndSendMail()

ilSystemNotification::composeAndSendMail (   $a_user_id,
  $a_goto_additional = null,
  $a_permission = "read" 
)
protected

Send notification to single recipient.

Parameters
mixed$a_rcp
string$a_goto_additional
string$a_permission
Returns
bool

Definition at line 330 of file class.ilSystemNotification.php.

331 {
332 if($this->compose($a_user_id, $a_goto_additional, $a_permission))
333 {
334 parent::sendMail(array($a_user_id), array('system'), is_numeric($a_user_id));
335 return true;
336 }
337 return false;
338 }

References compose().

Referenced by sendMail().

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

◆ sendMail()

ilSystemNotification::sendMail ( array  $a_user_ids,
  $a_goto_additional = null,
  $a_permission = "read" 
)

Send notification(s)

Parameters
array$a_user_ids
string$a_goto_additional
string$a_permission
Returns
array recipient ids

Reimplemented from ilMailNotification.

Definition at line 121 of file class.ilSystemNotification.php.

122 {
123 $this->all_ref_ids = null;
124
125 // prepare object related info
126 if($this->getObjId())
127 {
128 if(!$this->getRefId())
129 {
130 // try to find ref_id(s)
131 if(!$this->is_in_wsp)
132 {
133 $ref_ids = ilObject::_getAllReferences($this->getObjId());
134 if(sizeof($ref_ids) == 1)
135 {
136 $this->ref_id = array_shift($ref_ids);
137 }
138 else
139 {
140 $this->all_ref_ids = $ref_ids;
141 }
142 }
143 }
144 else if($this->is_in_wsp) // #11680
145 {
146 $this->ref_id = $this->wsp_tree->lookupNodeId($this->getObjId());
147 }
148
149 // default values
150 if(!$this->goto_caption)
151 {
152 $this->goto_caption = "url";
153 }
154 }
155
156 $recipient_ids = array();
157 foreach(array_unique($a_user_ids) as $user_id)
158 {
159 // author of change should not get notification
160 if($this->changed_by == $user_id)
161 {
162 continue;
163 }
164
165 if($this->composeAndSendMail($user_id, $a_goto_additional, $a_permission))
166 {
167 $recipient_ids[] = $user_id;
168 }
169 }
170
171 return $recipient_ids;
172 }
static _getAllReferences($a_id)
get all reference ids of object
composeAndSendMail($a_user_id, $a_goto_additional=null, $a_permission="read")
Send notification to single recipient.

References ilObject\_getAllReferences(), composeAndSendMail(), ilMailNotification\getObjId(), and ilMailNotification\getRefId().

+ Here is the call graph for this function:

◆ setChangedByUserId()

ilSystemNotification::setChangedByUserId (   $a_id)

Set changed by user id.

Parameters
int$a_id

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

94 {
95 $this->changed_by = (int)$a_id;
96
97 include_once "Services/User/classes/class.ilUserUtil.php";
98 }

◆ setGotoLangId()

ilSystemNotification::setGotoLangId (   $a_lang_id)

Set goto lang id.

Parameters
string$a_lang_id

Definition at line 83 of file class.ilSystemNotification.php.

84 {
85 $this->goto_caption = (string)$a_lang_id;
86 }

◆ setIntroductionDirect()

ilSystemNotification::setIntroductionDirect (   $a_text)

Set introduction text.

Parameters
string$a_text

Definition at line 53 of file class.ilSystemNotification.php.

54 {
55 $this->introduction_direct = trim($a_text);
56 }

◆ setIntroductionLangId()

ilSystemNotification::setIntroductionLangId (   $a_lang_id)

Set introduction lang id.

Parameters
string$a_lang_id

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

44 {
45 $this->introduction = (string)$a_lang_id;
46 }

◆ setReasonLangId()

ilSystemNotification::setReasonLangId (   $a_lang_id)

Set reason lang id.

Parameters
string$a_lang_id

Definition at line 73 of file class.ilSystemNotification.php.

74 {
75 $this->reason = (string)$a_lang_id;
76 }

◆ setSubjectLangId()

ilSystemNotification::setSubjectLangId (   $a_lang_id)

Set subject lang id.

Parameters
string$a_lang_id

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

34 {
35 $this->subject_lang_id = (string)$a_lang_id;
36 }

◆ setTaskLangId()

ilSystemNotification::setTaskLangId (   $a_lang_id)

Set task lang id.

Parameters
string$a_lang_id

Definition at line 63 of file class.ilSystemNotification.php.

64 {
65 $this->task = (string)$a_lang_id;
66 }

Field Documentation

◆ $additional

ilSystemNotification::$additional
protected

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

◆ $all_ref_ids

ilSystemNotification::$all_ref_ids
protected

Definition at line 26 of file class.ilSystemNotification.php.

◆ $changed_by

ilSystemNotification::$changed_by
protected

Definition at line 25 of file class.ilSystemNotification.php.

◆ $goto_caption

ilSystemNotification::$goto_caption
protected

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

◆ $introduction

ilSystemNotification::$introduction
protected

Definition at line 19 of file class.ilSystemNotification.php.

◆ $introduction_direct

ilSystemNotification::$introduction_direct
protected

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

◆ $reason

ilSystemNotification::$reason
protected

Definition at line 22 of file class.ilSystemNotification.php.

◆ $subject_lang_id

ilSystemNotification::$subject_lang_id
protected

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

◆ $task

ilSystemNotification::$task
protected

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


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