Class ilObjForumNotificationDataProvider. More...

Inheritance diagram for ilObjForumNotificationDataProvider:

Collaboration diagram for ilObjForumNotificationDataProvider:

Public Member Functions
	__construct (ilForumPost $objPost, $ref_id)

	getRefId ()

	getObjId ()

	getThreadId ()

	getPostId ()

	getForumId ()

	getForumTitle ()

	getThreadTitle ()

	getPostTitle ()

	getPostMessage ()

	getPosDisplayUserId ()

	getPostUserName ($user_lang)

	getPostDate ()

	getPostUpdate ()

	getPostUpdateUserName ($user_lang)

	getPostCensored ()

	getPostCensoredDate ()

	getCensorshipComment ()

	getAttachments ()

	getPosUserAlias ()

	getForumNotificationRecipients ()

	getThreadNotificationRecipients ()

	getPostAnsweredRecipients ()

	getPostActivationRecipients ()

	setPosAuthorId ($pos_author_id)

	getPosAuthorId ()

	getRefId ()

	getObjId ()

	getForumId ()

	getForumTitle ()

	getThreadId ()

	getThreadTitle ()

	getPostId ()

	getPostTitle ()

	getPostMessage ()

	getPosAuthorId ()

	getPosDisplayUserId ()

	getPosUserAlias ()

	getPostUserName ($user_lang)

	getPostDate ()

	getPostUpdate ()

	getPostUpdateUserName ($user_lang)

	getPostCensored ()

	getPostCensoredDate ()

	getCensorshipComment ()

	getAttachments ()

Data Fields
	$pos_author_id = 0

	$objPost

Protected Member Functions
	read ()

Protected Attributes
	$ref_id = 0

	$obj_id = 0

	$post_user_name = ''

	$forum_id = 0

	$forum_title = ''

	$thread_title = ''

	$attachments = array()

Private Member Functions
	readThreadTitle ()

	readForumData ()

	readAttachments ()

Detailed Description

Class ilObjForumNotificationDataProvider.

Author: Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

Definition at line 10 of file class.ilObjForumNotificationDataProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjForumNotificationDataProvider::__construct	(	ilForumPost	$objPost,
			$ref_id
	)

Parameters

ilForumPost	$objPost
int	$ref_id

Definition at line 59 of file class.ilObjForumNotificationDataProvider.php.

        {
                $this->objPost = $objPost;
                $this->ref_id  = $ref_id;
                $this->obj_id  = ilObject::_lookupObjId($ref_id);
                $this->read();
        }

References $objPost, $ref_id, ilObject\_lookupObjId(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ getAttachments()

ilObjForumNotificationDataProvider::getAttachments ( )

Returns: array file names

Implements ilForumNotificationMailData.

Definition at line 237 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->attachments;
        }

References $attachments.

◆ getCensorshipComment()

ilObjForumNotificationDataProvider::getCensorshipComment ( )

Returns: string

Implements ilForumNotificationMailData.

Definition at line 229 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getCensorshipComment();
        }

◆ getForumId()

ilObjForumNotificationDataProvider::getForumId ( )

Returns: int

Implements ilForumNotificationMailData.

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

        {
                return $this->forum_id;
        }

References $forum_id.

Referenced by getForumNotificationRecipients().

Here is the caller graph for this function:

◆ getForumNotificationRecipients()

ilObjForumNotificationDataProvider::getForumNotificationRecipients ( )

Returns: array

Definition at line 311 of file class.ilObjForumNotificationDataProvider.php.

        {
                global $ilDB, $ilAccess, $ilUser;
 
                $res = $ilDB->queryf('
                        SELECT frm_notification.user_id FROM frm_notification, frm_data 
                        WHERE frm_data.top_pk = %s
                        AND frm_notification.frm_id = frm_data.top_frm_fk 
                        AND frm_notification.user_id <> %s
                        GROUP BY frm_notification.user_id',
                        array('integer', 'integer'),
                        array($this->getForumId(), $ilUser->getId()));
 
                // get all references of obj_id
                $frm_references = ilObject::_getAllReferences($this->getObjId());
                $rcps = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        // do rbac check before sending notification
                        foreach((array)$frm_references as $ref_id)
                        {
                                if($ilAccess->checkAccessOfUser($row['user_id'], 'read', '', $ref_id))
                                {
                                        $rcps[] = $row['user_id'];
                                }
                        }
                }
 
 
                return array_unique($rcps);
        }

