Class Forum core functions for forum. More...

Collaboration diagram for ilForum:

Public Member Functions
	__construct ()
	Constructor public. More...

	setLanguage ($lng)

	setForumId ($a_obj_id)
	set object id which refers to ILIAS obj_id More...

	setForumRefId ($a_ref_id)
	set reference id which refers to ILIAS obj_id More...

	getForumId ()
	get forum id public More...

	getForumRefId ()
	get forum ref_id public More...

	getOrderField ()
	get name of orderField More...

	setDbTable ($dbTable)
	set database table More...

	getDbTable ()
	get name of database table More...

	setMDB2WhereCondition ($query_string, $data_type, $data_value)
	set content for additional condition More...

	getMDB2Query ()
	get content of additional condition More...

	getMDB2DataValue ()
	/* get content of additional condition More...

	getMDB2DataType ()
	get content of additional condition More...

	setPageHits ($pageHits)

	getPageHits ()
	get number of max. More...

	getOneTopic ()
	get one topic-dataset by WhereCondition More...

	getOneThread ()
	get one thread-dataset by WhereCondition More...

	getOnePost ($post)
	get one post-dataset More...

	_lookupPostMessage ($a_id)

	generatePost ($forum_id, $thread_id, $author_id, $display_user_id, $message, $parent_pos, $notify, $subject='', $alias='', $date='', $status=1, $send_activation_mail=0)
	generate new dataset in frm_posts More...

	generateThread ($forum_id, $author_id, $display_user_id, $subject, $message, $notify, $notify_posts, $alias='', $date='', $status=1)
	generate new dataset in frm_threads More...

	moveThreads ($thread_ids=array(), $src_ref_id=0, $dest_top_frm_fk=0)
	Moves all chosen threads and their posts to a new forum. More...

	postCensorship ($message, $pos_pk, $cens=0)
	update dataset in frm_posts with censorship info More...

	deletePost ($post)
	delete post and sub-posts More...

	getUserStatistic ($is_moderator=false)

	getFirstPostByThread ($a_thread_id)
	Get first post of thread. More...

	getModerators ()
	get all users assigned to local role il_frm_moderator_<frm_ref_id> More...

	_getModerators ($a_ref_id)
	get all users assigned to local role il_frm_moderator_<frm_ref_id> (static) More...

	countUserArticles ($a_user_id)
	get number of articles from given user-ID More...

	countActiveUserArticles ($a_user_id)

	convertDate ($date)
	converts the date format More...

	addPostTree ($a_tree_id, $a_node_id=-1, $a_date='')
	create a new post-tree More...

	insertPostNode ($a_node_id, $a_parent_id, $tree_id, $a_date='')
	insert node under parent node public More...

	getPostDepth ($a_node_id, $tree_id)
	Return depth of an object private. More...

	getFirstPostNode ($tree_id)
	get data of the first node from frm_posts_tree and frm_posts public More...

	getPostNode ($post_id)
	get data of given node from frm_posts_tree and frm_posts public More...

	fetchPostNodeData ($a_row)
	get data of parent node from frm_posts_tree and frm_posts private More...

	deletePostTree ($a_node)
	delete node and the whole subtree under this node public More...

	updateVisits ($ID)
	update page hits of given forum- or thread-ID public More...

	prepareText ($text, $edit=0, $quote_user='', $type='')
	prepares given string public More...

	getModeratorFromPost ($pos_pk)
	get one post-dataset More...

	__deletePostFiles ($a_ids)

	getImportName ()

	setImportName ($a_import_name)

	enableForumNotification ($user_id)
	Enable a user's notification about new posts in this forum. More...

	disableForumNotification ($user_id)
	Disable a user's notification about new posts in this forum. More...

	isForumNotificationEnabled ($user_id)
	Check whether a user's notification about new posts in this forum is enabled (result > 0) or not (result == 0) More...

	enableThreadNotification ($user_id, $thread_id)
	Enable a user's notification about new posts in a thread. More...

	isThreadNotificationEnabled ($user_id, $thread_id)
	Check whether a user's notification about new posts in a thread is enabled (result > 0) or not (result == 0) More...

Static Public Member Functions
static	_getLanguageInstanceByUsrId ($usr_id)
	Get the ilLanguage instance for the passed user id. More...

static	_isModerator ($a_ref_id, $a_usr_id)
	checks whether a user is moderator of a given forum object More...

static	_getThreads ($a_obj_id, $a_sort_mode=self::SORT_DATE)
	Get thread infos of object. More...

static	_lookupObjIdForForumId ($a_for_id)

static	updateLastPostByObjId ($a_obj_id)

static	mergeThreads ($obj_id, $source_id, $target_id)

Data Fields
const	SORT_TITLE = 1

const	SORT_DATE = 2

const	DEFAULT_PAGE_HITS = 30

	$ilias

	$lng

Static Protected Attributes
static	$moderators_by_ref_id_map = array()

Private Member Functions
	setOrderField ($orderField)
	set database field for sorting results More...

Private Attributes
	$dbTable

	$className ="ilForum"

	$orderField

	$mdb2Query

	$mdb2DataValue

	$mdb2DataType

	$txtQuote1 = "[quote]"

	$txtQuote2 = "[/quote]"

	$replQuote1 = '<blockquote class="ilForumQuote">'

	$replQuote2 = '</blockquote>'

	$pageHits = self::DEFAULT_PAGE_HITS

	$id

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilForum::__construct ( )

Constructor public.

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

References $ilias, and $lng.

         {
                 global $ilias,$lng;
 
                 $this->ilias = $ilias;
                 $this->lng = $lng;
         }

Member Function Documentation

◆ __deletePostFiles()

ilForum::__deletePostFiles ( $a_ids )

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

References $file, and getForumId().

Referenced by deletePost().

         {
                 if(!is_array($a_ids))
                 {
                         return false;
                 }
                 include_once "./Modules/Forum/classes/class.ilFileDataForum.php";
                 
                 $tmp_file_obj =& new ilFileDataForum($this->getForumId());
                 foreach($a_ids as $pos_id)
                 {
                         $tmp_file_obj->setPosId($pos_id);
                         $files = $tmp_file_obj->getFilesOfPost();
                         foreach($files as $file)
                         {
                                 $tmp_file_obj->unlinkFile($file["name"]);
                         }
                 }
                 unset($tmp_file_obj);
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getLanguageInstanceByUsrId()

static ilForum::_getLanguageInstanceByUsrId ( $usr_id )

static

Get the ilLanguage instance for the passed user id.

Parameters

integer $usr_id a user id

Returns: ilLanguage public

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

References ilObjUser\_lookupLanguage().

         {
                 static $lngCache = array();
                 
                 $languageShorthandle = ilObjUser::_lookupLanguage($usr_id);
                 
                 // lookup in cache array
                 if(!isset($lngCache[$languageShorthandle]))
                 {
                         $lngCache[$languageShorthandle] = new ilLanguage($languageShorthandle);
                         $lngCache[$languageShorthandle]->loadLanguageModule('forum');
                 }
                 
                 return $lngCache[$languageShorthandle];
         }

Here is the call graph for this function:

◆ _getModerators()

ilForum::_getModerators ( $a_ref_id )

get all users assigned to local role il_frm_moderator_<frm_ref_id> (static)

Parameters

int $a_ref_id reference id

Returns: array user_ids public

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

References ilObject\_lookupTitle().

Referenced by _isModerator(), getModerators(), and ilObjForumNotificationDataProvider\getPostActivationRecipients().

         {
                 global $rbacreview;
 
                 $role_arr  = $rbacreview->getRolesOfRoleFolder($a_ref_id);
 
                 foreach ($role_arr as $role_id)
                 {
                         //$roleObj = $this->ilias->obj_factory->getInstanceByObjId($role_id);
                         $title = ilObject::_lookupTitle($role_id);
                         if ($title == "il_frm_moderator_".$a_ref_id)                    
                         {
                                 #return $rbacreview->assignedUsers($roleObj->getId());
                                 return $title = $rbacreview->assignedUsers($role_id);
                         }
                 }
 
                 return array();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getThreads()

static ilForum::_getThreads	(	$a_obj_id,
		$a_sort_mode = `self::SORT_DATE`
	)

static

Get thread infos of object.

public

Parameters

int	obj_id of forum
int	sort mode SORT_TITLE or SORT_DATE

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

References $ilDB, $res, and $row.

Referenced by ilObjForumGUI\cloneWizardPageObject().

         {
                 global $ilDB;
                 
                 switch($a_sort_mode)
                 {
                         case self::SORT_DATE:
                                 $sort = 'thr_date';
                                 break;
                         
                         case self::SORT_TITLE:
                         default:
                                 $sort = 'thr_subject';
                                 break;
                 }
                 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_threads 
                         JOIN frm_data ON top_pk = thr_top_fk 
                         WHERE top_frm_fk = %s
                         ORDER BY %s',
                         array('integer', 'text'), array($a_obj_id, $sort));
                 
                 while($row = $ilDB->fetchObject($res))
                 {
                         $threads[$row->thr_pk] = $row->thr_subject;
                 }
                 return $threads ? $threads : array();
         }

Here is the caller graph for this function:

◆ _isModerator()

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

static

checks whether a user is moderator of a given forum object

Parameters

int	$a_ref_id	reference id
int	$a_usr_id	user id

Returns: bool public

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

References _getModerators().

Referenced by ilForumExportGUI\executeCommand(), and ilObjForumGUI\setTreeStateAsynchObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupObjIdForForumId()

static ilForum::_lookupObjIdForForumId ( $a_for_id )

static

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

References $ilDB, and $res.

Referenced by ilObjMediaObject\getParentObjectIdForUsage(), ilObjForumGUI\mergeThreadsObject(), and ilForumTopic\movePosts().

         {
                 global $ilDB;
                 
                 $res = $ilDB->queryf('
                         SELECT top_frm_fk FROM frm_data
                         WHERE top_pk = %s',
                         array('integer'), array($a_for_id));
                 
                 if ($fdata = $ilDB->fetchAssoc($res))
                 {
                         return $fdata["top_frm_fk"];
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ _lookupPostMessage()

ilForum::_lookupPostMessage ( $a_id )

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

References $ilDB, $res, and $row.

Referenced by ilObjForum\getDiskUsage().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_posts WHERE pos_pk = %s',
                         array('integer'), array($a_id));
                 
                 while($row = $ilDB->fetchObject($res))
                 {
                         return $row->pos_message;
                 }
                 return '';
         }

Here is the caller graph for this function:

◆ addPostTree()

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

create a new post-tree

Parameters

integer	a_tree_id: id where tree belongs to
integer	a_node_id: root node of tree (optional; default is tree_id itself)

Returns: boolean true on success public

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

References $ilDB.

Referenced by generatePost().

         {
                 global $ilDB;
                 
                 $a_date = $a_date ? $a_date : date("Y-m-d H:i:s");
                 
                 if ($a_node_id <= 0)
                 {
                         $a_node_id = $a_tree_id;
                 }
                 
                 $nextId = $ilDB->nextId('frm_posts_tree');
                 
                 $statement = $ilDB->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 )',
                         array('integer','integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'timestamp'),
                         array($nextId, $a_tree_id, $a_node_id, '0', '1', '2', '1', $a_date));           
                 
                 return true;
         }

Here is the caller graph for this function:

◆ convertDate()

ilForum::convertDate ( $date )

converts the date format

Parameters

string $date

Returns: string formatted datetime public

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

References ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

Referenced by getOnePost().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countActiveUserArticles()

ilForum::countActiveUserArticles ( $a_user_id )

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

References $ilDB, $ilUser, $res, and getForumId().

         {
                 global $ilDB, $ilUser;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_data
                         INNER JOIN frm_posts ON pos_top_fk = top_pk
                         WHERE top_frm_fk = %s
                         AND (pos_status = %s
                                 OR (pos_status = %s 
                                         AND pos_author_id = %s
                                         )
                                 )          
                         AND pos_author_id = %s',
                         array('integer', 'integer', 'integer', 'integer', 'integer'),
                         array($this->getForumId(),'1', '0', $ilUser->getId(), $a_user_id));
                 
                 return $res->numRows();
         }

Here is the call graph for this function:

◆ countUserArticles()

ilForum::countUserArticles ( $a_user_id )

get number of articles from given user-ID

Parameters

integer $user, user-ID

Returns: integer public

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

References $ilDB, $res, and getForumId().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_data
                         INNER JOIN frm_posts ON pos_top_fk = top_pk 
                         WHERE top_frm_fk = %s
                         AND pos_author_id = %s',
                         array('integer', 'integer'),
                         array($this->getForumId(), $a_user_id));
                 
                 return $res->numRows();
         }       

Here is the call graph for this function:

◆ deletePost()

ilForum::deletePost ( $post )

delete post and sub-posts

Parameters

integer $post, ID public

Returns: integer 0 or thread-ID

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

References $data, $GLOBALS, $ilDB, $ilSetting, $ilUser, $mobs, $params, $query, $res, $row, __deletePostFiles(), ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), deletePostTree(), ilForumProperties\FORUM_OVERVIEW_WITH_NEW_POSTS, ilNewsItem\getFirstNewsIdForContext(), getForumId(), getForumRefId(), ilForumProperties\getInstance(), and getPostNode().

         {
                 global $ilDB;
 
                 include_once "./Modules/Forum/classes/class.ilObjForum.php";
 
                 $p_node = $this->getPostNode($post);
 
                 $GLOBALS['ilAppEventHandler']->raise(
                         'Modules/Forum',
                         'deletedPost',
                         array(
                                 'ref_id' => $this->getForumRefId(),
                                 'post'           => new ilForumPost($post),
                                 'thread_deleted' => ($p_node["parent"] == 0)? true : false
                         )
                 );
 
                 // delete tree and get id's of all posts to delete
                 $del_id = $this->deletePostTree($p_node);
 
                 // Delete User read entries
                 foreach($del_id as $post_id)
                 {
                         ilObjForum::_deleteReadEntries($post_id);
                 }
 
                 // DELETE ATTACHMENTS ASSIGNED TO POST
                 $this->__deletePostFiles($del_id);
                 
                 $dead_pos = count($del_id);
                 $dead_thr = 0;
 
                 // if deletePost is thread opener ...
                 if ($p_node["parent"] == 0)
                 {
                         // delete thread access data
                         include_once './Modules/Forum/classes/class.ilObjForum.php';
 
                         ilObjForum::_deleteAccessEntries($p_node['tree']);
 
                         // delete thread
                         $dead_thr = $p_node["tree"];
 
                         $statement = $ilDB->manipulateF('
                                 DELETE FROM frm_threads
                                 WHERE thr_pk = %s',
                                 array('integer'), array($p_node['tree']));
 
                         // update num_threads
                         $statement = $ilDB->manipulateF('
                                 UPDATE frm_data 
                                 SET top_num_threads = top_num_threads - 1 
                                 WHERE top_frm_fk = %s',
                                 array('integer'), array($this->id));
                         
                         // delete all related news
                         $posset = $ilDB->queryf('
                                 SELECT * FROM frm_posts
                                 WHERE pos_thr_fk = %s',
                                 array('integer'), array($p_node['tree']));
                         
                         while ($posrec = $ilDB->fetchAssoc($posset))
                         {
                                 include_once("./Services/News/classes/class.ilNewsItem.php");
                                 $news_id = ilNewsItem::getFirstNewsIdForContext($this->id,
                                         "frm", $posrec["pos_pk"], "pos");
                                 if ($news_id > 0)
                                 {
                                         $news_item = new ilNewsItem($news_id);
                                         $news_item->delete();
                                 }
                                 
                                 try
                                 {
                                         include_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                                         $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', $posrec['pos_pk']);
                                         foreach($mobs as $mob)
                                         {                                               
                                                 if(ilObjMediaObject::_exists($mob))
                                                 {
                                                         ilObjMediaObject::_removeUsage($mob, 'frm:html', $posrec['pos_pk']);
                                                         $mob_obj = new ilObjMediaObject($mob);
                                                         $mob_obj->delete();
                                                 }
                                         }
                                 }
                                 catch(Exception $e)
                                 {
                                 }
                         }
                         
                         
                         // delete all posts of this thread
                         $statement = $ilDB->manipulateF('
                                 DELETE FROM frm_posts
                                 WHERE pos_thr_fk = %s',
                                 array('integer'), array($p_node['tree']));
                         
                 }
                 else
                 {
 
                         // delete this post and its sub-posts
                         for ($i = 0; $i < $dead_pos; $i++)
                         {
                                 $statement = $ilDB->manipulateF('
                                         DELETE FROM frm_posts
                                         WHERE pos_pk = %s',
                                         array('integer'), array($del_id[$i]));
                                 
                                 // delete related news item
                                 include_once("./Services/News/classes/class.ilNewsItem.php");
                                 $news_id = ilNewsItem::getFirstNewsIdForContext($this->id,
                                         "frm", $del_id[$i], "pos");
                                 if ($news_id > 0)
                                 {
                                         $news_item = new ilNewsItem($news_id);
                                         $news_item->delete();
                                 }
                                 
                                 try
                                 {
                                         include_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                                         $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', $del_id[$i]);
                                         foreach($mobs as $mob)
                                         {                                               
                                                 if(ilObjMediaObject::_exists($mob))
                                                 {
                                                         ilObjMediaObject::_removeUsage($mob, 'frm:html', $del_id[$i]);
                                                         $mob_obj = new ilObjMediaObject($mob);
                                                         $mob_obj->delete();
                                                 }
                                         }
                                 }
                                 catch(Exception $e)
                                 {
                                 }
                         }
                         
                         // update num_posts in frm_threads
                         $statement = $ilDB->manipulateF('
                                 UPDATE frm_threads
                                 SET thr_num_posts = thr_num_posts - %s
                                 WHERE thr_pk = %s',
                                 array('integer', 'integer'),
                                 array($dead_pos, $p_node['tree']));
                         
                         
                         // get latest post of thread and update last_post
                         $res1 = $ilDB->queryf('
                                 SELECT * FROM frm_posts 
                                 WHERE pos_thr_fk = %s
                                 ORDER BY pos_date DESC',
                                 array('integer'), array($p_node['tree']));
                         
                         if ($res1->numRows() == 0)
                         {
                                 $lastPost_thr = "";
                         }
                         else
                         {
                                 $z = 0;
 
                                 while ($selData = $ilDB->fetchAssoc($res1))
                                 {
                                         if ($z > 0)
                                         {
                                                 break;
                                         }
 
                                         $lastPost_thr = $selData["pos_top_fk"]."#".$selData["pos_thr_fk"]."#".$selData["pos_pk"];
                                         $z ++;
                                 }
                         }
                         
                         $statement = $ilDB->manipulateF('
                                 UPDATE frm_threads
                                 SET thr_last_post = %s
                                 WHERE thr_pk = %s',
                                 array('text', 'integer'), array($lastPost_thr, $p_node['tree']));
                 }
                 
                 // update num_posts in frm_data
                 $statement = $ilDB->manipulateF('
                         UPDATE frm_data
                         SET top_num_posts = top_num_posts - %s
                         WHERE top_frm_fk = %s',
                         array('integer', 'integer'), array($dead_pos, $this->id));
                 
                 
                 // get latest post of forum and update last_post
                 $res2 = $ilDB->queryf('
                         SELECT * FROM frm_posts, frm_data 
                         WHERE pos_top_fk = top_pk 
                         AND top_frm_fk = %s
                         ORDER BY pos_date DESC',
                         array('integer'), array($this->id));
                 
                 if ($res2->numRows() == 0)
                 {
                         $lastPost_top = "";
                 }
                 else
                 {
                         $z = 0;
 
                         while ($selData = $ilDB->fetchAssoc($res2))
                         {
                                 if ($z > 0)
                                 {
                                         break;
                                 }
 
                                 $lastPost_top = $selData["pos_top_fk"]."#".$selData["pos_thr_fk"]."#".$selData["pos_pk"];
                                 $z ++;
                         }
                 }
                 
                 $statement = $ilDB->manipulateF('
                         UPDATE frm_data
                         SET top_last_post = %s
                         WHERE top_frm_fk = %s',
                         array('text', 'integer'), array($lastPost_top, $this->id));
                 
                 return $dead_thr;               
         }

Here is the call graph for this function:

◆ deletePostTree()

ilForum::deletePostTree ( $a_node )

delete node and the whole subtree under this node public

Parameters

array node_data of a node

Returns: array ID's of deleted posts

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

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

Referenced by deletePost().

         {
                 global $ilDB;
                 
                 // GET LEFT AND RIGHT VALUES
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_posts_tree
                         WHERE thr_fk = %s 
                         AND pos_fk = %s
                         AND parent_pos = %s',
                         array('integer', 'integer', 'integer'), 
                         array($a_node['tree'], $a_node['pos_pk'], $a_node['parent']));
                 
                 while($row = $ilDB->fetchObject($res))
                 {
                         $a_node["lft"] = $row->lft;
                         $a_node["rgt"] = $row->rgt;
                 }
 
                 $diff = $a_node["rgt"] - $a_node["lft"] + 1;            
                 
                 // get data of posts
                 $result = $ilDB->queryf('
                         SELECT * FROM frm_posts_tree 
                         WHERE lft BETWEEN %s AND %s
                         AND thr_fk = %s',
                         array('integer', 'integer', 'integer'),
                         array($a_node['lft'], $a_node['rgt'], $a_node['tree']));
                 
                 $del_id = array();
                 
                 while ($treeData = $ilDB->fetchAssoc($result))
                 {
                         $del_id[] = $treeData["pos_fk"];
                 }
                 
                 // delete subtree
                 $statement = $ilDB->manipulateF('
                         DELETE FROM frm_posts_tree
                         WHERE lft BETWEEN %s AND %s
                         AND thr_fk = %s',
                         array('integer', 'integer', 'integer'),
                         array($a_node['lft'], $a_node['rgt'], $a_node['tree']));
 
                 
                 // close gaps
                 $statement = $ilDB->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',
                         array('integer', 'integer', 'integer', 'integer', 'integer'),
                         array($a_node['lft'], $diff, $a_node['lft'], $diff, $a_node['tree']));
                 
                 return $del_id;
 
         }

Here is the caller graph for this function:

◆ disableForumNotification()

ilForum::disableForumNotification ( $user_id )

Disable a user's notification about new posts in this forum.

Parameters

integer user_id A user's ID

Returns: bool true private

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

References $ilDB.

         {
                 global $ilDB;
                 
                 $statement = $ilDB->manipulateF('
                         DELETE FROM frm_notification 
                         WHERE user_id = %s
                         AND frm_id = %s',
                         array('integer', 'integer'),
                         array($user_id, $this->id));
                 
                 return true;
         }

◆ enableForumNotification()

ilForum::enableForumNotification ( $user_id )

Enable a user's notification about new posts in this forum.

Parameters

integer user_id A user's ID

Returns: bool true private

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

References $ilDB, $query, $res, $row, and isForumNotificationEnabled().

         {
                 global $ilDB;
 
                 if (!$this->isForumNotificationEnabled($user_id))
                 {
                         /* Remove all notifications of threads that belong to the forum */ 
                                 
                         $res = $ilDB->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',
                                 array('integer', 'integer'),
                                 array($user_id, $this->id));
                         
                         if (is_object($res) && $res->numRows() > 0)
                         {
                                 $thread_data = array();
                                 $thread_data_types = array();                           
 
                                 $query = ' DELETE FROM frm_notification 
                                                         WHERE user_id = %s 
                                                         AND thread_id IN (';
                                 
                                 array_push($thread_data, $user_id);
                                 array_push($thread_data_types, 'integer');
                                 
                                 $counter = 1;
 
                                 while($row = $ilDB->fetchAssoc($res))
                                 {       
                                         if($counter < $res->numRows())
                                         {       
                                                 $query .= '%s, ';
                                                 array_push($thread_data, $row['thread_id']);
                                                 array_push($thread_data_types, 'integer');
                                         }
                         
                                         if($counter == $res->numRows())
                                         {
                                                 $query .= '%s)';
                                                 array_push($thread_data, $row['thread_id']);
                                                 array_push($thread_data_types, 'integer');
                                                 
                                         }
                                         $counter++;
                                 }
 
                                 $statement = $ilDB->manipulateF($query, $thread_data_types, $thread_data);
                         }
 
                         /* Insert forum notification */ 
 
                         $nextId = $ilDB->nextId('frm_notification');
                         
                         $statement = $ilDB->manipulateF('
                                 INSERT INTO frm_notification
                                 (       notification_id,
                                         user_id, 
                                         frm_id
                                 )
                                 VALUES(%s, %s, %s)',
                                 array('integer','integer', 'integer'),
                                 array($nextId, $user_id, $this->id));
                 
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ enableThreadNotification()

ilForum::enableThreadNotification	(	$user_id,
		$thread_id
	)

Enable a user's notification about new posts in a thread.

Parameters

integer	user_id A user's ID
integer	thread_id ID of the thread

Returns: bool true private

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

References $ilDB, and isThreadNotificationEnabled().

         {
                 global $ilDB;
                 
                 if (!$this->isThreadNotificationEnabled($user_id, $thread_id))
                 {
                         $nextId = $ilDB->nextId('frm_notification');
                         $statement = $ilDB->manipulateF('
                                 INSERT INTO frm_notification
                                 (       notification_id,
                                         user_id,
                                         thread_id
                                 )
                                 VALUES (%s, %s, %s)',
                                 array('integer', 'integer', 'integer'), array($nextId, $user_id, $thread_id));
                         
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ fetchPostNodeData()

ilForum::fetchPostNodeData ( $a_row )

get data of parent node from frm_posts_tree and frm_posts private

Parameters

object db db result object containing node_data

Returns: array 2-dim (int/str) node_data

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

References $data, $lng, and ilObject\_exists().

Referenced by getFirstPostNode(), and getPostNode().

         {
                 global $lng;
 
                 require_once('./Services/User/classes/class.ilObjUser.php');
                 
                 if (ilObject::_exists($a_row->pos_display_user_id))
                 {
                         $tmp_user = new ilObjUser($a_row->pos_display_user_id);
                         $fullname = $tmp_user->getFullname();
                         $loginname = $tmp_user->getLogin();
                 }
         
                 $fullname = $fullname ? $fullname : ($a_row->import_name ? $a_row->import_name : $lng->txt("unknown"));
 
                 $data = array(
                                         "pos_pk"                => $a_row->pos_pk,
                                         "child"         => $a_row->pos_pk,
                                         "author"                => $a_row->pos_display_user_id,
                                         "alias"                 => $a_row->pos_usr_alias,
                                         "title"         => $fullname,
                                         "loginname"             => $loginname,
                                         "type"          => "post",
                                         "message"               => $a_row->pos_message,
                                         "subject"               => $a_row->pos_subject, 
                                         "pos_cens_com"  => $a_row->pos_cens_com,
                                         "pos_cens"              => $a_row->pos_cens,
                                 //      "date"                  => $a_row->date,
                                         "date"                  => $a_row->fpt_date,
                                         "create_date"   => $a_row->pos_date,
                                         "update"                => $a_row->pos_update,                                  
                                         "update_user"   => $a_row->update_user,
                                         "tree"                  => $a_row->thr_fk,                                      
                                         "parent"                => $a_row->parent_pos,
                                         "lft"                   => $a_row->lft,
                                         "rgt"                   => $a_row->rgt,
                                         "depth"                 => $a_row->depth,
                                         "id"                    => $a_row->fpt_pk,
                                         "notify"                => $a_row->notify,
                                         "import_name"   => $a_row->import_name,
                                         "pos_status"   => $a_row->pos_status
                                         );
                 
                 // why this line? data should be stored without slashes in db
                 //$data["message"] = stripslashes($data["message"]);
 
                 return $data ? $data : array();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generatePost()

ilForum::generatePost	(	$forum_id,
		$thread_id,
		$author_id,
		$display_user_id,
		$message,
		$parent_pos,
		$notify,
		$subject = `''`,
		$alias = `''`,
		$date = `''`,
		$status = `1`,
		$send_activation_mail = `0`
	)

generate new dataset in frm_posts

Parameters

integer	$topic
integer	$thread
integer	$author_id
integer	$display_user_id
string	$message
integer	$parent_pos
integer	$notify
integer	$anonymize
string	$subject
datetime	$date

Returns: integer $last: new post ID public

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

References $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), addPostTree(), getForumRefId(), getImportName(), ilObjectFactory\getInstanceByRefId(), insertPostNode(), NEWS_NOTICE, NEWS_USERS, and prepareText().

Referenced by generateThread().

         {
                 global $ilDB;
         
                 $objNewPost = new ilForumPost();
                 $objNewPost->setForumId($forum_id);
                 $objNewPost->setThreadId($thread_id);
                 $objNewPost->setSubject($subject);
                 $objNewPost->setMessage($message);
                 $objNewPost->setDisplayUserId($display_user_id);
                 $objNewPost->setUserAlias($alias);
                 $objNewPost->setPosAuthorId($author_id);
                 
                 self::_isModerator($this->getForumRefId(), $author_id) ? $is_moderator = true : $is_moderator = false; 
                 $objNewPost->setIsAuthorModerator($is_moderator);
                 
                 if ($date == "")
                 {
                         $objNewPost->setCreateDate(date("Y-m-d H:i:s"));
                 }
                 else
                 {
                         if (strpos($date, "-") >  0)            // in mysql format
                         {
                                 $objNewPost->setCreateDate($date);
                         }
                         else                                                            // a timestamp
                         {
                                 $objNewPost->setCreateDate(date("Y-m-d H:i:s", $date));
                         }
                 }
                 if($status == 1)
                 {
                         $objNewPost->setPostActivationDate($objNewPost->getCreateDate());
                 }
 
                 $objNewPost->setImportName($this->getImportName());
                 $objNewPost->setNotification($notify);
                 $objNewPost->setStatus($status);
                 $objNewPost->insert();
                 
                 // entry in tree-table
                 if ($parent_pos == 0)
                 {
                         $this->addPostTree($objNewPost->getThreadId(), $objNewPost->getId(), $objNewPost->getCreateDate());
                 }
                 else
                 {
                         $this->insertPostNode($objNewPost->getId(), $parent_pos, $objNewPost->getThreadId(), $objNewPost->getCreateDate());
                 }
                 
                 // string last post
                 $lastPost = $objNewPost->getForumId()."#".$objNewPost->getThreadId()."#".$objNewPost->getId();
                         
                 // update thread
                 $result = $ilDB->manipulateF('
                         UPDATE frm_threads 
                         SET thr_num_posts = thr_num_posts + 1,
                                 thr_last_post = %s
                         WHERE thr_pk = %s',
                         array('text', 'integer'),
                         array($lastPost, $objNewPost->getThreadId()));
                 
                 // update forum
                 $result = $ilDB->manipulateF('
                         UPDATE frm_data 
                         SET top_num_posts = top_num_posts + 1,
                                 top_last_post = %s
                         WHERE top_pk = %s',
                         array('text', 'integer'),
                         array($lastPost, $objNewPost->getForumId()));
                 
                 // MARK READ
                 $forum_obj = ilObjectFactory::getInstanceByRefId($this->getForumRefId());
                 $forum_obj->markPostRead($objNewPost->getPosAuthorId(), $objNewPost->getThreadId(), $objNewPost->getId());
 
                 // Add Notification to news
                 if($status)
                 {
                         require_once 'Services/RTE/classes/class.ilRTE.php';
                         include_once("./Services/News/classes/class.ilNewsItem.php");
                         $news_item = new ilNewsItem();
                         $news_item->setContext($forum_obj->getId(), 'frm', $objNewPost->getId(), 'pos');
                         $news_item->setPriority(NEWS_NOTICE);
                         $news_item->setTitle($objNewPost->getSubject());
                         $news_item->setContent(ilRTE::_replaceMediaObjectImageSrc($this->prepareText($objNewPost->getMessage(), 0), 1));
                         $news_item->setUserId($display_user_id);
                         $news_item->setVisibility(NEWS_USERS);
                         $news_item->create();
                 }
 
                 return $objNewPost->getId();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateThread()

ilForum::generateThread	(	$forum_id,
		$author_id,
		$display_user_id,
		$subject,
		$message,
		$notify,
		$notify_posts,
		$alias = `''`,
		$date = `''`,
		$status = `1`
	)

generate new dataset in frm_threads

Parameters

integer	$topic
integer	$author_id
integer	$display_user_id
string	$subject
string	$message
integer	$notify
integer	$notify_posts
integer	$anonymize
datetime	$date

Returns: integer new post ID public

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

References $ilDB, generatePost(), and getImportName().

         {       
                 global $ilDB;
 
                 $objNewThread = new ilForumTopic();
                 $objNewThread->setForumId($forum_id);
                 $objNewThread->setDisplayUserId($display_user_id);
                 $objNewThread->setSubject($subject);
                 $objNewThread->setThrAuthorId($author_id);
                 
                 if ($date == "")
                 {
                         $objNewThread->setCreateDate(date("Y-m-d H:i:s"));
                 }
                 else
                 {
                         if (strpos($date, "-") >  0)            // in mysql format
                         {
                                 $objNewThread->setCreateDate($date);
                         }
                         else                                                            // a timestamp
                         {
                                 $objNewThread->setCreateDate(date("Y-m-d H:i:s", $date));
                         }
                 }
                 $objNewThread->setImportName($this->getImportName());
                 $objNewThread->setUserAlias($alias);
                 $objNewThread->insert();
                 
                 if ($notify_posts == 1)
                 {
                         $objNewThread->enableNotification($author_id);
                 }
                         
                 // update forum
                 $statement = $ilDB->manipulateF('
                         UPDATE frm_data 
                         SET top_num_threads = top_num_threads + 1
                         WHERE top_pk = %s',
                         array('integer'), array($forum_id));
                 
                 return $this->generatePost($forum_id, $objNewThread->getId(), $author_id, $display_user_id, $message, 0, $notify, $subject, $alias, $objNewThread->getCreateDate(), $status, 0);
         }

Here is the call graph for this function:

◆ getDbTable()

ilForum::getDbTable ( )

get name of database table

Returns: string name of database table

See also: $dbTable User interface

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

References $dbTable.

         {
                 return $this->dbTable;
         }

◆ getFirstPostByThread()

ilForum::getFirstPostByThread ( $a_thread_id )

Get first post of thread.

public

Parameters

int thread id

Returns

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

References $ilDB, $res, and $row.

         {       
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_posts_tree 
                         WHERE thr_fk = %s
                         AND parent_pos = %s',
                         array('integer', 'integer'), array($a_thread_id, '0'));
 
                 $row = $ilDB->fetchObject($res);
                 
                 return $row->pos_fk ? $row->pos_fk : 0;
         }

◆ getFirstPostNode()

ilForum::getFirstPostNode ( $tree_id )

get data of the first node from frm_posts_tree and frm_posts public

Parameters

integer tree id

Returns: object db result object

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

References $ilDB, $res, $row, and fetchPostNodeData().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_posts, frm_posts_tree 
                         WHERE pos_pk = pos_fk 
                         AND parent_pos = %s
                         AND thr_fk = %s',
                         array('integer', 'integer'),
                         array('0', $tree_id));
                 
                 $row = $ilDB->fetchObject($res);
                 
                 return $this->fetchPostNodeData($row);
         }

Here is the call graph for this function:

◆ getForumId()

ilForum::getForumId ( )

get forum id public

Returns: integer object id of forum

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

References $id.

Referenced by __deletePostFiles(), countActiveUserArticles(), countUserArticles(), deletePost(), and getUserStatistic().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getForumRefId()

ilForum::getForumRefId ( )

get forum ref_id public

Returns: integer reference id of forum

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

References $ref_id.

Referenced by deletePost(), generatePost(), getModerators(), and postCensorship().

         {
                 return $this->ref_id;
         }

Here is the caller graph for this function:

◆ getImportName()

ilForum::getImportName ( )

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

Referenced by generatePost(), and generateThread().

         {
                 return $this->import_name;
         }

Here is the caller graph for this function:

◆ getMDB2DataType()

ilForum::getMDB2DataType ( )

get content of additional condition

Returns: array

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

References $mdb2DataType.

Referenced by getOneThread(), getOneTopic(), and updateVisits().

         {
                 if($this->mdb2DataType != '')
                 {
                         return $this->mdb2DataType;
                 }
         }

Here is the caller graph for this function:

◆ getMDB2DataValue()

ilForum::getMDB2DataValue ( )

/* get content of additional condition

Returns: array

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

References $mdb2DataValue.

Referenced by getOneThread(), getOneTopic(), and updateVisits().

         {
                 if($this->mdb2DataValue != '')
                 {
                         return $this->mdb2DataValue;
                 }
         }

Here is the caller graph for this function:

◆ getMDB2Query()

ilForum::getMDB2Query ( )

get content of additional condition

Returns: string

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

References $mdb2Query.

Referenced by getOneThread(), getOneTopic(), and updateVisits().

         {
                 if($this->mdb2Query != '')
                 {
                         return $this->mdb2Query;
                 }
                 
         }

Here is the caller graph for this function:

◆ getModeratorFromPost()

ilForum::getModeratorFromPost ( $pos_pk )

get one post-dataset

Parameters

integer post id

Returns: array result dataset of the post public

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

References $ilDB, $res, and $row.

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT frm_data.* FROM frm_data, frm_posts 
                         WHERE pos_pk = %s
                         AND pos_top_fk = top_pk',
                         array('integer'), array($pos_pk));
                 
                 $row = $ilDB->fetchAssoc($res);
                 
                 return $row;
                 
         }

◆ getModerators()

ilForum::getModerators ( )

get all users assigned to local role il_frm_moderator_<frm_ref_id>

Returns: array user_ids public

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

References _getModerators(), and getForumRefId().

         {
                 global $rbacreview;
 
                 return $this->_getModerators($this->getForumRefId());
         }

Here is the call graph for this function:

◆ getOnePost()

ilForum::getOnePost ( $post )

get one post-dataset

Parameters

integer post id

Returns: array result dataset of the post public

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

References $ilDB, $res, $row, and convertDate().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT frm_posts.*, usr_data.lastname FROM frm_posts, usr_data 
                         WHERE pos_pk = %s
                         AND pos_display_user_id = usr_id',
                         array('integer'), array($post));
 
                 $row = $ilDB->fetchAssoc($res);
                 
                 
                 $row["pos_date"] = $this->convertDate($row["pos_date"]);                
                 $row["pos_message"] = nl2br($row["pos_message"]);
                                         
                 return $row;
         }

Here is the call graph for this function:

◆ getOneThread()

ilForum::getOneThread ( )

get one thread-dataset by WhereCondition

Returns: array $result dataset of the thread public

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

References $ilDB, $query, $result, getMDB2DataType(), getMDB2DataValue(), and getMDB2Query().

         {       
                 global $ilDB;
                         
                 $data_type = array();
                 $data_value = array();
                 
                 $query = 'SELECT * FROM frm_threads WHERE ';
                 
                 if($this->getMDB2Query() != '' && $this->getMDB2DataType() != '' && $this->getMDB2DataValue() != '')
                 {
                         $query .= $this->getMDB2Query();
                         $data_type = $data_type + $this->getMDB2DataType();
                         $data_value = $data_value + $this->getMDB2DataValue();
                         
                         $sql_res = $ilDB->queryf($query, $data_type, $data_value);
                         $result = $ilDB->fetchAssoc($sql_res);
                         $result["thr_subject"] = trim($result["thr_subject"]);
                 }
 
                 return $result;
         }

Here is the call graph for this function:

◆ getOneTopic()

ilForum::getOneTopic ( )

get one topic-dataset by WhereCondition

Returns: array $result dataset of the topic public

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

References $ilDB, $query, $res, $row, getMDB2DataType(), getMDB2DataValue(), and getMDB2Query().

Referenced by moveThreads().

         {
                 global $ilDB;
                 
                 $data_type = array();
                 $data_value = array();
                 
                 $query = 'SELECT * FROM frm_data WHERE ';
                 
                 if($this->getMDB2Query() != '' && $this->getMDB2DataType() != '' && $this->getMDB2DataValue() != '')
                 {
                         $query .= ''.$this->getMDB2Query().'';
                         $data_type = $data_type + $this->getMDB2DataType();
                         $data_value = $data_value + $this->getMDB2DataValue();
 
                         $res = $ilDB->queryf($query, $data_type, $data_value);                  
                         $row = $ilDB->fetchAssoc($res);
                         
                         if(is_null($row)) return NULL;
                         
                         $row["top_name"] = trim($row["top_name"]);
                         $row["top_description"] = nl2br($row["top_description"]);
 
                         return $row;
                         
                 }
                 else
                 {                       
                         $query .= '1 = 1';
                 
                         $res = $ilDB->query($query);                    
                         $row = $ilDB->fetchAssoc($res);
                         
                         if(!is_array($row) || !count($row)) return null;
                         
                         $row['top_name'] = trim($row['top_name']);
                         $row['top_description'] = nl2br($row['top_description']);
         
                         return $row;                    
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrderField()

ilForum::getOrderField ( )

get name of orderField

Returns: string name of orderField

See also: $orderField User interface

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

References $orderField.

         {
                 return $this->orderField;
         }

◆ getPageHits()

ilForum::getPageHits ( )

get number of max.

visible datasets

Returns: integer $pageHits

See also: $pageHits User interface

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

References $pageHits.

         {
                 return $this->pageHits;
         }

◆ getPostDepth()

ilForum::getPostDepth	(	$a_node_id,
		$tree_id
	)

Return depth of an object private.

Parameters

integer	node_id of parent's node_id
integer	node_id of parent's node parent_id

Returns: integer depth of node

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

References $ilDB, and $res.

Referenced by insertPostNode().

         {
                 global $ilDB;
 
                 if ($tree_id)
                 {
                         $sql_res = $ilDB->queryf('
                                 SELECT depth FROM frm_posts_tree
                                 WHERE pos_fk = %s
                                 AND thr_fk = %s',
                                 array('integer', 'integer'),
                                 array($a_node_id, $tree_id));
                         
                         $res = $ilDB->fetchObject($sql_res);
                         
                         return $res->depth;
                 }
                 else
                 {
                         return 0;
                 }
         }

Here is the caller graph for this function:

◆ getPostNode()

ilForum::getPostNode ( $post_id )

get data of given node from frm_posts_tree and frm_posts public

Parameters

integer post_id

Returns: object db result object

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

References $ilDB, $res, $row, and fetchPostNodeData().

Referenced by deletePost().

         {
                 global $ilDB;
 
                 $res = $ilDB->queryf('
                         SELECT * FROM frm_posts, frm_posts_tree 
                         WHERE pos_pk = pos_fk 
                         AND pos_pk = %s',
                         array('integer'),
                         array($post_id));
                 
                 $row = $ilDB->fetchObject($res);
 
                 return $this->fetchPostNodeData($row);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserStatistic()

ilForum::getUserStatistic ( $is_moderator = false )

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

References $data, $ilDB, $ilUser, $query, $res, $row, and getForumId().

         {
                 global $ilDB, $ilUser;
                 
                 $statistic = array();
                 
                 $data_types = array();
                 $data = array();
                 
                 $query = "SELECT COUNT(f.pos_display_user_id) ranking, u.login, p.value, u.lastname, u.firstname
                                         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_display_user_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 1 = 1";
         
                 array_push($data_types, 'text');
                 array_push($data, 'public_profile');
 
                 if (!$is_moderator) 
                 {
                         $query .= ' AND (pos_status = %s
                                                 OR (pos_status = %s
                                                 AND pos_author_id = %s ))';
                         
                         array_push($data_types,'integer', 'integer', 'integer');
                         array_push($data, '1', '0', $ilUser->getId());
                 }
                 
                 $query .= ' AND d.top_frm_fk = %s
                                         GROUP BY pos_display_user_id, u.login, p.value,u.lastname, u.firstname';
 
                 array_push($data_types,'integer');
                 array_push($data, $this->getForumId());
         
 
                 
                 $res = $ilDB->queryf($query, $data_types, $data);
                 
                 $counter = 0;
                 while ($row = $ilDB->fetchAssoc($res))
                 {
                     $statistic[$counter][] = $row['ranking'];
                     $statistic[$counter][] = $row['login'];
 
                         $lastname ='';
                         $firstname = '';
                         if(!$ilUser->isAnonymous() && in_array($row['value'], array('y', 'g')) ||
                             $ilUser->isAnonymous() && 'g' == $row['value'])
                         {
                                 $lastname = $row['lastname'];
                                 $firstname = $row['firstname'];
                         }
 
                         $statistic[$counter][] = $lastname;
                     $statistic[$counter][] = $firstname;
                         
                     ++$counter;
                 }         
                           
                 return is_array($statistic) ? $statistic : array();                     
         }

Here is the call graph for this function:

◆ insertPostNode()

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

insert node under parent node public

Parameters

integer	node_id
integer	tree_id
integer	parent_id (optional)

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

References $ilDB, $res, and getPostDepth().

Referenced by generatePost().

         {               
                 global $ilDB;
 
                 $a_date = $a_date ? $a_date : date("Y-m-d H:i:s");
                 
                 // get left value
                 $sql_res = $ilDB->queryf('
                         SELECT * FROM frm_posts_tree
                         WHERE pos_fk = %s
                         AND thr_fk = %s',
                         array('integer', 'integer'),
                         array($a_parent_id, $tree_id));
                 
                 $res = $ilDB->fetchObject($sql_res);
                 
                 $left = $res->lft;
 
                 $lft = $left + 1;
                 $rgt = $left + 2;
 
                 // spread tree
                 $statement = $ilDB->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',
                         array('integer', 'integer', 'integer'),
                         array($left, $left, $tree_id));
                 
                 $depth = $this->getPostDepth($a_parent_id, $tree_id) + 1;
         
                 // insert node
                 $nextId = $ilDB->nextId('frm_posts_tree');
                 $statement = $ilDB->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)',
                         array('integer','integer', 'integer', 'integer', 'integer', 'integer', 'integer', 'timestamp'),
                         array(  $nextId,
                                         $tree_id, 
                                         $a_node_id, 
                                         $a_parent_id,
                                         $lft,
                                         $rgt,
                                         $depth,
                                         $a_date)
                 );
                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isForumNotificationEnabled()

ilForum::isForumNotificationEnabled ( $user_id )

Check whether a user's notification about new posts in this forum is enabled (result > 0) or not (result == 0)

Parameters

integer user_id A user's ID

Returns: integer Result private

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

References $ilDB, and $result.

Referenced by enableForumNotification().

         {
                 global $ilDB;
 
                 $result = $ilDB->queryf('SELECT COUNT(*) cnt FROM frm_notification WHERE user_id = %s AND frm_id = %s',
                     array('integer', 'integer'), array($user_id, $this->id));
                  
                 while($record = $ilDB->fetchAssoc($result))
                 {               
                         return (bool)$record['cnt'];
                 }
                 
                 return false;
         }

Here is the caller graph for this function:

◆ isThreadNotificationEnabled()

ilForum::isThreadNotificationEnabled	(	$user_id,
		$thread_id
	)

Check whether a user's notification about new posts in a thread is enabled (result > 0) or not (result == 0)

Parameters

integer	user_id A user's ID
integer	thread_id ID of the thread

Returns: integer Result private

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

References $ilDB, and $result.

Referenced by enableThreadNotification().

         {
                 global $ilDB;
 
                 $result = $ilDB->queryf('
                         SELECT COUNT(*) cnt FROM frm_notification 
                         WHERE user_id = %s 
                         AND thread_id = %s',
                         array('integer', 'integer'),
                         array($user_id, $thread_id));                           
 
                                 
                 while($record = $ilDB->fetchAssoc($result))
                 {
                         return (bool)$record['cnt'];
                 }
                 
                 return false;
         }

Here is the caller graph for this function:

◆ mergeThreads()

static ilForum::mergeThreads	(	$obj_id,
		$source_id,
		$target_id
	)

static

Parameters

$obj_id
$source_id
$target_id

Exceptions

ilException

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

References $target_id, ilForumTopic\deleteByThreadId(), ilObjForum\mergeForumUserRead(), ilForumPost\mergePosts(), ilForumNotification\mergeThreadNotificiations(), updateLastPostByObjId(), and ilForumPostsTree\updateTargetRootRgt().

Referenced by ilObjForumGUI\confirmMergeThreadsObject().

         {
                 // selected source & target objects
                 $source_thread_obj = new ilForumTopic((int)$source_id);
                 $target_thread_obj = new ilForumTopic((int)$target_id);
 
                 if($source_thread_obj->getForumId() != $target_thread_obj->getForumId())
                 {
                         throw new ilException('not_allowed_to_merge_into_another_forum');
                 }
                 // use the "older" thread as target
                 if($source_thread_obj->getCreateDate() > $target_thread_obj->getCreateDate())
                 {
                         $merge_thread_source = $source_thread_obj;
                         $merge_thread_target = $target_thread_obj;
                 }
                 else
                 {
                         $merge_thread_source = $target_thread_obj;
                         $merge_thread_target = $source_thread_obj;
                 }
 
                 $thread_subject = $target_thread_obj->getSubject();
 
                 // remember if the threads are open or closed and then close both threads ! 
                 $targed_was_closed = $merge_thread_target->isClosed();
 
                 $merge_thread_source->close();
 
                 if($targed_was_closed == false)
                 {
                         $merge_thread_target->close();
                 }
 
                 $source_all_posts = $merge_thread_source->getAllPosts();
                 $source_root_node = $merge_thread_source->getFirstPostNode();
                 $target_root_node = $merge_thread_target->getFirstPostNode();
 
                 $add_difference = $target_root_node->getRgt();
 
 // update target root node rgt
                 include_once 'Modules/Forum/classes/class.ilForumPostsTree.php';
 //              $new_target_rgt = ($target_root_node->getRgt() + $source_root_node->getRgt() + 1);
                 $new_target_rgt = ($target_root_node->getRgt() + $source_root_node->getRgt());
                 ilForumPostsTree::updateTargetRootRgt($target_root_node->getId(), $new_target_rgt);
 
                 $new_target_root = $target_root_node->getId();
 
                 // get source post tree and update posts tree
                 foreach($source_all_posts as $post)
                 {
                         $post_obj = new ilForumPost($post->pos_pk);
 
                         $posts_tree_obj = new ilForumPostsTree();
                         $posts_tree_obj->setPosFk($post->pos_pk);
 
                         if($post_obj->getParentId() == 0)
                         {
                                 $posts_tree_obj->setParentPos($new_target_root);
 
                                 //$posts_tree_obj->setRgt(($post_obj->getRgt() + $add_difference));
                                 $posts_tree_obj->setRgt(($post_obj->getRgt() + $add_difference) - 1);
                                 $posts_tree_obj->setLft($target_root_node->getRgt());
                                 
                                 $posts_tree_obj->setDepth(($post_obj->getDepth() + 1));
                                 $posts_tree_obj->setSourceThreadId($merge_thread_source->getId());
 
                                 $posts_tree_obj->setTargetThreadId($merge_thread_target->getId());
 
                                 $posts_tree_obj->mergeParentPos();
                         }
                         else
                         {
                                 $posts_tree_obj->setRgt(($post_obj->getRgt() + $add_difference) - 1);
                                 $posts_tree_obj->setLft(($post_obj->getLft() + $add_difference) - 1);
 
                                 $posts_tree_obj->setDepth(($post_obj->getDepth() + 1));
                                 $posts_tree_obj->setSourceThreadId($merge_thread_source->getId());
 
                                 $posts_tree_obj->setParentPos($post_obj->getParentId());
                                 $posts_tree_obj->setTargetThreadId($merge_thread_target->getId());
 
                                 $posts_tree_obj->merge();
                         }
                 }
 
 // update frm_posts pos_thr_fk = target_thr_id
                 include_once 'Modules/Forum/classes/class.ilForumPost.php';
                 ilForumPost::mergePosts($merge_thread_source->getId(), $merge_thread_target->getId());
 
 // check notifications
                 include_once 'Modules/Forum/classes/class.ilForumNotification.php';
                 ilForumNotification::mergeThreadNotificiations($merge_thread_source->getId(), $merge_thread_target->getId());
 
 // delete frm_thread_access entries
                 include_once './Modules/Forum/classes/class.ilObjForum.php';
                 ilObjForum::_deleteAccessEntries($merge_thread_source->getId());
 
 // update frm_user_read  
                 ilObjForum::mergeForumUserRead($merge_thread_source->getId(), $merge_thread_target->getId());
 
 // update visits, thr_num_posts, last_post, subject
                 $post_date_source = $merge_thread_source->getLastPost()->getCreateDate();
                 $post_date_target = $merge_thread_target->getLastPost()->getCreateDate();
 
                 $target_last_post = $merge_thread_target->getLastPostString();
                 $exp              = explode('#', $target_last_post);
 
                 if($post_date_source > $post_date_target)
                 {
                         $exp[2] = $merge_thread_source->getLastPost()->getId();
                 }
                 else
                 {
                         $exp[2] = $merge_thread_target->getLastPost()->getId();
                 }
                 $new_thr_last_post = implode('#', $exp);
 
                 $num_posts_source  = (int)$merge_thread_source->getNumPosts();
                 $num_visits_source = (int)$merge_thread_source->getVisits();
                 $num_posts_target  = (int)$merge_thread_target->getNumPosts();
                 $num_visits_target = (int)$merge_thread_source->getVisits();
 
                 $frm_topic_obj = new ilForumTopic(0, false, true);
                 $frm_topic_obj->setNumPosts(($num_posts_source + $num_posts_target));
                 $frm_topic_obj->setVisits(($num_visits_source + $num_visits_target));
                 $frm_topic_obj->setLastPostString($new_thr_last_post);
                 $frm_topic_obj->setSubject($thread_subject);
                 $frm_topic_obj->setId($merge_thread_target->getId());
 
                 $frm_topic_obj->updateMergedThread();
 
 // update frm_data:  top_last_post , top_num_threads
                 ilForum::updateLastPostByObjId($obj_id);
 
 // reopen target if was not "closed" before merging
                 if(!$targed_was_closed)
                 {
                         $merge_thread_target->reopen();
                 }
 
 // delete source thread 
                 ilForumTopic::deleteByThreadId($merge_thread_source->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveThreads()

ilForum::moveThreads	(	$thread_ids = `array()`,
		$src_ref_id = `0`,
		$dest_top_frm_fk = `0`
	)

Moves all chosen threads and their posts to a new forum.

Parameters

array	chosen thread pks
integer	object id of src forum
integer	object id of dest forum public

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

References $id, $ilDB, $res, $row, ilObject\_lookupObjectId(), getOneTopic(), and setMDB2WhereCondition().

         {       
                 global $ilDB;
                 
                 $src_top_frm_fk = ilObject::_lookupObjectId($src_ref_id);               
                 
                 if (is_numeric($src_top_frm_fk) && $src_top_frm_fk > 0 && is_numeric($dest_top_frm_fk) && $dest_top_frm_fk > 0)
                 {       
 
                         $this->setMDB2WhereCondition('top_frm_fk = %s ', array('integer'), array($src_top_frm_fk));
                         
                         $oldFrmData = $this->getOneTopic();                     
 
                         $this->setMDB2WhereCondition('top_frm_fk = %s ', array('integer'), array($dest_top_frm_fk));    
                                         
                         $newFrmData = $this->getOneTopic();
                         
                         if ($oldFrmData['top_pk'] && $newFrmData['top_pk'])
                         {
                                 $moved_posts = 0;
                                 $moved_threads = 0;
                                 $visits = 0;
                                 foreach ($thread_ids as $id)
                                 {
                                         $objTmpThread = new ilForumTopic($id);                                  
 
                                         $numPosts = $objTmpThread->movePosts($src_top_frm_fk, $oldFrmData['top_pk'], $dest_top_frm_fk, $newFrmData['top_pk']);                                  
                                         if (($last_post_string = $objTmpThread->getLastPostString()) != '')
                                         {
                                                 $last_post_string = explode('#', $last_post_string);
                                                 $last_post_string[0] = $newFrmData['top_pk'];
                                                 $last_post_string = implode('#', $last_post_string);
                                                 $objTmpThread->setLastPostString($last_post_string);
                                         }
                                         
                                         $visits += $objTmpThread->getVisits();
                                         
                                         $moved_posts += $numPosts;
                                         ++$moved_threads;
                                         
                                         $objTmpThread->setForumId($newFrmData['top_pk']);
                                         $objTmpThread->update();
                                         
                                         unset($objTmpThread);
                                 }                               
                                 
                                 // update frm_data source forum
                                 $ilDB->setLimit(1);
                                 $res = $ilDB->queryf('
                                         SELECT pos_thr_fk, pos_pk 
                                         FROM frm_posts                                            
                                         WHERE pos_top_fk = %s
                                         ORDER BY pos_date DESC',
                                         array('integer'), array($oldFrmData['top_pk']));
                                 
                                 $row = $ilDB->fetchObject($res);                                
                                 $last_post_src = $oldFrmData['top_pk'] . '#' . $row->pos_thr_fk . '#' . $row->pos_pk;
                                 
                                 $statement = $ilDB->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',
                                         array('integer', 'integer', 'integer', 'text', 'integer'), 
                                         array(  $moved_posts, 
                                                         $moved_threads, 
                                                         $visits, 
                                                         $last_post_src, 
                                                         $oldFrmData['top_pk']));
                                 
                                 // update frm_data destination forum
                                 
                                 $ilDB->setLimit(1);
                                 $res = $ilDB->queryf('
                                         SELECT pos_thr_fk, pos_pk 
                                         FROM frm_posts                                            
                                         WHERE pos_top_fk = %s
                                         ORDER BY pos_date DESC',
                                         array('integer'), array($newFrmData['top_kp']));
                                 
                                 $row = $ilDB->fetchObject($res);
                                 $last_post_dest = $newFrmData['top_pk'] . '#' . $row->pos_thr_fk . '#' . $row->pos_pk;
 
                                 $statement = $ilDB->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',
                                         array('integer', 'integer', 'integer', 'text', 'integer'),
                                         array($moved_posts, $moved_threads, $visits, $last_post_dest, $newFrmData['top_pk']));
                                 
                                 /*
                                 // update news items
                                 include_once("./Services/News/classes/class.ilNewsItem.php");
                                 $objNewsItem = new ilNewsItem();
                                 $news_items = $objNewsItem->getNewsForRefId($src_ref_id);
                                 foreach ($news_items as $news_item)
                                 {
                                         $tmpObjNewsItem = new ilNewsItem($news_item['id']);
                                         if ($tmpObjNewsItem->getContextObjId() == $src_top_frm_fk)
                                         {
                                                 $tmpObjNewsItem->setContextObjId($dest_top_frm_fk);
                                                 $tmpObjNewsItem->update();
                                         }
                                         unset($tmpObjNewsItem);
                                 }
                                 */
                         }
                 }
 }

