ilObjForumNotificationDataProvider Class Reference

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 ()
	getPostDate ()
	getPostUpdate ()
	getPostCensored ()
	getPostCensoredDate ()
	getCensorshipComment ()
	getAttachments ()
	getPosUserAlias ()
	isAnonymized ()
	getImportName ()
	getPostUpdateUserId ()
	Returns int More...
	getPostUserName (\ilLanguage $user_lang)
	Parameters \ilLanguage $user_lang Returns string More...
	getPostUpdateUserName (\ilLanguage $user_lang)
	Parameters \ilLanguage $user_lang Returns string More...
	getPublicUserInformation (ilForumAuthorInformation $authorinfo)
	getForumNotificationRecipients ()
	getThreadNotificationRecipients ()
	getPostAnsweredRecipients ()
	getPostActivationRecipients ()
	setPosAuthorId ($pos_author_id)
	getPosAuthorId ()
	getDeletedBy ()
	getRefId ()
	getObjId ()
	getForumId ()
	getForumTitle ()
	getThreadId ()
	getThreadTitle ()
	getPostId ()
	getPostTitle ()
	getPostMessage ()
	getPosAuthorId ()
	getPostUpdateUserId ()
	getPosDisplayUserId ()
	getPosUserAlias ()
	getPostUserName (\ilLanguage $user_lang)
	getPostDate ()
	getPostUpdate ()
	getPostUpdateUserName (\ilLanguage $user_lang)
	getPostCensored ()
	getPostCensoredDate ()
	getCensorshipComment ()
	getAttachments ()
	getDeletedBy ()

Data Fields
	$pos_author_id = 0
	$objPost

Protected Member Functions
	read ()

Protected Attributes
	$ref_id = 0
	$obj_id = 0
	$post_user_name = null
	$update_user_name = null
	$forum_id = 0
	$forum_title = ''
	$thread_title = ''
	$attachments = array()
	$is_anonymized = false

Private Member Functions
	readThreadTitle ()
	readForumData ()
	readAttachments ()
	shouldUsePseudonym ()

Private Attributes
	$db
	$access
	$user

Detailed Description

Class ilObjForumNotificationDataProvider.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

Parameters

ilForumPost	$objPost
int	$ref_id

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

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        
        $this->objPost = $objPost;
        $this->ref_id  = $ref_id;
        $this->obj_id  = ilObject::_lookupObjId($ref_id);
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

getAttachments()

ilObjForumNotificationDataProvider::getAttachments

(

)

Returns

array file names

Implements ilForumNotificationMailData.

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

    {
        return $this->attachments;
    }

References $attachments.

getCensorshipComment()

ilObjForumNotificationDataProvider::getCensorshipComment

(

)

Returns

string

Implements ilForumNotificationMailData.

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

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

getDeletedBy()

ilObjForumNotificationDataProvider::getDeletedBy

(

)

Returns

string

Implements ilForumNotificationMailData.

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

    {
        global $DIC;
 
        if ($this->shouldUsePseudonym()) {
            return (string) $this->objPost->getUserAlias();
        }
        return $DIC->user()->getLogin();
    }

References $DIC, and shouldUsePseudonym().

Here is the call graph for this function:

getForumId()

ilObjForumNotificationDataProvider::getForumId

(

)

Returns

int

Implements ilForumNotificationMailData.

Definition at line 123 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 378 of file class.ilObjForumNotificationDataProvider.php.

    {
        $res = $this->db->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(), $this->user->getId())
        );
 
        // get all references of obj_id
        $frm_references = ilObject::_getAllReferences($this->getObjId());
        $rcps = array();
        while ($row = $this->db->fetchAssoc($res)) {
            // do rbac check before sending notification
            foreach ((array) $frm_references as $ref_id) {
                if ($this->access->checkAccessOfUser($row['user_id'], 'read', '', $ref_id)) {
                    $rcps[] = $row['user_id'];
                }
            }
        }
 
 
        return array_unique($rcps);
    }

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

Here is the call graph for this function:

getForumTitle()

ilObjForumNotificationDataProvider::getForumTitle

(

)

Returns

string frm_data.top_name

Implements ilForumNotificationMailData.

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

    {
        return $this->forum_title;
    }

References $forum_title.

getImportName()

ilObjForumNotificationDataProvider::getImportName

(

)

Returns

string

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

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

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

getObjId()

ilObjForumNotificationDataProvider::getObjId

(

)

Returns

int

Implements ilForumNotificationMailData.

Definition at line 99 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 477 of file class.ilObjForumNotificationDataProvider.php.

    {
        return $this->pos_author_id;
    }

References $pos_author_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

getPosDisplayUserId()

ilObjForumNotificationDataProvider::getPosDisplayUserId

(

)

Returns

string frm_posts.pos_display_user_id

Implements ilForumNotificationMailData.

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

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

Referenced by getPostUserName().

Here is the caller graph for this function:

getPostActivationRecipients()

ilObjForumNotificationDataProvider::getPostActivationRecipients

(

)

