Collaboration diagram for ilNotification:

Static Public Member Functions
static	hasNotification ($type, $user_id, $id)
	Check notification status for object and user. More...

static	hasOptOut ($obj_id)
	Is opt out (disable notification) allowed? More...

static	getNotificationsForObject ($type, $id, $page_id=null, $ignore_threshold=false)
	Get all users for given object. More...

static	setNotification ($type, $user_id, $id, $status=true)
	Set notification status for object and user. More...

static	updateNotificationTime ($type, $id, array $user_ids, $page_id=false)
	Update the last mail timestamp for given object and users. More...

static	removeForObject ($type, $id)
	Remove all notifications for given object. More...

static	removeForUser ($user_id)
	Remove all notifications for given user. More...

static	getActivatedNotifications (int $type, int $user_id)
	Get activated notifications of give type for user. More...

Data Fields
const	TYPE_EXERCISE_SUBMISSION = 1

const	TYPE_WIKI = 2

const	TYPE_WIKI_PAGE = 3

const	TYPE_BLOG = 4

const	TYPE_DATA_COLLECTION = 5

const	TYPE_POLL = 6

const	TYPE_LM_BLOCKED_USERS = 7

const	TYPE_BOOK = 8

const	TYPE_LM = 9

const	TYPE_LM_PAGE = 10

const	THRESHOLD = 180

Detailed Description

Class ilNotification.

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 13 of file class.ilNotification.php.

Member Function Documentation

◆ getActivatedNotifications()

static ilNotification::getActivatedNotifications	(	int	$type,
		int	$user_id
	)

static

Get activated notifications of give type for user.

Parameters

int	$type
int	$user_id

Returns: int[]

Definition at line 343 of file class.ilNotification.php.

References $DIC.

Referenced by ilExcTutorRepository\getExerciseIdsBeingTutor().

                                                                               : array
     {
         global $DIC;
 
         $db = $DIC->database();
 
         $set = $db->queryF(
             "SELECT id FROM notification " .
             " WHERE type = %s " .
             " AND user_id = %s " .
             " AND activated = %s ",
             array("integer", "integer", "integer"),
             array($type, $user_id, 1)
         );
         $ids = [];
         while ($rec = $db->fetchAssoc($set)) {
             $ids[] = $rec["id"];
         }
 
         return $ids;
     }

Here is the caller graph for this function:

◆ getNotificationsForObject()

static ilNotification::getNotificationsForObject	(	$type,
		$id,
		$page_id = `null`,
		$ignore_threshold = `false`
	)

static

Get all users for given object.

Parameters

int	$type
int	$id
int	$page_id
bool	$ignore_threshold

Returns: array

Definition at line 120 of file class.ilNotification.php.

References $DIC, $ilDB, $log, $type, ilObject\_getAllReferences(), ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), ilObject\_lookupObjectId(), ilLoggerFactory\getLogger(), ilObjNotificationSettings\MODE_DEF_OFF_USER_ACTIVATION, ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, and ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT.