References $ilDB, $ilUser, $ref_id, $res, $row, ilObject\_getAllReferences(), getForumId(), and getObjId().

Here is the call graph for this function:

◆ getForumTitle()

ilObjForumNotificationDataProvider::getForumTitle ( )

Returns: string frm_data.top_name

Implements ilForumNotificationMailData.

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

        {
                return $this->forum_title;
        }

References $forum_title.

◆ getObjId()

ilObjForumNotificationDataProvider::getObjId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 78 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->obj_id;
        }

References $obj_id.

Referenced by getForumNotificationRecipients(), getThreadNotificationRecipients(), readAttachments(), and readForumData().

Here is the caller graph for this function:

◆ getPosAuthorId()

ilObjForumNotificationDataProvider::getPosAuthorId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 410 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->pos_author_id;
        }

References $pos_author_id.

◆ getPosDisplayUserId()

ilObjForumNotificationDataProvider::getPosDisplayUserId ( )

Returns: string frm_posts.pos_display_user_id

Implements ilForumNotificationMailData.

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

        {
                return $this->objPost->getDisplayUserId();
        }

◆ getPostActivationRecipients()

ilObjForumNotificationDataProvider::getPostActivationRecipients ( )

Returns: array

Definition at line 392 of file class.ilObjForumNotificationDataProvider.php.

        {
                include_once './Modules/Forum/classes/class.ilForum.php';
                // get moderators to notify about needed activation
                $rcps =  ilForum::_getModerators($this->getRefId());
                return  (array)$rcps;
        }

References ilForum\_getModerators(), and getRefId().

Here is the call graph for this function:

◆ getPostAnsweredRecipients()

ilObjForumNotificationDataProvider::getPostAnsweredRecipients ( )

Returns: array

Definition at line 378 of file class.ilObjForumNotificationDataProvider.php.

        {
                include_once './Modules/Forum/classes/class.ilForumPost.php';
                $parent_objPost = new ilForumPost($this->objPost->getParentId());
 
                $rcps = array();
                $rcps[] = $parent_objPost->getPosAuthorId();
 
                return $rcps;
        }

◆ getPostCensored()

ilObjForumNotificationDataProvider::getPostCensored ( )

Returns: bool frm_posts.pos_cens

Implements ilForumNotificationMailData.

Definition at line 216 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->isCensored();
        }

◆ getPostCensoredDate()

ilObjForumNotificationDataProvider::getPostCensoredDate ( )

Returns: string frm_posts.pos_cens_date

Implements ilForumNotificationMailData.

Definition at line 224 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getCensoredDate();
        }

◆ getPostDate()

ilObjForumNotificationDataProvider::getPostDate ( )

Returns: string frm_posts.pos_date

Implements ilForumNotificationMailData.

Definition at line 173 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getCreateDate();
        }

◆ getPostId()

ilObjForumNotificationDataProvider::getPostId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 94 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getId();
        }

◆ getPostMessage()

ilObjForumNotificationDataProvider::getPostMessage ( )

Returns: string frm_posts.pos_message

Implements ilForumNotificationMailData.

Definition at line 134 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getMessage();
        }

◆ getPostTitle()

ilObjForumNotificationDataProvider::getPostTitle ( )

Returns: string frm_posts.pos_subject

Implements ilForumNotificationMailData.

Definition at line 126 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getSubject();
        }

◆ getPostUpdate()

ilObjForumNotificationDataProvider::getPostUpdate ( )

Returns: string frm_posts.pos_update

Implements ilForumNotificationMailData.

Definition at line 181 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getChangeDate();
        }

◆ getPostUpdateUserName()

ilObjForumNotificationDataProvider::getPostUpdateUserName ( $user_lang )

Returns: string login

Implements ilForumNotificationMailData.

Definition at line 189 of file class.ilObjForumNotificationDataProvider.php.

        {
                // GET AUTHOR OF UPDATED POST
                if($this->objPost->getUpdateUserId() > 0)
                {
                        $this->post_user_name = ilObjUser::_lookupLogin($this->objPost->getUpdateUserId());
                }
                
                if($this->objPost->getDisplayUserId() == 0 && $this->objPost->getPosAuthorId() == $this->objPost->getUpdateUserId())
                {
                        if(strlen($this->objPost->getUserAlias()))
                        {
                                $this->post_user_name = $this->objPost->getUserAlias() . ' (' . $user_lang->txt('frm_pseudonym') . ')';
                        }
                        
                        if($this->post_user_name == '')
                        {
                                $this->post_user_name = $user_lang->txt('forums_anonymous');
                        }
                }
                
                return $this->post_user_name;
        }