Here is the call graph for this function:

◆ postCensorship()

ilForum::postCensorship	(	$message,
		$pos_pk,
		$cens = `0`
	)

update dataset in frm_posts with censorship info

Parameters

string	message
integer	pos_pk

Returns: boolean public

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

References $_SESSION, $GLOBALS, $ilDB, $res, ilNewsItem\getFirstNewsIdForContext(), getForumRefId(), and prepareText().

         {               
                 global $ilDB;
 
                 $cens_date = date("Y-m-d H:i:s");
 
                 $ilDB->manipulateF('
                         UPDATE frm_posts
                         SET pos_cens_com = %s,
                                 pos_cens_date = %s,
                                 pos_cens = %s,
                                 update_user = %s
                         WHERE pos_pk = %s',
                         array('text', 'timestamp', 'integer', 'integer', 'integer'),
                         array($message, $cens_date, $cens, $_SESSION['AccountId'], $pos_pk));
                 
                 // Change news item accordingly
                 include_once("./Services/News/classes/class.ilNewsItem.php");
                 $news_id = ilNewsItem::getFirstNewsIdForContext($this->id,
                         "frm", $pos_pk, "pos");
                 if ($news_id > 0)
                 {
                         if ($cens > 0)          // censor
                         {
                                 $news_item = new ilNewsItem($news_id);
                                 //$news_item->setTitle($subject);
                                 $news_item->setContent(nl2br($this->prepareText($message, 0)));
                                 $news_item->update();
                         }
                         else                            // revoke censorship
                         {
                                 // get original message
                                 $res = $ilDB->queryf('
                                         SELECT * FROM frm_posts
                                         WHERE pos_pk = %s',
                                         array('integer'), array($pos_pk));
                                         
                                 $rec = $ilDB->fetchAssoc($res);
 
                                 $news_item = new ilNewsItem($news_id);
                                 //$news_item->setTitle($subject);
                                 $news_item->setContent(nl2br($this->prepareText($rec["pos_message"], 0)));
                                 $news_item->update();
                         }
                 }
 
                 require_once 'Modules/Forum/classes/class.ilForumPost.php';
                 $GLOBALS['ilAppEventHandler']->raise(
                         'Modules/Forum',
                         'censoredPost',
                         array(
                                 'ref_id' => $this->getForumRefId(),
                                 'post'   => new ilForumPost($pos_pk)
                         )
                 );
 
                 return true;
         }

