ilForum Class Reference

Class Forum core functions for forum. More...

Collaboration diagram for ilForum:

Public Member Functions
	__construct ()
	setForumId (int $a_obj_id)
	setForumRefId (int $a_ref_id)
	getForumId ()
	getForumRefId ()
	setDbTable (string $dbTable)
	getDbTable ()
	setMDB2WhereCondition (string $query_string, array $data_type, array $data_value)
	getMDB2Query ()
	getMDB2DataValue ()
	getMDB2DataType ()
	setPageHits (int $pageHits)
	getPageHits ()
	getOneTopic ()
	getOneThread ()
	generateThread (ilForumTopic $thread, string $message, bool $notify, bool $notify_posts, bool $status=true, bool $withFirstVisibleEntry=true)
	moveThreads (array $thread_ids, ilObjForum $src_forum, int $target_obj_id)
	postCensorship (ilObjForum $forum, string $message, int $pos_pk, int $cens=0)
	deletePost ($postIdOrRecord, bool $raiseEvents=true)
	getAllThreads (int $a_topic_id, array $params=[], int $limit=0, int $offset=0)
	getNumberOfPublishedUserPostings (int $usr_id, bool $post_activation_required)
	getUserStatistics (bool $post_activation_required)
	getRootPostIdByThread (int $a_thread_id)
	getModerators ()
	countUserArticles (int $a_user_id)
	countActiveUserArticles (int $a_user_id)
	convertDate (string $date)
	addPostTree (int $a_tree_id, int $a_node_id=-1, string $a_date='')
	insertPostNode (int $a_node_id, int $a_parent_id, int $tree_id, string $a_date='')
	insert node under parent node More...
	getPostDepth (int $a_node_id, int $tree_id)
	getFirstPostNode (int $tree_id)
	getPostNode (int $post_id)
	fetchPostNodeData (stdClass $a_row)
	getSubPathIdsForNode (ilForumPost $post)
	deletePostTree (array $a_node)
	updateVisits (int $ID)
	prepareText (string $text, int $edit=0, string $quote_user='', string $type='')
	getImportName ()
	setImportName (string $a_import_name)
	enableForumNotification (int $user_id)
	disableForumNotification (int $user_id)
	isForumNotificationEnabled (int $user_id)
	isThreadNotificationEnabled (int $user_id, int $thread_id)
	mergeThreads (int $source_id, int $target_id)

Static Public Member Functions
static	_getModerators (int $a_ref_id)
static	_isModerator (int $a_ref_id, int $a_usr_id)
static	getSortedThreadSubjects (int $a_obj_id, int $a_sort_mode=self::SORT_DATE)
static	_lookupObjIdForForumId (int $a_for_id)

Data Fields
ilLanguage	$lng
ilErrorHandling	$error
ilDBInterface	$db
ilObjUser	$user
ilSetting	$settings

Static Protected Attributes
static array	$moderators_by_ref_id_map = []

Private Member Functions
	deletePostFiles (array $a_ids)

Private Attributes
const int	SORT_TITLE = 1
const int	SORT_DATE = 2
const int	DEFAULT_PAGE_HITS = 30
readonly ilAppEventHandler	$event
string	$dbTable
string	$className = 'ilForum'
string	$mdb2Query = ''
array	$mdb2DataValue = []
array	$mdb2DataType = []
string	$txtQuote1 = "[quote]"
string	$txtQuote2 = "[/quote]"
string	$replQuote1 = '<blockquote class="ilForumQuote">'
string	$replQuote2 = '</blockquote>'
int	$pageHits = self::DEFAULT_PAGE_HITS
int	$id
int	$ref_id
string	$import_name = ''
ILIAS UI Factory	$ui_factory
ILIAS UI Renderer	$ui_renderer

Detailed Description

Class Forum core functions for forum.

Author

Wolfgang Merkens wmerk.nosp@m.ens@.nosp@m.datab.nosp@m.ay.d.nosp@m.e \

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

Constructor & Destructor Documentation

__construct()

ilForum::__construct

(

)

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

    {
        global $DIC;
 
        $this->error = $DIC['ilErr'];
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $this->event = $DIC->event();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
    }

References $DIC, error(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

_getModerators()

static ilForum::_getModerators ( int  $a_ref_id )

static

Returns

int[]

Definition at line 1073 of file class.ilForum.php.

                                                        : array
    {
        global $DIC;
 
        $rbacreview = $DIC->rbac()->review();
 
        $role_arr = $rbacreview->getRolesOfRoleFolder($a_ref_id);
        foreach ($role_arr as $role_id) {
            if (ilObject::_lookupTitle($role_id) === 'il_frm_moderator_' . $a_ref_id) {
                return array_map('intval', $rbacreview->assignedUsers($role_id));
            }
        }
 
        return [];
    }

References $DIC, and ilObject\_lookupTitle().

Referenced by ilObjForum\getAllForumParticipants(), ILIAS\Forum\Notification\ForumNotificationTable\getFilteredUserIds(), ilForumNotificationDataProvider\getPostActivationRecipients(), and ILIAS\Forum\Notification\ForumNotificationTable\getUserNotificationTableData().

Here is the call graph for this function:

Here is the caller graph for this function:

_isModerator()

static ilForum::_isModerator ( int  $a_ref_id, int  $a_usr_id  )

static

Definition at line 1089 of file class.ilForum.php.

                                                                     : bool
    {
        if (!isset(self::$moderators_by_ref_id_map[$a_ref_id])) {
            self::$moderators_by_ref_id_map[$a_ref_id] = self::_getModerators($a_ref_id);
        }
 
        return in_array($a_usr_id, self::$moderators_by_ref_id_map[$a_ref_id], true);
    }

Referenced by ilForumExportGUI\renderPostHtml().

Here is the caller graph for this function:

_lookupObjIdForForumId()

static ilForum::_lookupObjIdForForumId ( int  $a_for_id )

static

Definition at line 1650 of file class.ilForum.php.

                                                                : int
    {
        global $DIC;
 
        $res = $DIC->database()->queryF('SELECT top_frm_fk FROM frm_data WHERE top_pk = %s', ['integer'], [$a_for_id]);
        if ($row = $DIC->database()->fetchAssoc($res)) {
            return (int) $row['top_frm_fk'];
        }
 
        return 0;
    }

References $DIC, and $res.

Referenced by ilForumDraftsDerivedTaskProvider\getTasks(), ilObjForumGUI\mergeThreadsObject(), and ilForumTopic\movePosts().

Here is the caller graph for this function:

addPostTree()

ilForum::addPostTree	(	int	$a_tree_id,
		int	$a_node_id = -1,
		string	$a_date = ''
	)

Definition at line 1134 of file class.ilForum.php.

                                                                                         : bool
    {
        $a_date = $a_date ?: date('Y-m-d H:i:s');
 
        if ($a_node_id <= 0) {
            $a_node_id = $a_tree_id;
        }
 
        $nextId = $this->db->nextId('frm_posts_tree');
 
        $this->db->manipulateF(
            '
                        INSERT INTO frm_posts_tree
                        (       fpt_pk,
                                thr_fk,
                                pos_fk,
                                parent_pos,
                                lft,
                                rgt,
                                depth,
                                fpt_date
                        )
                        VALUES(%s, %s, %s, %s,  %s,  %s, %s, %s )',
            ['integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'timestamp'],
            [$nextId, $a_tree_id, $a_node_id, 0, 1, 2, 1, $a_date]
        );
 
        return true;
    }

convertDate()

ilForum::convertDate

(

string

$date

)

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

                                             : string
    {
        return ilDatePresentation::formatDate(new ilDateTime($date, IL_CAL_DATETIME));
    }

References ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

Here is the call graph for this function:

countActiveUserArticles()

ilForum::countActiveUserArticles

(

int

$a_user_id

)

Definition at line 1113 of file class.ilForum.php.

                                                           : int
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_data
                        INNER JOIN frm_posts ON pos_top_fk = top_pk
                        INNER JOIN frm_posts_tree tree1 ON tree1.pos_fk = frm_posts.pos_pk AND tree1.parent_pos != 0
                        WHERE top_frm_fk = %s
                        AND (pos_status = %s OR (pos_status = %s AND pos_author_id = %s))
                        AND pos_author_id = %s',
            ['integer', 'integer', 'integer', 'integer', 'integer'],
            [$this->getForumId(), 1, 0, $this->user->getId(), $a_user_id]
        );
 
        return $res->numRows();
    }

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

Here is the call graph for this function:

countUserArticles()

ilForum::countUserArticles

