Class ilObjForumNotificationDataProvider. More...

Inheritance diagram for ilObjForumNotificationDataProvider:

Collaboration diagram for ilObjForumNotificationDataProvider:

Public Member Functions

__construct (ilForumPost $objPost, $ref_id, \ilForumNotificationCache $notificationCache)

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 ()

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 = []

	$is_anonymized = false

Private Member Functions
	readThreadTitle ()

	readForumData ()

	readAttachments ()

	getRefIdsByObjId (int $objId)

	createRecipientArray (\ilPDOStatement $statement)

	shouldUsePseudonym ()

Private Attributes
	$db

	$access

	$user

	$notificationCache

Detailed Description

Class ilObjForumNotificationDataProvider.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjForumNotificationDataProvider::__construct	(	ilForumPost	$objPost,
			$ref_id,
		\ilForumNotificationCache	$notificationCache
	)

Parameters

ilForumPost	$objPost
int	$ref_id
ilForumNotificationCache	$notificationCache

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ createRecipientArray()

ilObjForumNotificationDataProvider::createRecipientArray ( \ilPDOStatement $statement )

private

Parameters

\ilPDOStatement $statement - statement to be executed by the database needs to a 'user_id' as result

Returns: int[]

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

References $row, getObjId(), and getRefIdsByObjId().

Referenced by getForumNotificationRecipients(), and getThreadNotificationRecipients().

                                                                       : array
     {
         $refIds = $this->getRefIdsByObjId((int) $this->getObjId());
 
         $usrIds = [];
         while ($row = $this->db->fetchAssoc($statement)) {
             foreach ($refIds as $refId) {
                 if ($this->access->checkAccessOfUser($row['user_id'], 'read', '', $refId)) {
                     $usrIds[] = (int) $row['user_id'];
                 }
             }
         }
 
         return $usrIds;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttachments()

ilObjForumNotificationDataProvider::getAttachments ( )

Returns: array file names

Implements ilForumNotificationMailData.

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

References $attachments.

     {
         return $this->attachments;
     }

◆ getCensorshipComment()

ilObjForumNotificationDataProvider::getCensorshipComment ( )

Returns: string

Implements ilForumNotificationMailData.

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

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

◆ getDeletedBy()

ilObjForumNotificationDataProvider::getDeletedBy ( )

Returns: string

Implements ilForumNotificationMailData.

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

References $DIC, and shouldUsePseudonym().

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

Here is the call graph for this function:

◆ getForumId()

ilObjForumNotificationDataProvider::getForumId ( )

Returns: int

Implements ilForumNotificationMailData.

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

References $forum_id.

Referenced by getForumNotificationRecipients().

     {
         return $this->forum_id;
     }

Here is the caller graph for this function:

◆ getForumNotificationRecipients()

ilObjForumNotificationDataProvider::getForumNotificationRecipients ( )

Returns: array

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

References $res, createRecipientArray(), getForumId(), and user().

Referenced by ilForumAppEventListener\delegateNotification().

     {
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'forum',
             $this->getForumId(),
             $this->user->getId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             $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())
             );
 
             $rcps = $this->createRecipientArray($res);
             $this->notificationCache->store($cacheKey, $rcps);
         }
 
         $rcps = $this->notificationCache->fetch($cacheKey);
 
         return array_unique($rcps);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForumTitle()

ilObjForumNotificationDataProvider::getForumTitle ( )

Returns: string frm_data.top_name

Implements ilForumNotificationMailData.

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

References $forum_title.

     {
         return $this->forum_title;
     }

◆ getImportName()

ilObjForumNotificationDataProvider::getImportName ( )

Returns: string

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

Referenced by getPostUpdateUserName(), and getPostUserName().

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

Here is the caller graph for this function:

◆ getObjId()

ilObjForumNotificationDataProvider::getObjId ( )

Returns: int

Implements ilForumNotificationMailData.

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

References $obj_id.

Referenced by createRecipientArray(), readAttachments(), readForumData(), and readThreadTitle().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPosAuthorId()