Here is the call graph for this function:

◆ prepareText()

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

prepares given string public

Parameters

string
integer

Returns: string

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

References $lng, $text, $txtQuote2, and ilUtil\insertLatexImages().

Referenced by generatePost(), and postCensorship().

         {
                 global $lng; 
                 
                 if($type == 'export')
                 {
                         $this->replQuote1 = "<blockquote class=\"quote\"><hr size=\"1\" color=\"#000000\">"; 
                         $this->replQuote2 = "<hr size=\"1\" color=\"#000000\"/></blockquote>"; 
                 }
 
                 if($edit == 1)
                 {
                         // add login name of quoted users
                         $lname = ($quote_user != "")
                                 ? '="'.$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)
                                 {
                                         $ws= "[ \t\r\f\v\n]*";
 
                                         $text = eregi_replace("\[(quote$ws=$ws\"([^\"]*)\"$ws)\]",
                                                 $this->replQuote1.'<div class="ilForumQuoteHead">'.$lng->txt("quote")." (\\2)".'</div>', $text);
 
                                         $text = str_replace("[quote]",
                                                 $this->replQuote1.'<div class="ilForumQuoteHead">'.$lng->txt("quote").'</div>', $text);
                                         
                                         $text = str_replace("[/quote]", $this->replQuote2, $text);
                                 }
                         }
                 }
                 
                 if($type != 'export')
                 {
                         if($edit == 0)
                         {
                                 $text = ilUtil::insertLatexImages($text, "<span class\=\"latex\">", "<\/span>");
                                 $text = ilUtil::insertLatexImages($text, "\[tex\]", "\[\/tex\]");
                         }
                         
                         // workaround for preventing template engine
                         // from hiding text that is enclosed
                         // in curly brackets (e.g. "{a}")
                         $text = str_replace("{", "&#123;", $text);
                         $text = str_replace("}", "&#125;", $text);
                 }
 
                 return $text;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDbTable()