(

int

$a_user_id

)

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

                                                     : int
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_data
                        INNER JOIN frm_posts ON pos_top_fk = top_pk
                        INNER JOIN frm_posts_tree tree1 ON tree1.pos_fk = frm_posts.pos_pk AND tree1.parent_pos != 0  
                        WHERE top_frm_fk = %s
                        AND pos_author_id = %s',
            ['integer', 'integer'],
            [$this->getForumId(), $a_user_id]
        );
 
        return $res->numRows();
    }

References $res.

deletePost()

ilForum::deletePost	(		$postIdOrRecord,
		bool	$raiseEvents = true
	)

Parameters

int|array<string,mixed>

$postIdOrRecord

Definition at line 535 of file class.ilForum.php.

                                                                         : int
    {
        $p_node = $postIdOrRecord;
        if (is_numeric($postIdOrRecord)) {
            $p_node = $this->getPostNode($postIdOrRecord);
        }
 
        $post = new ilForumPost((int) $p_node['pos_pk']);
        if ($raiseEvents) {
            $is_deleted_thread = ($post->getParentId() == 0) ? true : false;
            $num_visible_active_posts = 0;
            if ($is_deleted_thread) {
                $query = '
                    SELECT COUNT(*) AS cnt
                    FROM frm_posts
                    INNER JOIN frm_posts_tree ON pos_pk = pos_fk
                    WHERE frm_posts_tree.parent_pos != 0
                    AND pos_thr_fk = ' . $this->db->quote($post->getThreadId(), 'integer') . '
                    AND pos_status = ' . $this->db->quote(1, 'integer');
                $res = $this->db->query($query);
                $row = $this->db->fetchAssoc($res);
                $num_visible_active_posts = (int) ($row['cnt'] ?? 0);
            }
 
            $this->event->raise(
                'components/ILIAS/Forum',
                'beforePostDeletion',
                [
                    'obj_id' => $this->getForumId(),
                    'ref_id' => $this->getForumRefId(),
                    'post' => $post,
                    'thread_deleted' => $is_deleted_thread,
                    'num_visible_active_posts' => $num_visible_active_posts
                ]
            );
        }
 
        $this->deletePostFiles(array_merge(
            $this->getSubPathIdsForNode($post),
            [$post->getId()]
        ));
 
        $affected_user_ids[] = $post->getPosAuthorId();
        $deleted_post_ids = $this->deletePostTree($p_node);
 
        $obj_history = new ilForumDraftsHistory();
        $obj_history->deleteHistoryByPostIds($deleted_post_ids);
 
        $obj_draft = new ilForumPostDraft();
        $obj_draft->deleteDraftsByPostIds($deleted_post_ids);
 
        foreach ($deleted_post_ids as $post_id) {
            ilObjForum::_deleteReadEntries($post_id);
        }
 
        $dead_pos = count($deleted_post_ids);
        $dead_thr = 0;
 
        if ((int) $post->getParentId() === 0) {
            $dead_thr = $post->getThreadId();
 
            $this->db->manipulateF('DELETE FROM frm_threads WHERE thr_pk = %s', ['integer'], [$dead_thr]);
            $this->db->manipulateF(
                'UPDATE frm_data SET top_num_threads = top_num_threads - 1 WHERE top_frm_fk = %s',
                ['integer'],
                [$this->id]
            );
 
            $posset = $this->db->queryF('SELECT * FROM frm_posts WHERE pos_thr_fk = %s', ['integer'], [$dead_thr]);
            while ($posrec = $this->db->fetchAssoc($posset)) {
                $news_id = ilNewsItem::getFirstNewsIdForContext(
                    $this->id,
                    'frm',
                    (int) $posrec['pos_pk'],
                    'pos'
                );
                if ($news_id > 0) {
                    $news_item = new ilNewsItem($news_id);
                    $news_item->delete();
                }
 
                try {
                    $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', (int) $posrec['pos_pk']);
                    foreach ($mobs as $mob) {
                        if (ilObjMediaObject::_exists($mob)) {
                            ilObjMediaObject::_removeUsage($mob, 'frm:html', (int) $posrec['pos_pk']);
                            $mob_obj = new ilObjMediaObject($mob);
                            $mob_obj->delete();
                        }
                    }
                } catch (Exception) {
                }
                $affected_user_ids[] = (int) $posrec['pos_author_id'];
            }
 
            $this->db->manipulateF('DELETE FROM frm_posts WHERE pos_thr_fk = %s', ['integer'], [$post->getThreadId()]);
        } else {
            for ($i = 0; $i < $dead_pos; $i++) {
                $this->db->manipulateF('DELETE FROM frm_posts WHERE pos_pk = %s', ['integer'], [$deleted_post_ids[$i]]);
 
                $news_id = ilNewsItem::getFirstNewsIdForContext(
                    $this->id,
                    'frm',
                    $deleted_post_ids[$i],
                    'pos'
                );
                if ($news_id > 0) {
                    $news_item = new ilNewsItem($news_id);
                    $news_item->delete();
                }
 
                try {
                    $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', $deleted_post_ids[$i]);
                    foreach ($mobs as $mob) {
                        if (ilObjMediaObject::_exists($mob)) {
                            ilObjMediaObject::_removeUsage($mob, 'frm:html', $deleted_post_ids[$i]);
                            $mob_obj = new ilObjMediaObject($mob);
                            $mob_obj->delete();
                        }
                    }
                } catch (Exception) {
                }
            }
 
            $this->db->manipulateF(
                'UPDATE frm_threads SET thr_num_posts = thr_num_posts - %s WHERE thr_pk = %s',
                ['integer', 'integer'],
                [$dead_pos, $post->getTreeId()]
            );
 
            $res1 = $this->db->queryF(
                'SELECT * FROM frm_posts WHERE pos_thr_fk = %s ORDER BY pos_date DESC',
                ['integer'],
                [$post->getTreeId()]
            );
 
            $lastPost_thr = '';
            if ($res1->numRows() > 0) {
                $z = 0;
 
                while ($selData = $this->db->fetchAssoc($res1)) {
                    if ($z > 0) {
                        break;
                    }
 
                    $lastPost_thr = $selData['pos_top_fk'] . '#' . $selData['pos_thr_fk'] . '#' . $selData['pos_pk'];
                    $z++;
                }
            }
 
            $this->db->manipulateF(
                'UPDATE frm_threads SET thr_last_post = %s WHERE thr_pk = %s',
                ['text', 'integer'],
                [$lastPost_thr, $post->getTreeId()]
            );
        }
 
        $this->db->manipulateF(
            'UPDATE frm_data SET top_num_posts = top_num_posts - %s WHERE top_frm_fk = %s',
            ['integer', 'integer'],
            [$dead_pos, $this->id]
        );
 
        $res2 = $this->db->queryF(
            'SELECT * FROM frm_posts, frm_data WHERE pos_top_fk = top_pk AND top_frm_fk = %s ORDER BY pos_date DESC',
            ['integer'],
            [$this->id]
        );
 
        $lastPost_top = '';
        if ($res2->numRows() > 0) {
            $z = 0;
 
            while ($selData = $this->db->fetchAssoc($res2)) {
                if ($z > 0) {
                    break;
                }
 
                $lastPost_top = $selData['pos_top_fk'] . '#' . $selData['pos_thr_fk'] . '#' . $selData['pos_pk'];
                $z++;
            }
        }
 
        $this->db->manipulateF(
            'UPDATE frm_data SET top_last_post = %s WHERE top_frm_fk = %s',
            ['text', 'integer'],
            [$lastPost_top, $this->id]
        );
 
        if ($raiseEvents) {
            $this->event->raise(
                'components/ILIAS/Forum',
                'afterPostDeletion',
                [
                    'obj_id' => $this->getForumId(),
                    'ref_id' => $this->getForumRefId(),
                    'user_ids' => $affected_user_ids
                ]
            );
        }
 
        return $dead_thr;
    }

References $post, $res, ilObjForum\_deleteReadEntries(), ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), ilNewsItem\getFirstNewsIdForContext(), and ILIAS\Repository\int().

Here is the call graph for this function:

deletePostFiles()

ilForum::deletePostFiles ( array  $a_ids )

private

Parameters

int[]

$a_ids

Definition at line 1507 of file class.ilForum.php.

                                                  : void
    {
        foreach ($a_ids as $pos_id) {
            $forumFiles = new ilFileDataForum($this->getForumId(), $pos_id);
            $files = $forumFiles->getFilesOfPost();
            foreach ($files as $file) {
                $forumFiles->unlinkFile($file['name']);
            }
        }
    }

deletePostTree()

ilForum::deletePostTree

(

array

$a_node

)

Returns

int[] An list of deleted post ids