Returns

array

Definition at line 458 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 444 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 186 of file class.ilObjForumNotificationDataProvider.php.

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

getPostCensoredDate()

ilObjForumNotificationDataProvider::getPostCensoredDate

(

)

Returns

string frm_posts.pos_cens_date

Implements ilForumNotificationMailData.

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

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

getPostDate()

ilObjForumNotificationDataProvider::getPostDate

(

)

Returns

string frm_posts.pos_date

Implements ilForumNotificationMailData.

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

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

getPostId()

ilObjForumNotificationDataProvider::getPostId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

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

getPostMessage()

ilObjForumNotificationDataProvider::getPostMessage

(

)

Returns

string frm_posts.pos_message

Implements ilForumNotificationMailData.

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

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

getPostTitle()

ilObjForumNotificationDataProvider::getPostTitle

(

)

Returns

string frm_posts.pos_subject

Implements ilForumNotificationMailData.

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

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

getPostUpdate()

ilObjForumNotificationDataProvider::getPostUpdate

(

)

Returns

string frm_posts.pos_update

Implements ilForumNotificationMailData.

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

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

getPostUpdateUserId()

ilObjForumNotificationDataProvider::getPostUpdateUserId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

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

Referenced by getPostUpdateUserName().

Here is the caller graph for this function:

getPostUpdateUserName()

ilObjForumNotificationDataProvider::getPostUpdateUserName

(

\ilLanguage

$user_lang

)

Parameters

\ilLanguage

$user_lang

Returns

string

Implements ilForumNotificationMailData.

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

    {
        if ($this->update_user_name === null) {
            $authorinfo             = new ilForumAuthorInformation(
                $this->getPosAuthorId(),
                $this->getPostUpdateUserId(),
                $this->getPosUserAlias(),
                $this->getImportName(),
                array(),
                $user_lang
            );
            $this->update_user_name = $this->getPublicUserInformation($authorinfo);
        }
        
        // Possible Fix for #25432
        if ($this->objPost->getUserAlias() && $this->objPost->getDisplayUserId() == 0
            && $this->objPost->getPosAuthorId() == $this->objPost->getUpdateUserId()) {
            return (string) $this->objPost->getUserAlias();
        }
        
        return (string) $this->update_user_name;
    }

References $update_user_name, getImportName(), getPosAuthorId(), getPostUpdateUserId(), getPosUserAlias(), and getPublicUserInformation().

Here is the call graph for this function:

getPostUserName()

ilObjForumNotificationDataProvider::getPostUserName

(

\ilLanguage

$user_lang

)

Parameters

\ilLanguage

$user_lang

Returns

string

Implements ilForumNotificationMailData.

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

    {
        if ($this->post_user_name === null) {
            $authorinfo           = new ilForumAuthorInformation(
                $this->getPosAuthorId(),
                $this->getPosDisplayUserId(),
                $this->getPosUserAlias(),
                $this->getImportName(),
                array(),
                $user_lang
            );
            $this->post_user_name = $this->getPublicUserInformation($authorinfo);
        }
 
        return (string) $this->post_user_name;
    }

References $post_user_name, getImportName(), getPosAuthorId(), getPosDisplayUserId(), getPosUserAlias(), and getPublicUserInformation().

Here is the call graph for this function:

getPosUserAlias()

ilObjForumNotificationDataProvider::getPosUserAlias

(

)

Returns

string frm_posts.pos_usr_alias

Implements ilForumNotificationMailData.

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

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

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

getPublicUserInformation()

ilObjForumNotificationDataProvider::getPublicUserInformation

(

ilForumAuthorInformation

$authorinfo

)

Parameters

ilForumAuthorInformation

$authorinfo

Returns

string

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

    {
        if ($authorinfo->hasSuffix()) {
            $public_name = $authorinfo->getAuthorName();
        } else {
            $public_name = $authorinfo->getAuthorShortName();
 
            if ($authorinfo->getAuthorName() && !$this->isAnonymized()) {
                $public_name = $authorinfo->getAuthorName();
            }
        }
 
        return $public_name;
    }

References ilForumAuthorInformation\getAuthorName(), ilForumAuthorInformation\getAuthorShortName(), and ilForumAuthorInformation\hasSuffix().

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilObjForumNotificationDataProvider::getRefId

(

)

Returns

int

Implements ilForumNotificationMailData.

Definition at line 91 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 107 of file class.ilObjForumNotificationDataProvider.php.

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

Referenced by getThreadNotificationRecipients().

Here is the caller graph for this function:

getThreadNotificationRecipients()

ilObjForumNotificationDataProvider::getThreadNotificationRecipients

(

)

Returns