ilForum::setDbTable ( $dbTable )

set database table

Parameters

string $dbTable database table

See also: $dbTable User interface

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

References $dbTable.

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

◆ setForumId()

ilForum::setForumId ( $a_obj_id )

set object id which refers to ILIAS obj_id

Parameters

integer object id public

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

         {
 
                 if (!isset($a_obj_id))
                 {
                         $message = get_class($this)."::setForumId(): No obj_id given!";
                         $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);    
                 }
                 
                 $this->id = $a_obj_id;
         }

◆ setForumRefId()

ilForum::setForumRefId ( $a_ref_id )

set reference id which refers to ILIAS obj_id

Parameters

integer object id public

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

         {
                 if (!isset($a_ref_id))
                 {
                         $message = get_class($this)."::setForumRefId(): No ref_id given!";
                         $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);    
                 }
                 
                 $this->ref_id = $a_ref_id;
         }

◆ setImportName()

ilForum::setImportName ( $a_import_name )

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

         {
                 $this->import_name = $a_import_name;
         }

◆ setLanguage()

ilForum::setLanguage ( $lng )

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

References $lng.

         {
                 $this->lng = $lng;
         }

◆ setMDB2WhereCondition()

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

set content for additional condition

Parameters

string	$query_string
array	$data_type
array	$data_value

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