Definition at line 1353 of file class.ilForum.php.

                                                 : array
    {
        $res = $this->db->queryF(
            'SELECT lft, rgt FROM frm_posts_tree WHERE thr_fk = %s AND pos_fk = %s AND parent_pos = %s',
            ['integer', 'integer', 'integer'],
            [$a_node['tree'], $a_node['pos_pk'], $a_node['parent']]
        );
 
        while ($row = $this->db->fetchObject($res)) {
            $a_node['lft'] = (int) $row->lft;
            $a_node['rgt'] = (int) $row->rgt;
        }
 
        $diff = $a_node['rgt'] - $a_node['lft'] + 1;
 
        $res = $this->db->queryF(
            'SELECT pos_fk FROM frm_posts_tree WHERE lft BETWEEN %s AND %s AND thr_fk = %s',
            ['integer', 'integer', 'integer'],
            [$a_node['lft'], $a_node['rgt'], $a_node['tree']]
        );
 
        $deleted_post_ids = [];
        while ($treeData = $this->db->fetchAssoc($res)) {
            $deleted_post_ids[] = (int) $treeData['pos_fk'];
        }
 
        $this->db->manipulateF(
            'DELETE FROM frm_posts_tree WHERE lft BETWEEN %s AND %s AND thr_fk = %s',
            ['integer', 'integer', 'integer'],
            [$a_node['lft'], $a_node['rgt'], $a_node['tree']]
        );
 
        $this->db->manipulateF(
            '
                        UPDATE frm_posts_tree 
                        SET lft = CASE 
                                                WHEN lft > %s
                                                THEN lft - %s
                                                ELSE lft 
                                                END, 
                                rgt = CASE 
                                                WHEN rgt > %s
                                                THEN rgt - %s
                                                ELSE rgt 
                                                END 
                        WHERE thr_fk = %s',
            ['integer', 'integer', 'integer', 'integer', 'integer'],
            [$a_node['lft'], $diff, $a_node['lft'], $diff, $a_node['tree']]
        );
 
        return $deleted_post_ids;
    }

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

Here is the call graph for this function:

disableForumNotification()

ilForum::disableForumNotification

(

int

$user_id

)

Definition at line 1583 of file class.ilForum.php.

                                                          : bool
    {
        $this->db->manipulateF(
            'DELETE FROM frm_notification WHERE user_id = %s AND frm_id = %s',
            ['integer', 'integer'],
            [$user_id, $this->id]
        );
 
        return true;
    }

References $user_id.

enableForumNotification()

ilForum::enableForumNotification

(

int

$user_id

)

Definition at line 1528 of file class.ilForum.php.

                                                         : bool
    {
        if (!$this->isForumNotificationEnabled($user_id)) {
            /* Remove all notifications of threads that belong to the forum */
            $res = $this->db->queryF(
                '
                                SELECT frm_notification.thread_id FROM frm_data, frm_notification, frm_threads 
                                WHERE frm_notification.user_id = %s
                                AND frm_notification.thread_id = frm_threads.thr_pk 
                                AND frm_threads.thr_top_fk = frm_data.top_pk 
                                AND frm_data.top_frm_fk = %s
                                GROUP BY frm_notification.thread_id',
                ['integer', 'integer'],
                [$user_id, $this->id]
            );
 
            if ($res->numRows() > 0) {
                $thread_data = [];
                $thread_data_types = [];
 
                $query = ' DELETE FROM frm_notification WHERE user_id = %s AND thread_id IN (';
                $thread_data[] = $user_id;
                $thread_data_types[] = 'integer';
 
                $counter = 1;
                while ($row = $this->db->fetchAssoc($res)) {
                    if ($counter < $res->numRows()) {
                        $query .= '%s, ';
                        $thread_data[] = $row['thread_id'];
                        $thread_data_types[] = 'integer';
                    }
 
                    if ($counter === $res->numRows()) {
                        $query .= '%s)';
                        $thread_data[] = $row['thread_id'];
                        $thread_data_types[] = 'integer';
                    }
                    $counter++;
                }
 
                $this->db->manipulateF($query, $thread_data_types, $thread_data);
            }
 
            /* Insert forum notification */
            $nextId = $this->db->nextId('frm_notification');
            $this->db->manipulateF(
                'INSERT INTO frm_notification (notification_id, user_id, frm_id) VALUES(%s, %s, %s)',
                ['integer', 'integer', 'integer'],
                [$nextId, $user_id, $this->id]
            );
        }
 
        return true;
    }

References $counter, $res, and $user_id.

fetchPostNodeData()

ilForum::fetchPostNodeData

(

stdClass

$a_row

)

Returns

array{type: string, pos_pk: int, child: int, author: int, alias: string, title: mixed, loginname: string, message: string, subject: string, pos_cens_com: string, pos_cens: int, date: mixed, create_date: mixed, update: mixed, update_user: int, tree: int, parent: int, lft: int, rgt: int, depth: int, id: int, notify: int, import_name: mixed, pos_status: int}

Definition at line 1284 of file class.ilForum.php.

                                                      : array
    {
        $fullname = '';
        $loginname = '';
 
        if (ilObject::_exists((int) $a_row->pos_display_user_id)) {
            $tmp_user = new ilObjUser((int) $a_row->pos_display_user_id);
            $fullname = $tmp_user->getFullname();
            $loginname = $tmp_user->getLogin();
        }
 
        if ($fullname === '') {
            $fullname = $this->lng->txt('unknown');
            if ($a_row->import_name) {
                $fullname = $a_row->import_name;
            }
        }
 
        return [
            'type' => 'post',
            'pos_pk' => (int) $a_row->pos_pk,
            'pos_thr_fk' => (int) $a_row->pos_thr_fk,
            'child' => (int) $a_row->pos_pk,
            'author' => (int) $a_row->pos_display_user_id,
            'alias' => (string) $a_row->pos_usr_alias,
            'title' => $fullname,
            'loginname' => $loginname,
            'message' => (string) $a_row->pos_message,
            'subject' => (string) $a_row->pos_subject,
            'pos_cens_com' => (string) $a_row->pos_cens_com,
            'pos_cens' => (int) $a_row->pos_cens,
            'date' => $a_row->fpt_date,
            'create_date' => $a_row->pos_date,
            'update' => $a_row->pos_update,
            'update_user' => (int) $a_row->update_user,
            'tree' => (int) $a_row->thr_fk,
            'parent' => (int) $a_row->parent_pos,
            'lft' => (int) $a_row->lft,
            'rgt' => (int) $a_row->rgt,
            'depth' => (int) $a_row->depth,
            'id' => (int) $a_row->fpt_pk,
            'notify' => (int) $a_row->notify,
            'import_name' => $a_row->import_name,
            'pos_status' => (int) $a_row->pos_status
        ];
    }

