Class ilLearningModuleNotification class. More...

Collaboration diagram for ilLearningModuleNotification:

Public Member Functions
	__construct (string $a_action, int $a_type, ilObjLearningModule $a_learning_module, int $a_page_id, string $a_comment=null)
	ilLearningModuleNotification constructor. More...

	send ()
	Generate notifications and send them if necessary. More...

Data Fields
const	ACTION_COMMENT = "comment"

const	ACTION_UPDATE = "update"

Protected Member Functions
	getLink ()
	Get Link to the LM page. More...

	getPageTitle ()
	Get formatted title page. More...

	getMailSubject (ilLanguage $ulng)
	get Subject of mail/notification More...

	getMailBody (ilLanguage $a_ulng, int $a_user_id)
	get email/notification body More...

	getPreviewText (ilLanguage $a_ulng)
	Get first 500 characters of the recently added content behavior copied from ilWikiUtil->sendNotification. More...

Protected Attributes
	$ilUser

	$ilAccess

	$lng

	$lm_set

	$action

	$type

	$learning_module

	$page_id

	$comment

	$link

	$lm_ref_id

	$pg_title

Detailed Description

Class ilLearningModuleNotification class.

//TODO create an interface for notifications contract.(ilnotification?).Similar code in ilwikipage, ilblogposting

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 14 of file class.ilLearningModuleNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningModuleNotification::__construct	(	string	$a_action,
		int	$a_type,
		ilObjLearningModule	$a_learning_module,
		int	$a_page_id,
		string	$a_comment = `null`
	)

ilLearningModuleNotification constructor.

Parameters

string	$a_action
int	$a_type	Notification type e.g. ilNotification::TYPE_LM_PAGE
ilObjLearningModule	$a_learning_module
int	$a_page_id
string \| null	$a_comment

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

