Collaboration diagram for ilForumPost:

Public Member Functions
	__construct (private int $id=0, bool $a_is_moderator=false, bool $preventImplicitRead=false)

	insert ()

	update ()

	isAnyParentDeactivated ()

	reload ()

	activatePost ()

	activatePostAndChildPosts ()

	activateParentPosts ()

	isPostRead ()

	isRead (int $a_user_id=0)

	hasReplies ()

	isOwner (int $a_user_id=0)

	setId (int $a_id)

	getId ()

	setForumId (int $a_forum_id)

	getForumId ()

	setThreadId (int $a_thread_id)

	getThreadId ()

	getRCID ()

	setRCID (string $rcid)

	setDisplayUserId (int $a_user_id)

	getDisplayUserId ()

	setUserAlias (?string $a_user_alias)

	getUserAlias ()

	setSubject (string $a_subject)

	getSubject ()

	setMessage (string $a_message)

	getMessage ()

	setCreateDate (?string $a_createdate)

	getCreateDate ()

	setChangeDate (?string $a_changedate)

	getChangeDate ()

	setUpdateUserId (int $a_user_id_update)

	getUpdateUserId ()

	setCensorship (bool $a_censorship)

	isCensored ()

	setCensorshipComment (?string $a_comment)

	getCensorshipComment ()

	setNotification (bool $a_notification)

	isNotificationEnabled ()

	setImportName (?string $a_import_name)

	getImportName ()

	setStatus (bool $a_status)

	isActivated ()

	setTreeId (int $a_tree_id)

	getTreeId ()

	setParentId (int $a_parent_id)

	setIsRead (bool $a_is_read)

	getIsRead ()

	getParentId ()

	setLft (int $a_lft)

	getLft ()

	setRgt (int $a_rgt)

	getRgt ()

	setDepth (int $a_depth)

	getDepth ()

	setThread (ilForumTopic $thread)

	getThread ()

	setPosAuthorId (int $pos_author_id)

	getPosAuthorId ()

	isAuthorModerator ()

	setIsAuthorModerator (?bool $is_author_moderator)

	getCensoredDate ()

	getPostActivationDate ()

	setPostActivationDate (?string $post_activation_date)

	setCensoredDate (?string $censored_date)

	assignData (array $row)

Static Public Member Functions
static	mergePosts (int $sourceThreadId, int $targetThreadId, array $excludedPostIds=[])

static	lookupNotificationStatusByPostId (int $post_id)

static	lookupPostMessage (int $post_id)

Data Fields
const	NO_RCID = '-'

Private Member Functions
	read ()

Private Attributes
int	$forum_id = 0

int	$thread_id = 0

int	$display_user_id = 0

string	$user_alias = null

string	$subject = ''

string	$message = ''

string	$createdate = null

string	$changedate = null

int	$user_id_update = 0

bool	$censored = false

string	$censorship_comment = null

string	$censored_date = null

bool	$notification = false

string	$import_name = null

bool	$status = true

int	$tree_id = 0

int	$parent_id = 0

int	$lft = 0

int	$rgt = 0

int	$depth = 0

ilForumTopic	$objThread = null

readonly ilDBInterface	$db

bool	$is_moderator = false

bool	$is_author_moderator = false

bool	$post_read = false

int	$pos_author_id = 0

string	$post_activation_date = null

string	$rcid = self::NO_RCID

Detailed Description

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de \

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

Constructor & Destructor Documentation

◆ __construct()

ilForumPost::__construct	(	private int	$id = `0`,
		bool	$a_is_moderator = `false`,
		bool	$preventImplicitRead = `false`
	)

Definition at line 57 of file class.ilForumPost.php.

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
 
         if (!$preventImplicitRead) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateParentPosts()

ilForumPost::activateParentPosts ( )

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