References ilObject\_exists(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Here is the call graph for this function:

generateThread()

ilForum::generateThread	(	ilForumTopic	$thread,
		string	$message,
		bool	$notify,
		bool	$notify_posts,
		bool	$status = true,
		bool	$withFirstVisibleEntry = true
	)

Definition at line 291 of file class.ilForum.php.

     : int {
        if (!$thread->getCreateDate()) {
            $thread->setCreateDate(date('Y-m-d H:i:s'));
        }
 
        $thread->setImportName($this->getImportName());
        $thread->insert();
 
        if ($notify_posts) {
            $thread->enableNotification($thread->getThrAuthorId());
        }
 
        $this->db->manipulateF(
            'UPDATE frm_data SET top_num_threads = top_num_threads + 1 WHERE top_pk = %s',
            ['integer'],
            [$thread->getForumId()]
        );
 
        $rootNodeId = $this->generatePost(
            $thread->getForumId(),
            $thread->getId(),
            $thread->getThrAuthorId(),
            $thread->getDisplayUserId(),
            '',
            0,
            false,
            $thread->getSubject(),
            $thread->getUserAlias(),
            $thread->getCreateDate(),
            true,
            false
        );
 
        if (!$withFirstVisibleEntry) {
            return $rootNodeId;
        }
 
        return $this->generatePost(
            $thread->getForumId(),
            $thread->getId(),
            $thread->getThrAuthorId(),
            $thread->getDisplayUserId(),
            $message,
            $rootNodeId,
            $notify,
            $thread->getSubject(),
            $thread->getUserAlias(),
            $thread->getCreateDate(),
            $status,
            false
        );
    }

References ilForumTopic\setCreateDate().

Here is the call graph for this function:

getAllThreads()

ilForum::getAllThreads	(	int	$a_topic_id,
		array	$params = [],
		int	$limit = 0,
		int	$offset = 0
	)

Returns

array{cnt: int, items: array<int, ilForumTopic>}

Definition at line 742 of file class.ilForum.php.

                                                                                                       : array
    {
        $frm_props = ilForumProperties::getInstance($this->getForumId());
        $is_post_activation_enabled = $frm_props->isPostActivationEnabled();
 
        $user_id = $this->user->getId();
 
        $excluded_ids_condition = '';
        if (isset($params['excluded_ids']) && is_array($params['excluded_ids']) && $params['excluded_ids']) {
            $excluded_ids_condition = ' AND ' . $this->db->in('thr_pk', $params['excluded_ids'], true, 'integer') . ' ';
        }
 
        if (!isset($params['order_column']) || !in_array(
            strtolower($params['order_column']),
            ['lp_date', 'rating', 'thr_subject', 'num_posts', 'num_visit']
        )) {
            $params['order_column'] = 'post_date';
        }
        if (!isset($params['order_direction']) || !in_array(strtolower($params['order_direction']), ['asc', 'desc'])) {
            $params['order_direction'] = 'desc';
        }
 
        $cnt_active_pos_query = '';
        $cnt_join_type = 'LEFT';
        if ($is_post_activation_enabled && !$params['is_moderator']) {
            $cnt_active_pos_query = " AND (pos_status = {$this->db->quote(1, 'integer')} OR pos_author_id = {$this->db->quote($user_id, 'integer')}) ";
            $cnt_join_type = "INNER";
        }
        $query =
            "SELECT COUNT(DISTINCT(thr_pk)) cnt
                         FROM frm_threads
                         $cnt_join_type JOIN frm_posts
                                ON pos_thr_fk = thr_pk $cnt_active_pos_query
                         WHERE thr_top_fk = %s $excluded_ids_condition
                ";
        $res = $this->db->queryF($query, ['integer'], [$a_topic_id]);
        $cntData = $this->db->fetchAssoc($res);
        $cnt = (int) $cntData['cnt'];
 
        $active_query = '';
        $having = '';
        if ($is_post_activation_enabled && !$params['is_moderator']) {
            $active_query = ' AND (pos_status = %s OR pos_author_id = %s) ';
            $having = ' HAVING num_posts > 0';
        }
 
        $threads = [];
        $data = [];
        $data_types = [];
 
        $optional_fields = '';
        if ($frm_props->isIsThreadRatingEnabled()) {
            $optional_fields = ', avg_rating';
        }
 
        $additional_sort = '';
 
        if ($params['order_column'] === 'thr_subject') {
            $dynamic_columns = [', thr_subject ' . $params['order_direction']];
        } elseif ($params['order_column'] === 'num_posts') {
            $dynamic_columns = [', num_posts ' . $params['order_direction']];
        } elseif ($params['order_column'] === 'num_visit') {
            $dynamic_columns = [', visits ' . $params['order_direction']];
        } else {
            $dynamic_columns = [', post_date ' . $params['order_direction']];
        }
 
        if ($frm_props->isIsThreadRatingEnabled()) {
            $dynamic_columns[] = ' ,avg_rating ' . $params['order_direction'];
        }
        if ('rating' === strtolower($params['order_column'])) {
            $dynamic_columns = array_reverse($dynamic_columns);
        }
        $additional_sort .= implode(' ', $dynamic_columns);
 
 
        if (!$this->user->isAnonymous()) {
            $query = "SELECT
                                          (CASE WHEN COUNT(DISTINCT(notification_id)) > 0 THEN 1 ELSE 0 END) usr_notification_is_enabled,
                                          MAX(pos_date) post_date,
                                          SUM(tree1.parent_pos != 0) num_posts, 
                                          SUM(tree1.parent_pos != 0) - SUM(tree1.parent_pos != 0 AND postread.post_id IS NOT NULL) num_unread_posts, ";
 
            $query .= " thr_pk, thr_top_fk, thr_subject, thr_author_id, thr_display_user_id, thr_usr_alias, thr_num_posts, thr_last_post, thr_date, thr_update, visits, frm_threads.import_name, is_sticky, is_closed
                                          $optional_fields
                                          FROM frm_threads
                                          
                                          LEFT JOIN frm_notification
                                                ON frm_notification.thread_id = thr_pk
                                                AND frm_notification.user_id = %s
                                          
                                          LEFT JOIN frm_posts
                                                ON pos_thr_fk = thr_pk $active_query
                                          LEFT JOIN frm_posts_tree tree1
                                            ON tree1.pos_fk = frm_posts.pos_pk 
                                          LEFT JOIN frm_user_read postread
                                                ON postread.post_id = pos_pk
                                                AND postread.usr_id = %s";
 
            $query .= " WHERE thr_top_fk = %s
                                                $excluded_ids_condition
                                                GROUP BY thr_pk, thr_top_fk, thr_subject, thr_author_id, thr_display_user_id, thr_usr_alias, thr_num_posts, thr_last_post, thr_date, thr_update, visits, frm_threads.import_name, is_sticky, is_closed
                                                $optional_fields
                                                $having
                                                ORDER BY is_sticky DESC $additional_sort, thr_date DESC";
 
 
            $data_types[] = 'integer';
            if ($is_post_activation_enabled && !$params['is_moderator']) {
                $data_types[] = 'integer';
                $data_types[] = 'integer';
            }
            $data_types[] = 'integer';
            $data_types[] = 'integer';
 
 
            $data[] = $user_id;
            if ($is_post_activation_enabled && !$params['is_moderator']) {
                $data[] = 1;
                $data[] = $user_id;
            }
            $data[] = $user_id;
        } else {
            $query = "SELECT
                                          0 usr_notification_is_enabled,
                                          MAX(pos_date) post_date,
                                          COUNT(DISTINCT(tree1.pos_fk)) num_posts,
                                          COUNT(DISTINCT(tree1.pos_fk)) num_unread_posts,
                                          thr_pk, thr_top_fk, thr_subject, thr_author_id, thr_display_user_id, thr_usr_alias, thr_num_posts, thr_last_post, thr_date, thr_update, visits, frm_threads.import_name, is_sticky, is_closed
                                          $optional_fields
                                          FROM frm_threads
                                          
                                          LEFT JOIN frm_posts
                                                ON pos_thr_fk = thr_pk $active_query
                                          LEFT JOIN frm_posts_tree tree1
                                            ON tree1.pos_fk = frm_posts.pos_pk AND tree1.parent_pos != 0
                                        ";
 
            $query .= " WHERE thr_top_fk = %s
                                                $excluded_ids_condition
                                                GROUP BY thr_pk, thr_top_fk, thr_subject, thr_author_id, thr_display_user_id, thr_usr_alias, thr_num_posts, thr_last_post, thr_date, thr_update, visits, frm_threads.import_name, is_sticky, is_closed
                                                $optional_fields
                                                $having
                                                ORDER BY is_sticky DESC $additional_sort, thr_date DESC";
 
            if ($is_post_activation_enabled && !$params['is_moderator']) {
                $data_types[] = 'integer';
                $data_types[] = 'integer';
            }
            $data_types[] = 'integer';
            if ($is_post_activation_enabled && !$params['is_moderator']) {
                $data[] = 1;
                $data[] = $user_id;
            }
        }
        $data[] = $a_topic_id;
 
        if ($limit || $offset) {
            $this->db->setLimit($limit, $offset);
        }
 
        $threadIds = [];
        $res = $this->db->queryF($query, $data_types, $data);
        while ($row = $this->db->fetchAssoc($res)) {
            $thread = new ilForumTopic((int) $row['thr_pk'], (bool) $params['is_moderator'], true);
            $thread->assignData($row);
            $threads[(int) $row['thr_pk']] = $thread;
            $threadIds[] = (int) $row['thr_pk'];
        }
 
        $inner_last_active_post_condition = '';
        if ($is_post_activation_enabled && !$params['is_moderator']) {
            $inner_last_active_post_condition = sprintf(
                ' AND (iposts.pos_status = %s OR (iposts.pos_status = %s AND iposts.pos_author_id = %s)) ',
                $this->db->quote(1, 'integer'),
                $this->db->quote(0, 'integer'),
                $this->db->quote($this->user->getId(), 'integer')
            );
        }
 
        $post_res = $this->db->query(
            'SELECT frm_posts.*
                        FROM frm_posts
                        INNER JOIN (
                                SELECT pos_thr_fk, MAX(iposts.pos_date) i_pos_date
                                FROM frm_posts iposts
                                WHERE ' . $this->db->in('iposts.pos_thr_fk', $threadIds, false, 'integer') . ' 
                                ' . $inner_last_active_post_condition . '
                                GROUP BY pos_thr_fk
                        ) opost ON frm_posts.pos_thr_fk = opost.pos_thr_fk AND frm_posts.pos_date = opost.i_pos_date'
        );
        while ($post_row = $this->db->fetchAssoc($post_res)) {
            $tmp_obj = new ilForumPost((int) $post_row['pos_pk'], (bool) $params['is_moderator'], true);
            $tmp_obj->setPosAuthorId((int) $post_row['pos_author_id']);
            $tmp_obj->setDisplayUserId((int) $post_row['pos_display_user_id']);
            $tmp_obj->setUserAlias((string) $post_row['pos_usr_alias']);
            $tmp_obj->setImportName((string) $post_row['import_name']);
            $tmp_obj->setId((int) $post_row['pos_pk']);
            $tmp_obj->setCreateDate((string) $post_row['pos_date']);
 
            $threads[(int) $post_row['pos_thr_fk']]->setLastPostForThreadOverview($tmp_obj);
        }
 
        return [
            'items' => $threads,
            'cnt' => $cnt
        ];
    }

References $data, $params, $res, $user_id, ilForumProperties\getInstance(), ILIAS\Repository\int(), and ILIAS\Repository\user().

Here is the call graph for this function:

getDbTable()

ilForum::getDbTable

(

)

Definition at line 103 of file class.ilForum.php.

                                : string
    {
        return $this->dbTable;
    }

References $dbTable.

getFirstPostNode()

ilForum::getFirstPostNode

(

int

$tree_id

)

Definition at line 1251 of file class.ilForum.php.

                                                  : array
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_posts, frm_posts_tree WHERE pos_pk = pos_fk AND parent_pos = %s AND thr_fk = %s',
            ['integer', 'integer'],
            [0, $tree_id]
        );
 
        if (($row = $this->db->fetchObject($res)) !== null) {
            return $this->fetchPostNodeData($row);
        }
 
        return [];
    }

