Collaboration diagram for ilForumTopic:

Public Member Functions
	__construct (int $a_id=0, bool $a_is_moderator=false, bool $preventImplicitRead=false)
	Returns an object of a forum topic. More...

	assignData (array $data)

	insert ()

	update ()

	reload ()

	getPostRootId ()

	getFirstVisiblePostId ()

	updateVisits ()

	countPosts (bool $ignoreRoot=false)

	countActivePosts (bool $ignoreRoot=false)

	getPostRootNode (bool $isModerator=false, bool $preventImplicitRead=false)

	getFirstVisiblePostNode (bool $isModerator=false, bool $preventImplicitRead=false)

	getLastPost ()

	getLastActivePost ()

	getAllPostIds ()

	getPostTree (ilForumPost $a_post_node)
	Fetches and returns an array of posts from the post tree, starting with the node object passed by the first paramter. More...

	movePosts (int $old_obj_id, int $old_pk, int $new_obj_id, int $new_pk)
	Moves all posts within the current thread to a new forum. More...

	getNestedSetPostChildren (?int $pos_id=null, ?int $num_levels=null)

	isNotificationEnabled (int $a_user_id)

	enableNotification (int $a_user_id)

	disableNotification (int $a_user_id)

	makeSticky ()

	unmakeSticky ()

	close ()

	reopen ()

	getAverageRating ()

	setAverageRating (float $average_rating)

	setId (int $a_id)

	getId ()

	setForumId (int $a_forum_id)

	getForumId ()

	setDisplayUserId (int $a_user_id)

	getDisplayUserId ()

	setUserAlias (?string $a_user_alias)

	getUserAlias ()

	setSubject (string $a_subject)

	getSubject ()

	setCreateDate (?string $a_createdate)

	getCreateDate ()

	setChangeDate (?string $a_changedate)

	getChangeDate ()

	setImportName (?string $a_import_name)

	getImportName ()

	setLastPostString (?string $a_last_post)

	getLastPostString ()

	setVisits (int $a_visits)

	getVisits ()

	setSticky (bool $a_sticky)

	isSticky ()

	getOrderSequenceIndex ()

	setOrderSequenceIndex (?int $order_sequence_index)

	setClosed (bool $a_closed)

	isClosed ()

	setOrderField (string $a_order_field)

	getOrderField ()

	getFrmObjId ()

	setThrAuthorId (int $thr_author_id)

	getThrAuthorId ()

	updateThreadTitle ()

	setNumPosts (int $a_num_posts)

	getNumPosts ()

	setNumNewPosts (int $num_new_posts)

	getNumNewPosts ()

	setNumUnreadPosts (int $num_unread_posts)

	getNumUnreadPosts ()

	setUserNotificationEnabled (bool $status)

	isUserNotificationEnabled ()

	setOrderDirection (string $direction)

	getOrderDirection ()

	updateMergedThread ()

	getLastPostForThreadOverview ()

	setLastPostForThreadOverview (ilForumPost $post)

Static Public Member Functions
static	lookupTitle (int $a_topic_id)

static	lookupForumIdByTopicId (int $a_topic_id)

static	lookupCreationDate (int $thread_id)

Static Protected Attributes
static array	$possibleOrderDirections = ['ASC', 'DESC']

Private Member Functions
	read ()

Private Attributes
int	$id

int	$forum_id = 0

int	$frm_obj_id = 0

int	$display_user_id = 0

string	$user_alias = null

string	$subject = ''

string	$createdate = null

string	$changedate = null

int	$num_posts = 0

string	$last_post_string = null

int	$visits = 0

string	$import_name = null

bool	$is_sticky = false

int	$order_sequence_index = null

bool	$is_closed = false

string	$orderField = ''

ilForumPost	$last_post = null

ilDBInterface	$db

bool	$is_moderator

int	$thr_author_id = 0

float	$average_rating = 0.0

string	$orderDirection = 'DESC'

ilObjUser	$user

int	$num_new_posts = 0

int	$num_unread_posts = 0

bool	$user_notification_enabled = false

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumTopic::__construct	(	int	$a_id = `0`,
		bool	$a_is_moderator = `false`,
		bool	$preventImplicitRead = `false`
	)

Returns an object of a forum topic.

The constructor calls the private method read() to load the topic data from database into the object.

Parameters

int	$a_id	primary key of a forum topic (optional)
bool	$a_is_moderator	moderator-status of the current user (optional)
bool	$preventImplicitRead	Prevents the implicit database query if an id was passed

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

