ilForumNotification Class Reference

Collaboration diagram for ilForumNotification:

Public Member Functions
	__construct (int $ref_id)
	setNotificationId (int $a_notification_id)
	getNotificationId ()
	setUserId (?int $a_user_id)
	getUserId ()
	setForumId (int $a_forum_id)
	getForumId ()
	setThreadId (int $a_thread_id)
	getThreadId ()
	setInterestedEvents ($interested_events)
	getInterestedEvents ()
	setAdminForce (bool $a_admin_force)
	getAdminForce ()
	setUserToggle (bool $a_user_toggle)
	getUserToggle ()
	setForumRefId (int $a_ref_id)
	getForumRefId ()
	setUserIdNoti (int $a_user_id_noti)
	getUserIdNoti ()
	isAdminForceNotification ()
	isUserToggleNotification ()
	insertAdminForce ()
	deleteAdminForce ()
	deleteUserToggle ()
	updateUserToggle ()
	update ()
	deleteNotificationAllUsers ()
	read ()
	existsNotification ()
	cloneFromSource (int $sourceRefId)
	updateInterestedEvents ()
	readInterestedEvents ()
	readAllForcedEvents ()
	getForcedEventsObjectByUserId (int $user_id)

Static Public Member Functions
static	checkForumsExistsInsert (int $ref_id, int $user_id)
static	checkForumsExistsDelete (int $ref_id, int $user_id)
static	getCachedNodeData (int $ref_id)
static	_isParentNodeGrpCrs (int $a_ref_id)
static	_clearForcedForumNotifications (array $move_tree_event)
static	mergeThreadNotifications ($merge_source_thread_id, $merge_target_thread_id)

Private Member Functions
	createMissingNotification (int $user_id)

Private Attributes
ilDBInterface	$db
ilObjUser	$user
int	$notification_id
int	$user_id = null
int	$forum_id
int	$thread_id
bool	$admin_force = false
bool	$user_toggle = false
int	$interested_events = 0
int	$ref_id
int	$user_id_noti

Static Private Attributes
static array	$node_data_cache = []
static array	$forced_events_cache = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilForumNotification::__construct

(

int

$ref_id

)

Definition at line 40 of file class.ilForumNotification.php.

References $DIC, $ref_id, and ILIAS\Repository\user().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->ref_id = $ref_id;
        $this->forum_id = $DIC['ilObjDataCache']->lookupObjId($ref_id);
    }

Here is the call graph for this function:

Member Function Documentation

_clearForcedForumNotifications()

static ilForumNotification::_clearForcedForumNotifications ( array  $move_tree_event )

static

Definition at line 342 of file class.ilForumNotification.php.

References $DIC, $ilDB, and ILIAS\Repository\int().

                                                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilObjDataCache = $DIC['ilObjDataCache'];

        if ($move_tree_event['tree'] !== 'tree') {
            return;
        }

        $ref_id = (int) $move_tree_event['source_id'];
        $is_parent = self::_isParentNodeGrpCrs($ref_id);

        if ($is_parent) {
            $forum_id = $ilObjDataCache->lookupObjId($ref_id);

            $ilDB->manipulateF(
                'DELETE FROM frm_notification WHERE frm_id = %s AND admin_force_noti = %s',
                ['integer', 'integer'],
                [$forum_id, 1]
            );
        }
    }

Here is the call graph for this function:

_isParentNodeGrpCrs()

static ilForumNotification::_isParentNodeGrpCrs ( int  $a_ref_id )

static

Definition at line 332 of file class.ilForumNotification.php.

References $DIC, and ilObjectFactory\getInstanceByRefId().