Referenced by ilObjDataCollection\doUpdate(), ilExSubmissionBaseGUI\handleNewUpload(), ilExAssTypeWikiTeam\handleNewUpload(), ilExAssignmentReminder\parseGradeReminders(), ilLMPageGUI\processAnswer(), ilLearningModuleNotification\send(), ilObjBlog\sendNotification(), ilWikiUtil\sendNotification(), ilBookCronNotification\sendNotifications(), and ilObjPollGUI\sendNotifications().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $tree = $DIC->repositoryTree();
 
         include_once("./Services/Notification/classes/class.ilObjNotificationSettings.php");
 
         $log = ilLoggerFactory::getLogger('noti');
         $log->debug("Get notifications for type " . $type . ", id " . $id . ", page_id " . $page_id .
             ", ignore threshold " . $ignore_threshold);
 
         // currently done for blog
         $recipients = array();
         $setting = new ilObjNotificationSettings($id);
         if ($setting->getMode() != ilObjNotificationSettings::MODE_DEF_OFF_USER_ACTIVATION) {
             foreach (ilObject::_getAllReferences($id) as $ref_id) {
                 $grp_ref_id = $tree->checkForParentType($ref_id, 'grp');
                 if ($grp_ref_id > 0) {
                     include_once("./Modules/Group/classes/class.ilGroupParticipants.php");
                     $p = ilGroupParticipants::_getInstanceByObjId(ilObject::_lookupObjectId($grp_ref_id));
                     foreach ($p->getMembers() as $user_id) {
                         if (!in_array($user_id, $recipients)) {
                             $recipients[$user_id] = $user_id;
                         }
                     }
                 }
                 $crs_ref_id = $tree->checkForParentType($ref_id, 'crs');
                 if ($crs_ref_id > 0) {
                     include_once("./Modules/Course/classes/class.ilCourseParticipants.php");
                     $p = ilCourseParticipants::_getInstanceByObjId(ilObject::_lookupObjectId($crs_ref_id));
                     foreach ($p->getMembers() as $user_id) {
                         if (!in_array($user_id, $recipients)) {
                             $recipients[$user_id] = $user_id;
                         }
                     }
                 }
             }
         }
 
         $log->debug("Step 1 recipients: " . print_r($recipients, true));
 
 
         // remove all users that deactivated the feature
         if ($setting->getMode() == ilObjNotificationSettings::MODE_DEF_ON_OPT_OUT) {
             $sql = "SELECT user_id FROM notification" .
                 " WHERE type = " . $ilDB->quote($type, "integer") .
                 " AND id = " . $ilDB->quote($id, "integer") .
                 " AND activated = " . $ilDB->quote(0, "integer") .
                 " AND " . $ilDB->in("user_id", $recipients, false, "integer");
             $set = $ilDB->query($sql);
             while ($rec = $ilDB->fetchAssoc($set)) {
                 unset($recipients[$rec["user_id"]]);
                 $log->debug("Remove due to deactivation: " . $rec["user_id"]);
             }
         }
 
         // remove all users that got a mail
         // see #22773
         //if ($setting->getMode() != ilObjNotificationSettings::MODE_DEF_OFF_USER_ACTIVATION && !$ignore_threshold) {
         if (!$ignore_threshold) {
             $sql = "SELECT user_id FROM notification" .
                 " WHERE type = " . $ilDB->quote($type, "integer") .
                 " AND id = " . $ilDB->quote($id, "integer") .
                 " AND " . $ilDB->in("user_id", $recipients, false, "integer");
             $sql .= " AND (last_mail > " . $ilDB->quote(date(
                 "Y-m-d H:i:s",
                 strtotime("-" . self::THRESHOLD . "minutes")
             ), "timestamp");
             if ($page_id) {
                 $sql .= " AND page_id = " . $ilDB->quote($page_id, "integer");
             }
             $sql .= ")";
             $set = $ilDB->query($sql);
             while ($rec = $ilDB->fetchAssoc($set)) {
                 unset($recipients[$rec["user_id"]]);
                 $log->debug("Remove due to got mail: " . $rec["user_id"]);
             }
         }
 
         // get single subscriptions
         if ($setting->getMode() != ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT) {
             $sql = "SELECT user_id FROM notification" .
                 " WHERE type = " . $ilDB->quote($type, "integer") .
                 " AND id = " . $ilDB->quote($id, "integer") .
                 " AND activated = " . $ilDB->quote(1, "integer");
             if (!$ignore_threshold) {
                 $sql .= " AND (last_mail < " . $ilDB->quote(date(
                     "Y-m-d H:i:s",
                     strtotime("-" . self::THRESHOLD . "minutes")
                 ), "timestamp") .
                     " OR last_mail IS NULL";
                 if ($page_id) {
                     $sql .= " OR page_id <> " . $ilDB->quote($page_id, "integer");
                 }
                 $sql .= ")";
             }
             $set = $ilDB->query($sql);
             while ($row = $ilDB->fetchAssoc($set)) {
                 $recipients[$row["user_id"]] = $row["user_id"];
                 $log->debug("Adding single subscription: " . $row["user_id"]);
             }
         }
 
         return $recipients;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasNotification()