References $res.

getForumId()

ilForum::getForumId

(

)

Definition at line 84 of file class.ilForum.php.

                                : int
    {
        return $this->id;
    }

References $id.

getForumRefId()

ilForum::getForumRefId

(

)

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

                                   : int
    {
        return $this->ref_id;
    }

References $ref_id.

getImportName()

ilForum::getImportName

(

)

Definition at line 1518 of file class.ilForum.php.

                                   : string
    {
        return $this->import_name;
    }

getMDB2DataType()

ilForum::getMDB2DataType

(

)

Definition at line 127 of file class.ilForum.php.

                                     : array
    {
        return $this->mdb2DataType ?: [];
    }

Referenced by getOneThread(), and getOneTopic().

Here is the caller graph for this function:

getMDB2DataValue()

ilForum::getMDB2DataValue

(

)

Definition at line 122 of file class.ilForum.php.

                                      : array
    {
        return $this->mdb2DataValue ?: [];
    }

Referenced by getOneThread(), and getOneTopic().

Here is the caller graph for this function:

getMDB2Query()

ilForum::getMDB2Query

(

)

Definition at line 117 of file class.ilForum.php.

                                  : string
    {
        return $this->mdb2Query ?: '';
    }

Referenced by getOneThread(), and getOneTopic().

Here is the caller graph for this function:

getModerators()

ilForum::getModerators

(

)

Returns

int[]

Definition at line 1065 of file class.ilForum.php.

                                   : array
    {
        return self::_getModerators($this->getForumRefId());
    }

getNumberOfPublishedUserPostings()

ilForum::getNumberOfPublishedUserPostings	(	int	$usr_id,
		bool	$post_activation_required
	)

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

                                                                                                 : int
    {
        $query = '
            SELECT 
                   SUM(IF(f.pos_cens = %s, 1, 0)) cnt
            FROM frm_posts f
            INNER JOIN frm_posts_tree t ON f.pos_pk = t.pos_fk AND t.parent_pos != %s
            INNER JOIN frm_threads th ON t.thr_fk = th.thr_pk 
            INNER JOIN frm_data d ON d.top_pk = f.pos_top_fk AND d.top_frm_fk = %s
            WHERE f.pos_author_id = %s
        ';
 
        if ($post_activation_required) {
            $query .= ' AND f.pos_status = ' . $this->db->quote(1, 'integer');
        }
 
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer', 'integer', 'integer'],
            [0, 0, $this->getForumId(), $usr_id]
        );
        $row = $this->db->fetchAssoc($res);
        if (is_array($row)) {
            return (int) $row['cnt'];
        }
 
        return 0;
    }

References $res.

getOneThread()

ilForum::getOneThread

(

)

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

                                  : ilForumTopic
    {
        $data_type = [];
        $data_value = [];
 
        $query = 'SELECT * FROM frm_threads WHERE ';
        if ($this->getMDB2Query() !== '' && $this->getMDB2DataType() !== [] && $this->getMDB2DataValue() !== []) {
            $query .= ' ' . $this->getMDB2Query() . ' ';
            $data_type += $this->getMDB2DataType();
            $data_value += $this->getMDB2DataValue();
        } else {
            $query .= '1 = 1';
        }
 
        $sql_res = $this->db->queryF($query, $data_type, $data_value);
        $result = $this->db->fetchAssoc($sql_res);
        $result['thr_subject'] = trim((string) ($result['thr_subject'] ?? ''));
 
        $thread_obj = new ilForumTopic();
        $thread_obj->assignData($result);
 
        return $thread_obj;
    }

References getMDB2DataType(), getMDB2DataValue(), and getMDB2Query().

Here is the call graph for this function:

getOneTopic()

ilForum::getOneTopic

(

)

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

                                 : ForumDto
    {
        $data_type = [];
        $data_value = [];
 
        $query = 'SELECT * FROM frm_data WHERE ';
        if ($this->getMDB2Query() !== '' && $this->getMDB2DataType() !== [] && $this->getMDB2DataValue() !== []) {
            $query .= ' ' . $this->getMDB2Query() . ' ';
            $data_type += $this->getMDB2DataType();
            $data_value += $this->getMDB2DataValue();
        } else {
            $query .= '1 = 1';
        }
 
        $res = $this->db->queryF($query, $data_type, $data_value);
        $row = $this->db->fetchAssoc($res);
 
        if (!is_array($row) || $row === []) {
            return ForumDto::getEmptyInstance();
        }
 
        return ForumDto::getInstanceFromArray($row);
    }

References $res, ForumDto\getEmptyInstance(), ForumDto\getInstanceFromArray(), getMDB2DataType(), getMDB2DataValue(), and getMDB2Query().

Here is the call graph for this function:

getPageHits()

ilForum::getPageHits

(

)

Definition at line 142 of file class.ilForum.php.

                                 : int
    {
        return $this->pageHits;
    }

References $pageHits.

getPostDepth()

ilForum::getPostDepth	(	int	$a_node_id,
		int	$tree_id
	)

Definition at line 1233 of file class.ilForum.php.

                                                              : int
    {
        if ($tree_id !== 0) {
            $res = $this->db->queryF(
                'SELECT depth FROM frm_posts_tree WHERE pos_fk = %s AND thr_fk = %s',
                ['integer', 'integer'],
                [$a_node_id, $tree_id]
            );
 
            $row = $this->db->fetchObject($res);
            if ($row instanceof stdClass) {
                return (int) $row->depth;
            }
        }
 
        return 0;
    }

References $res.

getPostNode()

ilForum::getPostNode

(

int

$post_id

)

Definition at line 1266 of file class.ilForum.php.

                                             : array
    {
        $res = $this->db->queryF(
            'SELECT * FROM frm_posts, frm_posts_tree WHERE pos_pk = pos_fk AND pos_pk = %s',
            ['integer'],
            [$post_id]
        );
 
        if (($row = $this->db->fetchObject($res)) !== null) {
            return $this->fetchPostNodeData($row);
        }
 
        return [];
    }

References $res.

getRootPostIdByThread()

ilForum::getRootPostIdByThread

(

int

$a_thread_id

)

Definition at line 1046 of file class.ilForum.php.

                                                           : int
    {
        $res = $this->db->queryF(
            'SELECT pos_fk FROM frm_posts_tree WHERE thr_fk = %s AND parent_pos = %s',
            ['integer', 'integer'],
            [$a_thread_id, 0]
        );
 
        $row = $this->db->fetchObject($res);
        if ($row instanceof stdClass) {
            return (int) $row->pos_fk;
        }
 
        return 0;
    }

References $res.

getSortedThreadSubjects()

static ilForum::getSortedThreadSubjects ( int  $a_obj_id, int  $a_sort_mode = self::SORT_DATE  )

static

Returns

array<int, string>

