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

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

Detailed Description

Class ilObjForumNotificationDataProvider.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilForumPost	$objPost
int	$ref_id

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

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

         {
                 $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

◆ getAttachments()

ilObjForumNotificationDataProvider::getAttachments ( )

Returns: array file names

Implements ilForumNotificationMailData.

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

References $attachments.

         {
                 return $this->attachments;
         }

◆ getCensorshipComment()

ilObjForumNotificationDataProvider::getCensorshipComment ( )

Returns: string

Implements ilForumNotificationMailData.

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

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

◆ getForumId()

ilObjForumNotificationDataProvider::getForumId ( )

Returns: int

Implements ilForumNotificationMailData.

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

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

Referenced by ilForumAppEventListener\delegateNotification().

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

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

References $forum_title.

         {
                 return $this->forum_title;
         }

◆ getImportName()

ilObjForumNotificationDataProvider::getImportName ( )

Returns: string

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

References $obj_id.

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

         {
                 return $this->obj_id;
         }

Here is the caller graph for this function:

◆ getPosAuthorId()

ilObjForumNotificationDataProvider::getPosAuthorId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 466 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 154 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 447 of file class.ilObjForumNotificationDataProvider.php.

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

Referenced by ilForumAppEventListener\delegateNotification().

         {
                 include_once './Modules/Forum/classes/class.ilForum.php';
                 // get moderators to notify about needed activation
                 $rcps =  ilForum::_getModerators($this->getRefId());
                 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 433 of file class.ilObjForumNotificationDataProvider.php.

References array, and ilForumPost\getPosAuthorId().

Referenced by ilForumAppEventListener\delegateNotification().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPostCensored()

ilObjForumNotificationDataProvider::getPostCensored ( )

Returns: bool frm_posts.pos_cens

Implements ilForumNotificationMailData.

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

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

◆ getPostCensoredDate()

ilObjForumNotificationDataProvider::getPostCensoredDate ( )

Returns: string frm_posts.pos_cens_date

Implements ilForumNotificationMailData.

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

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

◆ getPostDate()

ilObjForumNotificationDataProvider::getPostDate ( )

Returns: string frm_posts.pos_date

Implements ilForumNotificationMailData.

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

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

◆ getPostId()

ilObjForumNotificationDataProvider::getPostId ( )

Returns: int

Implements ilForumNotificationMailData.

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

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

◆ getPostMessage()

ilObjForumNotificationDataProvider::getPostMessage ( )

Returns: string frm_posts.pos_message

Implements ilForumNotificationMailData.

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

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

◆ getPostTitle()

ilObjForumNotificationDataProvider::getPostTitle ( )

Returns: string frm_posts.pos_subject

Implements ilForumNotificationMailData.

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

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

◆ getPostUpdate()

ilObjForumNotificationDataProvider::getPostUpdate ( )

Returns: string frm_posts.pos_update

Implements ilForumNotificationMailData.

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

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

◆ getPostUpdateUserId()

ilObjForumNotificationDataProvider::getPostUpdateUserId ( )

Returns: int

Implements ilForumNotificationMailData.

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

References $update_user_name, array, 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);
                 }
 
                 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 237 of file class.ilObjForumNotificationDataProvider.php.

References $post_user_name, array, 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 206 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 278 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 82 of file class.ilObjForumNotificationDataProvider.php.

References $ref_id.

Referenced by getPostActivationRecipients().

         {
                 return $this->ref_id;
         }

Here is the caller graph for this function:

◆ getThreadId()

ilObjForumNotificationDataProvider::getThreadId ( )

Returns: int

Implements ilForumNotificationMailData.

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

Referenced by getThreadNotificationRecipients().

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

Here is the caller graph for this function:

◆ getThreadNotificationRecipients()

ilObjForumNotificationDataProvider::getThreadNotificationRecipients ( )

Returns: array

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

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

Referenced by ilForumAppEventListener\delegateNotification().

         {
                 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(), $GLOBALS['DIC']['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 $rcps;
         }

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

References $thread_title.

         {
                 return $this->thread_title;
         }

◆ isAnonymized()

ilObjForumNotificationDataProvider::isAnonymized ( )

Returns: bool

Definition at line 214 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 300 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 345 of file class.ilObjForumNotificationDataProvider.php.

References getObjId().

Referenced by read().

         {
                 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']);
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readForumData()

ilObjForumNotificationDataProvider::readForumData ( )

private

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

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

Referenced by read().

         {
                 global $ilDB;
 
                 $result = $ilDB->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 = $ilDB->fetchAssoc($result);
                 $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 310 of file class.ilObjForumNotificationDataProvider.php.

References $ilDB, $result, $row, and array.

Referenced by read().

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

Here is the caller graph for this function:

◆ setPosAuthorId()

ilObjForumNotificationDataProvider::setPosAuthorId ( $pos_author_id )

Parameters

$pos_author_id

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

References $pos_author_id.

         {
                 $this->pos_author_id = $pos_author_id;
         }

Field Documentation

◆ $attachments

array ilObjForumNotificationDataProvider::$attachments = array()

protected

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

Referenced by getAttachments().

◆ $forum_id

ilObjForumNotificationDataProvider::$forum_id = 0

protected

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

Referenced by getForumId().

◆ $forum_title

string ilObjForumNotificationDataProvider::$forum_title = ''

protected

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

Referenced by getForumTitle().

◆ $is_anonymized

ilObjForumNotificationDataProvider::$is_anonymized = false

protected

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

Referenced by isAnonymized().

◆ $obj_id

int ilObjForumNotificationDataProvider::$obj_id = 0

protected

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

Referenced by getObjId().

◆ $objPost

ilObjForumNotificationDataProvider::$objPost

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

Referenced by __construct().

◆ $pos_author_id

ilObjForumNotificationDataProvider::$pos_author_id = 0

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

Referenced by getPosAuthorId(), and setPosAuthorId().

◆ $post_user_name

string null ilObjForumNotificationDataProvider::$post_user_name = null

protected

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

Referenced by getPostUserName().

◆ $ref_id

int ilObjForumNotificationDataProvider::$ref_id = 0

protected

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

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

◆ $thread_title

string ilObjForumNotificationDataProvider::$thread_title = ''

protected

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

Referenced by getThreadTitle().

◆ $update_user_name

string null ilObjForumNotificationDataProvider::$update_user_name = null

protected

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

Referenced by getPostUpdateUserName().

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

◆ getImportName()

◆ getObjId()

◆ getPosAuthorId()

◆ getPosDisplayUserId()

◆ getPostActivationRecipients()

◆ getPostAnsweredRecipients()

◆ getPostCensored()

◆ getPostCensoredDate()

◆ getPostDate()

◆ getPostId()

◆ getPostMessage()

◆ getPostTitle()

◆ getPostUpdate()

◆ getPostUpdateUserId()

◆ getPostUpdateUserName()

◆ getPostUserName()

◆ getPosUserAlias()

◆ getPublicUserInformation()

◆ getRefId()

◆ getThreadId()

◆ getThreadNotificationRecipients()

◆ getThreadTitle()

◆ isAnonymized()

◆ read()

◆ readAttachments()

◆ readForumData()

◆ readThreadTitle()

◆ setPosAuthorId()

Field Documentation

◆ $attachments

◆ $forum_id

◆ $forum_title

◆ $is_anonymized

◆ $obj_id

◆ $objPost

◆ $pos_author_id

◆ $post_user_name

◆ $ref_id

◆ $thread_title

◆ $update_user_name