ilForumNotification Class Reference

Class ilForumNotification. More...

Collaboration diagram for ilForumNotification:

Public Member Functions
	__construct ($ref_id)
	Constructor public. More...
	setNotificationId ($a_notification_id)
	getNotificationId ()
	setUserId ($a_user_id)
	getUserId ()
	setForumId ($a_forum_id)
	getForumId ()
	setThreadId ($a_thread_id)
	getThreadId ()
	setAdminForce ($a_admin_force)
	getAdminForce ()
	setUserToggle ($a_user_toggle)
	getUserToggle ()
	setForumRefId ($a_ref_id)
	getForumRefId ()
	setUserIdNoti ($a_user_id_noti)
	getUserIdNoti ()
	isAdminForceNotification ()
	isUserToggleNotification ()
	insertAdminForce ()
	deleteAdminForce ()
	deleteUserToggle ()
	updateUserToggle ()
	update ()
	deleteNotificationAllUsers ()
	read ()
	existsNotification ()
	cloneFromSource (int $sourceRefId)

Static Public Member Functions
static	checkForumsExistsInsert ($ref_id, $user_id=0)
static	checkForumsExistsDelete ($ref_id, $user_id=0)
static	getCachedNodeData ($ref_id)
static	_isParentNodeGrpCrs ($a_ref_id)
static	_clearForcedForumNotifications ($a_parameter)
static	checkParentNodeTree ($ref_id)
static	mergeThreadNotificiations ($merge_source_thread_id, $merge_target_thread_id)

Static Protected Attributes
static	$node_data_cache = array()

Private Attributes
	$notification_id
	$user_id
	$forum_id
	$thread_id
	$admin_force
	$user_toggle
	$ref_id
	$db
	$user

Detailed Description

Class ilForumNotification.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Version

$Id:$

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

Constructor & Destructor Documentation

__construct()

ilForumNotification::__construct

(

$ref_id

)

Constructor public.

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

References $DIC, $ref_id, and user().

    {
        global $DIC;
        
        $this->lng = $DIC->language();
        $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 (   $a_parameter )

static

Parameters

$a_parameter

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

References $DIC, $forum_id, $ilDB, and $ref_id.

    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilObjDataCache = $DIC['ilObjDataCache'];
         
        if (!$a_parameter['tree'] == 'tree') {
            return;
        }
        
        $ref_id = $a_parameter['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',
                array('integer','integer'),
                array($forum_id, 1)
            );
        }
    }

_isParentNodeGrpCrs()

static ilForumNotification::_isParentNodeGrpCrs (   $a_ref_id )

static

Parameters

$a_ref_id

Returns

bool

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

References $DIC, and ilObjectFactory\getInstanceByRefId().

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

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

        if ($parent_obj->getType() == 'crs' || $parent_obj->getType() == 'grp') {
            return $parent_obj->getType();
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkForumsExistsDelete()

static ilForumNotification::checkForumsExistsDelete (   $ref_id,   $user_id = 0  )

static

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

References $data, $DIC, $ilUser, $ref_id, and $user_id.

Referenced by ilPDSelectedItemsBlockGUI\confirmedUnsubscribe().

    {
        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($data['ref_id']);
            $objFrmMods = new ilForumModerators($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($data['obj_id']);
            if (!in_array($frm_noti->getUserId(), $moderator_ids)) {
                $frm_noti->deleteAdminForce();
            }
        }
    }

Here is the caller graph for this function:

checkForumsExistsInsert()

static ilForumNotification::checkForumsExistsInsert (   $ref_id,   $user_id = 0  )

static

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

References $admin_force, $data, $DIC, $ilUser, $ref_id, $user_id, $user_toggle, ilForumProperties\_isAdminForceNoti(), and ilForumProperties\_isUserToggleNoti().

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

    {
        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($data['ref_id']);
            if ($user_id != 0) {
                $frm_noti->setUserId($user_id);
            } else {
                $frm_noti->setUserId($ilUser->getId());
            }
                    
            $admin_force = ilForumProperties::_isAdminForceNoti($data['obj_id']);
            $frm_noti->setAdminForce($admin_force);
    
            $user_toggle = ilForumProperties::_isUserToggleNoti($data['obj_id']);
            if ($user_toggle) {
                $frm_noti->setAdminForce(1);
            }
            
            if ($admin_force == 1 || $user_toggle == 1) {
                $frm_noti->setUserToggle($user_toggle);
                $frm_noti->setForumId($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:

checkParentNodeTree()

static ilForumNotification::checkParentNodeTree (   $ref_id )

static

Parameters

$ref_id

Returns

array

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

References $DIC, $ref_id, $result, $tree, ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), ilForum\_getModerators(), and ilObjectFactory\getInstanceByRefId().

    {
        global $DIC;
        $tree = $DIC->repositoryTree();
        
        $parent_ref_id = $tree->getParentId($ref_id);
        $parent_obj = ilObjectFactory::getInstanceByRefId($parent_ref_id);

        if ($parent_obj->getType() == 'crs') {
            $oParticipants = ilCourseParticipants::_getInstanceByObjId($parent_obj->getId());
        } elseif ($parent_obj->getType() == 'grp') {
            $oParticipants = ilGroupParticipants::_getInstanceByObjId($parent_obj->getId());
        }
        
        $result = array();
        if ($parent_obj->getType() == 'crs' || $parent_obj->getType() == 'grp') {
            $moderator_ids = ilForum::_getModerators($ref_id);
            $admin_ids = $oParticipants->getAdmins();
            $tutor_ids = $oParticipants->getTutors();
            
            $result = array_unique(array_merge($moderator_ids, $admin_ids, $tutor_ids));
        }
        return $result;
    }

Here is the call graph for this function:

cloneFromSource()

ilForumNotification::cloneFromSource

(

int

$sourceRefId

)

Parameters

int

$sourceRefId

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

References $records, $row, insertAdminForce(), setAdminForce(), setUserId(), setUserIdNoti(), and setUserToggle().

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

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

            $this->insertAdminForce();
        }
    }

Here is the call graph for this function:

deleteAdminForce()

ilForumNotification::deleteAdminForce

(

)

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

References getForumId(), and getUserId().

    {
        $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',
            array('integer', 'integer','integer', 'integer'),
            array($this->getUserId(), $this->getForumId(), 1, 0)
        );
    }