static ilNotification::hasNotification	(	$type,
		$user_id,
		$id
	)

static

Check notification status for object and user.

Parameters

int	$type
int	$user_id
int	$id

Returns: bool

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

References $DIC, $ilDB, $type, ilObject\_getAllReferences(), ilGroupParticipants\_isParticipant(), ilParticipants\_isParticipant(), ilObjNotificationSettings\MODE_DEF_OFF_USER_ACTIVATION, ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT, and ilObjNotificationSettings\MODE_DEF_ON_OPT_OUT.

Referenced by ilWikiPageGUI\addHeaderAction(), ilObjDataCollectionGUI\addHeaderAction(), ilObjExerciseGUI\getEditFormCustomValues(), ilLMPresentationGUI\getHeaderAction(), ilPollBlockGUI\getHTML(), ilObjContentObjectGUI\getPropertiesFormValues(), ilObjBookingPoolGUI\initHeaderAction(), and ilObjBlogGUI\initHeaderAction().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $tree = $DIC->repositoryTree();
 
         $notification = false;
 
         include_once("./Services/Notification/classes/class.ilObjNotificationSettings.php");
         $setting = new ilObjNotificationSettings($id);
         if ($setting->getMode() != ilObjNotificationSettings::MODE_DEF_OFF_USER_ACTIVATION) {
             // check membership, members should be notidifed...
             foreach (ilObject::_getAllReferences($id) as $ref_id) {
                 $grp_ref_id = $tree->checkForParentType($ref_id, 'grp');
                 if ($grp_ref_id > 0) {
                     include_once("./Modules/Group/classes/class.ilGroupParticipants.php");
                     if (ilGroupParticipants::_isParticipant($grp_ref_id, $user_id)) {
                         $notification = true;
                     }
                 }
                 $crs_ref_id = $tree->checkForParentType($ref_id, 'crs');
                 if ($crs_ref_id > 0) {
                     include_once("./Modules/Course/classes/class.ilCourseParticipants.php");
                     if (ilCourseParticipants::_isParticipant($crs_ref_id, $user_id)) {
                         $notification = true;
                     }
                 }
             }
 
             if ($notification && $setting->getMode() == ilObjNotificationSettings::MODE_DEF_ON_OPT_OUT) {
                 $set = $ilDB->query("SELECT user_id FROM notification" .
                     " WHERE type = " . $ilDB->quote($type, "integer") .
                     " AND user_id = " . $ilDB->quote($user_id, "integer") .
                     " AND id = " . $ilDB->quote($id, "integer") .
                     " AND activated = " . $ilDB->quote(0, "integer"));
                 $rec = $ilDB->fetchAssoc($set);
                 // ... except when the opted out
                 if ($rec["user_id"] == $user_id) {
                     return false;
                 }
                 return true;
             }
 
             if ($notification && $setting->getMode() == ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT) {
                 return true;
             }
         }
 
 
         $set = $ilDB->query("SELECT user_id FROM notification" .
             " WHERE type = " . $ilDB->quote($type, "integer") .
             " AND user_id = " . $ilDB->quote($user_id, "integer") .
             " AND id = " . $ilDB->quote($id, "integer") .
             " AND activated = " . $ilDB->quote(1, "integer"));
 
         return (bool) $ilDB->numRows($set);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasOptOut()

static ilNotification::hasOptOut ( $obj_id )

static

Is opt out (disable notification) allowed?

Parameters

int $obj_id

Returns: bool

Definition at line 101 of file class.ilNotification.php.

References ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT.

