This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSystemNotification:

Collaboration diagram for ilSystemNotification:

Public Member Functions
	__construct (protected bool $is_in_wsp=false)

	setSubjectLangId (string $a_lang_id)

	setSubjectDirect (string $a_text)

	setIntroductionLangId (string $a_lang_id)

	setIntroductionDirect (string $a_text)

	setTaskLangId (string $a_lang_id)

	setReasonLangId (string $a_lang_id)

	setGotoLangId (string $a_lang_id)

	setChangedByUserId (int $a_id)

	addAdditionalInfo (string $a_lang_id, string $a_value, bool $a_multiline=false, bool $a_lang_direct=false)
	Add additional information. More...

	sendMailAndReturnRecipients (array $a_user_ids, ?string $a_goto_additional=null, string $a_permission="read")
	Send notification(s) More...

	compose (int $a_user_id, ?string $a_goto_additional=null, string $a_permission="read", bool $a_append_signature_direct=false)
	Compose notification to single recipient. More...

	composeAndGetMessage (int $a_user_id, ?string $a_goto_additional=null, string $a_permission="read", bool $a_append_signature_direct=false)
	Compose notification to single recipient. More...

Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=false)

	setType (int $a_type)

	getType ()

	setSender (int $a_usr_id)

	getSender ()

	setRecipients (array $a_rcp)

	getRecipients ()

	setAttachments (array $a_att)

	getAttachments ()

	setLangModules (array $a_modules)

	getUserLanguage (int $a_usr_id)

	setRefId (int $a_id)

	getRefId ()

	getObjId ()

	setObjId (int $a_obj_id)

	getObjType ()

	setAdditionalInformation (array $a_info)

	getAdditionalInformation ()

	sendMail (array $a_rcp, bool $a_parse_recipients=true)

	getBlockBorder ()

Protected Member Functions
	composeAndSendMail (int $a_user_id, ?string $a_goto_additional=null, string $a_permission="read")
	Send notification to single recipient. More...

Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)

	getSubject ()

	setBody (string $a_body)

	appendBody (string $a_body)

	getBody ()

	initLanguage (int $a_usr_id)

	initLanguageByIso2Code (string $a_code='')

	setLanguage (ilLanguage $a_language)

	getLanguage ()

	getLanguageText (string $a_keyword)

	getObjectTitle (bool $a_shorten=false)

	initMail ()

	getMail ()

	createPermanentLink (array $a_params=[], string $a_append='')

	userToString (int $a_usr_id)

	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission="read")

Protected Attributes
string	$subject_lang_id = ""

string	$subject_direct = ""

string	$introduction = ""

string	$introduction_direct = ""

string	$task = ""

string	$reason = ""

array	$additional = []

string	$goto_caption = ""

int	$changed_by = 0

array	$all_ref_ids = []

Protected Attributes inherited from ilMailNotification
int	$type

int	$sender

ilMail	$mail = null

string	$subject = ''

string	$body = ''

array	$attachments = []

ilLanguage	$language

array	$lang_modules = []

array	$recipients = []

int	$ref_id

int	$obj_id = 0

string	$obj_type = ''

array	$additional_info = []

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

Additional Inherited Members
Data Fields inherited from ilMailNotification
final const	SUBJECT_TITLE_LENGTH = 60

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Constructor & Destructor Documentation

◆ __construct()

ilSystemNotification::__construct ( protected bool $is_in_wsp = false )

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

References ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct($is_in_wsp);
         $this->ref_id = 0;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAdditionalInfo()

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

Add additional information.

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

      : void {
         $this->additional[$a_lang_id] = array(trim($a_value), $a_multiline, $a_lang_direct);
     }

◆ compose()

ilSystemNotification::compose	(	int	$a_user_id,
		?string	$a_goto_additional = `null`,
		string	$a_permission = `"read"`,
		bool	$a_append_signature_direct = `false`
	)

Compose notification to single recipient.

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