Here is the call graph for this function:

deleteNotificationAllUsers()

ilForumNotification::deleteNotificationAllUsers

(

)

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

References getForumId().

Referenced by ilForumSettingsGUI\updateNotificationSettings().

    {
        $this->db->manipulateF(
            '
                        DELETE FROM frm_notification
                        WHERE frm_id = %s
                        AND user_id_noti > %s',
            array('integer', 'integer'),
            array($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 179 of file class.ilForumNotification.php.

References getForumId(), and getUserId().

    {
        $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',
            array('integer', 'integer','integer','integer', 'integer'),
            array($this->getUserId(),$this->getForumId(),1,1, 0 )
        );
    }

Here is the call graph for this function:

existsNotification()

ilForumNotification::existsNotification

(

)

Returns

bool

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

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

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

        if ($row = $this->db->numRows($res) > 0) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

getAdminForce()

ilForumNotification::getAdminForce

(

)

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

References $admin_force.

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

    {
        return $this->admin_force;
    }

Here is the caller graph for this function:

getCachedNodeData()

static ilForumNotification::getCachedNodeData (   $ref_id )

static

Parameters

$ref_id

Returns

mixed

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

References $DIC, and $ref_id.

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

getForumId()

ilForumNotification::getForumId

(

)

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

References $forum_id.

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

    {
        return $this->forum_id;
    }

Here is the caller graph for this function:

getForumRefId()

ilForumNotification::getForumRefId

(

)

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

References $ref_id.

    {
        return $this->ref_id;
    }

getNotificationId()

ilForumNotification::getNotificationId

(

)

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

References $notification_id.

    {
        return $this->notification_id;
    }

getThreadId()

ilForumNotification::getThreadId

(

)

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

References $thread_id.

    {
        return $this->thread_id;
    }

getUserId()

ilForumNotification::getUserId

(

)

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

References $user_id.

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

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

getUserIdNoti()

ilForumNotification::getUserIdNoti

(

)

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

    {
        return $this->user_id_noti;
    }

getUserToggle()

ilForumNotification::getUserToggle

(

)

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

References $user_toggle.

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

    {
        return $this->user_toggle;
    }

Here is the caller graph for this function:

insertAdminForce()

ilForumNotification::insertAdminForce

(

)

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

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

Referenced by cloneFromSource().

    {
        $next_id = $this->db->nextId('frm_notification');
        $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)',
            array('integer', 'integer', 'integer', 'integer', 'integer', 'integer'),
            array($next_id, $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 118 of file class.ilForumNotification.php.

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

    {
        $res = $this->db->queryF(
            '
                        SELECT admin_force_noti FROM frm_notification
                        WHERE user_id = %s 
                        AND frm_id = %s
                        AND user_id_noti > %s ',
            array('integer','integer', 'integer'),
            array($this->getUserId(), $this->getForumId(), 0)
        );
            
        while ($row = $this->db->fetchAssoc($res)) {
            return $row['admin_force_noti'];
        }
    }

Here is the call graph for this function:

isUserToggleNotification()

ilForumNotification::isUserToggleNotification

(

)

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

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

Referenced by ilForumSettingsGUI\getUserNotificationTableData().

    {
        $res = $this->db->queryF(
            '
                        SELECT user_toggle_noti FROM frm_notification
                        WHERE user_id = %s 
                        AND frm_id = %s
                        AND user_id_noti > %s',
            array('integer', 'integer', 'integer'),
            array($this->getUserId(), $this->getForumId(), 0 )
        );
                
        while ($row = $this->db->fetchAssoc($res)) {
            return $row['user_toggle_noti'];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mergeThreadNotificiations()

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

static

Parameters

$merge_source_thread_id
$merge_target_thread_id

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

References $DIC, $ilDB, $res, and $row.

Referenced by ilForum\mergeThreads().

    {
        // check notifications etc..
        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',
            array('integer', 'integer'),
            array(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',
            array('integer', 'integer'),
            array(0, $merge_target_thread_id)
        );

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

        while ($row = $ilDB->fetchAssoc($res)) {
            if (isset($users_already_notified[$row['user_id']])) {
                // delete source notification because already exists for target_id
                $ilDB->manipulatef(
                    'DELETE FROM frm_notification WHERE notification_id = %s',
                    array('integer'),
                    array($row['notification_id'])
                );
            } else {
                // update source notification
                $ilDB->update(
                    'frm_notification',
                    array('thread_id' => array('integer', $merge_target_thread_id)),
                    array('thread_id' => array('integer', $merge_source_thread_id)
                    )
                );
            }
        }
    }

Here is the caller graph for this function:

read()

ilForumNotification::read

(

)

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

References $query, $result, $row, and getForumId().

    {
        $result = array();
    
        $query = $this->db->queryF(
            '
                        SELECT * FROM frm_notification WHERE
                        frm_id = %s',
            array('integer'),
            array($this->getForumId())
        );

        while ($row = $this->db->fetchAssoc($query)) {
            $result[$row['user_id']] = $row;
        }
        return $result;
    }

Here is the call graph for this function:

setAdminForce()

ilForumNotification::setAdminForce

(

$a_admin_force

)

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

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

    {
        $this->admin_force = $a_admin_force;
    }

Here is the caller graph for this function:

setForumId()

ilForumNotification::setForumId

(

$a_forum_id

)

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

    {
        $this->forum_id = $a_forum_id;
    }

setForumRefId()

ilForumNotification::setForumRefId

(

$a_ref_id

)

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

    {
        $this->ref_id = $a_ref_id;
    }

setNotificationId()

ilForumNotification::setNotificationId

(

$a_notification_id

)

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

    {
        $this->notification_id = $a_notification_id;
    }

setThreadId()

ilForumNotification::setThreadId

(

$a_thread_id

)

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

    {
        $this->thread_id = $a_thread_id;
    }

setUserId()

ilForumNotification::setUserId

(

$a_user_id

)

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

Referenced by cloneFromSource(), ilForumSettingsGUI\disableAdminForceNoti(), ilForumSettingsGUI\disableHideUserToggleNoti(), ilForumSettingsGUI\enableAdminForceNoti(), ilForumSettingsGUI\enableHideUserToggleNoti(), and ilForumSettingsGUI\getUserNotificationTableData().

    {
        $this->user_id = $a_user_id;
    }

Here is the caller graph for this function:

setUserIdNoti()

ilForumNotification::setUserIdNoti

(

$a_user_id_noti

)

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

Referenced by cloneFromSource().

    {
        $this->user_id_noti = $a_user_id_noti;
    }

Here is the caller graph for this function:

setUserToggle()

ilForumNotification::setUserToggle

(

$a_user_toggle

)

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

Referenced by cloneFromSource().

    {
        $this->user_toggle = $a_user_toggle;
    }

Here is the caller graph for this function:

update()

ilForumNotification::update

(

)

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

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

    {
        $this->db->manipulateF(
            '
                        UPDATE frm_notification
                        SET admin_force_noti = %s,
                                user_toggle_noti = %s
                                WHERE user_id = %s
                                AND frm_id = %s',
            array('integer','integer','integer','integer'),
            array($this->getAdminForce(), $this->getUserToggle(), $this->getUserId(), $this->getForumId())
        );
    }

Here is the call graph for this function:

updateUserToggle()

ilForumNotification::updateUserToggle

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$admin_force

ilForumNotification::$admin_force

private

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

Referenced by checkForumsExistsInsert(), and getAdminForce().

$db

ilForumNotification::$db

private

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

$forum_id

ilForumNotification::$forum_id

private

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

Referenced by _clearForcedForumNotifications(), and getForumId().

$node_data_cache

ilForumNotification::$node_data_cache = array()

staticprotected

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

$notification_id

ilForumNotification::$notification_id

private

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

Referenced by getNotificationId().

$ref_id

ilForumNotification::$ref_id

private

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

Referenced by __construct(), _clearForcedForumNotifications(), checkForumsExistsDelete(), checkForumsExistsInsert(), checkParentNodeTree(), getCachedNodeData(), and getForumRefId().

$thread_id

ilForumNotification::$thread_id

private

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

Referenced by getThreadId().

$user

ilForumNotification::$user

private

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

$user_id

ilForumNotification::$user_id

private

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

Referenced by checkForumsExistsDelete(), checkForumsExistsInsert(), and getUserId().

$user_toggle

ilForumNotification::$user_toggle

private

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

Referenced by checkForumsExistsInsert(), and getUserToggle().

---

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

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