Referenced by moveThreads().

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

Here is the caller graph for this function:

◆ setOrderField()

ilForum::setOrderField ( $orderField )

private

set database field for sorting results

Parameters

string $orderField database field for sorting

See also: $orderField private

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

References $orderField.

         {
                 if ($orderField == "")
                 {
                         die($this->className . "::setOrderField(): No orderField given.");
                 }
                 else
                 {
                         $this->orderField = $orderField;
                 }
         }

◆ setPageHits()

ilForum::setPageHits ( $pageHits )

Parameters

int $pageHits

Returns: bool

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

References $pageHits.

         {
                 if($pageHits < 1 || !is_numeric($pageHits))
                 {
                         $pageHits = 1;
                 }
 
                 $this->pageHits = (int)$pageHits;
                 return true;
         }

◆ updateLastPostByObjId()

static ilForum::updateLastPostByObjId ( $a_obj_id )

static

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

References $ilDB.

Referenced by mergeThreads().

         {
                 global $ilDB;
                 // get latest post of forum and update last_post
                 $ilDB->setLimit(1);
                 $res2 = $ilDB->queryf('
                         SELECT pos_top_fk, pos_thr_fk, pos_pk FROM frm_posts, frm_data 
                         WHERE pos_top_fk = top_pk 
                         AND top_frm_fk = %s
                         ORDER BY pos_date DESC',
                         array('integer'), array($a_obj_id));
 
                 if ($res2->numRows() == 0)
                 {
                         $lastPost_top = "";
                 }
                 else
                 {
                         $z = 0;
 
                         while ($selData = $ilDB->fetchAssoc($res2))
                         {
                                 if ($z > 0)
                                 {
                                         break;
                                 }
 
                                 $lastPost_top = $selData["pos_top_fk"]."#".$selData["pos_thr_fk"]."#".$selData["pos_pk"];
                                 $z ++;
                         }
                 }
 
                 $ilDB->update('frm_data',
                         array('top_last_post' => array('text', $lastPost_top)),
                         array('top_frm_fk' => array('integer',  $a_obj_id))
                 );
                 
         }