Definition at line 1627 of file class.ilForum.php.

                                                                                                   : array
    {
        global $DIC;
 
        $sort = match ($a_sort_mode) {
            self::SORT_DATE => 'thr_date',
            default => 'thr_subject',
        };
 
        $res = $DIC->database()->queryF(
            'SELECT thr_pk, thr_subject FROM frm_threads INNER JOIN frm_data ON top_pk = thr_top_fk WHERE top_frm_fk = %s ORDER BY %s',
            ['integer', 'text'],
            [$a_obj_id, $sort]
        );
 
        $threads = [];
        while ($row = $DIC->database()->fetchObject($res)) {
            $threads[(int) $row->thr_pk] = $row->thr_subject;
        }
 
        return $threads;
    }

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

Referenced by ilObjForumSearchResultTableGUI\parse().

Here is the call graph for this function:

Here is the caller graph for this function:

getSubPathIdsForNode()

ilForum::getSubPathIdsForNode

(

ilForumPost

$post

)

Returns

list<int> A list of post ids

Definition at line 1334 of file class.ilForum.php.

                                                           : array
    {
        $res = $this->db->queryF(
            'SELECT pos_fk FROM frm_posts_tree WHERE lft BETWEEN %s AND %s AND thr_fk = %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$post->getLft(), $post->getRgt(), $post->getTreeId()]
        );
 
        $post_ids = [];
        while ($post_tree_data = $this->db->fetchAssoc($res)) {
            $post_ids[] = (int) $post_tree_data['pos_fk'];
        }
 
        return $post_ids;
    }

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

Here is the call graph for this function:

getUserStatistics()

ilForum::getUserStatistics

(

bool

$post_activation_required

)

Returns

array{usr_id: int, pos_author_id: int, firstname: string, lastname: string, login: string, public_profile: string, num_postings: int}[]

Definition at line 983 of file class.ilForum.php.

                                                                     : array
    {
        $statistic = [];
        $data_types = [];
        $data = [];
 
        $query = '
            SELECT 
                   u.login, u.lastname, u.firstname, f.pos_author_id, u.usr_id,
                   p.value public_profile,
                   SUM(IF(f.pos_cens = %s, 1, 0)) num_postings
            FROM frm_posts f
            INNER JOIN frm_posts_tree t ON f.pos_pk = t.pos_fk
            INNER JOIN frm_threads th ON t.thr_fk = th.thr_pk
            INNER JOIN usr_data u ON u.usr_id = f.pos_author_id
            INNER JOIN frm_data d ON d.top_pk = f.pos_top_fk
            LEFT JOIN usr_pref p ON p.usr_id = u.usr_id AND p.keyword = %s
            WHERE t.parent_pos != %s
        ';
 
        $data_types[] = 'integer';
        $data_types[] = 'text';
        $data_types[] = 'integer';
        $data[] = 0;
        $data[] = 'public_profile';
        $data[] = 0;
 
        if ($post_activation_required) {
            $query .= ' AND pos_status = %s';
            $data_types[] = 'integer';
            $data[] = 1;
        }
 
        $query .= '
            AND d.top_frm_fk = %s
            GROUP BY u.login, p.value,u.lastname, u.firstname, f.pos_author_id
        ';
 
        $data_types[] = 'integer';
        $data[] = $this->getForumId();
 
        $res = $this->db->queryF($query, $data_types, $data);
        while ($row = $this->db->fetchAssoc($res)) {
            if (
                !in_array($row['public_profile'], [
                    PersonalProfileVisbility::PROFILE_ENABLED_LOGGED_IN_USERS,
                    PersonalProfileVisbility::PROFILE_ENABLED_GLOBAL], true)
                || ($this->user->isAnonymous() && $row['public_profile'] !== PersonalProfileVisbility::PROFILE_ENABLED_GLOBAL)
            ) {
                $row['lastname'] = '';
                $row['firstname'] = '';
            }
 
            $row['usr_id'] = (int) $row['usr_id'];
            $row['pos_author_id'] = (int) $row['pos_author_id'];
            $row['num_postings'] = (int) $row['num_postings'];
 
            $statistic[] = $row;
        }
 
        return $statistic;
    }

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

Here is the call graph for this function:

insertPostNode()

ilForum::insertPostNode	(	int	$a_node_id,
		int	$a_parent_id,
		int	$tree_id,
		string	$a_date = ''
	)

insert node under parent node