References $post_user_name, and ilObjUser\_lookupLogin().

Here is the call graph for this function:

◆ getPostUserName()

ilObjForumNotificationDataProvider::getPostUserName ( $user_lang )

Returns: string

Implements ilForumNotificationMailData.

Definition at line 150 of file class.ilObjForumNotificationDataProvider.php.

        {
                // GET AUTHOR OF NEW POST
                if($this->objPost->getDisplayUserId())
                {
                        $this->post_user_name = ilObjUser::_lookupLogin($this->objPost->getDisplayUserId());
                }
                else if(strlen($this->objPost->getUserAlias()))
                {
                        $this->post_user_name = $this->objPost->getUserAlias() . ' (' . $user_lang->txt('frm_pseudonym') . ')';
                }
 
                if($this->post_user_name == '')
                {
                        $this->post_user_name = $user_lang->txt('forums_anonymous');
                }
 
                return $this->post_user_name;
        }

References $post_user_name, and ilObjUser\_lookupLogin().

Here is the call graph for this function:

◆ getPosUserAlias()

ilObjForumNotificationDataProvider::getPosUserAlias ( )

Returns: string frm_posts.pos_usr_alias

Implements ilForumNotificationMailData.

Definition at line 245 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getUserAlias();
        }

◆ getRefId()

ilObjForumNotificationDataProvider::getRefId ( )

Returns: int

Implements ilForumNotificationMailData.

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

        {
                return $this->ref_id;
        }

References $ref_id.

Referenced by getPostActivationRecipients().

Here is the caller graph for this function:

◆ getThreadId()

ilObjForumNotificationDataProvider::getThreadId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 86 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->objPost->getThreadId();
        }

Referenced by getThreadNotificationRecipients().

Here is the caller graph for this function:

◆ getThreadNotificationRecipients()

ilObjForumNotificationDataProvider::getThreadNotificationRecipients ( )

Returns: array

Definition at line 346 of file class.ilObjForumNotificationDataProvider.php.

        {
                global $ilDB, $ilAccess, $ilUser;
 
                // GET USERS WHO WANT TO BE INFORMED ABOUT NEW POSTS
                $res = $ilDB->queryf('
                        SELECT user_id FROM frm_notification 
                        WHERE thread_id = %s
                        AND user_id <> %s',
                        array('integer', 'integer'),
                        array($this->getThreadId(), $_SESSION['AccountId']));
 
                // get all references of obj_id
                $frm_references = ilObject::_getAllReferences($this->getObjId());
                $rcps = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        // do rbac check before sending notification
                        foreach((array)$frm_references as $ref_id)
                        {
                                if($ilAccess->checkAccessOfUser($row['user_id'], 'read', '', $ref_id))
                                {
                                        $rcps[] = $row['user_id'];
                                }
                        }
                }
                return $rcps;
        }

References $_SESSION, $ilDB, $ilUser, $ref_id, $res, $row, ilObject\_getAllReferences(), getObjId(), and getThreadId().

Here is the call graph for this function:

◆ getThreadTitle()

ilObjForumNotificationDataProvider::getThreadTitle ( )

Returns: string frm_threads.thr_subject

Implements ilForumNotificationMailData.

Definition at line 118 of file class.ilObjForumNotificationDataProvider.php.

        {
                return $this->thread_title;
        }

References $thread_title.

◆ read()

ilObjForumNotificationDataProvider::read ( )

protected

Definition at line 253 of file class.ilObjForumNotificationDataProvider.php.

        {
                $this->readForumData();
                $this->readThreadTitle();
                $this->readAttachments();
        }

References readAttachments(), readForumData(), and readThreadTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAttachments()

ilObjForumNotificationDataProvider::readAttachments ( )

private

Definition at line 296 of file class.ilObjForumNotificationDataProvider.php.

        {
                require_once 'Modules/Forum/classes/class.ilFileDataForum.php';
                $fileDataForum = new ilFileDataForum($this->getObjId(), $this->objPost->getId());
                $filesOfPost   = $fileDataForum->getFilesOfPost();
 
                foreach($filesOfPost as $attachment)
                {
                        $this->attachments[] = $attachment['name'];
                }
        }