Here is the caller graph for this function:

◆ updateVisits()

ilForum::updateVisits ( $ID )

update page hits of given forum- or thread-ID public

Parameters

integer

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

References $_SESSION, $ilDB, $query, $res, getMDB2DataType(), getMDB2DataValue(), and getMDB2Query().

         {
 
                 global $ilDB;
                 
                 $checkTime = time() - (60*60);
                         
                 if ($_SESSION["frm_visit_".$this->dbTable."_".$ID] < $checkTime)
                 {
                 
                         $_SESSION["frm_visit_".$this->dbTable."_".$ID] = time();                
                         $query = 'UPDATE '.$this->dbTable.' SET visits = visits + 1 WHERE ';
                         
                         $data_type = array();
                         $data_value = array();
                 
                         if($this->getMDB2Query() != '' && $this->getMDB2DataType() != '' && $this->getMDB2DataValue() != '')
                         {
                                 $query .= $this->getMDB2Query();
                                 $data_type = $data_type + $this->getMDB2DataType();
                                 $data_value = $data_value + $this->getMDB2DataValue();
 
                                 $res = $ilDB->queryf($query, $data_type, $data_value);
                         }
                 }
         }

Here is the call graph for this function:

Field Documentation

◆ $className

ilForum::$className ="ilForum"