ilObjForumNotificationDataProvider::getPosAuthorId ( )

Returns: int

Implements ilForumNotificationMailData.

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

References $pos_author_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

     {
         return $this->pos_author_id;
     }

Here is the caller graph for this function:

◆ getPosDisplayUserId()

ilObjForumNotificationDataProvider::getPosDisplayUserId ( )

Returns: string frm_posts.pos_display_user_id

Implements ilForumNotificationMailData.

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

Referenced by getPostUserName().

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

Here is the caller graph for this function:

◆ getPostActivationRecipients()

ilObjForumNotificationDataProvider::getPostActivationRecipients ( )

Returns: array

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

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

Referenced by ilForumAppEventListener\delegateNotification().

     {
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'post_activation',
             $this->getRefId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             // get moderators to notify about needed activation
             $rcps = ilForum::_getModerators($this->getRefId());
             $this->notificationCache->store($cacheKey, $rcps);
         }
 
         $rcps = $this->notificationCache->fetch($cacheKey);
 
         return (array) $rcps;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPostAnsweredRecipients()

ilObjForumNotificationDataProvider::getPostAnsweredRecipients ( )

Returns: array

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

Referenced by ilForumAppEventListener\delegateNotification().

     {
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'post_answered',
             $this->objPost->getParentId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             $parent_objPost = new ilForumPost($this->objPost->getParentId());
 
             $this->notificationCache->store($cacheKey, $parent_objPost);
         }
 
         $parent_objPost = $this->notificationCache->fetch($cacheKey);
         $rcps = array();
         $rcps[] = $parent_objPost->getPosAuthorId();
 
         return $rcps;
     }

Here is the caller graph for this function:

◆ getPostCensored()

ilObjForumNotificationDataProvider::getPostCensored ( )

Returns: bool frm_posts.pos_cens

Implements ilForumNotificationMailData.

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

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

◆ getPostCensoredDate()

ilObjForumNotificationDataProvider::getPostCensoredDate ( )

Returns: string frm_posts.pos_cens_date

Implements ilForumNotificationMailData.

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

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

◆ getPostDate()

ilObjForumNotificationDataProvider::getPostDate ( )

Returns: string frm_posts.pos_date

Implements ilForumNotificationMailData.

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

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

◆ getPostId()

ilObjForumNotificationDataProvider::getPostId ( )

Returns: int

Implements ilForumNotificationMailData.

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

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

◆ getPostMessage()

ilObjForumNotificationDataProvider::getPostMessage ( )

Returns: string frm_posts.pos_message

Implements ilForumNotificationMailData.

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

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

◆ getPostTitle()

ilObjForumNotificationDataProvider::getPostTitle ( )

Returns: string frm_posts.pos_subject

Implements ilForumNotificationMailData.

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

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

◆ getPostUpdate()

ilObjForumNotificationDataProvider::getPostUpdate ( )

Returns: string frm_posts.pos_update

Implements ilForumNotificationMailData.

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

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

◆ getPostUpdateUserId()

ilObjForumNotificationDataProvider::getPostUpdateUserId ( )

Returns: int

Implements ilForumNotificationMailData.

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

Referenced by getPostUpdateUserName().

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

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

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

     {
         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;
     }

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

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

     {
         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;
     }

Here is the call graph for this function:

◆ getPosUserAlias()

ilObjForumNotificationDataProvider::getPosUserAlias ( )

Returns: string frm_posts.pos_usr_alias

Implements ilForumNotificationMailData.

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

Referenced by getPostUpdateUserName(), and getPostUserName().

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

Here is the caller graph for this function:

◆ getPublicUserInformation()

ilObjForumNotificationDataProvider::getPublicUserInformation ( ilForumAuthorInformation $authorinfo )

Parameters

ilForumAuthorInformation $authorinfo

Returns: string

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

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

Referenced by getPostUpdateUserName(), and getPostUserName().

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

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

References $ref_id.

Referenced by getPostActivationRecipients().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getRefIdsByObjId()

ilObjForumNotificationDataProvider::getRefIdsByObjId ( int $objId )