References getObjId().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readForumData()

ilObjForumNotificationDataProvider::readForumData ( )

private

Definition at line 279 of file class.ilObjForumNotificationDataProvider.php.

        {
                global $ilDB;
 
                $result = $ilDB->queryf('
                        SELECT top_pk, top_name FROM frm_data
                        WHERE top_frm_fk = %s',
                        array('integer'), array($this->getObjId()));
 
                $row = $ilDB->fetchAssoc($result);
                $this->forum_id    = $row['top_pk'];
                $this->forum_title = $row['top_name'];
        }

References $ilDB, $result, $row, and getObjId().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readThreadTitle()

ilObjForumNotificationDataProvider::readThreadTitle ( )

private

Definition at line 263 of file class.ilObjForumNotificationDataProvider.php.

        {
                global $ilDB;
 
                $result = $ilDB->queryf('
                        SELECT thr_subject FROM frm_threads 
                        WHERE thr_pk = %s',
                        array('integer'), array($this->objPost->getThreadId()));
 
                $row = $ilDB->fetchAssoc($result);
                $this->thread_title = $row['thr_subject'];
        }

References $ilDB, $result, and $row.

Referenced by read().

Here is the caller graph for this function:

◆ setPosAuthorId()

ilObjForumNotificationDataProvider::setPosAuthorId ( $pos_author_id )

Parameters

$pos_author_id

Definition at line 402 of file class.ilObjForumNotificationDataProvider.php.

        {
                $this->pos_author_id = $pos_author_id;
        }

References $pos_author_id.

Field Documentation

◆ $attachments

array ilObjForumNotificationDataProvider::$attachments = array()

protected

Definition at line 48 of file class.ilObjForumNotificationDataProvider.php.

Referenced by getAttachments().

◆ $forum_id

ilObjForumNotificationDataProvider::$forum_id = 0

protected

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

Referenced by getForumId().

◆ $forum_title

string ilObjForumNotificationDataProvider::$forum_title = ''

protected

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

Referenced by getForumTitle().

◆ $obj_id

int ilObjForumNotificationDataProvider::$obj_id = 0

protected

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

Referenced by getObjId().

◆ $objPost

ilObjForumNotificationDataProvider::$objPost

Definition at line 53 of file class.ilObjForumNotificationDataProvider.php.

Referenced by __construct().

◆ $pos_author_id

ilObjForumNotificationDataProvider::$pos_author_id = 0

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

Referenced by getPosAuthorId(), and setPosAuthorId().

◆ $post_user_name

string ilObjForumNotificationDataProvider::$post_user_name = ''

protected

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

Referenced by getPostUpdateUserName(), and getPostUserName().

◆ $ref_id

int ilObjForumNotificationDataProvider::$ref_id = 0

protected

Definition at line 15 of file class.ilObjForumNotificationDataProvider.php.

Referenced by __construct(), getForumNotificationRecipients(), getRefId(), and getThreadNotificationRecipients().

◆ $thread_title

string ilObjForumNotificationDataProvider::$thread_title = ''

protected

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

Referenced by getThreadTitle().

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

Modules/Forum/classes/class.ilObjForumNotificationDataProvider.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAttachments()

◆ getCensorshipComment()

◆ getForumId()

◆ getForumNotificationRecipients()

◆ getForumTitle()

◆ getObjId()

◆ getPosAuthorId()

◆ getPosDisplayUserId()

◆ getPostActivationRecipients()

◆ getPostAnsweredRecipients()

◆ getPostCensored()

◆ getPostCensoredDate()

◆ getPostDate()

◆ getPostId()

◆ getPostMessage()

◆ getPostTitle()

◆ getPostUpdate()

◆ getPostUpdateUserName()

◆ getPostUserName()

◆ getPosUserAlias()

◆ getRefId()

◆ getThreadId()

◆ getThreadNotificationRecipients()

◆ getThreadTitle()

◆ read()

◆ readAttachments()

◆ readForumData()

◆ readThreadTitle()

◆ setPosAuthorId()

Field Documentation

◆ $attachments

◆ $forum_id

◆ $forum_title

◆ $obj_id

◆ $objPost

◆ $pos_author_id

◆ $post_user_name

◆ $ref_id

◆ $thread_title