private

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

◆ $dbTable

ilForum::$dbTable

private

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

Referenced by getDbTable(), and setDbTable().

◆ $id

ilForum::$id

private

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

Referenced by getForumId(), and moveThreads().

◆ $ilias

ilForum::$ilias

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

Referenced by __construct().

◆ $lng

ilForum::$lng

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

Referenced by __construct(), fetchPostNodeData(), prepareText(), and setLanguage().

◆ $mdb2DataType

ilForum::$mdb2DataType

private

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

Referenced by getMDB2DataType().

◆ $mdb2DataValue

ilForum::$mdb2DataValue

private

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

Referenced by getMDB2DataValue().

◆ $mdb2Query

ilForum::$mdb2Query

private

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

Referenced by getMDB2Query().

◆ $moderators_by_ref_id_map

ilForum::$moderators_by_ref_id_map = array()

staticprotected

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

◆ $orderField

ilForum::$orderField

private

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

Referenced by getOrderField(), and setOrderField().

◆ $pageHits

ilForum::$pageHits = self::DEFAULT_PAGE_HITS

private

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

Referenced by getPageHits(), and setPageHits().

◆ $replQuote1

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

private

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

◆ $replQuote2

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

private

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

◆ $txtQuote1

ilForum::$txtQuote1 = "[quote]"