private

Parameters

int $objId

Returns: int[]

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

References ilObject\_getAllReferences().

Referenced by createRecipientArray().

                                                   : array
     {
         $cacheKey = $this->notificationCache->createKeyByValues([
             'refs_by_obj_id',
             $objId
         ]);
 
         if (!$this->notificationCache->exists($cacheKey)) {
             $this->notificationCache->store($cacheKey, (array) ilObject::_getAllReferences($objId));
         }
 
         return $this->notificationCache->fetch($cacheKey);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThreadId()

ilObjForumNotificationDataProvider::getThreadId ( )

Returns: int

Implements ilForumNotificationMailData.

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

Referenced by getThreadNotificationRecipients().

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

Here is the caller graph for this function:

◆ getThreadNotificationRecipients()

ilObjForumNotificationDataProvider::getThreadNotificationRecipients ( )

Returns: int[]

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

References $res, createRecipientArray(), getThreadId(), and user().

Referenced by ilForumAppEventListener\delegateNotification().

     {
         if (!$this->getThreadId()) {
             return [];
         }
 
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'thread',
             $this->getThreadId(),
             $this->user->getId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             $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())
             );
 
             $usrIds = $this->createRecipientArray($res);
             $this->notificationCache->store($cacheKey, $usrIds);
         }
 
         $usrIds = $this->notificationCache->fetch($cacheKey);
 
         return $usrIds;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThreadTitle()

ilObjForumNotificationDataProvider::getThreadTitle ( )

Returns: string frm_threads.thr_subject

Implements ilForumNotificationMailData.

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

References $thread_title.

     {
         return $this->thread_title;
     }

◆ isAnonymized()

ilObjForumNotificationDataProvider::isAnonymized ( )

Returns: bool

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

References $is_anonymized.

Referenced by getPublicUserInformation().

     {
         return $this->is_anonymized;
     }

Here is the caller graph for this function:

◆ read()

ilObjForumNotificationDataProvider::read ( )

protected

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAttachments()

ilObjForumNotificationDataProvider::readAttachments ( )

private

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

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

Referenced by read().

     {
         if (ilForumProperties::isSendAttachmentsByMailEnabled()) {
             $fileDataForum = new ilFileDataForum($this->getObjId(), $this->objPost->getId());
             $filesOfPost = $fileDataForum->getFilesOfPost();
             
             $fileDataMail = new ilFileDataMail(ANONYMOUS_USER_ID);
             
             foreach ($filesOfPost as $attachment) {
                 $this->attachments[$attachment['path']] = $attachment['name'];
                 $fileDataMail->copyAttachmentFile($attachment['path'], $attachment['name']);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readForumData()

ilObjForumNotificationDataProvider::readForumData ( )

private

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

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

Referenced by read().

     {
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'forum_data',
             $this->getObjId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             $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->notificationCache->store($cacheKey, $row);
         }
 
         $row = $this->notificationCache->fetch($cacheKey);
         $this->forum_id = $row['top_pk'];
         $this->forum_title = $row['top_name'];
         $this->is_anonymized = (bool) $row['anonymized'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readThreadTitle()

ilObjForumNotificationDataProvider::readThreadTitle ( )

private

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

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

Referenced by read().

     {
         $cacheKey = $this->notificationCache->createKeyByValues(array(
             'thread_title',
             $this->getObjId()
         ));
 
         if (false === $this->notificationCache->exists($cacheKey)) {
             $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->notificationCache->store($cacheKey, $row);
         }
 
         $row = $this->notificationCache->fetch($cacheKey);
         $this->thread_title = $row['thr_subject'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPosAuthorId()

ilObjForumNotificationDataProvider::setPosAuthorId ( $pos_author_id )

Parameters

$pos_author_id

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

References $pos_author_id.

     {
         $this->pos_author_id = $pos_author_id;
     }

◆ shouldUsePseudonym()

ilObjForumNotificationDataProvider::shouldUsePseudonym ( )

private

Returns: bool

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

References $DIC.

Referenced by getDeletedBy().

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