ilNotification Class Reference

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

Collaboration diagram for ilNotification:

Static Public Member Functions
static	hasNotification (int $type, int $user_id, int $id)
	Check notification status for object and user. More...
static	hasOptOut (int $obj_id)
	Is opt out (disable notification) allowed? More...
static	getNotificationsForObject (int $type, int $id, ?int $page_id=null, bool $ignore_threshold=false)
	Get all users/recipients for given object. More...
static	setNotification (int $type, int $user_id, int $id, bool $status=true)
	Set notification status for object and user. More...
static	updateNotificationTime (int $type, int $id, array $user_ids, ?int $page_id=null, bool $activate_new_entries=true)
	Update the last mail timestamp for given object and users. More...
static	removeForObject (int $type, int $id)
	Remove all notifications for given object. More...
static	removeForUser (int $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	THRESHOLD = 180
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

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

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 19 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.

Returns

int[]

Definition at line 339 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 ( int  $type, int  $id, ?int  $page_id = null, bool  $ignore_threshold = false  )

static

Get all users/recipients for given object.

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

References $DIC, $ilDB, $log, $ref_id, ilObject\_getAllReferences(), ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_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(), ilWikiUtil\sendNotification(), ilObjBlog\sendNotification(), ilBookCronNotification\sendNotifications(), and ilObjPollGUI\sendNotifications().

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $tree = $DIC->repositoryTree();


        $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) {
                    $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) {
                    $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"]);
            }
        }

        // 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"]);
            }
        }

        // 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"]);
            }

            if ($type === self::TYPE_WIKI) {
                $sql = "SELECT user_id FROM notification" .
                    " WHERE type = " . $ilDB->quote(self::TYPE_WIKI_PAGE, "integer") .
                    " AND id = " . $ilDB->quote($page_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");
                $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"]);
                }
            }
        }


        return $recipients;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasNotification()

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

static

Check notification status for object and user.

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

References $DIC, $ilDB, $ref_id, ilObject\_getAllReferences(), ilGroupParticipants\_isParticipant(), ilParticipants\_isParticipant(), ILIAS\Repository\int(), 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().

     : bool {
        global $DIC;

        $ilDB = $DIC->database();
        $tree = $DIC->repositoryTree();

        $notification = false;

        $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) && ilGroupParticipants::_isParticipant($grp_ref_id, $user_id)) {
                    $notification = true;
                }
                $crs_ref_id = $tree->checkForParentType($ref_id, 'crs');
                if (($crs_ref_id > 0) && 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);
                // if there is no user record, take the default value
                if (!isset($rec["user_id"])) {
                    return $notification;
                }
                // ... except when the opted out
                return isset($rec["user_id"]) && ((int) $rec["user_id"] !== $user_id);
            }

            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 ( int  $obj_id )

static

Is opt out (disable notification) allowed?

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

References ilObjNotificationSettings\MODE_DEF_ON_NO_OPT_OUT.

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

                                                 : bool
    {
        $setting = new ilObjNotificationSettings($obj_id);
        return $setting->getMode() !== ilObjNotificationSettings::MODE_DEF_ON_NO_OPT_OUT;
    }

Here is the caller graph for this function:

removeForObject()

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

static

Remove all notifications for given object.

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

References $DIC, and $ilDB.

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

     : void {
        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 ( int  $user_id )

static

Remove all notifications for given user.

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

References $DIC, and $ilDB.

Referenced by ilObjUser\delete(), and NotificationTest\testRemoveForUser().

     : void {
        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 ( int  $type, int  $user_id, int  $id, bool  $status = true  )

static

Set notification status for object and user.

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

References $DIC, and $ilDB.

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

     : void {
        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 ( int  $type, int  $id, array  $user_ids, ?int  $page_id = null, bool  $activate_new_entries = true  )

static

Update the last mail timestamp for given object and users.

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

References $DIC, $id, $ilDB, and $type.

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

     : void {
        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_PAGE, 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", (int) $activate_new_entries]
                    ]);
                }
            }
        }

        $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);
    }

Here is the caller graph for this function:

Field Documentation

THRESHOLD

const ilNotification::THRESHOLD = 180

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

TYPE_BLOG

const ilNotification::TYPE_BLOG = 4

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

Referenced by ilObjBlog\doDelete(), ilObjBlogGUI\initHeaderAction(), ilObjBlog\sendNotification(), and ilObjBlogGUI\setNotification().

TYPE_BOOK

const ilNotification::TYPE_BOOK = 8

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

Referenced by ilObjBookingPoolGUI\initHeaderAction(), ilObjBookingPoolGUI\saveNotificationObject(), and ilBookCronNotification\sendNotifications().

TYPE_DATA_COLLECTION

const ilNotification::TYPE_DATA_COLLECTION = 5

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

Referenced by ilObjDataCollectionGUI\addHeaderAction(), ilObjDataCollection\doUpdate(), ilObjDataCollectionGUI\toggleNotification(), and ilObjBibliographicGUI\toggleNotification().

TYPE_EXERCISE_SUBMISSION

const ilNotification::TYPE_EXERCISE_SUBMISSION = 1

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

Referenced by ilObjExercise\delete(), ilObjExerciseGUI\getEditFormCustomValues(), ilExcTutorRepository\getExerciseIdsBeingTutor(), ilExSubmissionBaseGUI\handleNewUpload(), ilExAssTypeWikiTeam\handleNewUpload(), ilExAssignmentReminder\parseGradeReminders(), and ilObjExerciseGUI\updateCustom().

TYPE_LM

const ilNotification::TYPE_LM = 9

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

Referenced by ilLMPresentationGUI\executeCommand(), ilLMPresentationGUI\getHeaderAction(), and ilLearningModuleNotification\send().

TYPE_LM_BLOCKED_USERS

const ilNotification::TYPE_LM_BLOCKED_USERS = 7

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

Referenced by ilObjContentObjectGUI\getPropertiesFormValues(), ilLMPageGUI\processAnswer(), and ilObjContentObjectGUI\saveProperties().

TYPE_LM_PAGE

const ilNotification::TYPE_LM_PAGE = 10

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

Referenced by ilLMPage\afterUpdate(), ilLMPresentationGUI\executeCommand(), ilLMPresentationGUI\getHeaderAction(), ilLMPresentationGUI\observeNoteAction(), and ilLearningModuleNotification\send().

TYPE_POLL

const ilNotification::TYPE_POLL = 6

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

Referenced by ilPollBlockGUI\getHTML(), ilObjPollGUI\sendNotifications(), ilObjPollGUI\subscribe(), and ilObjPollGUI\unsubscribe().

TYPE_WIKI

const ilNotification::TYPE_WIKI = 2

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

Referenced by ilWikiPageGUI\addHeaderAction(), ilWikiPage\create(), ilObjWiki\delete(), ilWikiPageGUI\executeCommand(), and ilWikiUtil\sendNotification().

TYPE_WIKI_PAGE

const ilNotification::TYPE_WIKI_PAGE = 3

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

Referenced by ilWikiPageGUI\addHeaderAction(), ilWikiPage\delete(), ilWikiPageGUI\executeCommand(), ilWikiPageGUI\observeNoteAction(), ilWikiUtil\sendNotification(), and ilWikiPage\update().

---

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

• Services/Notification/classes/class.ilNotification.php