int[]

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

    {
        if (!$this->getThreadId()) {
            return [];
        }
 
        $res = $this->db->queryf(
            '
                        SELECT frm_notification.user_id
                        FROM frm_notification
                        INNER JOIN frm_threads ON frm_threads.thr_pk = frm_notification.thread_id
                        WHERE frm_notification.thread_id = %s
                        AND frm_notification.user_id != %s',
            array('integer', 'integer'),
            array($this->getThreadId(), $this->user->getId())
        );
 
 
        $frm_references = \ilObject::_getAllReferences($this->getObjId());
        $usrIds = [];
        while ($row = $this->db->fetchAssoc($res)) {
            foreach ((array) $frm_references as $ref_id) {
                if ($this->access->checkAccessOfUser($row['user_id'], 'read', '', $ref_id)) {
                    $usrIds[] = $row['user_id'];
                }
            }
        }
 
        return array_unique($usrIds);
    }

References $ref_id, $res, $row, ilObject\_getAllReferences(), getObjId(), getThreadId(), and user().

Here is the call graph for this function:

getThreadTitle()

ilObjForumNotificationDataProvider::getThreadTitle

(

)

Returns

string frm_threads.thr_subject

Implements ilForumNotificationMailData.

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

    {
        return $this->thread_title;
    }

References $thread_title.

isAnonymized()

ilObjForumNotificationDataProvider::isAnonymized

(

)

Returns

bool

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

    {
        return $this->is_anonymized;
    }

References $is_anonymized.

read()

ilObjForumNotificationDataProvider::read ( )

protected

Definition at line 311 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 358 of file class.ilObjForumNotificationDataProvider.php.

    {
        if (ilForumProperties::isSendAttachmentsByMailEnabled()) {
            require_once 'Modules/Forum/classes/class.ilFileDataForum.php';
            $fileDataForum = new ilFileDataForum($this->getObjId(), $this->objPost->getId());
            $filesOfPost   = $fileDataForum->getFilesOfPost();
            
            require_once 'Services/Mail/classes/class.ilFileDataMail.php';
            $fileDataMail = new ilFileDataMail(ANONYMOUS_USER_ID);
            
            foreach ($filesOfPost as $attachment) {
                $this->attachments[$attachment['path']] = $attachment['name'];
                $fileDataMail->copyAttachmentFile($attachment['path'], $attachment['name']);
            }
        }
    }

References getObjId(), and ilForumProperties\isSendAttachmentsByMailEnabled().

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 338 of file class.ilObjForumNotificationDataProvider.php.

    {
        $result = $this->db->queryf(
            '
                        SELECT top_pk, top_name, frm_settings.anonymized FROM frm_data
                        INNER JOIN frm_settings ON top_frm_fk = frm_settings.obj_id 
                        WHERE top_frm_fk = %s',
            array('integer'),
            array($this->getObjId())
        );
 
        $row = $this->db->fetchAssoc($result);
        $this->forum_id    = $row['top_pk'];
        $this->forum_title = $row['top_name'];
        $this->is_anonymized = (bool) $row['anonymized'];
    }

References $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 321 of file class.ilObjForumNotificationDataProvider.php.

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

References $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 469 of file class.ilObjForumNotificationDataProvider.php.

    {
        $this->pos_author_id = $pos_author_id;
    }

References $pos_author_id.

shouldUsePseudonym()

ilObjForumNotificationDataProvider::shouldUsePseudonym ( )

private

Returns

bool

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

    {
        global $DIC;
 
        if ($this->objPost->getUserAlias() && $this->objPost->getDisplayUserId() == 0
            && $this->objPost->getPosAuthorId() == $DIC->user()->getId()) {
            return true;
        }
        return false;
    }

References $DIC.

Referenced by getDeletedBy().

Here is the caller graph for this function:

Field Documentation

$access

ilObjForumNotificationDataProvider::$access

private

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

$attachments

array ilObjForumNotificationDataProvider::$attachments = array()

protected

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

Referenced by getAttachments().

$db

ilObjForumNotificationDataProvider::$db

private

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

$forum_id

ilObjForumNotificationDataProvider::$forum_id = 0

protected

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

Referenced by getForumId().

$forum_title

string ilObjForumNotificationDataProvider::$forum_title = ''

protected

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

Referenced by getForumTitle().

$is_anonymized

ilObjForumNotificationDataProvider::$is_anonymized = false

protected

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

Referenced by isAnonymized().

$obj_id

int ilObjForumNotificationDataProvider::$obj_id = 0

protected

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

Referenced by getObjId().

$objPost

ilObjForumNotificationDataProvider::$objPost

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

Referenced by __construct().

$pos_author_id

ilObjForumNotificationDataProvider::$pos_author_id = 0

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

Referenced by getPosAuthorId(), and setPosAuthorId().

$post_user_name

string null ilObjForumNotificationDataProvider::$post_user_name = null

protected

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

Referenced by getPostUserName().

$ref_id

int ilObjForumNotificationDataProvider::$ref_id = 0

protected

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

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

$thread_title

string ilObjForumNotificationDataProvider::$thread_title = ''

protected

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

Referenced by getThreadTitle().

$update_user_name

string null ilObjForumNotificationDataProvider::$update_user_name = null

protected

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

Referenced by getPostUpdateUserName().

$user

ilObjForumNotificationDataProvider::$user

private

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

---

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

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