Referenced by ilForumModeratorsGUI\addModerator(), and ilForumModeratorsGUI\detachModeratorRole().

                                                             : bool
    {
        global $DIC;

        $parent_ref_id = $DIC->repositoryTree()->getParentId($a_ref_id);
        $parent_obj = ilObjectFactory::getInstanceByRefId($parent_ref_id);

        return $parent_obj->getType() === 'crs' || $parent_obj->getType() === 'grp';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkForumsExistsDelete()

static ilForumNotification::checkForumsExistsDelete ( int  $ref_id, int  $user_id  )

static

Definition at line 278 of file class.ilForumNotification.php.

References $data, $DIC, and $ilUser.

Referenced by ilPDSelectedItemsBlockGUI\confirmedUnsubscribe().

                                                                             : void
    {
        global $DIC;

        $ilUser = $DIC->user();

        $node_data = self::getCachedNodeData($ref_id);

        foreach ($node_data as $data) {
            $frm_noti = new ilForumNotification((int) $data['ref_id']);
            $objFrmMods = new ilForumModerators((int) $data['ref_id']);
            $moderator_ids = $objFrmMods->getCurrentModerators();

            if ($user_id !== 0) {
                $frm_noti->setUserId($user_id);
            } else {
                $frm_noti->setUserId($ilUser->getId());
            }

            $frm_noti->setForumId((int) $data['obj_id']);
            if (!in_array($frm_noti->getUserId(), $moderator_ids, true)) {
                $frm_noti->deleteAdminForce();
            }
        }
    }

Here is the caller graph for this function:

checkForumsExistsInsert()

static ilForumNotification::checkForumsExistsInsert ( int  $ref_id, int  $user_id  )

static

Definition at line 243 of file class.ilForumNotification.php.

References $data, $DIC, $ilUser, ilForumProperties\_isAdminForceNoti(), and ilForumProperties\_isUserToggleNoti().

Referenced by ilCourseRegistrationGUI\add(), ilGroupRegistrationGUI\add(), ilObjCourse\register(), and ilForumNotificationTest\testCheckForumsExistsInsert().

                                                                             : void
    {
        global $DIC;

        $ilUser = $DIC->user();

        $node_data = self::getCachedNodeData($ref_id);

        foreach ($node_data as $data) {
            //check frm_properties if frm_noti is enabled
            $frm_noti = new ilForumNotification((int) $data['ref_id']);
            if ($user_id !== 0) {
                $frm_noti->setUserId($user_id);
            } else {
                $frm_noti->setUserId($ilUser->getId());
            }

            $admin_force = ilForumProperties::_isAdminForceNoti((int) $data['obj_id']);
            $frm_noti->setAdminForce($admin_force);

            $user_toggle = ilForumProperties::_isUserToggleNoti((int) $data['obj_id']);
            if ($user_toggle) {
                $frm_noti->setAdminForce(true);
            }

            if ($admin_force || $user_toggle) {
                $frm_noti->setUserToggle($user_toggle);
                $frm_noti->setForumId((int) $data['obj_id']);
                if ($frm_noti->existsNotification() === false) {
                    $frm_noti->insertAdminForce();
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneFromSource()

ilForumNotification::cloneFromSource

(

int

$sourceRefId

)

Definition at line 464 of file class.ilForumNotification.php.

References insertAdminForce(), setAdminForce(), setInterestedEvents(), setUserId(), setUserIdNoti(), and setUserToggle().

                                                     : void
    {
        $sourceNotificationSettings = new self($sourceRefId);
        $records = $sourceNotificationSettings->read();

        foreach ($records as $usrId => $row) {
            $this->setUserId($usrId);
            $this->setAdminForce((bool) $row['admin_force_noti']);
            $this->setUserToggle((bool) $row['user_toggle_noti']);
            $this->setUserIdNoti((int) $row['user_id_noti']);
            $this->setInterestedEvents((int) $row['interested_events']);

            $this->insertAdminForce();
        }
    }

Here is the call graph for this function:

createMissingNotification()

ilForumNotification::createMissingNotification ( int  $user_id )

private

Definition at line 546 of file class.ilForumNotification.php.

References $ref_id.

Referenced by getForcedEventsObjectByUserId().

                                                            : self
    {
        $new_object = new self($this->ref_id);
        $new_object->setUserId($user_id);
        $new_object->setForumId($this->forum_id);
        $new_object->insertAdminForce();

        return $new_object;
    }

Here is the caller graph for this function:

deleteAdminForce()

ilForumNotification::deleteAdminForce

(

)

Definition at line 201 of file class.ilForumNotification.php.

References getForumId(), and getUserId().

                                      : void
    {
        $this->db->manipulateF(
            '
                        DELETE FROM frm_notification
                        WHERE   user_id = %s
                        AND             frm_id = %s
                        AND             admin_force_noti = %s
                        AND             user_id_noti > %s',
            ['integer', 'integer', 'integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId(), 1, 0]
        );
    }

Here is the call graph for this function:

deleteNotificationAllUsers()

ilForumNotification::deleteNotificationAllUsers

(

)

Definition at line 382 of file class.ilForumNotification.php.

References getForumId().

Referenced by ilForumSettingsGUI\updateNotificationSettings().

                                                : void
    {
        $this->db->manipulateF(
            'DELETE FROM frm_notification WHERE frm_id = %s AND user_id_noti > %s',
            ['integer', 'integer'],
            [$this->getForumId(), 0]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteUserToggle()

ilForumNotification::deleteUserToggle

(

)

Definition at line 215 of file class.ilForumNotification.php.

References getForumId(), and getUserId().

                                      : void
    {
        $this->db->manipulateF(
            '
                        DELETE FROM frm_notification
                        WHERE   user_id = %s
                        AND             frm_id = %s
                        AND             admin_force_noti = %s
                        AND             user_toggle_noti = %s
                        AND             user_id_noti > %s',
            ['integer', 'integer', 'integer', 'integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId(), 1, 1, 0]
        );
    }

Here is the call graph for this function:

existsNotification()

ilForumNotification::existsNotification

(

)

Definition at line 453 of file class.ilForumNotification.php.

References $res, getAdminForce(), getForumId(), and getUserId().

                                        : bool
    {
        $res = $this->db->queryF(
            'SELECT user_id FROM frm_notification WHERE user_id = %s AND frm_id = %s AND admin_force_noti = %s',
            ['integer', 'integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId(), (int) $this->getAdminForce()]
        );

        return $this->db->numRows($res) > 0;
    }

Here is the call graph for this function:

getAdminForce()

ilForumNotification::getAdminForce

(

)

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

References $admin_force.

Referenced by existsNotification(), insertAdminForce(), and update().

                                   : bool
    {
        return $this->admin_force;
    }

Here is the caller graph for this function:

getCachedNodeData()

static ilForumNotification::getCachedNodeData ( int  $ref_id )

static

Definition at line 304 of file class.ilForumNotification.php.

References $DIC, $ref_id, and ILIAS\Repository\int().

                                                         : array
    {
        global $DIC;

        if (!array_key_exists($ref_id, self::$node_data_cache)) {
            $node_data = $DIC->repositoryTree()->getSubTree(
                $DIC->repositoryTree()->getNodeData($ref_id),
                true,
                ['frm']
            );
            $node_data = array_filter($node_data, static function (array $forum_node) use ($DIC, $ref_id): bool {
                // filter out forum if a grp lies in the path (#0027702)
                foreach ($DIC->repositoryTree()->getNodePath((int) $forum_node['child'], $ref_id) as $path_node) {
                    $notRootNode = (int) $path_node['child'] !== (int) $ref_id;
                    $isGroup = $path_node['type'] === 'grp';
                    if ($notRootNode && $isGroup) {
                        return false;
                    }
                }

                return true;
            });
            self::$node_data_cache[$ref_id] = $node_data;
        }

        return self::$node_data_cache[$ref_id];
    }

Here is the call graph for this function:

getForcedEventsObjectByUserId()

ilForumNotification::getForcedEventsObjectByUserId

(

int

$user_id

)

Definition at line 533 of file class.ilForumNotification.php.

References $user_id, createMissingNotification(), and readAllForcedEvents().

                                                               : self
    {
        if (!isset(self::$forced_events_cache[$user_id])) {
            $this->readAllForcedEvents();
        }

        if (!isset(self::$forced_events_cache[$user_id])) {
            self::$forced_events_cache[$user_id] = $this->createMissingNotification($user_id);
        }

        return self::$forced_events_cache[$user_id];
    }

Here is the call graph for this function:

getForumId()

ilForumNotification::getForumId

(

)

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

References $forum_id.

Referenced by deleteAdminForce(), deleteNotificationAllUsers(), deleteUserToggle(), existsNotification(), insertAdminForce(), isAdminForceNotification(), isUserToggleNotification(), read(), readInterestedEvents(), update(), updateInterestedEvents(), and updateUserToggle().

                                : int
    {
        return $this->forum_id;
    }

Here is the caller graph for this function:

getForumRefId()

ilForumNotification::getForumRefId

(

)

Definition at line 125 of file class.ilForumNotification.php.

References $ref_id.

                                   : int
    {
        return $this->ref_id;
    }

getInterestedEvents()

ilForumNotification::getInterestedEvents

(

)

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

References $interested_events.

Referenced by update(), and updateInterestedEvents().

                                         : int
    {
        return $this->interested_events;
    }

Here is the caller graph for this function:

getNotificationId()

ilForumNotification::getNotificationId

(

)

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

References $notification_id.

                                       : int
    {
        return $this->notification_id;
    }

getThreadId()

ilForumNotification::getThreadId

(

)

Definition at line 85 of file class.ilForumNotification.php.

References $thread_id.

                                 : int
    {
        return $this->thread_id;
    }

getUserId()

ilForumNotification::getUserId

(

)

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

References $user_id.

Referenced by deleteAdminForce(), deleteUserToggle(), existsNotification(), insertAdminForce(), isAdminForceNotification(), isUserToggleNotification(), readInterestedEvents(), update(), updateInterestedEvents(), and updateUserToggle().

                               : ?int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

getUserIdNoti()

ilForumNotification::getUserIdNoti

(

)

Definition at line 137 of file class.ilForumNotification.php.

References $user_id_noti.

                                   : int
    {
        return $this->user_id_noti;
    }

getUserToggle()

ilForumNotification::getUserToggle

(

)

Definition at line 115 of file class.ilForumNotification.php.

References $user_toggle.

Referenced by insertAdminForce(), update(), and updateUserToggle().

                                   : bool
    {
        return $this->user_toggle;
    }

Here is the caller graph for this function:

insertAdminForce()

ilForumNotification::insertAdminForce

(

)

Definition at line 179 of file class.ilForumNotification.php.

References getAdminForce(), getForumId(), getUserId(), getUserToggle(), setNotificationId(), and ILIAS\Repository\user().

Referenced by cloneFromSource().

                                      : void
    {
        $next_id = $this->db->nextId('frm_notification');
        $this->setNotificationId($next_id);

        $this->db->manipulateF(
            '
                        INSERT INTO frm_notification
                                (notification_id, user_id, frm_id, admin_force_noti, user_toggle_noti, user_id_noti)
                        VALUES(%s, %s, %s, %s, %s, %s)',
            ['integer', 'integer', 'integer', 'integer', 'integer', 'integer'],
            [
                $next_id,
                (int) $this->getUserId(),
                $this->getForumId(),
                $this->getAdminForce(),
                $this->getUserToggle(),
                $this->user->getId()
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAdminForceNotification()

ilForumNotification::isAdminForceNotification

(

)

Definition at line 142 of file class.ilForumNotification.php.

References $res, getForumId(), and getUserId().

                                              : bool
    {
        $res = $this->db->queryF(
            '
                        SELECT admin_force_noti FROM frm_notification
                        WHERE user_id = %s
                        AND frm_id = %s
                        AND user_id_noti > %s ',
            ['integer', 'integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId(), 0]
        );

        if ($row = $this->db->fetchAssoc($res)) {
            return (bool) $row['admin_force_noti'];
        }

        return false;
    }

Here is the call graph for this function:

isUserToggleNotification()

ilForumNotification::isUserToggleNotification

(

)

Definition at line 161 of file class.ilForumNotification.php.

References $res, getForumId(), and getUserId().

                                              : bool
    {
        $res = $this->db->queryF(
            '
                        SELECT user_toggle_noti FROM frm_notification
                        WHERE user_id = %s
                        AND frm_id = %s
                        AND user_id_noti > %s',
            ['integer', 'integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId(), 0]
        );

        if ($row = $this->db->fetchAssoc($res)) {
            return (bool) $row['user_toggle_noti'];
        }
        return false;
    }

Here is the call graph for this function:

mergeThreadNotifications()

static ilForumNotification::mergeThreadNotifications (   $merge_source_thread_id,   $merge_target_thread_id  )

static

Definition at line 413 of file class.ilForumNotification.php.

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilForum\mergeThreads(), and ilForumNotificationTest\testMergeThreadNotifications().

                                                                                                     : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = $ilDB->queryF(
            'SELECT notification_id, user_id FROM frm_notification WHERE frm_id = %s AND  thread_id = %s ORDER BY user_id ASC',
            ['integer', 'integer'],
            [0, $merge_source_thread_id]
        );

        $res_2 = $ilDB->queryF(
            'SELECT DISTINCT user_id FROM frm_notification WHERE frm_id = %s AND  thread_id = %s ORDER BY user_id ASC',
            ['integer', 'integer'],
            [0, $merge_target_thread_id]
        );

        $users_already_notified = [];
        while ($users_row = $ilDB->fetchAssoc($res_2)) {
            $users_already_notified[(int) $users_row['user_id']] = (int) $users_row['user_id'];
        }

        while ($row = $ilDB->fetchAssoc($res)) {
            if (isset($users_already_notified[(int) $row['user_id']])) {
                $ilDB->manipulateF(
                    'DELETE FROM frm_notification WHERE notification_id = %s',
                    ['integer'],
                    [$row['notification_id']]
                );
            } else {
                $ilDB->update(
                    'frm_notification',
                    ['thread_id' => ['integer', $merge_target_thread_id]],
                    ['thread_id' => ['integer', $merge_source_thread_id]]
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilForumNotification::read

(

)

Returns

array<int, array<string, mixed>>

Definition at line 394 of file class.ilForumNotification.php.

References $res, getForumId(), and ILIAS\Repository\int().

                          : array
    {
        $result = [];

        $res = $this->db->queryF('SELECT * FROM frm_notification WHERE frm_id = %s', ['integer'], [$this->getForumId()]);
        while ($row = $this->db->fetchAssoc($res)) {
            $result[(int) $row['user_id']]['notification_id'] = (int) $row['notification_id'];
            $result[(int) $row['user_id']]['user_id'] = (int) $row['user_id'];
            $result[(int) $row['user_id']]['frm_id'] = (int) $row['frm_id'];
            $result[(int) $row['user_id']]['thread_id'] = (int) $row['thread_id'];
            $result[(int) $row['user_id']]['admin_force_noti'] = (int) $row['admin_force_noti'];
            $result[(int) $row['user_id']]['user_toggle_noti'] = (int) $row['user_toggle_noti'];
            $result[(int) $row['user_id']]['interested_events'] = (int) $row['interested_events'];
            $result[(int) $row['user_id']]['user_id_noti'] = (int) $row['user_id_noti'];
        }

        return $result;
    }

Here is the call graph for this function:

readAllForcedEvents()

ilForumNotification::readAllForcedEvents

(

)

Returns

array<int, ilForumNotification>

Definition at line 510 of file class.ilForumNotification.php.

References $ref_id, $res, and ILIAS\Repository\int().

Referenced by getForcedEventsObjectByUserId(), and ilForumSettingsGUI\initForcedForumNotification().

                                         : array
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_notification WHERE admin_force_noti = %s AND frm_id = %s',
            ['integer', 'integer'],
            [1, $this->forum_id]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $notificationConfig = new self($this->ref_id);
            $notificationConfig->setNotificationId((int) $row['notification_id']);
            $notificationConfig->setUserId((int) $row['user_id']);
            $notificationConfig->setForumId((int) $row['frm_id']);
            $notificationConfig->setAdminForce((bool) $row['admin_force_noti']);
            $notificationConfig->setUserToggle((bool) $row['user_toggle_noti']);
            $notificationConfig->setInterestedEvents((int) $row['interested_events']);

            self::$forced_events_cache[(int) $row['user_id']] = $notificationConfig;
        }

        return self::$forced_events_cache;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readInterestedEvents()

ilForumNotification::readInterestedEvents

(

)

Definition at line 489 of file class.ilForumNotification.php.

References $interested_events, $res, ilForumNotificationEvents\DEACTIVATED, getForumId(), getUserId(), and ILIAS\Repository\int().

                                          : int
    {
        $interested_events = ilForumNotificationEvents::DEACTIVATED;

        $this->db->setLimit(1);
        $res = $this->db->queryF(
            'SELECT interested_events FROM frm_notification WHERE user_id = %s AND frm_id = %s',
            ['integer', 'integer'],
            [(int) $this->getUserId(), $this->getForumId()]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $interested_events = (int) $row['interested_events'];
        }

        return $interested_events;
    }

Here is the call graph for this function:

setAdminForce()

ilForumNotification::setAdminForce

(

bool

$a_admin_force

)

Definition at line 100 of file class.ilForumNotification.php.

Referenced by cloneFromSource(), and ilForumSettingsGUI\showMembers().

                                                      : void
    {
        $this->admin_force = $a_admin_force;
    }

Here is the caller graph for this function:

setForumId()

ilForumNotification::setForumId

(

int

$a_forum_id

)

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

                                               : void
    {
        $this->forum_id = $a_forum_id;
    }

setForumRefId()

ilForumNotification::setForumRefId

(

int

$a_ref_id

)

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

                                                : void
    {
        $this->ref_id = $a_ref_id;
    }

setInterestedEvents()

ilForumNotification::setInterestedEvents

(

$interested_events

)

Definition at line 90 of file class.ilForumNotification.php.

References $interested_events.

Referenced by cloneFromSource().

                                                           : void
    {
        $this->interested_events = $interested_events;
    }

Here is the caller graph for this function:

setNotificationId()

ilForumNotification::setNotificationId

(

int

$a_notification_id

)

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

Referenced by insertAdminForce().

                                                             : void
    {
        $this->notification_id = $a_notification_id;
    }

Here is the caller graph for this function:

setThreadId()

ilForumNotification::setThreadId

(

int

$a_thread_id

)

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

                                                 : void
    {
        $this->thread_id = $a_thread_id;
    }

setUserId()

ilForumNotification::setUserId

(

?int

$a_user_id

)

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

Referenced by cloneFromSource(), ilForumSettingsGUI\disableAdminForceNoti(), ilForumSettingsGUI\disableHideUserToggleNoti(), ilForumSettingsGUI\enableAdminForceNoti(), ilForumSettingsGUI\enableHideUserToggleNoti(), ilForumSettingsGUI\saveEventsForUser(), and ilObjForumGUI\saveUserNotificationSettingsObject().

                                              : void
    {
        $this->user_id = $a_user_id;
    }

Here is the caller graph for this function:

setUserIdNoti()

ilForumNotification::setUserIdNoti

(

int

$a_user_id_noti

)

Definition at line 131 of file class.ilForumNotification.php.

Referenced by cloneFromSource().

                                                      : void
    {
        $this->user_id_noti = $a_user_id_noti;
    }

Here is the caller graph for this function:

setUserToggle()

ilForumNotification::setUserToggle

(

bool

$a_user_toggle

)

Definition at line 110 of file class.ilForumNotification.php.

Referenced by cloneFromSource().

                                                      : void
    {
        $this->user_toggle = $a_user_toggle;
    }

Here is the caller graph for this function:

update()

ilForumNotification::update

(

)

Definition at line 366 of file class.ilForumNotification.php.

References getAdminForce(), getForumId(), getInterestedEvents(), getUserId(), and getUserToggle().

                            : void
    {
        $this->db->manipulateF(
            'UPDATE frm_notification SET admin_force_noti = %s, user_toggle_noti = %s, ' .
            'interested_events = %s WHERE user_id = %s AND frm_id = %s',
            ['integer', 'integer', 'integer', 'integer', 'integer'],
            [
                (int) $this->getAdminForce(),
                (int) $this->getUserToggle(),
                $this->getInterestedEvents(),
                (int) $this->getUserId(),
                $this->getForumId()
            ]
        );
    }

Here is the call graph for this function:

updateInterestedEvents()

ilForumNotification::updateInterestedEvents

(

)

Definition at line 480 of file class.ilForumNotification.php.

References getForumId(), getInterestedEvents(), and getUserId().

                                            : void
    {
        $this->db->manipulateF(
            'UPDATE frm_notification SET interested_events = %s WHERE user_id = %s AND frm_id = %s',
            ['integer', 'integer', 'integer'],
            [$this->getInterestedEvents(), (int) $this->getUserId(), $this->getForumId()]
        );
    }

Here is the call graph for this function:

updateUserToggle()

ilForumNotification::updateUserToggle

(

)

Definition at line 230 of file class.ilForumNotification.php.

References getForumId(), getUserId(), and getUserToggle().

                                      : void
    {
        $this->db->manipulateF(
            'UPDATE frm_notification SET user_toggle_noti = %s WHERE user_id = %s AND frm_id = %s AND admin_force_noti = %s',
            ['integer', 'integer', 'integer', 'integer'],
            [$this->getUserToggle(), (int) $this->getUserId(), $this->getForumId(), 1]
        );
    }

Here is the call graph for this function:

Field Documentation

$admin_force

bool ilForumNotification::$admin_force = false

private

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

Referenced by getAdminForce().

$db

ilDBInterface ilForumNotification::$db

private

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

$forced_events_cache

array ilForumNotification::$forced_events_cache = []

staticprivate

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

$forum_id

int ilForumNotification::$forum_id

private

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

Referenced by getForumId().

$interested_events

int ilForumNotification::$interested_events = 0

private

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

Referenced by getInterestedEvents(), readInterestedEvents(), and setInterestedEvents().

$node_data_cache

array ilForumNotification::$node_data_cache = []

staticprivate

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

$notification_id

int ilForumNotification::$notification_id

private

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

Referenced by getNotificationId().

$ref_id

int ilForumNotification::$ref_id

private

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

Referenced by __construct(), createMissingNotification(), getCachedNodeData(), getForumRefId(), and readAllForcedEvents().

$thread_id

int ilForumNotification::$thread_id

private

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

Referenced by getThreadId().

$user

ilObjUser ilForumNotification::$user

private

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

$user_id

int ilForumNotification::$user_id = null

private

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

Referenced by getForcedEventsObjectByUserId(), and getUserId().

$user_id_noti

int ilForumNotification::$user_id_noti

private

Definition at line 38 of file class.ilForumNotification.php.

Referenced by getUserIdNoti().

$user_toggle

bool ilForumNotification::$user_toggle = false

private

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

Referenced by getUserToggle().

---

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

• Modules/Forum/classes/Notification/class.ilForumNotification.php