References $DIC, read(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->is_moderator = $a_is_moderator;
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->id = $a_id;
 
         if (!$preventImplicitRead) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignData()

ilForumTopic::assignData ( array $data )

Definition at line 76 of file class.ilForumTopic.php.

References setAverageRating(), setChangeDate(), setClosed(), setCreateDate(), setDisplayUserId(), setForumId(), setId(), setImportName(), setLastPostString(), setNumNewPosts(), setNumPosts(), setNumUnreadPosts(), setOrderSequenceIndex(), setSticky(), setSubject(), setThrAuthorId(), setUserAlias(), setUserNotificationEnabled(), and setVisits().

                                            : void
     {
         $this->setId((int) $data['thr_pk']);
         $this->setForumId((int) $data['thr_top_fk']);
         $this->setSubject($data['thr_subject']);
         $this->setDisplayUserId((int) $data['thr_display_user_id']);
         $this->setUserAlias($data['thr_usr_alias']);
         $this->setLastPostString($data['thr_last_post']);
         $this->setCreateDate($data['thr_date']);
         $this->setChangeDate($data['thr_update']);
         $this->setVisits((int) $data['visits']);
         $this->setImportName($data['import_name']);
         $this->setSticky((bool) $data['is_sticky']);
         $this->setClosed((bool) $data['is_closed']);
         $this->setAverageRating(isset($data['avg_rating']) ? (float) $data['avg_rating'] : 0);
         $this->setThrAuthorId((int) $data['thr_author_id']);
 
         if (isset($data['thread_sorting'])) {
             $this->setOrderSequenceIndex((int) $data['thread_sorting']);
         }
 
         // Aggregated values
         if (isset($data['num_posts'])) {
             $this->setNumPosts((int) $data['num_posts']);
         }
         if (isset($data['num_unread_posts'])) {
             $this->setNumUnreadPosts((int) $data['num_unread_posts']);
         }
         if (isset($data['num_new_posts'])) {
             $this->setNumNewPosts((int) $data['num_new_posts']);
         }
         if (isset($data['usr_notification_is_enabled'])) {
             $this->setUserNotificationEnabled((bool) $data['usr_notification_is_enabled']);
         }
     }

Here is the call graph for this function:

◆ close()

ilForumTopic::close ( )

Definition at line 846 of file class.ilForumTopic.php.

                            : void
     {
         if ($this->id && !$this->is_closed) {
             $this->db->manipulateF(
                 'UPDATE frm_threads SET is_closed = %s WHERE thr_pk = %s',
                 ['integer', 'integer'],
                 [1, $this->id]
             );
             $this->is_closed = true;
         }
     }

◆ countActivePosts()

ilForumTopic::countActivePosts ( bool $ignoreRoot = false )

Definition at line 289 of file class.ilForumTopic.php.

References $id, $res, and ILIAS\Repository\user().

                                                               : int
     {
         $res = $this->db->queryF(
             '
                         SELECT COUNT(*) cnt
                         FROM frm_posts
                         INNER JOIN frm_posts_tree ON frm_posts_tree.pos_fk = pos_pk
                         WHERE (pos_status = %s
                                  OR (pos_status = %s AND pos_display_user_id = %s))
                         AND pos_thr_fk = %s' . ($ignoreRoot ? ' AND parent_pos != 0 ' : ''),
             ['integer', 'integer', 'integer', 'integer'],
             ['1', '0', $this->user->getId(), $this->id]
         );
 
         $row = $this->db->fetchAssoc($res);
         if (is_array($row)) {
             return (int) $row['cnt'];
         }
 
         return 0;
     }

Here is the call graph for this function:

◆ countPosts()

ilForumTopic::countPosts ( bool $ignoreRoot = false )

Definition at line 269 of file class.ilForumTopic.php.

References $res.

                                                         : int
     {
         $res = $this->db->queryF(
             '
                         SELECT COUNT(*) cnt
                         FROM frm_posts
                         INNER JOIN frm_posts_tree ON frm_posts_tree.pos_fk = pos_pk
                         WHERE pos_thr_fk = %s' . ($ignoreRoot ? ' AND parent_pos != 0 ' : ''),
             ['integer'],
             [$this->id]
         );
 
         $row = $this->db->fetchAssoc($res);
         if (is_array($row)) {
             return (int) $row['cnt'];
         }
 
         return 0;
     }

◆ disableNotification()

ilForumTopic::disableNotification ( int $a_user_id )

Definition at line 803 of file class.ilForumTopic.php.

                                                        : void
     {
         if ($this->id && $a_user_id) {
             $this->db->manipulateF(
                 'DELETE FROM frm_notification WHERE user_id = %s AND thread_id = %s',
                 ['integer', 'integer'],
                 [$a_user_id, $this->id]
             );
         }
     }

◆ enableNotification()

ilForumTopic::enableNotification ( int $a_user_id )

Definition at line 785 of file class.ilForumTopic.php.

References isNotificationEnabled().

Referenced by ilForum\generateThread().

                                                       : void
     {
         if ($this->id && $a_user_id && !$this->isNotificationEnabled($a_user_id)) {
             $nextId = $this->db->nextId('frm_notification');
             $this->db->manipulateF(
                 '
                 INSERT INTO frm_notification
                 (       notification_id,
                     user_id,
                     thread_id
                 )
                 VALUES(%s, %s, %s)',
                 ['integer', 'integer', 'integer'],
                 [$nextId, $a_user_id, $this->id]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPostIds()

ilForumTopic::getAllPostIds ( )

Returns: array<int, int>

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by movePosts().

                                    : array
     {
         $posts = [];
 
         if ($this->id) {
             $res = $this->db->queryF('SELECT pos_pk FROM frm_posts WHERE pos_thr_fk = %s', ['integer'], [$this->id]);
 
             while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                 $posts[(int) $row->pos_pk] = (int) $row->pos_pk;
             }
         }
 
         return $posts;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAverageRating()

ilForumTopic::getAverageRating ( )

Definition at line 871 of file class.ilForumTopic.php.

References $average_rating.

                                       : float
     {
         return $this->average_rating;
     }

◆ getChangeDate()

ilForumTopic::getChangeDate ( )

Definition at line 946 of file class.ilForumTopic.php.

References $changedate.

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

◆ getCreateDate()

ilForumTopic::getCreateDate ( )

Definition at line 936 of file class.ilForumTopic.php.

References $createdate.

Referenced by ilForum\generateThread().

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

Here is the caller graph for this function:

◆ getDisplayUserId()

ilForumTopic::getDisplayUserId ( )

Definition at line 906 of file class.ilForumTopic.php.

References $display_user_id.

Referenced by ilForum\generateThread().

                                       : int
     {
         return $this->display_user_id;
     }

Here is the caller graph for this function:

◆ getFirstVisiblePostId()

ilForumTopic::getFirstVisiblePostId ( )

Definition at line 239 of file class.ilForumTopic.php.

References $res.

                                            : int
     {
         $this->db->setLimit(1);
         $res = $this->db->queryF(
             'SELECT pos_fk FROM frm_posts_tree WHERE thr_fk = %s AND parent_pos != %s AND depth = %s ORDER BY rgt DESC',
             ['integer', 'integer', 'integer'],
             [$this->id, 0, 2]
         );
 
         if ($row = $this->db->fetchObject($res)) {
             return (int) $row->pos_fk ?: 0;
         }
         return 0;
     }

◆ getFirstVisiblePostNode()

ilForumTopic::getFirstVisiblePostNode	(	bool	$isModerator = `false`,
		bool	$preventImplicitRead = `false`
	)

Definition at line 335 of file class.ilForumTopic.php.

References $post, and $res.

Referenced by updateThreadTitle().

                                                                                                          : ilForumPost
     {
         $this->db->setLimit(1);
         $res = $this->db->queryF(
             '
                         SELECT *
                         FROM frm_posts 
                         INNER JOIN frm_posts_tree ON pos_fk = pos_pk
                         WHERE parent_pos != %s
                         AND thr_fk = %s
                         AND depth = %s
                         ORDER BY rgt DESC',
             ['integer', 'integer', 'integer'],
             [0, $this->id, 2]
         );
 
         if ($row = $this->db->fetchAssoc($res)) {
             $post = new ilForumPost((int) $row['pos_pk'], $isModerator, $preventImplicitRead);
             $post->assignData($row);
             return $post;
         }
 
         throw new OutOfBoundsException(sprintf('Could not find first posting by id: %s', $this->id));
     }

Here is the caller graph for this function:

◆ getForumId()

ilForumTopic::getForumId ( )

Definition at line 896 of file class.ilForumTopic.php.

References $forum_id.

Referenced by ilForumExportGUI\ensureThreadBelongsToForum(), ilObjForumGUI\ensureThreadBelongsToForum(), and ilForum\generateThread().

                                 : int
     {
         return $this->forum_id;
     }

Here is the caller graph for this function:

◆ getFrmObjId()

ilForumTopic::getFrmObjId ( )

Definition at line 1021 of file class.ilForumTopic.php.

References $frm_obj_id.

Referenced by getNestedSetPostChildren().

                                  : int
     {
         return $this->frm_obj_id;
     }

Here is the caller graph for this function:

◆ getId()

ilForumTopic::getId ( )

Definition at line 886 of file class.ilForumTopic.php.

References $id.

Referenced by ilForum\generateThread(), updateMergedThread(), and updateThreadTitle().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImportName()

ilForumTopic::getImportName ( )

Definition at line 956 of file class.ilForumTopic.php.

References $import_name.

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

◆ getLastActivePost()

ilForumTopic::getLastActivePost ( )

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

References $res, and ILIAS\Repository\user().

                                        : ilForumPost
     {
         if ($this->id) {
             $this->db->setLimit(1);
             $res = $this->db->queryF(
                 '
                                 SELECT pos_pk
                                 FROM frm_posts 
                                 WHERE pos_thr_fk = %s
                                 AND (pos_status = %s OR (pos_status = %s AND pos_display_user_id = %s))
                                 ORDER BY pos_date DESC',
                 ['integer', 'integer', 'integer', 'integer'],
                 [$this->id, '1', '0', $this->user->getId()]
             );
 
             if ($row = $this->db->fetchObject($res)) {
                 return new ilForumPost((int) $row->pos_pk);
             }
         }
 
         throw new OutOfBoundsException(sprintf('Could not find last active posting by id: %s', $this->id));
     }

Here is the call graph for this function:

◆ getLastPost()

ilForumTopic::getLastPost ( )

Definition at line 360 of file class.ilForumTopic.php.

References $res.

                                  : ilForumPost
     {
         if ($this->id) {
             $this->db->setLimit(1);
             $res = $this->db->queryF(
                 'SELECT pos_pk FROM frm_posts WHERE pos_thr_fk = %s ORDER BY pos_date DESC',
                 ['integer'],
                 [$this->id]
             );
 
             if ($row = $this->db->fetchObject($res)) {
                 return new ilForumPost((int) $row->pos_pk);
             }
         }
 
         throw new OutOfBoundsException(sprintf('Could not find last posting by id: %s', $this->id));
     }

◆ getLastPostForThreadOverview()

ilForumTopic::getLastPostForThreadOverview ( )

Definition at line 1179 of file class.ilForumTopic.php.

References $last_post.

                                                   : ?ilForumPost
     {
         return $this->last_post;
     }

◆ getLastPostString()

ilForumTopic::getLastPostString ( )

Definition at line 966 of file class.ilForumTopic.php.

References $last_post_string.

Referenced by updateMergedThread().

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

Here is the caller graph for this function:

◆ getNestedSetPostChildren()

ilForumTopic::getNestedSetPostChildren	(	?int	$pos_id = `null`,
		?int	$num_levels = `null`
	)

Definition at line 611 of file class.ilForumTopic.php.

References $data, $i, $query, $res, ANONYMOUS_USER_ID, getFrmObjId(), ilForumProperties\getInstance(), ILIAS\Repository\int(), ilForumAuthorInformationCache\preloadUserObjects(), and ILIAS\Repository\user().

                                                                                           : array
     {
         $data = null;
         $objProperties = ilForumProperties::getInstance($this->getFrmObjId());
         $is_post_activation_enabled = $objProperties->isPostActivationEnabled();
 
         if ($pos_id !== null) {
             $res = $this->db->queryF(
                 "
                                 SELECT          lft, rgt, depth
                                 FROM            frm_posts_tree
                                 WHERE           pos_fk = %s
                                 AND                     thr_fk = %s",
                 ['integer', 'integer'],
                 [$pos_id, $this->id]
             );
 
             $data = $this->db->fetchAssoc($res);
         }
 
         $query = '
                         SELECT                  fpt.depth,
                                                         fpt.rgt,
                                                         fpt.parent_pos,
                                                         fp.pos_pk,
                                                         fp.pos_subject,
                                                         fp.pos_usr_alias,
                                                         fp.pos_date,
                                                         fp.pos_update,
                                                         fp.pos_status,
                                                         fp.pos_display_user_id,
                                                         fp.pos_usr_alias,
                                                         fp.import_name,
                                                         fp.pos_author_id,
                                                         fp.is_author_moderator,
                                                         fur.post_id,
                                                         (CASE
                                                         WHEN fur.post_id IS NULL ' .
             ($this->user->getId() === ANONYMOUS_USER_ID ? ' AND 1 = 2 ' : '') . '
                                                         THEN 0
                                                         ELSE 1
                                                         END) post_read,
                                                         COUNT(fpt2.pos_fk) children
 
                         FROM                    frm_posts_tree fpt
 
                         INNER JOIN              frm_posts fp
                                 ON                      fp.pos_pk = fpt.pos_fk
                                 
                         LEFT JOIN               frm_posts_tree fpt2
                                  ON         fpt2.lft BETWEEN fpt.lft AND fpt.rgt
                                  AND            fpt.thr_fk = fpt2.thr_fk
                                  AND            fpt.pos_fk != fpt2.pos_fk ';
 
         $query .= '
                         LEFT JOIN               frm_user_read fur
                                 ON                      fur.thread_id = fp.pos_thr_fk
                                 AND                     fur.post_id = fp.pos_pk
                                 AND                     fur.usr_id = ' . $this->db->quote($this->user->getId(), 'integer') . '
 
                         LEFT JOIN               usr_data ud
                                 ON                      ud.usr_id = fp.pos_display_user_id
                 
                         WHERE                   fpt.thr_fk = ' . $this->db->quote($this->id, 'integer');
 
         if ($data) {
             $query .= '         AND fpt.lft > ' . $this->db->quote($data['lft'], 'integer') .
                 '               AND fpt.lft < ' . $this->db->quote($data['rgt'], 'integer') . ' ';
         }
         if ($is_post_activation_enabled && !$this->is_moderator) {
             $query .= ' AND (fp.pos_status = 1 OR fp.pos_status = 0 AND fp.pos_display_user_id = ' . $this->db->quote(
                 $this->user->getId(),
                 'integer'
             ) . ') ';
         }
 
         if ($data && is_numeric($num_levels)) {
             $query .= ' AND fpt.depth <= ' . $this->db->quote((int) $data['depth'] + $num_levels, 'integer') . ' ';
         }
 
         $query .= ' GROUP BY fpt.depth,
                                                         fpt.rgt,
                                                         fpt.parent_pos,
                                                         fp.pos_pk,
                                                         fp.pos_subject,
                                                         fp.pos_usr_alias,
                                                         fp.pos_date,
                                                         fp.pos_update,
                                                         fp.pos_status,
                                                         fp.pos_display_user_id,
                                                         fp.pos_usr_alias,
                                                         fp.import_name,
                                                         fp.pos_author_id,
                                                         fp.is_author_moderator,
                                                         fur.post_id
                                         ORDER BY fpt.rgt DESC
                 ';
 
         $queryCounter = '
                         SELECT                  pos_fk
                         FROM                    frm_posts_tree fpt
                         INNER JOIN              frm_posts fp
                                 ON                      fp.pos_pk = fpt.pos_fk
                         WHERE                   fpt.thr_fk = ' . $this->db->quote($this->id, 'integer');
 
         if ($is_post_activation_enabled && !$this->is_moderator) {
             $queryCounter .= ' AND (fp.pos_status = 1 OR fp.pos_status = 0 AND fp.pos_display_user_id = ' . $this->db->quote(
                 $this->user->getId(),
                 'integer'
             ) . ') ';
         }
         $queryCounter .= ' ORDER BY fpt.rgt DESC';
 
         $resCounter = $this->db->query($queryCounter);
         $counter = [];
         $i = 0;
         while ($row = $this->db->fetchAssoc($resCounter)) {
             $counter[(int) $row['pos_fk']] = $i++;
         }
 
         $res = $this->db->query($query);
         $children = [];
         $usr_ids = [];
         while ($row = $this->db->fetchAssoc($res)) {
             if ((int) $row['pos_display_user_id']) {
                 $usr_ids[] = (int) $row['pos_display_user_id'];
             }
 
             $row['counter'] = $counter[$row['pos_pk']];
             $casted_row = [];
             $casted_row['depth'] = (int) $row['depth'];
             $casted_row['rgt'] = (int) $row['rgt'];
             $casted_row['parent_pos'] = (int) $row['parent_pos'];
             $casted_row['pos_pk'] = (int) $row['pos_pk'];
             $casted_row['pos_subject'] = (string) $row['pos_subject'];
             $casted_row['pos_usr_alias'] = (string) $row['pos_usr_alias'];
             $casted_row['pos_date'] = (string) $row['pos_date'];
             $casted_row['pos_update'] = (string) $row['pos_update'];
             $casted_row['pos_status'] = (int) $row['pos_status'];
             $casted_row['pos_display_user_id'] = (int) $row['pos_display_user_id'];
             $casted_row['import_name'] = (string) $row['import_name'];
             $casted_row['pos_author_id'] = (int) $row['pos_author_id'];
             $casted_row['is_author_moderator'] = (int) $row['is_author_moderator'];
             $casted_row['post_id'] = (int) $row['post_id'];
             $casted_row['post_read'] = (int) $row['post_read'];
             $casted_row['children'] = (int) $row['children'];
 
             $children[] = $casted_row;
         }
 
         ilForumAuthorInformationCache::preloadUserObjects(array_unique($usr_ids));
 
         return $children;
     }

Here is the call graph for this function:

◆ getNumNewPosts()

ilForumTopic::getNumNewPosts ( )

Definition at line 1087 of file class.ilForumTopic.php.

References $num_new_posts.

                                     : int
     {
         return $this->num_new_posts;
     }

◆ getNumPosts()

ilForumTopic::getNumPosts ( )

Definition at line 1076 of file class.ilForumTopic.php.

References $num_posts.

Referenced by updateMergedThread().

                                  : int
     {
         return $this->num_posts;
     }

Here is the caller graph for this function:

◆ getNumUnreadPosts()

ilForumTopic::getNumUnreadPosts ( )

Definition at line 1098 of file class.ilForumTopic.php.

References $num_unread_posts.

                                        : int
     {
         return $this->num_unread_posts;
     }

◆ getOrderDirection()

ilForumTopic::getOrderDirection ( )

Definition at line 1124 of file class.ilForumTopic.php.

References $orderDirection.

Referenced by getPostTree().

                                        : string
     {
         return $this->orderDirection;
     }

Here is the caller graph for this function:

◆ getOrderField()

ilForumTopic::getOrderField ( )

Definition at line 1016 of file class.ilForumTopic.php.

References $orderField.

                                    : string
     {
         return $this->orderField;
     }

◆ getOrderSequenceIndex()

ilForumTopic::getOrderSequenceIndex ( )

Definition at line 991 of file class.ilForumTopic.php.

References $order_sequence_index.

                                            : ?int
     {
         return $this->order_sequence_index;
     }

◆ getPostRootId()

ilForumTopic::getPostRootId ( )

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

References $res.

                                    : int
     {
         $this->db->setLimit(1);
         $res = $this->db->queryF(
             'SELECT pos_fk FROM frm_posts_tree WHERE thr_fk = %s AND parent_pos = %s AND depth = %s ORDER BY rgt DESC',
             ['integer', 'integer', 'integer'],
             [$this->id, 0, 1]
         );
 
         if ($row = $this->db->fetchObject($res)) {
             return (int) $row->pos_fk ?: 0;
         }
         return 0;
     }

◆ getPostRootNode()

ilForumTopic::getPostRootNode	(	bool	$isModerator = `false`,
		bool	$preventImplicitRead = `false`
	)

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

References $post, and $res.

Referenced by ilObjForumGUI\toggleExplorerNodeStateObject().

                                                                                                  : ilForumPost
     {
         $this->db->setLimit(1);
         $res = $this->db->queryF(
             '
                         SELECT *
                         FROM frm_posts 
                         INNER JOIN frm_posts_tree ON pos_fk = pos_pk
                         WHERE parent_pos = %s
                         AND thr_fk = %s
                         ORDER BY rgt DESC',
             ['integer', 'integer'],
             [0, $this->id]
         );
 
         if ($row = $this->db->fetchAssoc($res)) {
             $post = new ilForumPost((int) $row['pos_pk'], $isModerator, $preventImplicitRead);
             $post->assignData($row);
             return $post;
         }
 
         throw new OutOfBoundsException(sprintf('Could not find first posting by id: %s', $this->id));
     }

Here is the caller graph for this function:

◆ getPostTree()

ilForumTopic::getPostTree ( ilForumPost $a_post_node )

Fetches and returns an array of posts from the post tree, starting with the node object passed by the first paramter.

Parameters

ilForumPost $a_post_node node-object of a post

Returns: ilForumPost[] Array of post objects

Definition at line 425 of file class.ilForumTopic.php.

References $data, $post, $query, $res, ANONYMOUS_USER_ID, ilForumPost\getLft(), getOrderDirection(), ilForumPost\getRgt(), ilForumPost\getThreadId(), ILIAS\Repository\int(), ilForumAuthorInformationCache\preloadUserObjects(), and ILIAS\Repository\user().

                                                          : array
     {
         $posts = [];
         $data = [];
         $data_types = [];
 
         if ($a_post_node->getLft() > 1) {
             $dummy_root_condition = 'lft >= %s AND lft < %s';
         } else {
             $dummy_root_condition = 'lft > %s AND lft < %s';
         }
 
         $query = '
                         SELECT                  is_author_moderator, pos_author_id, pos_pk, fpt_date, rgt, pos_top_fk, pos_thr_fk, 
                                                         pos_display_user_id, pos_usr_alias, pos_subject,
                                                         pos_status, pos_message, pos_date, pos_update,
                                                         update_user, pos_cens, pos_cens_com, notify,
                                                         import_name, fpt_pk, parent_pos, lft, depth,
                                                         (CASE
                                                         WHEN fur.post_id IS NULL ' .
             ($this->user->getId() === ANONYMOUS_USER_ID ? ' AND 1 = 2 ' : '') . '
                                                         THEN 0
                                                         ELSE 1
                                                         END) post_read,
                                                         firstname, lastname, title, login
                                                          
                         FROM                    frm_posts_tree
                          
                         INNER JOIN              frm_posts 
                                 ON                      pos_fk = pos_pk
                                 
                         LEFT JOIN               usr_data
                                 ON                      pos_display_user_id  = usr_id
                                 
                         LEFT JOIN               frm_user_read fur
                                 ON                      fur.thread_id = pos_thr_fk
                                 AND                     fur.post_id = pos_pk
                                 AND                     fur.usr_id = %s
                                  
                         WHERE                   ' . $dummy_root_condition . '
                                 AND             thr_fk = %s';
 
         array_push($data_types, 'integer', 'integer', 'integer', 'integer');
         array_push(
             $data,
             $this->user->getId(),
             $a_post_node->getLft(),
             $a_post_node->getRgt(),
             $a_post_node->getThreadId()
         );
 
         if ($this->orderField !== '') {
             $query .= " ORDER BY " . $this->orderField . " " . $this->getOrderDirection();
         }
 
         $res = $this->db->queryF($query, $data_types, $data);
 
         $usr_ids = [];
         while ($row = $this->db->fetchAssoc($res)) {
             $post = new ilForumPost((int) $row['pos_pk'], false, true);
             $post->assignData($row);
 
             if (!$this->is_moderator && !$post->isActivated() && $post->getPosAuthorId() !== $this->user->getId()) {
                 continue;
             }
 
             if ((int) $row['pos_display_user_id']) {
                 $usr_ids[(int) $row['pos_display_user_id']] = (int) $row['pos_display_user_id'];
             }
             if ((int) $row['update_user']) {
                 $usr_ids[(int) $row['update_user']] = (int) $row['update_user'];
             }
 
             $posts[] = $post;
         }
 
         ilForumAuthorInformationCache::preloadUserObjects(array_values($usr_ids));
 
         return $posts;
     }

Here is the call graph for this function:

◆ getSubject()

ilForumTopic::getSubject ( )

Definition at line 926 of file class.ilForumTopic.php.

References $subject.

Referenced by ilForum\generateThread(), updateMergedThread(), and updateThreadTitle().

                                 : string
     {
         return $this->subject;
     }

Here is the caller graph for this function:

◆ getThrAuthorId()

ilForumTopic::getThrAuthorId ( )

Definition at line 1031 of file class.ilForumTopic.php.

References $thr_author_id.

Referenced by ilForum\generateThread().

                                     : int
     {
         return $this->thr_author_id;
     }

Here is the caller graph for this function:

◆ getUserAlias()

ilForumTopic::getUserAlias ( )

Definition at line 916 of file class.ilForumTopic.php.

References $user_alias.

Referenced by ilForum\generateThread().

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

Here is the caller graph for this function:

◆ getVisits()

ilForumTopic::getVisits ( )

Definition at line 976 of file class.ilForumTopic.php.

References $visits.

Referenced by updateMergedThread().

                                : int
     {
         return $this->visits;
     }

Here is the caller graph for this function:

◆ insert()

ilForumTopic::insert ( )

Definition at line 112 of file class.ilForumTopic.php.

Referenced by ilForum\generateThread().

                             : bool
     {
         if ($this->forum_id) {
             $nextId = $this->db->nextId('frm_threads');
 
             $this->db->insert(
                 'frm_threads',
                 [
                     'thr_pk' => ['integer', $nextId],
                     'thr_top_fk' => ['integer', $this->forum_id],
                     'thr_subject' => ['text', $this->subject],
                     'thr_display_user_id' => ['integer', $this->display_user_id],
                     'thr_usr_alias' => ['text', $this->user_alias],
                     'thr_num_posts' => ['integer', $this->num_posts],
                     'thr_last_post' => ['text', $this->last_post_string],
                     'thr_date' => ['timestamp', $this->createdate],
                     'thr_update' => ['timestamp', null],
                     'thread_sorting' => ['integer', (int) $this->order_sequence_index],
                     'import_name' => ['text', $this->import_name],
                     'is_sticky' => ['integer', (int) $this->is_sticky],
                     'is_closed' => ['integer', (int) $this->is_closed],
                     'avg_rating' => ['text', (string) $this->average_rating],
                     'thr_author_id' => ['integer', $this->thr_author_id]
                 ]
             );
 
             $this->id = $nextId;
 
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isClosed()

ilForumTopic::isClosed ( )

Definition at line 1006 of file class.ilForumTopic.php.

References $is_closed.

                               : bool
     {
         return $this->is_closed;
     }

◆ isNotificationEnabled()

ilForumTopic::isNotificationEnabled ( int $a_user_id )

Definition at line 766 of file class.ilForumTopic.php.

Referenced by enableNotification().

                                                          : bool
     {
         if ($this->id && $a_user_id) {
             $result = $this->db->queryF(
                 'SELECT COUNT(notification_id) cnt FROM frm_notification WHERE user_id = %s AND thread_id = %s',
                 ['integer', 'integer'],
                 [$a_user_id, $this->id]
             );
 
             if ($row = $this->db->fetchAssoc($result)) {
                 return (int) $row['cnt'] > 0;
             }
 
             return false;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isSticky()

ilForumTopic::isSticky ( )

Definition at line 986 of file class.ilForumTopic.php.

References $is_sticky.

                               : bool
     {
         return $this->is_sticky;
     }

◆ isUserNotificationEnabled()

ilForumTopic::isUserNotificationEnabled ( )

Definition at line 1109 of file class.ilForumTopic.php.

References $user_notification_enabled.

                                                : bool
     {
         return $this->user_notification_enabled;
     }

◆ lookupCreationDate()

static ilForumTopic::lookupCreationDate ( int $thread_id )

static

Definition at line 1159 of file class.ilForumTopic.php.

References $DIC, $ilDB, and $res.

Referenced by ilObjForumGUI\confirmMergeThreadsObject().

                                                              : ?string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT thr_date FROM frm_threads WHERE thr_pk = %s',
             ['integer'],
             [$thread_id]
         );
 
         $date = null;
         $row = $ilDB->fetchAssoc($res);
         if (is_array($row)) {
             $date = $row['thr_date'];
         }
 
         return $date;
     }

Here is the caller graph for this function:

◆ lookupForumIdByTopicId()

static ilForumTopic::lookupForumIdByTopicId ( int $a_topic_id )

static

Definition at line 1129 of file class.ilForumTopic.php.

References $DIC, $ilDB, and $res.

Referenced by ilObjForumGUI\confirmMergeThreadsObject().

                                                                   : int
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT thr_top_fk FROM frm_threads WHERE thr_pk = %s',
             ['integer'],
             [$a_topic_id]
         );
 
         $row = $ilDB->fetchAssoc($res);
 
         return (int) $row['thr_top_fk'];
     }

Here is the caller graph for this function:

◆ lookupTitle()

static ilForumTopic::lookupTitle ( int $a_topic_id )

static

Definition at line 1036 of file class.ilForumTopic.php.

References $DIC, $ilDB, and $res.

Referenced by ilObjForumGUI\confirmMergeThreadsObject().

                                                        : string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $res = $ilDB->queryF(
             'SELECT thr_subject FROM frm_threads WHERE thr_pk = %s',
             ['integer'],
             [$a_topic_id]
         );
 
         if ($row = $ilDB->fetchObject($res)) {
             return (string) $row->thr_subject;
         }
 
         return '';
     }

Here is the caller graph for this function:

◆ makeSticky()

ilForumTopic::makeSticky ( )

Definition at line 814 of file class.ilForumTopic.php.

                                 : bool
     {
         if ($this->id && !$this->is_sticky) {
             $this->db->manipulateF(
                 'UPDATE frm_threads SET is_sticky = %s WHERE thr_pk = %s',
                 ['integer', 'integer'],
                 [1, $this->id]
             );
 
             $this->is_sticky = true;
             return true;
         }
 
         return false;
     }

◆ movePosts()

ilForumTopic::movePosts	(	int	$old_obj_id,
		int	$old_pk,
		int	$new_obj_id,
		int	$new_pk
	)

Moves all posts within the current thread to a new forum.

Parameters

int	$old_obj_id	object id of the current forum
int	$old_pk	primary key of old forum
int	$new_obj_id	object id of the new forum
int	$new_pk	primary key of new forum

Returns: int Number of afffected rows by updating posts

Exceptions

ilFileUtilsException

Definition at line 515 of file class.ilForumTopic.php.

References $id, $ilDB, $post, $res, ilForum\_lookupObjIdForForumId(), getAllPostIds(), ilNewsItem\getFirstNewsIdForContext(), and ilDBInterface\manipulateF().

                                                                                          : int
     {
         if (!$this->id) {
             return 0;
         }
 
         $post_ids = $this->getAllPostIds();
         $postsMoved = [];
         try {
             foreach ($post_ids as $post_id) {
                 $file_obj = new ilFileDataForum($old_obj_id, $post_id);
                 $moved = $file_obj->moveFilesOfPost($new_obj_id);
 
                 if (true === $moved) {
                     $postsMoved[] = [
                         'from' => $old_obj_id,
                         'to' => $new_obj_id,
                         'position_id' => $post_id
                     ];
                 }
 
                 unset($file_obj);
             }
         } catch (ilFileUtilsException $exception) {
             foreach ($postsMoved as $postedInformation) {
                 $file_obj = new ilFileDataForum($postedInformation['to'], $postedInformation['position_id']);
                 $file_obj->moveFilesOfPost($postedInformation['from']);
             }
 
             throw $exception;
         }
 
         $current_id = $this->id;
 
         $ilAtomQuery = $this->db->buildAtomQuery();
         $ilAtomQuery->addTableLock('frm_user_read');
         $ilAtomQuery->addTableLock('frm_thread_access');
 
         $ilAtomQuery->addQueryCallable(static function (ilDBInterface $ilDB) use ($new_obj_id, $current_id): void {
             $ilDB->manipulateF(
                 'DELETE FROM frm_user_read WHERE obj_id = %s AND thread_id =%s',
                 ['integer', 'integer'],
                 [$new_obj_id, $current_id]
             );
 
             $ilDB->manipulateF(
                 'UPDATE frm_user_read SET obj_id = %s WHERE thread_id = %s',
                 ['integer', 'integer'],
                 [$new_obj_id, $current_id]
             );
 
             $ilDB->manipulateF(
                 'DELETE FROM frm_thread_access WHERE obj_id = %s AND thread_id = %s',
                 ['integer', 'integer'],
                 [$new_obj_id, $current_id]
             );
 
             $ilDB->manipulateF(
                 'UPDATE frm_thread_access SET obj_id = %s WHERE thread_id =%s',
                 ['integer', 'integer'],
                 [$new_obj_id, $current_id]
             );
         });
 
         $ilAtomQuery->run();
 
         $this->db->manipulateF(
             'UPDATE frm_posts SET pos_top_fk = %s WHERE pos_thr_fk = %s',
             ['integer', 'integer'],
             [$new_pk, $this->id]
         );
 
         $res = $this->db->queryF(
             'SELECT * FROM frm_posts WHERE pos_thr_fk = %s',
             ['integer'],
             [$this->id]
         );
 
         $old_obj_id = ilForum::_lookupObjIdForForumId($old_pk);
         $new_obj_id = ilForum::_lookupObjIdForForumId($new_pk);
 
         while ($post = $this->db->fetchAssoc($res)) {
             $news_id = ilNewsItem::getFirstNewsIdForContext(
                 $old_obj_id,
                 'frm',
                 (int) $post['pos_pk'],
                 'pos'
             );
             $news_item = new ilNewsItem($news_id);
             $news_item->setContextObjId($new_obj_id);
             $news_item->update();
         }
 
         return count($post_ids);
     }

Here is the call graph for this function:

◆ read()

ilForumTopic::read ( )

private

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by __construct(), and reload().

                            : bool
     {
         if ($this->id) {
             $res = $this->db->queryF(
                 '
                                 SELECT frm_threads.*, top_frm_fk frm_obj_id
                                 FROM frm_threads
                                 INNER JOIN frm_data ON top_pk = thr_top_fk
                                 WHERE thr_pk = %s',
                 ['integer'],
                 [$this->id]
             );
 
             $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
             if (is_object($row)) {
                 $this->forum_id = (int) $row->thr_top_fk;
                 $this->display_user_id = (int) $row->thr_display_user_id;
                 $this->user_alias = $row->thr_usr_alias;
                 $this->subject = html_entity_decode((string) $row->thr_subject);
                 $this->createdate = $row->thr_date;
                 $this->changedate = $row->thr_update;
                 $this->import_name = $row->import_name;
                 $this->num_posts = (int) $row->thr_num_posts;
                 $this->last_post_string = $row->thr_last_post;
                 $this->visits = (int) $row->visits;
                 $this->is_sticky = (bool) $row->is_sticky;
                 $this->is_closed = (bool) $row->is_closed;
                 $this->frm_obj_id = (int) $row->frm_obj_id;
                 $this->average_rating = (float) $row->avg_rating;
                 $this->thr_author_id = (int) $row->thr_author_id;
                 $this->order_sequence_index = (int) $row->thread_sorting;
 
                 return true;
             }
             $this->id = 0;
             return false;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reload()

ilForumTopic::reload ( )

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

References read().

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

Here is the call graph for this function:

◆ reopen()

ilForumTopic::reopen ( )

Definition at line 858 of file class.ilForumTopic.php.

                             : void
     {
         if ($this->id && $this->is_closed) {
             $this->db->manipulateF(
                 'UPDATE frm_threads SET is_closed = %s WHERE thr_pk = %s',
                 ['integer', 'integer'],
                 [0, $this->id]
             );
 
             $this->is_closed = false;
         }
     }

◆ setAverageRating()

ilForumTopic::setAverageRating ( float $average_rating )

Definition at line 876 of file class.ilForumTopic.php.

References $average_rating.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setChangeDate()

ilForumTopic::setChangeDate ( ?string $a_changedate )

Definition at line 941 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setClosed()

ilForumTopic::setClosed ( bool $a_closed )

Definition at line 1001 of file class.ilForumTopic.php.

Referenced by assignData().

                                              : void
     {
         $this->is_closed = $a_closed;
     }

Here is the caller graph for this function:

◆ setCreateDate()

ilForumTopic::setCreateDate ( ?string $a_createdate )

Definition at line 931 of file class.ilForumTopic.php.

Referenced by assignData(), and ilForum\generateThread().

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

Here is the caller graph for this function:

◆ setDisplayUserId()

ilForumTopic::setDisplayUserId ( int $a_user_id )

Definition at line 901 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setForumId()

ilForumTopic::setForumId ( int $a_forum_id )

Definition at line 891 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setId()

ilForumTopic::setId ( int $a_id )

Definition at line 881 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setImportName()

ilForumTopic::setImportName ( ?string $a_import_name )

Definition at line 951 of file class.ilForumTopic.php.

Referenced by assignData(), and ilForum\generateThread().

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

Here is the caller graph for this function:

◆ setLastPostForThreadOverview()

ilForumTopic::setLastPostForThreadOverview ( ilForumPost $post )

Definition at line 1184 of file class.ilForumTopic.php.

References $post.

                                                                    : void
     {
         $this->last_post = $post;
     }

◆ setLastPostString()

ilForumTopic::setLastPostString ( ?string $a_last_post )

Definition at line 961 of file class.ilForumTopic.php.

Referenced by assignData().

                                                            : void
     {
         $this->last_post_string = $a_last_post;
     }

Here is the caller graph for this function:

◆ setNumNewPosts()

ilForumTopic::setNumNewPosts ( int $num_new_posts )

Definition at line 1081 of file class.ilForumTopic.php.

References $num_new_posts.

Referenced by assignData().

                                                       : ilForumTopic
     {
         $this->num_new_posts = $num_new_posts;
         return $this;
     }

Here is the caller graph for this function:

◆ setNumPosts()

ilForumTopic::setNumPosts ( int $a_num_posts )

Definition at line 1070 of file class.ilForumTopic.php.

Referenced by assignData().

                                                  : ilForumTopic
     {
         $this->num_posts = $a_num_posts;
         return $this;
     }

Here is the caller graph for this function:

◆ setNumUnreadPosts()

ilForumTopic::setNumUnreadPosts ( int $num_unread_posts )

Definition at line 1092 of file class.ilForumTopic.php.

References $num_unread_posts.

Referenced by assignData().

                                                             : ilForumTopic
     {
         $this->num_unread_posts = $num_unread_posts;
         return $this;
     }

Here is the caller graph for this function:

◆ setOrderDirection()

ilForumTopic::setOrderDirection ( string $direction )

Definition at line 1114 of file class.ilForumTopic.php.

                                                         : ilForumTopic
     {
         if (!in_array(strtoupper($direction), self::$possibleOrderDirections, true)) {
             $direction = current(self::$possibleOrderDirections);
         }
 
         $this->orderDirection = $direction;
         return $this;
     }

◆ setOrderField()

ilForumTopic::setOrderField ( string $a_order_field )

Definition at line 1011 of file class.ilForumTopic.php.

                                                         : void
     {
         $this->orderField = $a_order_field;
     }

◆ setOrderSequenceIndex()

ilForumTopic::setOrderSequenceIndex ( ?int $order_sequence_index )

Definition at line 996 of file class.ilForumTopic.php.

References $order_sequence_index.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setSticky()

ilForumTopic::setSticky ( bool $a_sticky )

Definition at line 981 of file class.ilForumTopic.php.

Referenced by assignData().

                                              : void
     {
         $this->is_sticky = $a_sticky;
     }

Here is the caller graph for this function:

◆ setSubject()

ilForumTopic::setSubject ( string $a_subject )

Definition at line 921 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setThrAuthorId()

ilForumTopic::setThrAuthorId ( int $thr_author_id )

Definition at line 1026 of file class.ilForumTopic.php.

References $thr_author_id.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setUserAlias()

ilForumTopic::setUserAlias ( ?string $a_user_alias )

Definition at line 911 of file class.ilForumTopic.php.

Referenced by assignData().

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

Here is the caller graph for this function:

◆ setUserNotificationEnabled()

ilForumTopic::setUserNotificationEnabled ( bool $status )

Definition at line 1103 of file class.ilForumTopic.php.

Referenced by assignData().

                                                             : ilForumTopic
     {
         $this->user_notification_enabled = $status;
         return $this;
     }

Here is the caller graph for this function:

◆ setVisits()

ilForumTopic::setVisits ( int $a_visits )

Definition at line 971 of file class.ilForumTopic.php.

Referenced by assignData().

                                             : void
     {
         $this->visits = $a_visits;
     }

Here is the caller graph for this function:

◆ unmakeSticky()

ilForumTopic::unmakeSticky ( )

Definition at line 830 of file class.ilForumTopic.php.

                                   : bool
     {
         if ($this->id && $this->is_sticky) {
             $this->db->manipulateF(
                 'UPDATE frm_threads SET is_sticky = %s WHERE thr_pk = %s',
                 ['integer', 'integer'],
                 [0, $this->id]
             );
 
             $this->is_sticky = false;
             return true;
         }
 
         return false;
     }

◆ update()

ilForumTopic::update ( )

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

                             : bool
     {
         if ($this->id) {
             $this->db->manipulateF(
                 '
                                 UPDATE frm_threads
                                 SET thr_top_fk = %s,
                                         thr_subject = %s,
                                         thr_update = %s,
                                         thr_num_posts = %s,
                                         thr_last_post = %s,
                                         avg_rating = %s
                                 WHERE thr_pk = %s',
                 ['integer', 'text', 'timestamp', 'integer', 'text', 'text', 'integer'],
                 [
                     $this->forum_id,
                     $this->subject,
                     date('Y-m-d H:i:s'),
                     $this->num_posts,
                     $this->last_post_string,
                     (string) $this->average_rating,
                     $this->id
                 ]
             );
 
             return true;
         }
 
         return false;
     }

◆ updateMergedThread()

ilForumTopic::updateMergedThread ( )

Definition at line 1145 of file class.ilForumTopic.php.

References getId(), getLastPostString(), getNumPosts(), getSubject(), and getVisits().

                                         : void
     {
         $this->db->update(
             'frm_threads',
             [
                 'thr_num_posts' => ['integer', $this->getNumPosts()],
                 'visits' => ['integer', $this->getVisits()],
                 'thr_last_post' => ['text', $this->getLastPostString()],
                 'thr_subject' => ['text', $this->getSubject()]
             ],
             ['thr_pk' => ['integer', $this->getId()]]
         );
     }

Here is the call graph for this function:

◆ updateThreadTitle()

ilForumTopic::updateThreadTitle ( )

Definition at line 1054 of file class.ilForumTopic.php.

References Vendor\Package\$e, getFirstVisiblePostNode(), getId(), and getSubject().

                                        : void
     {
         $this->db->update(
             'frm_threads',
             ['thr_subject' => ['text', $this->getSubject()]],
             ['thr_pk' => ['integer', $this->getId()]]
         );
 
         try {
             $first_node = $this->getFirstVisiblePostNode();
             $first_node->setSubject($this->getSubject());
             $first_node->update();
         } catch (OutOfBoundsException $e) {
         }
     }

Here is the call graph for this function:

◆ updateVisits()

ilForumTopic::updateVisits ( )

Definition at line 254 of file class.ilForumTopic.php.

References ilSession\get(), and ilSession\set().

                                   : void
     {
         $checkTime = time() - (60 * 60);
 
         if (ilSession::get('frm_visit_frm_threads_' . $this->id) < $checkTime) {
             ilSession::set('frm_visit_frm_threads_' . $this->id, time());
 
             $this->db->manipulateF(
                 'UPDATE frm_threads SET visits = visits + 1 WHERE thr_pk = %s',
                 ['integer'],
                 [$this->id]
             );
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $average_rating

float ilForumTopic::$average_rating = 0.0

private

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

Referenced by getAverageRating(), and setAverageRating().

◆ $changedate

string ilForumTopic::$changedate = null

private

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

Referenced by getChangeDate().

◆ $createdate

string ilForumTopic::$createdate = null

private

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

Referenced by getCreateDate().

◆ $db

ilDBInterface ilForumTopic::$db

private

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

◆ $display_user_id

int ilForumTopic::$display_user_id = 0

private

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

Referenced by getDisplayUserId().

◆ $forum_id

int ilForumTopic::$forum_id = 0

private

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

Referenced by getForumId().

◆ $frm_obj_id

int ilForumTopic::$frm_obj_id = 0

private

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

Referenced by getFrmObjId().

◆ $id

int ilForumTopic::$id

private

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

Referenced by countActivePosts(), getId(), and movePosts().

◆ $import_name

string ilForumTopic::$import_name = null

private

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

Referenced by getImportName().

◆ $is_closed

bool ilForumTopic::$is_closed = false

private

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

Referenced by isClosed().

◆ $is_moderator

bool ilForumTopic::$is_moderator

private

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

◆ $is_sticky

bool ilForumTopic::$is_sticky = false

private

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

Referenced by isSticky().

◆ $last_post

ilForumPost ilForumTopic::$last_post = null

private

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

Referenced by getLastPostForThreadOverview().

◆ $last_post_string

string ilForumTopic::$last_post_string = null

private

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

Referenced by getLastPostString().

◆ $num_new_posts

int ilForumTopic::$num_new_posts = 0

private

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

Referenced by getNumNewPosts(), and setNumNewPosts().

◆ $num_posts

int ilForumTopic::$num_posts = 0

private

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

Referenced by getNumPosts().

◆ $num_unread_posts

int ilForumTopic::$num_unread_posts = 0

private

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

Referenced by getNumUnreadPosts(), and setNumUnreadPosts().

◆ $order_sequence_index

int ilForumTopic::$order_sequence_index = null

private

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

Referenced by getOrderSequenceIndex(), and setOrderSequenceIndex().

◆ $orderDirection

string ilForumTopic::$orderDirection = 'DESC'

private

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

Referenced by getOrderDirection().

◆ $orderField

string ilForumTopic::$orderField = ''

private

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

Referenced by getOrderField().

◆ $possibleOrderDirections

array ilForumTopic::$possibleOrderDirections = ['ASC', 'DESC']

staticprotected

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

◆ $subject

string ilForumTopic::$subject = ''

private

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

Referenced by getSubject().

◆ $thr_author_id

int ilForumTopic::$thr_author_id = 0

private

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

Referenced by getThrAuthorId(), and setThrAuthorId().

◆ $user

ilObjUser ilForumTopic::$user

private

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

◆ $user_alias

string ilForumTopic::$user_alias = null

private

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

Referenced by getUserAlias().

◆ $user_notification_enabled

bool ilForumTopic::$user_notification_enabled = false

private

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

Referenced by isUserNotificationEnabled().

◆ $visits

int ilForumTopic::$visits = 0

private

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

Referenced by getVisits().

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

Modules/Forum/classes/class.ilForumTopic.php

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignData()

◆ close()

◆ countActivePosts()

◆ countPosts()

◆ disableNotification()

◆ enableNotification()

◆ getAllPostIds()

◆ getAverageRating()

◆ getChangeDate()

◆ getCreateDate()

◆ getDisplayUserId()

◆ getFirstVisiblePostId()

◆ getFirstVisiblePostNode()

◆ getForumId()

◆ getFrmObjId()

◆ getId()

◆ getImportName()

◆ getLastActivePost()

◆ getLastPost()

◆ getLastPostForThreadOverview()

◆ getLastPostString()

◆ getNestedSetPostChildren()

◆ getNumNewPosts()

◆ getNumPosts()

◆ getNumUnreadPosts()

◆ getOrderDirection()

◆ getOrderField()

◆ getOrderSequenceIndex()

◆ getPostRootId()

◆ getPostRootNode()

◆ getPostTree()

◆ getSubject()

◆ getThrAuthorId()

◆ getUserAlias()

◆ getVisits()

◆ insert()

◆ isClosed()

◆ isNotificationEnabled()

◆ isSticky()

◆ isUserNotificationEnabled()

◆ lookupCreationDate()

◆ lookupForumIdByTopicId()

◆ lookupTitle()

◆ makeSticky()

◆ movePosts()

◆ read()

◆ reload()

◆ reopen()

◆ setAverageRating()

◆ setChangeDate()

◆ setClosed()

◆ setCreateDate()

◆ setDisplayUserId()

◆ setForumId()

◆ setId()

◆ setImportName()

◆ setLastPostForThreadOverview()

◆ setLastPostString()

◆ setNumNewPosts()

◆ setNumPosts()

◆ setNumUnreadPosts()

◆ setOrderDirection()

◆ setOrderField()

◆ setOrderSequenceIndex()

◆ setSticky()

◆ setSubject()

◆ setThrAuthorId()

◆ setUserAlias()

◆ setUserNotificationEnabled()

◆ setVisits()

◆ unmakeSticky()