Referenced by ilWikiPageGUI\addHeaderAction(), ilLMPresentationGUI\getHeaderAction(), and ilObjBlogGUI\initHeaderAction().

     {
         include_once("./Services/Notification/classes/class.ilObjNotificationSettings.php");
         $setting = new ilObjNotificationSettings($obj_id);
         if ($setting->getMode() == ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ removeForObject()

static ilNotification::removeForObject	(	$type,
		$id
	)

static

Remove all notifications for given object.

Parameters

int	$type
int	$id

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

References $DIC, $ilDB, and $type.

Referenced by ilWikiPage\delete(), ilObjExercise\delete(), ilObjWiki\delete(), and ilObjBlog\doDelete().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilDB->query("DELETE FROM notification" .
                 " WHERE type = " . $ilDB->quote($type, "integer") .
                 " AND id = " . $ilDB->quote($id, "integer"));
     }

Here is the caller graph for this function:

◆ removeForUser()

static ilNotification::removeForUser ( $user_id )

static

Remove all notifications for given user.

Parameters

int $user_id

Definition at line 326 of file class.ilNotification.php.

References $DIC, and $ilDB.

Referenced by ilObjUser\delete().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilDB->query("DELETE FROM notification" .
                 " WHERE user_id = " . $ilDB->quote($user_id, "integer"));
     }

Here is the caller graph for this function:

◆ setNotification()

static ilNotification::setNotification	(	$type,
		$user_id,
		$id,
		$status = `true`
	)

static

Set notification status for object and user.

Parameters

int	$type
int	$user_id
int	$id
bool	$status

Definition at line 236 of file class.ilNotification.php.

References $DIC, $ilDB, and $type.

Referenced by ilWikiPageGUI\executeCommand(), ilLMPresentationGUI\executeCommand(), ilObjBookingPoolGUI\saveNotificationObject(), ilObjContentObjectGUI\saveProperties(), ilObjBlogGUI\setNotification(), ilObjPollGUI\subscribe(), ilObjDataCollectionGUI\toggleNotification(), ilObjBibliographicGUI\toggleNotification(), ilObjPollGUI\unsubscribe(), and ilObjExerciseGUI\updateCustom().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $fields = array(
             "type" => array("integer", $type),
             "user_id" => array("integer", $user_id),
             "id" => array("integer", $id)
         );
         $ilDB->replace("notification", $fields, array("activated" => array("integer", (int) $status)));
     }

Here is the caller graph for this function:

◆ updateNotificationTime()

static ilNotification::updateNotificationTime	(		$type,
			$id,
		array	$user_ids,
			$page_id = `false`
	)

static

Update the last mail timestamp for given object and users.

Parameters

int	$type
int	$id
array	$user_ids
int	$page_id

Definition at line 258 of file class.ilNotification.php.

References $DIC, $ilDB, and $type.

Referenced by ilObjDataCollection\doUpdate(), ilLearningModuleNotification\send(), ilObjBlog\sendNotification(), ilWikiUtil\sendNotification(), and ilObjPollGUI\sendNotifications().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         // create initial entries, if not existing
         // see #22773, currently only done for wiki, might be feasible for other variants
         if (in_array($type, [self::TYPE_WIKI, self::TYPE_BLOG])) {
             $set = $ilDB->queryF(
                 "SELECT user_id FROM notification " .
                 " WHERE type = %s AND id = %s AND " .
                 $ilDB->in("user_id", $user_ids, false, "integer"),
                 ["integer", "integer"],
                 [$type, $id]
             );
             $noti_users = [];
             while ($rec = $ilDB->fetchAssoc($set)) {
                 $noti_users[] = $rec["user_id"];
             }
             foreach ($user_ids as $user_id) {
                 if (!in_array($user_id, $noti_users)) {
                     $ilDB->insert("notification", [
                         "type" => ["integer", $type],
                         "id" => ["integer", $id],
                         "user_id" => ["integer", $user_id],
                         "page_id" => ["integer", (int) $page_id],
                         "activated" => ["integer", 1]
                     ]);
                 }
             }
         }
 
         $sql = "UPDATE notification" .
                 " SET last_mail = " . $ilDB->quote(date("Y-m-d H:i:s"), "timestamp");
 
         if ($page_id) {
             $sql .= ", page_id = " . $ilDB->quote($page_id, "integer");
         }
 
         $sql .= " WHERE type = " . $ilDB->quote($type, "integer") .
                 " AND id = " . $ilDB->quote($id, "integer") .
                 " AND " . $ilDB->in("user_id", $user_ids, false, "integer");
         $ilDB->query($sql);
     }