Referenced by composeAndGetMessage(), and composeAndSendMail().

      : bool {
         $find_ref_id = false;
         $this->initLanguage($a_user_id);
         $this->initMail();
         if ($this->subject_direct) {
             $this->setSubject($this->subject_direct);
         } else {
             $this->setSubject(
                 sprintf($this->getLanguageText($this->subject_lang_id), $this->getObjectTitle(true))
             );
         }
 
         $this->setBody(ilMail::getSalutation($a_user_id, $this->getLanguage()));
         $this->appendBody("\n\n");
 
         if ($this->introduction) {
             $this->appendBody($this->getLanguageText($this->introduction));
             $this->appendBody("\n\n");
         }
 
         if ($this->introduction_direct) {
             $this->appendBody($this->introduction_direct);
             $this->appendBody("\n\n");
         }
 
         if ($this->task) {
             $this->appendBody($this->getLanguageText($this->task));
             $this->appendBody("\n\n");
         }
 
         // details table
         if ($this->getObjId()) {
             $this->appendBody($this->getLanguageText("obj_" . $this->getObjType()) . ": " .
                 $this->getObjectTitle() . "\n");
         }
         if (count($this->additional) > 0) {
             foreach ($this->additional as $lang_id => $item) {
                 $caption = "";
                 if ($lang_id) {
                     $caption = (!$item[2])
                         ? $this->getLanguageText($lang_id)
                         : $lang_id;
                 }
                 if (!$item[1]) {
                     if ($caption) {
                         $caption .= ": ";
                     }
                     $this->appendBody($caption . $item[0] . "\n");
                 } else {
                     if ($caption) {
                         $caption .= "\n";
                     }
                     $this->appendBody("\n" . $caption .
                         $this->getBlockBorder() .
                         $item[0] . "\n" .
                         $this->getBlockBorder() . "\n");
                 }
             }
         }
         $this->body = trim($this->body);
         $this->appendBody("\n\n");
 
         if ($this->changed_by) {
             $this->appendBody($this->getLanguageText("system_notification_installation_changed_by") . ": " .
                 ilUserUtil::getNamePresentation($this->changed_by));
             $this->appendBody("\n\n");
         }
 
         if ($this->getObjId()) {
             // try to find accessible ref_id
             if (!$this->getRefId() && $this->all_ref_ids) {
                 $find_ref_id = true;
                 foreach ($this->all_ref_ids as $ref_id) {
                     if ($this->isRefIdAccessible($a_user_id, $ref_id, $a_permission)) {
                         $this->ref_id = $ref_id;
                         break;
                     }
                 }
             }
 
             // check if initially given ref_id is accessible for current recipient
             if ($this->getRefId() &&
                 !$find_ref_id &&
                 !$this->isRefIdAccessible($a_user_id, $this->getRefId(), $a_permission)) {
                 return false;
             }
 
             $goto = $this->createPermanentLink(array(), (string) $a_goto_additional);
             if ($goto) {
                 $this->appendBody($this->getLanguageText($this->goto_caption) . ": " .
                     $goto);
                 $this->appendBody("\n\n");
             }
 
             if ($find_ref_id) {
                 $this->ref_id = 0;
             }
         }
 
         if ($this->reason) {
             $this->appendBody($this->getLanguageText($this->reason));
             $this->appendBody("\n\n");
         }
 
         $this->appendBody(ilMail::_getAutoGeneratedMessageString($this->language));
 
         // signature will append new lines
         $this->body = trim($this->body);
 
         if (!$a_append_signature_direct) {
             $this->getMail()->appendInstallationSignature(true);
         } else {
             $this->appendBody(ilMail::_getInstallationSignature());
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ composeAndGetMessage()

ilSystemNotification::composeAndGetMessage	(	int	$a_user_id,
		?string	$a_goto_additional = `null`,
		string	$a_permission = `"read"`,
		bool	$a_append_signature_direct = `false`
	)

Compose notification to single recipient.

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

References ilMailNotification\$body, and compose().

      : string {
         if ($this->compose($a_user_id, $a_goto_additional, $a_permission, $a_append_signature_direct)) {
             return $this->body;
         }
         return "";
     }

Here is the call graph for this function:

◆ composeAndSendMail()

ilSystemNotification::composeAndSendMail	(	int	$a_user_id,
		?string	$a_goto_additional = `null`,
		string	$a_permission = `"read"`
	)

protected

Send notification to single recipient.

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

References compose(), and ilMailNotification\sendMail().

Referenced by sendMailAndReturnRecipients().

      : bool {
         if ($this->compose($a_user_id, $a_goto_additional, $a_permission)) {
             $this->sendMail(array($a_user_id), is_numeric($a_user_id));
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailAndReturnRecipients()

ilSystemNotification::sendMailAndReturnRecipients	(	array	$a_user_ids,
		?string	$a_goto_additional = `null`,
		string	$a_permission = `"read"`
	)

Send notification(s)

Parameters

array	$a_user_ids
	?string	$a_goto_additional
string	$a_permission

Returns: array recipient ids

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

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

      : array {
         $this->all_ref_ids = null;
 
         // prepare object related info
         if ($this->getObjId()) {
             if (!$this->getRefId()) {
                 // try to find ref_id(s)
                 if (!$this->is_in_wsp) {
                     $ref_ids = ilObject::_getAllReferences($this->getObjId());
                     if (count($ref_ids) === 1) {
                         $this->ref_id = array_shift($ref_ids);
                     } else {
                         $this->all_ref_ids = $ref_ids;
                     }
                 }
             } elseif ($this->is_in_wsp) { // #11680
                 $this->ref_id = $this->wsp_tree->lookupNodeId($this->getObjId());
             }
 
             // default values
             if (!$this->goto_caption) {
                 $this->goto_caption = "url";
             }
         }
 
         $recipient_ids = array();
         foreach (array_unique($a_user_ids) as $user_id) {
             // author of change should not get notification
             if ($this->changed_by === $user_id) {
                 continue;
             }
             if ($this->composeAndSendMail($user_id, $a_goto_additional, $a_permission)) {
                 $recipient_ids[] = $user_id;
             }
         }
 
         return $recipient_ids;
     }

Here is the call graph for this function:

◆ setChangedByUserId()

ilSystemNotification::setChangedByUserId ( int $a_id )

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

                                                  : void
     {
         $this->changed_by = $a_id;
     }

◆ setGotoLangId()

ilSystemNotification::setGotoLangId ( string $a_lang_id )

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

                                                     : void
     {
         $this->goto_caption = $a_lang_id;
     }

◆ setIntroductionDirect()

ilSystemNotification::setIntroductionDirect ( string $a_text )

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

                                                          : void
     {
         $this->introduction_direct = trim($a_text);
     }

◆ setIntroductionLangId()

ilSystemNotification::setIntroductionLangId ( string $a_lang_id )

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

                                                             : void
     {
         $this->introduction = $a_lang_id;
     }

◆ setReasonLangId()

ilSystemNotification::setReasonLangId ( string $a_lang_id )

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

                                                       : void
     {
         $this->reason = $a_lang_id;
     }

◆ setSubjectDirect()

ilSystemNotification::setSubjectDirect ( string $a_text )

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

                                                     : void
     {
         $this->subject_direct = trim($a_text);
     }

◆ setSubjectLangId()

ilSystemNotification::setSubjectLangId ( string $a_lang_id )

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

                                                        : void
     {
         $this->subject_lang_id = $a_lang_id;
     }

◆ setTaskLangId()

ilSystemNotification::setTaskLangId ( string $a_lang_id )

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

                                                     : void
     {
         $this->task = $a_lang_id;
     }

Field Documentation

◆ $additional

array ilSystemNotification::$additional = []

protected

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

◆ $all_ref_ids

array ilSystemNotification::$all_ref_ids = []

protected

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

◆ $changed_by

int ilSystemNotification::$changed_by = 0

protected

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

◆ $goto_caption

string ilSystemNotification::$goto_caption = ""

protected

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

◆ $introduction

string ilSystemNotification::$introduction = ""

protected

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

◆ $introduction_direct

string ilSystemNotification::$introduction_direct = ""

protected

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

◆ $reason

string ilSystemNotification::$reason = ""

protected

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

◆ $subject_direct

string ilSystemNotification::$subject_direct = ""

protected

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

◆ $subject_lang_id

string ilSystemNotification::$subject_lang_id = ""

protected

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

◆ $task

string ilSystemNotification::$task = ""

protected

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

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

components/ILIAS/Notification/classes/class.ilSystemNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalInfo()

◆ compose()

◆ composeAndGetMessage()

◆ composeAndSendMail()

◆ sendMailAndReturnRecipients()

◆ setChangedByUserId()

◆ setGotoLangId()

◆ setIntroductionDirect()

◆ setIntroductionLangId()

◆ setReasonLangId()

◆ setSubjectDirect()

◆ setSubjectLangId()

◆ setTaskLangId()

Field Documentation

◆ $additional

◆ $all_ref_ids

◆ $changed_by

◆ $goto_caption

◆ $introduction

◆ $introduction_direct

◆ $reason

◆ $subject_direct

◆ $subject_lang_id

◆ $task