private

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

◆ $txtQuote2

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

private

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

Referenced by prepareText().

◆ DEFAULT_PAGE_HITS

const ilForum::DEFAULT_PAGE_HITS = 30

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

◆ SORT_DATE

const ilForum::SORT_DATE = 2

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

◆ SORT_TITLE

const ilForum::SORT_TITLE = 1

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

Referenced by ilObjForumGUI\cloneWizardPageObject().

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

Modules/Forum/classes/class.ilForum.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __deletePostFiles()

◆ _getLanguageInstanceByUsrId()

◆ _getModerators()

◆ _getThreads()

◆ _isModerator()

◆ _lookupObjIdForForumId()

◆ _lookupPostMessage()

◆ addPostTree()

◆ convertDate()

◆ countActiveUserArticles()

◆ countUserArticles()

◆ deletePost()

◆ deletePostTree()

◆ disableForumNotification()

◆ enableForumNotification()

◆ enableThreadNotification()

◆ fetchPostNodeData()

◆ generatePost()

◆ generateThread()

◆ getDbTable()

◆ getFirstPostByThread()

◆ getFirstPostNode()

◆ getForumId()

◆ getForumRefId()

◆ getImportName()

◆ getMDB2DataType()

◆ getMDB2DataValue()

◆ getMDB2Query()

◆ getModeratorFromPost()

◆ getModerators()

◆ getOnePost()

◆ getOneThread()

◆ getOneTopic()

◆ getOrderField()

◆ getPageHits()

◆ getPostDepth()

◆ getPostNode()

◆ getUserStatistic()

◆ insertPostNode()

◆ isForumNotificationEnabled()

◆ isThreadNotificationEnabled()

◆ mergeThreads()

◆ moveThreads()

◆ postCensorship()

◆ prepareText()

◆ setDbTable()

◆ setForumId()

◆ setForumRefId()

◆ setImportName()

◆ setLanguage()

◆ setMDB2WhereCondition()

◆ setOrderField()

◆ setPageHits()

◆ updateLastPostByObjId()

◆ updateVisits()

Field Documentation

◆ $className

◆ $dbTable

◆ $id

◆ $ilias

◆ $lng

◆ $mdb2DataType

◆ $mdb2DataValue

◆ $mdb2Query

◆ $moderators_by_ref_id_map

◆ $orderField

◆ $pageHits

◆ $replQuote1

◆ $replQuote2

◆ $txtQuote1