Referenced by activatePost(), and activatePostAndChildPosts().

                                          : bool
     {
         if ($this->id !== 0) {
             $query = "SELECT pos_pk FROM frm_posts "
                 . "INNER JOIN frm_posts_tree ON pos_fk = pos_pk "
                 . "WHERE lft < %s AND rgt > %s AND thr_fk = %s";
             $result = $this->db->queryF(
                 $query,
                 ['integer', 'integer', 'integer'],
                 [$this->lft, $this->rgt, $this->thread_id]
             );
 
             $now = date('Y-m-d H:i:s');
             while ($row = $this->db->fetchAssoc($result)) {
                 $this->db->update(
                     'frm_posts',
                     [
                         'pos_status' => ['integer', 1],
                         'pos_activation_date' => ['timestamp', $now]
                     ],
                     ['pos_pk' => ['integer', $row['pos_pk']]]
                 );
             }
 
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ activatePost()

ilForumPost::activatePost ( )

Definition at line 200 of file class.ilForumPost.php.

References activateParentPosts(), setPostActivationDate(), and setStatus().

                                   : void
     {
         if ($this->id !== 0) {
             $now = date('Y-m-d H:i:s');
             $this->db->update(
                 'frm_posts',
                 [
                     'pos_status' => ['integer', 1],
                     'pos_activation_date' => ['timestamp', $now]
                 ],
                 ['pos_pk' => ['integer', $this->id]]
             );
 
             $this->activateParentPosts();
             $this->setPostActivationDate($now);
             $this->setStatus(true);
         }
     }

Here is the call graph for this function:

◆ activatePostAndChildPosts()

ilForumPost::activatePostAndChildPosts ( )

Definition at line 219 of file class.ilForumPost.php.

References activateParentPosts().

                                                : bool
     {
         if ($this->id !== 0) {
             $query = "SELECT pos_pk FROM frm_posts_tree treea "
                 . "INNER JOIN frm_posts_tree treeb ON treeb.thr_fk = treea.thr_fk "
                 . "AND treeb.lft BETWEEN treea.lft AND treea.rgt "
                 . "INNER JOIN frm_posts ON pos_pk = treeb.pos_fk "
                 . "WHERE treea.pos_fk = %s";
             $result = $this->db->queryF(
                 $query,
                 ['integer'],
                 [$this->id]
             );
 
             $now = date('Y-m-d H:i:s');
             while ($row = $this->db->fetchAssoc($result)) {
                 $this->db->update(
                     'frm_posts',
                     [
                         'pos_status' => ['integer', 1],
                         'pos_activation_date' => ['timestamp', $now]
                     ],
                     ['pos_pk' => ['integer', $row['pos_pk']]]
                 );
             }
 
             $this->activateParentPosts();
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ assignData()

ilForumPost::assignData ( array $row )

Definition at line 597 of file class.ilForumPost.php.

References null, setCensoredDate(), setCensorship(), setCensorshipComment(), setChangeDate(), setCreateDate(), setDepth(), setDisplayUserId(), setForumId(), setImportName(), setIsAuthorModerator(), setIsRead(), setLft(), setMessage(), setNotification(), setParentId(), setPosAuthorId(), setRCID(), setRgt(), setStatus(), setSubject(), setThreadId(), setTreeId(), setUpdateUserId(), and setUserAlias().

                                           : void
     {
         $this->setUserAlias((string) $row['pos_usr_alias']);
         $this->setSubject((string) $row['pos_subject']);
         $this->setCreateDate($row['pos_date']);
         $this->setMessage((string) $row['pos_message']);
         $this->setForumId((int) $row['pos_top_fk']);
         $this->setThreadId((int) $row['pos_thr_fk']);
         $this->setChangeDate($row['pos_update']);
         $this->setUpdateUserId((int) $row['update_user']);
         $this->setCensorship((bool) $row['pos_cens']);
         $this->setCensoredDate($row['pos_cens_date'] ?? null);
         $this->setCensorshipComment($row['pos_cens_com']);
         $this->setNotification((bool) $row['notify']);
         $this->setImportName($row['import_name']);
         $this->setStatus((bool) $row['pos_status']);
         $this->setTreeId((int) $row['fpt_pk']);
         $this->setParentId((int) $row['parent_pos']);
         $this->setLft((int) $row['lft']);
         $this->setRgt((int) $row['rgt']);
         $this->setDepth((int) $row['depth']);
         $this->setIsRead(isset($row['post_read']) && (int) $row['post_read']);
         $this->setDisplayUserId((int) $row['pos_display_user_id']);
         $this->setPosAuthorId((int) $row['pos_author_id']);
         $this->setIsAuthorModerator((bool) $row['is_author_moderator']);
         $this->setRCID((string) ($row['rcid'] ?? self::NO_RCID));
     }

Here is the call graph for this function:

◆ getCensoredDate()

ilForumPost::getCensoredDate ( )

Definition at line 577 of file class.ilForumPost.php.

References $censored_date.

                                      : ?string
     {
         return $this->censored_date;
     }

◆ getCensorshipComment()

ilForumPost::getCensorshipComment ( )

Definition at line 452 of file class.ilForumPost.php.

References $censorship_comment.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                           : ?string
     {
         return $this->censorship_comment;
     }

Here is the caller graph for this function:

◆ getChangeDate()

ilForumPost::getChangeDate ( )

Definition at line 422 of file class.ilForumPost.php.

References $changedate.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                    : ?string
     {
         return $this->changedate;
     }

Here is the caller graph for this function:

◆ getCreateDate()

ilForumPost::getCreateDate ( )

Definition at line 412 of file class.ilForumPost.php.

References $createdate.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                    : ?string
     {
         return $this->createdate;
     }

Here is the caller graph for this function:

◆ getDepth()

ilForumPost::getDepth ( )

Definition at line 542 of file class.ilForumPost.php.

References $depth.

Referenced by ilObjForumGUI\renderDraftContent(), and ilObjForumGUI\renderPostContent().

                               : int
     {
         return $this->depth;
     }

Here is the caller graph for this function:

◆ getDisplayUserId()

ilForumPost::getDisplayUserId ( )

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

References $display_user_id.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderPostingForm().

                                       : int
     {
         return $this->display_user_id;
     }

Here is the caller graph for this function:

◆ getForumId()

ilForumPost::getForumId ( )

Definition at line 342 of file class.ilForumPost.php.

References $forum_id.

Referenced by ilObjForumGUI\renderSplitButton().

                                 : int
     {
         return $this->forum_id;
     }

Here is the caller graph for this function:

◆ getId()

ilForumPost::getId ( )

Definition at line 332 of file class.ilForumPost.php.

References $id.

Referenced by ilObjForumGUI\addActivationFormModal(), ilObjForumGUI\ensureValidPageForCurrentPosting(), ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), ilObjForumGUI\renderSplitButton(), and ilObjForumGUI\viewThreadObject().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImportName()

ilForumPost::getImportName ( )

Definition at line 472 of file class.ilForumPost.php.

References $import_name.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderPostingForm().

                                    : ?string
     {
         return $this->import_name;
     }

Here is the caller graph for this function:

◆ getIsRead()

ilForumPost::getIsRead ( )

Definition at line 507 of file class.ilForumPost.php.

References $post_read.

Referenced by isPostRead().

                                : bool
     {
         return $this->post_read;
     }

Here is the caller graph for this function:

◆ getLft()

ilForumPost::getLft ( )

Definition at line 522 of file class.ilForumPost.php.

References $lft.

Referenced by ilForumTopic\getPostTree(), and ilForum\getSubPathIdsForNode().

                             : int
     {
         return $this->lft;
     }

Here is the caller graph for this function:

◆ getMessage()

ilForumPost::getMessage ( )

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

References $message.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderPostingForm().

                                 : string
     {
         return $this->message;
     }

Here is the caller graph for this function:

◆ getParentId()

ilForumPost::getParentId ( )

Definition at line 512 of file class.ilForumPost.php.

References $parent_id.

                                  : int
     {
         return $this->parent_id;
     }

◆ getPosAuthorId()

ilForumPost::getPosAuthorId ( )

Definition at line 562 of file class.ilForumPost.php.

References $pos_author_id.

Referenced by ilForumNotificationDataProvider\getThreadNotificationRecipients(), ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderPostingForm().

                                     : int
     {
         return $this->pos_author_id;
     }

Here is the caller graph for this function:

◆ getPostActivationDate()

ilForumPost::getPostActivationDate ( )

Definition at line 582 of file class.ilForumPost.php.

References $post_activation_date.

                                            : ?string
     {
         return $this->post_activation_date;
     }

◆ getRCID()

ilForumPost::getRCID ( )

Definition at line 357 of file class.ilForumPost.php.

References $rcid.

Referenced by ilFileDataForumRCImplementation\importFileToCollection().

                              : string
     {
         return $this->rcid;
     }

Here is the caller graph for this function:

◆ getRgt()

ilForumPost::getRgt ( )

Definition at line 532 of file class.ilForumPost.php.

References $rgt.

Referenced by ilForumTopic\getPostTree(), and ilForum\getSubPathIdsForNode().

                             : int
     {
         return $this->rgt;
     }

Here is the caller graph for this function:

◆ getSubject()

ilForumPost::getSubject ( )

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

References $subject.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                 : string
     {
         return $this->subject;
     }

Here is the caller graph for this function:

◆ getThread()

ilForumPost::getThread ( )

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

References $objThread.

                                : ?ilForumTopic
     {
         return $this->objThread;
     }

◆ getThreadId()

ilForumPost::getThreadId ( )

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

References $thread_id.

Referenced by ilObjForumGUI\addActivationFormModal(), ilForumTopic\getPostTree(), ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), and ilObjForumGUI\renderSplitButton().

                                  : int
     {
         return $this->thread_id;
     }

Here is the caller graph for this function:

◆ getTreeId()

ilForumPost::getTreeId ( )

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

References $tree_id.

Referenced by ilForum\getSubPathIdsForNode().

                                : int
     {
         return $this->tree_id;
     }

Here is the caller graph for this function:

◆ getUpdateUserId()

ilForumPost::getUpdateUserId ( )

Definition at line 432 of file class.ilForumPost.php.

References $user_id_update.

Referenced by ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                      : int
     {
         return $this->user_id_update;
     }

Here is the caller graph for this function:

◆ getUserAlias()

ilForumPost::getUserAlias ( )

Definition at line 382 of file class.ilForumPost.php.

References $user_alias.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderPostingForm().

                                   : ?string
     {
         return $this->user_alias;
     }

Here is the caller graph for this function:

◆ hasReplies()

ilForumPost::hasReplies ( )

Definition at line 303 of file class.ilForumPost.php.

References $res.

Referenced by ilObjForumGUI\renderSplitButton().

                                 : bool
     {
         if ($this->id && $this->rgt && $this->lft) {
             $res = $this->db->queryF(
                 'SELECT * FROM frm_posts_tree WHERE lft > %s AND rgt < %s AND thr_fk = %s',
                 ['integer', 'integer', 'integer'],
                 [$this->lft, $this->rgt, $this->thread_id]
             );
 
             return $res->numRows() > 0;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ insert()

ilForumPost::insert ( )

Definition at line 68 of file class.ilForumPost.php.

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

                             : void
     {
         if ($this->forum_id && $this->thread_id) {
             $this->id = $this->db->nextId('frm_posts');
 
             $this->db->insert('frm_posts', [
                 'pos_pk' => ['integer', $this->id],
                 'pos_top_fk' => ['integer', $this->forum_id],
                 'pos_thr_fk' => ['integer', $this->thread_id],
                 'pos_display_user_id' => ['integer', $this->display_user_id],
                 'pos_usr_alias' => ['text', $this->user_alias],
                 'pos_subject' => ['text', $this->subject],
                 'pos_message' => ['clob', $this->message],
                 'pos_date' => ['timestamp', $this->createdate],
                 'pos_update' => ['timestamp', $this->createdate],
                 'update_user' => ['integer', $this->user_id_update],
                 'pos_cens' => ['integer', (int) $this->censored],
                 'notify' => ['integer', (int) $this->notification],
                 'import_name' => ['text', $this->import_name],
                 'pos_status' => ['integer', (int) $this->status],
                 'pos_author_id' => ['integer', $this->pos_author_id],
                 'is_author_moderator' => ['integer', $this->is_author_moderator],
                 'pos_activation_date' => ['timestamp', $this->createdate]
             ]);
         }
     }

Here is the call graph for this function:

◆ isActivated()

ilForumPost::isActivated ( )

Definition at line 482 of file class.ilForumPost.php.

References $status.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), and ilObjForumGUI\renderSplitButton().

                                  : bool
     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ isAnyParentDeactivated()

ilForumPost::isAnyParentDeactivated ( )

Definition at line 175 of file class.ilForumPost.php.

References $res.

                                             : bool
     {
         if ($this->id !== 0) {
             $res = $this->db->queryF(
                 '
                                 SELECT * FROM frm_posts_tree
                                 INNER JOIN frm_posts ON pos_pk = pos_fk
                                 WHERE pos_status = %s
                                 AND lft < %s AND rgt > %s
                                 AND thr_fk = %s',
                 ['integer', 'integer', 'integer', 'integer'],
                 [0, $this->lft, $this->rgt, $this->thread_id]
             );
 
             return $res->numRows() > 0;
         }
 
         return false;
     }

◆ isAuthorModerator()

ilForumPost::isAuthorModerator ( )

Definition at line 567 of file class.ilForumPost.php.

References $is_author_moderator.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                        : ?bool
     {
         return $this->is_author_moderator;
     }

Here is the caller graph for this function:

◆ isCensored()

ilForumPost::isCensored ( )

Definition at line 442 of file class.ilForumPost.php.

References $censored.

Referenced by ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), ilObjForumGUI\renderPostingForm(), and ilObjForumGUI\renderSplitButton().

                                 : bool
     {
         return $this->censored;
     }

Here is the caller graph for this function:

◆ isNotificationEnabled()

ilForumPost::isNotificationEnabled ( )

Definition at line 462 of file class.ilForumPost.php.

References $notification.

                                            : bool
     {
         return $this->notification;
     }

◆ isOwner()

ilForumPost::isOwner ( int $a_user_id = 0 )

Definition at line 318 of file class.ilForumPost.php.

Referenced by ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), ilObjForumGUI\renderPostingForm(), and ilObjForumGUI\renderSplitButton().

                                                : bool
     {
         if ($this->pos_author_id && $a_user_id) {
             return $this->pos_author_id === $a_user_id;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isPostRead()

ilForumPost::isPostRead ( )

Definition at line 283 of file class.ilForumPost.php.

References getIsRead().

Referenced by ilObjForumGUI\renderPostContent(), and ilObjForumGUI\renderSplitButton().

                                 : bool
     {
         return $this->getIsRead();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRead()

ilForumPost::isRead ( int $a_user_id = 0 )

Definition at line 288 of file class.ilForumPost.php.

References $res.

                                               : bool
     {
         if ($a_user_id && $this->id) {
             $res = $this->db->queryF(
                 'SELECT * FROM frm_user_read WHERE usr_id = %s AND post_id = %s',
                 ['integer', 'integer'],
                 [$a_user_id, $this->id]
             );
 
             return $res->numRows() > 0;
         }
 
         return false;
     }

◆ lookupNotificationStatusByPostId()

static ilForumPost::lookupNotificationStatusByPostId ( int $post_id )

static

Definition at line 645 of file class.ilForumPost.php.

References $DIC, and $res.

                                                                          : bool
     {
         global $DIC;
 
         $res = $DIC->database()->queryF(
             'SELECT notify FROM frm_posts WHERE pos_pk = %s',
             ['integer'],
             [$post_id]
         );
 
         $row = $DIC->database()->fetchAssoc($res);
         return (bool) $row['notify'];
     }

◆ lookupPostMessage()

static ilForumPost::lookupPostMessage ( int $post_id )

static

Definition at line 659 of file class.ilForumPost.php.

References $DIC, $ilDB, and $res.

                                                           : string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT pos_message FROM frm_posts WHERE pos_pk = %s',
             ['integer'],
             [$post_id]
         );
 
         if ($row = $ilDB->fetchObject($res)) {
             return $row->pos_message ?: '';
         }
 
         return '';
     }

◆ mergePosts()

static ilForumPost::mergePosts	(	int	$sourceThreadId,
		int	$targetThreadId,
		array	$excludedPostIds = `[]`
	)

static

Parameters

int[] $excludedPostIds

Definition at line 628 of file class.ilForumPost.php.

References $DIC, and $ilDB.

Referenced by ilForum\mergeThreads().

                                                                                                             : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $conditions = ['pos_thr_fk = ' . $ilDB->quote($sourceThreadId, 'integer')];
         if ($excludedPostIds !== []) {
             $conditions[] = $ilDB->in('pos_pk', $excludedPostIds, true, 'integer');
         }
 
         $ilDB->manipulateF(
             'UPDATE frm_posts SET pos_thr_fk = %s WHERE ' . implode(' AND ', $conditions),
             ['integer',],
             [$targetThreadId,]
         );
     }

Here is the caller graph for this function:

◆ read()

ilForumPost::read ( )

private

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

References $res, ILIAS\Repository\int(), and ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

Referenced by __construct(), and reload().

                            : void
     {
         if ($this->id !== 0) {
             $res = $this->db->queryF(
                 '
                                 SELECT * FROM frm_posts
                                 INNER JOIN frm_posts_tree ON pos_fk = pos_pk
                                 WHERE pos_pk = %s',
                 ['integer'],
                 [$this->id]
             );
             $row = $this->db->fetchObject($res);
 
             if (is_object($row)) {
                 $this->id = (int) $row->pos_pk;
                 $this->forum_id = (int) $row->pos_top_fk;
                 $this->thread_id = (int) $row->pos_thr_fk;
                 $this->display_user_id = (int) $row->pos_display_user_id;
                 $this->user_alias = $row->pos_usr_alias;
                 $this->subject = (string) $row->pos_subject;
                 $this->message = (string) $row->pos_message;
                 $this->createdate = $row->pos_date;
                 $this->changedate = $row->pos_update;
                 $this->user_id_update = (int) $row->update_user;
                 $this->censored = (bool) $row->pos_cens;
                 $this->censored_date = $row->pos_cens_date;
                 $this->censorship_comment = $row->pos_cens_com;
                 $this->notification = (bool) $row->notify;
                 $this->import_name = $row->import_name;
                 $this->status = (bool) $row->pos_status;
                 $this->tree_id = (int) $row->fpt_pk;
                 $this->parent_id = (int) $row->parent_pos;
                 $this->lft = (int) $row->lft;
                 $this->rgt = (int) $row->rgt;
                 $this->depth = (int) $row->depth;
                 $this->pos_author_id = (int) $row->pos_author_id;
                 $this->is_author_moderator = (bool) $row->is_author_moderator;
                 $this->post_activation_date = $row->pos_activation_date;
                 $this->rcid = (string) $row->rcid;
                 $this->objThread = new ilForumTopic($this->thread_id, $this->is_moderator);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reload()

ilForumPost::reload ( )

Definition at line 195 of file class.ilForumPost.php.

References read().

                             : void
     {
         $this->read();
     }

Here is the call graph for this function:

◆ setCensoredDate()

ilForumPost::setCensoredDate ( ?string $censored_date )

Definition at line 592 of file class.ilForumPost.php.

References $censored_date.

Referenced by assignData().

                                                            : void
     {
         $this->censored_date = $censored_date;
     }

Here is the caller graph for this function:

◆ setCensorship()

ilForumPost::setCensorship ( bool $a_censorship )

Definition at line 437 of file class.ilForumPost.php.

Referenced by assignData().

                                                      : void
     {
         $this->censored = $a_censorship;
     }

Here is the caller graph for this function:

◆ setCensorshipComment()

ilForumPost::setCensorshipComment ( ?string $a_comment )

Definition at line 447 of file class.ilForumPost.php.

Referenced by assignData().

                                                             : void
     {
         $this->censorship_comment = $a_comment;
     }

Here is the caller graph for this function:

◆ setChangeDate()

ilForumPost::setChangeDate ( ?string $a_changedate )

Definition at line 417 of file class.ilForumPost.php.

Referenced by assignData(), ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                                         : void
     {
         $this->changedate = $a_changedate;
     }

Here is the caller graph for this function:

◆ setCreateDate()

ilForumPost::setCreateDate ( ?string $a_createdate )

Definition at line 407 of file class.ilForumPost.php.

Referenced by assignData().

                                                         : void
     {
         $this->createdate = $a_createdate;
     }

Here is the caller graph for this function:

◆ setDepth()

ilForumPost::setDepth ( int $a_depth )

Definition at line 537 of file class.ilForumPost.php.

Referenced by assignData().

                                           : void
     {
         $this->depth = $a_depth;
     }

Here is the caller graph for this function:

◆ setDisplayUserId()

ilForumPost::setDisplayUserId ( int $a_user_id )

Definition at line 367 of file class.ilForumPost.php.

Referenced by assignData().

                                                     : void
     {
         $this->display_user_id = $a_user_id;
     }

Here is the caller graph for this function:

◆ setForumId()

ilForumPost::setForumId ( int $a_forum_id )

Definition at line 337 of file class.ilForumPost.php.

Referenced by assignData().

                                                : void
     {
         $this->forum_id = $a_forum_id;
     }

Here is the caller graph for this function:

◆ setId()

ilForumPost::setId ( int $a_id )

Definition at line 327 of file class.ilForumPost.php.

                                     : void
     {
         $this->id = $a_id;
     }

◆ setImportName()

ilForumPost::setImportName ( ?string $a_import_name )

Definition at line 467 of file class.ilForumPost.php.

Referenced by assignData().

                                                          : void
     {
         $this->import_name = $a_import_name;
     }

Here is the caller graph for this function:

◆ setIsAuthorModerator()

ilForumPost::setIsAuthorModerator ( ?bool $is_author_moderator )

Definition at line 572 of file class.ilForumPost.php.

References $is_author_moderator.

Referenced by assignData().

                                                                     : void
     {
         $this->is_author_moderator = $is_author_moderator;
     }

Here is the caller graph for this function:

◆ setIsRead()

ilForumPost::setIsRead ( bool $a_is_read )

Definition at line 502 of file class.ilForumPost.php.

Referenced by assignData().

                                               : void
     {
         $this->post_read = $a_is_read;
     }

Here is the caller graph for this function:

◆ setLft()

ilForumPost::setLft ( int $a_lft )

Definition at line 517 of file class.ilForumPost.php.

Referenced by assignData().

                                       : void
     {
         $this->lft = $a_lft;
     }

Here is the caller graph for this function:

◆ setMessage()

ilForumPost::setMessage ( string $a_message )

Definition at line 397 of file class.ilForumPost.php.

Referenced by assignData(), ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                                  : void
     {
         $this->message = $a_message;
     }

Here is the caller graph for this function:

◆ setNotification()

ilForumPost::setNotification ( bool $a_notification )

Definition at line 457 of file class.ilForumPost.php.

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

Referenced by assignData().

                                                          : void
     {
         $this->notification = $a_notification;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParentId()

ilForumPost::setParentId ( int $a_parent_id )

Definition at line 497 of file class.ilForumPost.php.

Referenced by assignData().

                                                  : void
     {
         $this->parent_id = $a_parent_id;
     }

Here is the caller graph for this function:

◆ setPosAuthorId()

ilForumPost::setPosAuthorId ( int $pos_author_id )

Definition at line 557 of file class.ilForumPost.php.

References $pos_author_id.

Referenced by assignData().

                                                       : void
     {
         $this->pos_author_id = $pos_author_id;
     }

Here is the caller graph for this function:

◆ setPostActivationDate()

ilForumPost::setPostActivationDate ( ?string $post_activation_date )

Definition at line 587 of file class.ilForumPost.php.

References $post_activation_date.

Referenced by activatePost().

                                                                         : void
     {
         $this->post_activation_date = $post_activation_date;
     }

Here is the caller graph for this function:

◆ setRCID()

ilForumPost::setRCID ( string $rcid )

Definition at line 362 of file class.ilForumPost.php.

References $rcid.

Referenced by assignData(), and ilFileDataForumRCImplementation\importFileToCollection().

                                          : void
     {
         $this->rcid = $rcid;
     }

Here is the caller graph for this function:

◆ setRgt()

ilForumPost::setRgt ( int $a_rgt )

Definition at line 527 of file class.ilForumPost.php.

Referenced by assignData().

                                       : void
     {
         $this->rgt = $a_rgt;
     }

Here is the caller graph for this function:

◆ setStatus()

ilForumPost::setStatus ( bool $a_status )

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

Referenced by activatePost(), and assignData().

                                              : void
     {
         $this->status = $a_status;
     }

Here is the caller graph for this function:

◆ setSubject()

ilForumPost::setSubject ( string $a_subject )

Definition at line 387 of file class.ilForumPost.php.

Referenced by assignData().

                                                  : void
     {
         $this->subject = $a_subject;
     }

Here is the caller graph for this function:

◆ setThread()

ilForumPost::setThread ( ilForumTopic $thread )

Definition at line 547 of file class.ilForumPost.php.

                                                    : void
     {
         $this->objThread = $thread;
     }

◆ setThreadId()

ilForumPost::setThreadId ( int $a_thread_id )

Definition at line 347 of file class.ilForumPost.php.

Referenced by assignData().

                                                  : void
     {
         $this->thread_id = $a_thread_id;
     }

Here is the caller graph for this function:

◆ setTreeId()

ilForumPost::setTreeId ( int $a_tree_id )

Definition at line 487 of file class.ilForumPost.php.

Referenced by assignData().

                                              : void
     {
         $this->tree_id = $a_tree_id;
     }

Here is the caller graph for this function:

◆ setUpdateUserId()

ilForumPost::setUpdateUserId ( int $a_user_id_update )

Definition at line 427 of file class.ilForumPost.php.

Referenced by assignData().

                                                           : void
     {
         $this->user_id_update = $a_user_id_update;
     }

Here is the caller graph for this function:

◆ setUserAlias()

ilForumPost::setUserAlias ( ?string $a_user_alias )

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

Referenced by assignData().

                                                        : void
     {
         $this->user_alias = $a_user_alias;
     }

Here is the caller graph for this function:

◆ update()

ilForumPost::update ( )

Definition at line 95 of file class.ilForumPost.php.

References $id, and ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

Referenced by ilFileDataForumRCImplementation\importFileToCollection().

                             : bool
     {
         if ($this->id !== 0) {
             $this->db->update(
                 'frm_posts',
                 [
                     'pos_top_fk' => ['integer', $this->forum_id],
                     'pos_thr_fk' => ['integer', $this->thread_id],
                     'pos_subject' => ['text', $this->subject],
                     'pos_message' => ['clob', $this->message],
                     'pos_update' => ['timestamp', $this->changedate],
                     'update_user' => ['integer', $this->user_id_update],
                     'pos_cens' => ['integer', (int) $this->censored],
                     'pos_cens_date' => ['timestamp', $this->censored_date],
                     'pos_cens_com' => ['text', $this->censorship_comment],
                     'notify' => ['integer', (int) $this->notification],
                     'pos_status' => ['integer', (int) $this->status],
                     'rcid' => ['text', ($this->rcid ?? self::NO_RCID)]
                 ],
                 [
                     'pos_pk' => ['integer', $this->id]
                 ]
             );
 
             if ($this->objThread->getFirstVisiblePostId() === $this->id) {
                 $this->objThread->setSubject($this->subject);
                 $this->objThread->update();
                 $this->objThread->reload();
             }
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $censored

bool ilForumPost::$censored = false

private

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

Referenced by isCensored().

◆ $censored_date

string ilForumPost::$censored_date = null

private

Definition at line 39 of file class.ilForumPost.php.

Referenced by getCensoredDate(), and setCensoredDate().

◆ $censorship_comment

string ilForumPost::$censorship_comment = null

private

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

Referenced by getCensorshipComment().

◆ $changedate

string ilForumPost::$changedate = null

private

Definition at line 35 of file class.ilForumPost.php.

Referenced by getChangeDate().

◆ $createdate

string ilForumPost::$createdate = null

private

Definition at line 34 of file class.ilForumPost.php.

Referenced by getCreateDate().

◆ $db

readonly ilDBInterface ilForumPost::$db

private

Definition at line 49 of file class.ilForumPost.php.

◆ $depth

int ilForumPost::$depth = 0

private

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

Referenced by getDepth().

◆ $display_user_id

int ilForumPost::$display_user_id = 0

private

Definition at line 30 of file class.ilForumPost.php.

Referenced by getDisplayUserId().

◆ $forum_id

int ilForumPost::$forum_id = 0

private

Definition at line 28 of file class.ilForumPost.php.

Referenced by getForumId().

◆ $import_name

string ilForumPost::$import_name = null

private

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

Referenced by getImportName().

◆ $is_author_moderator

bool ilForumPost::$is_author_moderator = false

private

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

Referenced by isAuthorModerator(), and setIsAuthorModerator().

◆ $is_moderator

bool ilForumPost::$is_moderator = false

private

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

◆ $lft

int ilForumPost::$lft = 0

private

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

Referenced by getLft().

◆ $message

string ilForumPost::$message = ''

private

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

Referenced by getMessage().

◆ $notification

bool ilForumPost::$notification = false

private

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

Referenced by isNotificationEnabled().

◆ $objThread

ilForumTopic ilForumPost::$objThread = null

private

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

Referenced by getThread().

◆ $parent_id

int ilForumPost::$parent_id = 0

private

Definition at line 44 of file class.ilForumPost.php.

Referenced by getParentId().

◆ $pos_author_id

int ilForumPost::$pos_author_id = 0

private

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

Referenced by getPosAuthorId(), and setPosAuthorId().

◆ $post_activation_date

string ilForumPost::$post_activation_date = null

private

Definition at line 54 of file class.ilForumPost.php.

Referenced by getPostActivationDate(), and setPostActivationDate().

◆ $post_read

bool ilForumPost::$post_read = false

private

Definition at line 52 of file class.ilForumPost.php.

Referenced by getIsRead().

◆ $rcid

string ilForumPost::$rcid = self::NO_RCID

private

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

Referenced by getRCID(), and setRCID().

◆ $rgt

int ilForumPost::$rgt = 0

private

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

Referenced by getRgt().

◆ $status

bool ilForumPost::$status = true

private

Definition at line 42 of file class.ilForumPost.php.

Referenced by isActivated().

◆ $subject

string ilForumPost::$subject = ''

private

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

Referenced by getSubject().

◆ $thread_id

int ilForumPost::$thread_id = 0

private

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

Referenced by getThreadId().

◆ $tree_id

int ilForumPost::$tree_id = 0

private

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

Referenced by getTreeId().

◆ $user_alias

string ilForumPost::$user_alias = null

private

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

Referenced by getUserAlias().

◆ $user_id_update

int ilForumPost::$user_id_update = 0

private

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

Referenced by getUpdateUserId().

◆ NO_RCID

const ilForumPost::NO_RCID = '-'

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

Referenced by ilFileDataForumRCImplementation\importFileToCollection().

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

components/ILIAS/Forum/classes/class.ilForumPost.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateParentPosts()

◆ activatePost()

◆ activatePostAndChildPosts()

◆ assignData()

◆ getCensoredDate()

◆ getCensorshipComment()

◆ getChangeDate()

◆ getCreateDate()

◆ getDepth()

◆ getDisplayUserId()

◆ getForumId()

◆ getId()

◆ getImportName()

◆ getIsRead()

◆ getLft()

◆ getMessage()

◆ getParentId()

◆ getPosAuthorId()

◆ getPostActivationDate()

◆ getRCID()

◆ getRgt()

◆ getSubject()

◆ getThread()

◆ getThreadId()

◆ getTreeId()

◆ getUpdateUserId()

◆ getUserAlias()

◆ hasReplies()

◆ insert()

◆ isActivated()

◆ isAnyParentDeactivated()

◆ isAuthorModerator()

◆ isCensored()

◆ isNotificationEnabled()

◆ isOwner()

◆ isPostRead()

◆ isRead()

◆ lookupNotificationStatusByPostId()

◆ lookupPostMessage()

◆ mergePosts()

◆ read()

◆ reload()

◆ setCensoredDate()

◆ setCensorship()

◆ setCensorshipComment()

◆ setChangeDate()

◆ setCreateDate()

◆ setDepth()

◆ setDisplayUserId()

◆ setForumId()

◆ setId()

◆ setImportName()

◆ setIsAuthorModerator()

◆ setIsRead()

◆ setLft()

◆ setMessage()

◆ setNotification()

◆ setParentId()

◆ setPosAuthorId()

◆ setPostActivationDate()

◆ setRCID()

◆ setRgt()

◆ setStatus()

◆ setSubject()

◆ setThread()

◆ setThreadId()

◆ setTreeId()

◆ setUpdateUserId()

◆ setUserAlias()

◆ update()

Field Documentation