Definition at line 1167 of file class.ilForum.php.

                                                                                                       : void
    {
        $a_date = $a_date ?: date('Y-m-d H:i:s');
        $left = 1;
 
        $res = $this->db->queryF(
            'SELECT lft FROM frm_posts_tree WHERE pos_fk = %s AND thr_fk = %s',
            ['integer', 'integer'],
            [$a_parent_id, $tree_id]
        );
        $row = $this->db->fetchObject($res);
        if ($row instanceof stdClass) {
            $left = (int) $row->lft;
        }
 
        $lft = $left + 1;
        $rgt = $left + 2;
 
        $this->db->manipulateF(
            '
                        UPDATE frm_posts_tree 
                        SET  lft = CASE 
                                 WHEN lft > %s
                                 THEN lft + 2 
                                 ELSE lft 
                                 END, 
                                 rgt = CASE 
                                 WHEN rgt > %s
                                 THEN rgt + 2 
                                 ELSE rgt 
                                 END 
                                 WHERE thr_fk = %s',
            ['integer', 'integer', 'integer'],
            [$left, $left, $tree_id]
        );
 
        $depth = $this->getPostDepth($a_parent_id, $tree_id) + 1;
 
        $nextId = $this->db->nextId('frm_posts_tree');
        $this->db->manipulateF(
            '
                        INSERT INTO frm_posts_tree
                        (       fpt_pk,
                                thr_fk,
                                pos_fk,
                                parent_pos,
                                lft,
                                rgt,
                                depth,
                                fpt_date
                        )
                        VALUES(%s,%s,%s, %s, %s, %s,%s, %s)',
            ['integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'timestamp'],
            [
                $nextId,
                $tree_id,
                $a_node_id,
                $a_parent_id,
                $lft,
                $rgt,
                $depth,
                $a_date
            ]
        );
    }

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

Here is the call graph for this function:

isForumNotificationEnabled()

ilForum::isForumNotificationEnabled

(

int

$user_id

)

Definition at line 1594 of file class.ilForum.php.

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

References $res, and $user_id.

isThreadNotificationEnabled()

ilForum::isThreadNotificationEnabled	(	int	$user_id,
		int	$thread_id
	)

Definition at line 1609 of file class.ilForum.php.

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

References $res, and $user_id.

mergeThreads()

ilForum::mergeThreads	(	int	$source_id,
		int	$target_id
	)

Definition at line 1662 of file class.ilForum.php.

                                                                : void
    {
        // selected source and target objects
        $sourceThread = new ilForumTopic($source_id);
        $targetThread = new ilForumTopic($target_id);
 
        if ($sourceThread->getForumId() !== $targetThread->getForumId()) {
            throw new ilException('not_allowed_to_merge_into_another_forum');
        }
 
        // use the 'older' thread as target
        if ($sourceThread->getCreateDate() > $targetThread->getCreateDate()) {
            $sourceThreadForMerge = $sourceThread;
            $targetThreadForMerge = $targetThread;
        } else {
            $sourceThreadForMerge = $targetThread;
            $targetThreadForMerge = $sourceThread;
        }
 
        $threadSubject = $targetThreadForMerge->getSubject();
 
        $targetWasClosedBeforeMerge = $targetThreadForMerge->isClosed();
        $sourceThreadForMerge->close();
 
        if (!$targetWasClosedBeforeMerge) {
            $targetThreadForMerge->close();
        }
 
        $allSourcePostings = $sourceThreadForMerge->getAllPostIds();
        $sourceThreadRootNode = $sourceThreadForMerge->getPostRootNode();
        $targetThreadRootNode = $targetThreadForMerge->getPostRootNode();
 
        $sourceThreadRootArray = $this->getPostNode($sourceThreadRootNode->getId());
 
        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock('frm_posts');
        $ilAtomQuery->addTableLock('frm_posts_tree');
        $ilAtomQuery->addTableLock('frm_threads');
        $ilAtomQuery->addTableLock('frm_data');
 
        $ilAtomQuery->addQueryCallable(static function (ilDBInterface $ilDB) use (
            $targetThreadForMerge,
            $sourceThreadForMerge,
            $targetThreadRootNode,
            $sourceThreadRootNode,
            $allSourcePostings
        ): void {
            $targetRootNodeRgt = $targetThreadRootNode->getRgt();
            $targetRootNodeId = $targetThreadRootNode->getId();
 
            // update target root node rgt: Ignore the root node itself from the source (= -2)
            ilForumPostsTree::updateTargetRootRgt(
                $targetThreadRootNode->getId(),
                ($targetThreadRootNode->getRgt() + $sourceThreadRootNode->getRgt() - 2)
            );
 
            // get source post tree and update posts tree
            foreach ($allSourcePostings as $pos_pk) {
                $post_obj = new ilForumPost($pos_pk);
 
                if ($post_obj->getId() === $sourceThreadRootNode->getId()) {
                    // Ignore the source root node (MUST be deleted later)
                    continue;
                }
 
                $tree = new ilForumPostsTree();
                $tree->setPosFk($pos_pk);
 
                if ($post_obj->getParentId() === $sourceThreadRootNode->getId()) {
                    $tree->setParentPos($targetRootNodeId);
                } else {
                    $tree->setParentPos($post_obj->getParentId());
                }
 
                $tree->setLft(($post_obj->getLft() + $targetRootNodeRgt) - 2);
                $tree->setRgt(($post_obj->getRgt() + $targetRootNodeRgt) - 2);
 
                $tree->setDepth($post_obj->getDepth());
                $tree->setTargetThreadId($targetThreadForMerge->getId());
                $tree->setSourceThreadId($sourceThreadForMerge->getId());
 
                $tree->merge();
            }
 
            ilForumPost::mergePosts(
                $sourceThreadForMerge->getId(),
                $targetThreadForMerge->getId(),
                [$sourceThreadRootNode->getId()]
            );
        });
        $ilAtomQuery->run();
 
        ilForumNotification::mergeThreadNotifications($sourceThreadForMerge->getId(), $targetThreadForMerge->getId());
        ilObjForum::mergeForumUserRead($sourceThreadForMerge->getId(), $targetThreadForMerge->getId());
 
        $lastPostString = $targetThreadForMerge->getLastPostString() ?? '';
        $exp = explode('#', $lastPostString);
        if (array_key_exists(2, $exp)) {
            try {
                $exp[2] = $targetThreadForMerge->getLastPost()->getId();
                $lastPostString = implode('#', $exp);
            } catch (OutOfBoundsException) {
                $lastPostString = null;
            }
        }
 
        $frm_topic_obj = new ilForumTopic(0, false, true);
        $frm_topic_obj->setNumPosts($sourceThreadForMerge->getNumPosts() + $targetThreadForMerge->getNumPosts());
        $frm_topic_obj->setVisits($sourceThreadForMerge->getVisits() + $targetThreadForMerge->getVisits());
        $frm_topic_obj->setLastPostString($lastPostString);
        $frm_topic_obj->setSubject($threadSubject);
        $frm_topic_obj->setId($targetThreadForMerge->getId());
        $frm_topic_obj->updateMergedThread();
 
        if (!$targetWasClosedBeforeMerge) {
            $targetThreadForMerge->reopen();
        }
 
        $this->event->raise(
            'components/ILIAS/Forum',
            'mergedThreads',
            [
                'obj_id' => $this->getForumId(),
                'source_thread_id' => $sourceThreadForMerge->getId(),
                'target_thread_id' => $targetThreadForMerge->getId()
            ]
        );
 
        $this->deletePost($sourceThreadRootArray, false);
    }

References $ilDB, ilObjForum\mergeForumUserRead(), ilForumPost\mergePosts(), ilForumNotification\mergeThreadNotifications(), and ilForumPostsTree\updateTargetRootRgt().

Here is the call graph for this function:

moveThreads()

ilForum::moveThreads	(	array	$thread_ids,
		ilObjForum	$src_forum,
		int	$target_obj_id
	)

Parameters

int[]

$thread_ids

Returns

string[] A list of error message strings

Definition at line 355 of file class.ilForum.php.

                                                                                             : array
    {
        $errorMessages = [];
 
        if ($target_obj_id <= 0 || $src_forum->getId() <= 0) {
            return $errorMessages;
        }
 
        $this->setMDB2WhereCondition('top_frm_fk = %s ', ['integer'], [$src_forum->getId()]);
        $oldFrmData = $this->getOneTopic();
 
        $this->setMDB2WhereCondition('top_frm_fk = %s ', ['integer'], [$target_obj_id]);
        $newFrmData = $this->getOneTopic();
 
        if (!$oldFrmData->getTopPk() || !$newFrmData->getTopPk()) {
            return $errorMessages;
        }
 
        $num_moved_posts = 0;
        $num_moved_threads = 0;
        $num_visits = 0;
 
        foreach ($thread_ids as $id) {
            $objTmpThread = new ilForumTopic($id);
 
            try {
                $numPosts = $objTmpThread->movePosts(
                    $src_forum->getId(),
                    $oldFrmData->getTopPk(),
                    $target_obj_id,
                    $newFrmData->getTopPk()
                );
 
                if (($last_post_string = ($objTmpThread->getLastPostString() ?? '')) !== '') {
                    $last_post_string = explode('#', $last_post_string);
                    $last_post_string[0] = $newFrmData->getTopPk();
                    $last_post_string = implode('#', $last_post_string);
                    $objTmpThread->setLastPostString($last_post_string);
                }
 
                $num_visits += $objTmpThread->getVisits();
                $num_moved_posts += $numPosts;
                ++$num_moved_threads;
 
                $objTmpThread->setForumId($newFrmData->getTopPk());
                $objTmpThread->update();
            } catch (ilFileUtilsException) {
                $errorMessages[] = sprintf($this->lng->txt('frm_move_invalid_file_type'), $objTmpThread->getSubject());
                continue;
            }
        }
 
        if (0 === max($num_moved_threads, $num_moved_posts, $num_visits)) {
            return $errorMessages;
        }
 
        $this->db->setLimit(1, 0);
        $res = $this->db->queryF(
            'SELECT pos_thr_fk, pos_pk FROM frm_posts WHERE pos_top_fk = %s ORDER BY pos_date DESC',
            ['integer'],
            [$oldFrmData->getTopPk()]
        );
 
        $last_post_src = '';
        $row = $this->db->fetchObject($res);
        if ($row !== null) {
            $last_post_src = $oldFrmData->getTopPk() . '#' . $row->pos_thr_fk . '#' . $row->pos_pk;
        }
 
        $this->db->manipulateF(
            'UPDATE frm_data ' .
            'SET top_num_posts = top_num_posts - %s, top_num_threads = top_num_threads - %s, visits = visits - %s, ' .
            'top_last_post = %s WHERE top_pk = %s',
            ['integer', 'integer', 'integer', 'text', 'integer'],
            [
                $num_moved_posts,
                $num_moved_threads,
                $num_visits,
                $last_post_src,
                $oldFrmData->getTopPk()
            ]
        );
 
        $this->db->setLimit(1, 0);
        $res = $this->db->queryF(
            'SELECT pos_thr_fk, pos_pk FROM frm_posts WHERE pos_top_fk = %s ORDER BY pos_date DESC',
            ['integer'],
            [$newFrmData->getTopPk()]
        );
 
        $last_post_dest = '';
        $row = $this->db->fetchObject($res);
        if ($row !== null) {
            $last_post_dest = $newFrmData->getTopPk() . '#' . $row->pos_thr_fk . '#' . $row->pos_pk;
        }
 
        $this->db->manipulateF(
            'UPDATE frm_data SET top_num_posts = top_num_posts + %s, top_num_threads = top_num_threads + %s, ' .
            'visits = visits + %s, top_last_post = %s WHERE top_pk = %s',
            ['integer', 'integer', 'integer', 'text', 'integer'],
            [$num_moved_posts, $num_moved_threads, $num_visits, $last_post_dest, $newFrmData->getTopPk()]
        );
 
        $this->event->raise(
            'components/ILIAS/Forum',
            'movedThreads',
            [
                'source_ref_id' => $src_forum->getId(),
                'target_ref_id' => $src_forum->getId(),
                'thread_ids' => $src_forum->getId(),
                'source_frm_obj_id' => $src_forum->getId(),
                'target_frm_obj_id' => $target_obj_id
            ]
        );
 
        return $errorMessages;
    }

References $id, $res, ilObject\getId(), ILIAS\Survey\Mode\getId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

postCensorship()

ilForum::postCensorship	(	ilObjForum	$forum,
		string	$message,
		int	$pos_pk,
		int	$cens = 0
	)

Definition at line 473 of file class.ilForum.php.

                                                                                                  : void
    {
        $cens_date = date('Y-m-d H:i:s');
 
        $this->db->manipulateF(
            'UPDATE frm_posts
                        SET pos_cens_com = %s,
                                pos_cens_date = %s,
                                pos_cens = %s,
                                update_user = %s
                        WHERE pos_pk = %s',
            ['text', 'timestamp', 'integer', 'integer', 'integer'],
            [$message,
             $cens_date,
             $cens,
             $this->user->getId(),
             $pos_pk
            ]
        );
 
        $news_id = ilNewsItem::getFirstNewsIdForContext(
            $this->id,
            'frm',
            $pos_pk,
            'pos'
        );
        if ($news_id > 0) {
            if ($cens > 0) {
                $news_item = new ilNewsItem($news_id);
                $news_item->setContent(nl2br($this->prepareText($message, 0)));
                $news_item->setContentHtml(false);
                if ($message !== strip_tags($message)) {
                    $news_item->setContentHtml(true);
                }
            } else {
                $res = $this->db->queryF('SELECT pos_message FROM frm_posts WHERE pos_pk = %s', ['integer'], [$pos_pk]);
                $rec = $this->db->fetchAssoc($res);
 
                $news_item = new ilNewsItem($news_id);
                $news_item->setContent(nl2br($this->prepareText($rec['pos_message'], 0)));
                $news_item->setContentHtml(false);
                if ($rec['pos_message'] !== strip_tags($rec['pos_message'])) {
                    $news_item->setContentHtml(true);
                }
            }
            $news_item->update();
        }
 
        $this->event->raise(
            'components/ILIAS/Forum',
            'censoredPost',
            [
                'ref_id' => $this->getForumRefId(),
                'post' => new ilForumPost($pos_pk),
                'object' => $forum
            ]
        );
    }

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

Here is the call graph for this function:

prepareText()

ilForum::prepareText	(	string	$text,
		int	$edit = 0,
		string	$quote_user = '',
		string	$type = ''
	)

Definition at line 1427 of file class.ilForum.php.

                                                                                                        : string
    {
        if ($type === 'export') {
            $this->replQuote1 = "<blockquote class=\"quote\"><hr size=\"1\" color=\"#000000\">";
            $this->replQuote2 = "<hr size=\"1\" color=\"#000000\"/></blockquote>";
        }
 
        if ($edit === 1) {
            $lname = '';
            if ($quote_user !== '') {
                $lname = '="' . $quote_user . '"';
            }
 
            $text = "[quote$lname]" . $text . "[/quote]";
        } else {
            // check for quotation
            $startZ = substr_count($text, "[quote"); // also count [quote="..."]
            $endZ = substr_count($text, "[/quote]");
 
            if ($startZ > 0 || $endZ > 0) {
                // add missing opening and closing tags
                if ($startZ > $endZ) {
                    $diff = $startZ - $endZ;
 
                    for ($i = 0; $i < $diff; $i++) {
                        if ($type === 'export') {
                            $text .= $this->txtQuote2;
                        } else {
                            $text .= "[/quote]";
                        }
                    }
                } elseif ($startZ < $endZ) {
                    $diff = $endZ - $startZ;
 
                    for ($i = 0; $i < $diff; $i++) {
                        if ($type === 'export') {
                            $text = $this->txtQuote1 . $text;
                        } else {
                            $text = "[quote]" . $text;
                        }
                    }
                }
 
                if ($edit === 0) {
                    $text = preg_replace(
                        '@\[(quote\s*?=\s*?"([^"]*?)"\s*?)\]@i',
                        $this->replQuote1 . '<div class="ilForumQuoteHead">' . $this->lng->txt('quote') . ' ($2)</div>',
                        $text
                    );
 
                    $text = str_replace(
                        ["[quote]", "[/quote]"],
                        [
                            $this->replQuote1 . '<div class="ilForumQuoteHead">' . $this->lng->txt('quote') . '</div>',
                            $this->replQuote2
                        ],
                        $text
                    );
                }
            }
        }
 
        if ($type !== 'export') {
            if ($edit === 0) {
                $text = ilRTE::replaceLatexSpan($text);
                $text = $this->ui_renderer->render($this->ui_factory->legacy()->latexContent($text));
            }
 
            // workaround for preventing template engine
            // from hiding text that is enclosed
            // in curly brackets (e.g. "{a}")
            $text = str_replace(["{", "}"], ["&#123;", "&#125;"], $text);
        }
 
        return $text;
    }

References $text, ILIAS\Repository\lng(), and ilRTE\replaceLatexSpan().

Referenced by ilObjForumGUI\renderPostingForm().

Here is the call graph for this function:

Here is the caller graph for this function:

setDbTable()

ilForum::setDbTable

(

string

$dbTable

)

Definition at line 94 of file class.ilForum.php.

                                               : void
    {
        if ($dbTable === '') {
            die($this->className . '::setDbTable(): No database table given.');
        }
 
        $this->dbTable = $dbTable;
    }

References $dbTable.

setForumId()

ilForum::setForumId

(

int

$a_obj_id

)

Definition at line 74 of file class.ilForum.php.

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

setForumRefId()

ilForum::setForumRefId

(

int

$a_ref_id

)

Definition at line 79 of file class.ilForum.php.

                                                : void
    {
        $this->ref_id = $a_ref_id;
    }

setImportName()

ilForum::setImportName

(

string

$a_import_name

)

Definition at line 1523 of file class.ilForum.php.

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

setMDB2WhereCondition()

ilForum::setMDB2WhereCondition	(	string	$query_string,
		array	$data_type,
		array	$data_value
	)

Definition at line 108 of file class.ilForum.php.

                                                                                                    : bool
    {
        $this->mdb2Query = $query_string;
        $this->mdb2DataValue = $data_value;
        $this->mdb2DataType = $data_type;
 
        return true;
    }

setPageHits()

ilForum::setPageHits

(

int

$pageHits

)

Definition at line 132 of file class.ilForum.php.

                                              : bool
    {
        if ($pageHits < 1) {
            $pageHits = 1;
        }
 
        $this->pageHits = $pageHits;
        return true;
    }

References $pageHits.

updateVisits()

ilForum::updateVisits

(

int

$ID

)

Definition at line 1406 of file class.ilForum.php.

                                         : void
    {
        $checkTime = time() - (60 * 60);
        $session_key = 'frm_visit_' . $this->dbTable . '_' . $ID;
 
        if (ilSession::get($session_key) < $checkTime) {
            ilSession::set($session_key, time());
            $query = 'UPDATE ' . $this->dbTable . ' SET visits = visits + 1 WHERE ';
            $data_type = [];
            $data_value = [];
 
            if ($this->getMDB2Query() !== '' && $this->getMDB2DataType() !== [] && $this->getMDB2DataValue() !== []) {
                $query .= $this->getMDB2Query();
                $data_type += $this->getMDB2DataType();
                $data_value += $this->getMDB2DataValue();
 
                $this->db->manipulateF($query, $data_type, $data_value);
            }
        }
    }

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

Here is the call graph for this function:

Field Documentation

$className

string ilForum::$className = 'ilForum'

private

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

$db

ilDBInterface ilForum::$db

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

$dbTable

string ilForum::$dbTable

private

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

Referenced by getDbTable(), and setDbTable().

$error

ilErrorHandling ilForum::$error

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

$event

readonly ilAppEventHandler ilForum::$event

private

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

$id

int ilForum::$id

private

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

Referenced by getForumId().

$import_name

string ilForum::$import_name = ''

private

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

$lng

ilLanguage ilForum::$lng

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

$mdb2DataType

array ilForum::$mdb2DataType = []

private

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

$mdb2DataValue

array ilForum::$mdb2DataValue = []

private

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

$mdb2Query

string ilForum::$mdb2Query = ''

private

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

$moderators_by_ref_id_map

array ilForum::$moderators_by_ref_id_map = []

staticprotected

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

$pageHits

int ilForum::$pageHits = self::DEFAULT_PAGE_HITS

private

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

Referenced by getPageHits(), and setPageHits().

$ref_id

int ilForum::$ref_id

private

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

Referenced by getForumRefId().

$replQuote1

string ilForum::$replQuote1 = '<blockquote class="ilForumQuote">'

private

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

$replQuote2

string ilForum::$replQuote2 = '</blockquote>'

private

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

$settings

ilSetting ilForum::$settings

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

$txtQuote1

string ilForum::$txtQuote1 = "[quote]"

private

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

$txtQuote2

string ilForum::$txtQuote2 = "[/quote]"

private

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

$ui_factory

ILIAS UI Factory ilForum::$ui_factory

private

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

$ui_renderer

ILIAS UI Renderer ilForum::$ui_renderer

private

Definition at line 58 of file class.ilForum.php.

$user

ilObjUser ilForum::$user

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

DEFAULT_PAGE_HITS

const int ilForum::DEFAULT_PAGE_HITS = 30

private

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

SORT_DATE

const int ilForum::SORT_DATE = 2

private

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

SORT_TITLE

const int ilForum::SORT_TITLE = 1

private

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

---

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

• components/ILIAS/Forum/classes/class.ilForum.php