References $DIC, comment(), getLink(), and getPageTitle().

     {
         global $DIC;
 
         $this->ilUser = $DIC->user();
         $this->ilAccess = $DIC->access();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("content");
         $this->lm_set = new ilSetting("lm");
         $this->action = $a_action;
         $this->type = $a_type;
         $this->learning_module = $a_learning_module;
         $this->page_id = $a_page_id;
         $this->comment = $a_comment;
         $this->lm_ref_id = $this->learning_module->getRefId();
         $this->link = $this->getLink();
         $this->pg_title = $this->getPageTitle();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getLink()

ilLearningModuleNotification::getLink ( )

protected

Get Link to the LM page.

Returns: string

Definition at line 159 of file class.ilLearningModuleNotification.php.

References ilLink\_getLink().

Referenced by __construct().

                                  : string
     {
         // #15192 - should always be present
         if ($this->page_id) {
             // #18804 - see ilWikiPageGUI::preview()
             return ilLink::_getLink("", "pg", null, $this->page_id . "_" . $this->lm_ref_id);
         }
 
         return ilLink::_getLink($this->lm_ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMailBody()

ilLearningModuleNotification::getMailBody	(	ilLanguage	$a_ulng,
		int	$a_user_id
	)

protected

get email/notification body

Parameters

ilLanguage	$a_ulng
int	$a_user_id

Returns: string

Definition at line 207 of file class.ilLearningModuleNotification.php.

References $link, $message, ilObjUser\_lookupFullname(), comment(), ilUserUtil\getNamePresentation(), getPreviewText(), and ilLanguage\txt().

Referenced by send().

                                                                        : string
     {
         $message = sprintf($a_ulng->txt('cont_change_notification_salutation'), ilObjUser::_lookupFullname($a_user_id)) . "\n\n";
         $message .= $a_ulng->txt('cont_notification_' . $this->action . "_lm") . ":\n\n";
         $message .= $a_ulng->txt('learning module') . ": " . $this->learning_module->getTitle() . "\n";
         $message .= $a_ulng->txt('page') . ": " . $this->pg_title . "\n";
         if ($this->action == self::ACTION_COMMENT) {
             // include comment/note text
             $message .= $a_ulng->txt('cont_commented_by') . ": " . ilUserUtil::getNamePresentation($this->ilUser->getId()) . "\n";
             $message .= "\n" . $a_ulng->txt('comment') . ":\n\"" . trim($this->comment) . "\"\n";
         } else {
             $message .= $this->getPreviewText($a_ulng);
         }
 
         $message .= "\n" . $a_ulng->txt('url') . ": " . $this->link;
 
         return $message;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMailSubject()

ilLearningModuleNotification::getMailSubject ( ilLanguage $ulng )

protected

get Subject of mail/notification

Parameters

ilLanguage $ulng

Returns: string

Definition at line 192 of file class.ilLearningModuleNotification.php.

References $pg_title, and ilLanguage\txt().

Referenced by send().

                                                         : string
     {
         if ($this->action == self::ACTION_COMMENT) {
             return sprintf($ulng->txt('cont_notification_comment_subject_lm'), $this->learning_module->getTitle(), $this->pg_title);
         }
 
         return sprintf($ulng->txt('cont_change_notification_subject_lm'), $this->learning_module->getTitle(), $this->pg_title);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPageTitle()

ilLearningModuleNotification::getPageTitle ( )

protected

Get formatted title page.

Returns: string

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

References ilLMPageObject\_getPresentationTitle().

Referenced by __construct().

                                       : string
     {
         return (string) ilLMPageObject::_getPresentationTitle(
             $this->page_id,
             $this->learning_module->getPageHeader(),
             $this->learning_module->isActiveNumbering(),
             $this->lm_set->get("time_scheduled_page_activation"),
             false,
             0,
             $this->lng->getLangKey()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPreviewText()

ilLearningModuleNotification::getPreviewText ( ilLanguage $a_ulng )

protected

Get first 500 characters of the recently added content behavior copied from ilWikiUtil->sendNotification.

Parameters

ilLanguage $a_ulng

Returns: string

Definition at line 232 of file class.ilLearningModuleNotification.php.

References ilPageObject\truncateHTML(), and ilLanguage\txt().

Referenced by getMailBody().

                                                           : string
     {
         $page = new ilLMPageGUI($this->page_id);
         $page->setRawPageContent(true);
         $page->setAbstractOnly(true);
         $page->setFileDownloadLink(".");
         $page->setFullscreenLink(".");
         $page->setSourcecodeDownloadScript(".");
         $str = $page->showPage();
         $str = ilPageObject::truncateHTML($str, 500, "...");
         // making things more readable
         $str = str_replace('<br/>', "\n", $str);
         $str = str_replace('<br />', "\n", $str);
         $str = str_replace('</p>', "\n", $str);
         $str = str_replace('</div>', "\n", $str);
         $str = trim(strip_tags($str));
 
         $content = "\n" . $a_ulng->txt('content') . "\n" .
             "----------------------------------------\n" .
             $str . "\n" .
             "----------------------------------------\n";
 
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ilLearningModuleNotification::send ( )

Generate notifications and send them if necessary.

Definition at line 109 of file class.ilLearningModuleNotification.php.

References $message, ilLanguageFactory\_getLanguageOfUser(), ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, getMailBody(), getMailSubject(), ilNotification\getNotificationsForObject(), ilNotification\TYPE_LM, ilNotification\TYPE_LM_PAGE, and ilNotification\updateNotificationTime().

     {
         $lm_id = $this->learning_module->getId();
 
         // #11138  //only comment implemented so always true.
         $ignore_threshold = ($this->action == self::ACTION_COMMENT);
 
         $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_LM, $lm_id, "", $ignore_threshold);
 
         if ($this->type == ilNotification::TYPE_LM_PAGE) {
             $page_users = ilNotification::getNotificationsForObject($this->type, $this->page_id, null, $ignore_threshold);
             $users = array_merge($users, $page_users);
             ilNotification::updateNotificationTime(ilNotification::TYPE_LM_PAGE, $this->page_id, $users);
         }
 
         if (!sizeof($users)) {
             return;
         }
 
         ilNotification::updateNotificationTime(ilNotification::TYPE_LM, $lm_id, $users, $this->page_id);
 
 
         foreach (array_unique($users) as $idx => $user_id) {
             if ($user_id != $this->ilUser->getId() &&
                 $this->ilAccess->checkAccessOfUser($user_id, 'read', '', $this->lm_ref_id)) {
                 // use language of recipient to compose message
                 $ulng = ilLanguageFactory::_getLanguageOfUser($user_id);
                 $ulng->loadLanguageModule('content');
 
                 $subject = $this->getMailSubject($ulng);
                 $message = $this->getMailBody($ulng, $user_id);
 
                 $mail_obj = new ilMail(ANONYMOUS_USER_ID);
                 $mail_obj->appendInstallationSignature(true);
                 $mail_obj->enqueue(
                     ilObjUser::_lookupLogin($user_id),
                     "",
                     "",
                     $subject,
                     $message,
                     []
                 );
             }
         }
     }