Forum Class Reference

Inheritance diagram for Forum:

Public Member Functions
	__construct ()
	getSearchResultsXML ($text, $type, $forum, $u, $disp, $start=0, $isWholePage=false)
	getSearchXML ($wp=false)
	getNewTopicXML ($forum_uri, $isWholePage=false)
	getPostReplyXML ($forum_id, $topic_id)
	getHiddenPostXML ($post_id, $force_show)
	getPostsXML ($topic_uri, $wp)
	getXxxTopicsXML ($wp, $sTitle, $sDesc, $sFunc, $start=0)
	getHiddenTopicsXML ($wp, $start=0)
	getMyThreadsXML ($wp, $start=0)
	getMyFlagsXML ($wp, $start=0)
	getTopicsXML ($forum_uri, $wp, $start=0)
	getRecentTopicsXML ($wp, $start=0)
	getTrackTopics ()
	setTrackTopic ($topic_id)
	isNewTopic ($topic_id, $topic_last_time, $user_last_time)
	getCategsShortXML ($sCheckPermission=false)
	getForumsShortXML ($cat, $root, $sCheckPermission=false)
	getForumsXML ($cat, $root)
	getPageXML ($first_load=1, &$p)
	getCategoriesXML ($first_load=1, &$p)
	liveTracker ()
	getLivePostsXML ($count=10, $ts=0)
	isNewPost ($ts)
	postReplyXML (&$p)
	topicAutoContinue ($t)
	editPostXml ($post_id, $topic_id)
	editPost ($post_id, $topic_id, $text)
	deletePostXML ($post_id, $topic_id, $forum_id)
	hidePost ($is_hide, $post_id)
	moveTopicForm ($topic_id)
	moveTopicSubmit ($topic_id, $forum_id, $old_forum_id, $goto_new_location)
	delTopic ($topic_id)
	hideTopic ($is_hide, $topic_id)
	stick ($topic_id)
	lock ($topic_id)
	postNewTopicXML ($p)
	isAdmin ()
	getLoginUser ()
	updateCurrentUserActivity ()
	logout ()
	votePost ($post_id, $vote)
	report ($post_id)
	flag ($topic_id)
	getRssForum ($forum_uri)
	getRssUpdatedTopics ()
	getRssTopic ($topic_uri)
	getRssUser ($user, $sort)
	getRssAll ($sort)
	_rssPrepareConf ()
	_rssItem ($sTitle, $sLink, $sDesc, $iTimestamp)
	_rssFeed ($sTitle, $sLink, $sDesc, $iLastDateTimestamp, $sItems)
	showProfile ($u, $wp)
	_getLoginInfo ($user='')
	_getUserInfoReadyArray ($user, $bWrapWithCdata=true)
	_getUserInfo ($user)
	_checkUserPerm ($user, $f_type, $a_type, $forum_id=0)
	_isEditTimeout ($post_id)
	_getLoginUserName ()
	_getLoginUser ()
	_format_when ($iSec)
	_no_access ($wp=0)
	_buld_topic_desc (&$s)
	uriGenerate ($s, $sTable, $sField, $iMaxLen=255)
	uriCheckUniq ($s, $sTable, $sField)
	setTitle ($s)
	_handleSignature (&$p, $user)
	_handleUpload (&$p, $post_id)
	download ($hash)
	_getAttachmentsXML ($post_id)
	_getPages ($iStart, $iNum, $iPerPage)
Public Member Functions inherited from ThingPage
	getLangs ()
	getLangsXml ()
	getUrlsXml ()
	addHeaderFooter (&$li, $content)
	cacheWrite ($fn, $s)
	cacheRead ($fn)
	cacheExists ($fn)
	cacheEnabled ()

Public Attributes
	$getUserInfo
	$getUserPerm
	$getLoginUser
	$onPostReply
	$onPostEdit
	$onPostDelete
	$onNewTopic
	$onVote
	$onReport
	$onFlag
	$onUnflag

Detailed Description

This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/

Definition at line 10 of file Forum.php.

Constructor & Destructor Documentation

__construct()

Forum::__construct

(

)

constructor

Reimplemented from ThingPage.

Definition at line 30 of file Forum.php.

Member Function Documentation

_buld_topic_desc()

Forum::_buld_topic_desc

(

&

$s

)

Definition at line 2170 of file Forum.php.

_checkUserPerm()

Forum::_checkUserPerm	(		$user,
			$f_type,
			$a_type,
			$forum_id = 0
	)

check user perms

Parameters

$user	username
$f_type	forum type private/public/own
$a_type	access type read/post/edit/del

Definition at line 2105 of file Forum.php.

_format_when()

Forum::_format_when

(

$iSec

)

Definition at line 2143 of file Forum.php.

_getAttachmentsXML()

Forum::_getAttachmentsXML

(

$post_id

)

Definition at line 2319 of file Forum.php.

_getLoginInfo()

Forum::_getLoginInfo

(

$user = ''

)

Definition at line 2068 of file Forum.php.

_getLoginUser()

Forum::_getLoginUser

(

)

returns logged in user

Definition at line 2136 of file Forum.php.

_getLoginUserName()

Forum::_getLoginUserName

(

)

returns loggen in user

Definition at line 2128 of file Forum.php.

_getPages()

Forum::_getPages	(		$iStart,
			$iNum,
			$iPerPage
	)

Definition at line 2332 of file Forum.php.

_getUserInfo()

Forum::_getUserInfo

(

$user

)

Definition at line 2092 of file Forum.php.

_getUserInfoReadyArray()

Forum::_getUserInfoReadyArray	(		$user,
			$bWrapWithCdata = true
	)

Definition at line 2076 of file Forum.php.

_handleSignature()

Forum::_handleSignature	(	&	$p,
			$user
	)

Definition at line 2221 of file Forum.php.

_handleUpload()

Forum::_handleUpload	(	&	$p,
			$post_id
	)

Definition at line 2234 of file Forum.php.

_isEditTimeout()

Forum::_isEditTimeout

(

$post_id

)

check timeout

Parameters

$post_id

post id

Definition at line 2118 of file Forum.php.

_no_access()

Forum::_no_access

(

$wp = 0

)

Definition at line 2162 of file Forum.php.

_rssFeed()

Forum::_rssFeed	(		$sTitle,
			$sLink,
			$sDesc,
			$iLastDateTimestamp,
			$sItems
	)

Definition at line 2015 of file Forum.php.

_rssItem()

Forum::_rssItem	(		$sTitle,
			$sLink,
			$sDesc,
			$iTimestamp
	)

Definition at line 1998 of file Forum.php.

_rssPrepareConf()

Forum::_rssPrepareConf

(

)

Definition at line 1992 of file Forum.php.

deletePostXML()

Forum::deletePostXML	(		$post_id,
			$topic_id,
			$forum_id
	)

delete post

Parameters

$post_id	post id
$topic_id	topic id
$forum_id	forum id

Definition at line 1433 of file Forum.php.

delTopic()

Forum::delTopic

(

$topic_id

)

delete topic

Parameters

$topic_id

topic id

Definition at line 1565 of file Forum.php.

download()

Forum::download

(

$hash

)

Definition at line 2289 of file Forum.php.

editPost()

Forum::editPost	(		$post_id,
			$topic_id,
			$text
	)

edit post

Parameters

$post_id	post id
$topic_id	topic id
$text	new post text

Definition at line 1376 of file Forum.php.

editPostXml()

Forum::editPostXml	(		$post_id,
			$topic_id
	)

xml for edit post

Parameters

$post_id	post id
$topic_id	topic id

Definition at line 1323 of file Forum.php.

flag()

Forum::flag

(

$topic_id

)

flag/unflag topic

Parameters

$topic_id

topic id

Definition at line 1789 of file Forum.php.

getCategoriesXML()

Forum::getCategoriesXML	(		$first_load = 1,
		&	$p
	)

returns categories XML (forums index)

Definition at line 1102 of file Forum.php.

getCategsShortXML()

Forum::getCategsShortXML

(

$sCheckPermission = false

)

returns categs XML

Definition at line 986 of file Forum.php.

getForumsShortXML()

Forum::getForumsShortXML	(		$cat,
			$root,
			$sCheckPermission = false
	)

returns forums XML

Definition at line 1004 of file Forum.php.

getForumsXML()

Forum::getForumsXML	(		$cat,
			$root
	)

returns forums XML

Definition at line 1029 of file Forum.php.

getHiddenPostXML()

Forum::getHiddenPostXML	(		$post_id,
			$force_show
	)

returns single post XML

Parameters

$post_id	post id
$force_show	force show hidden post

Definition at line 313 of file Forum.php.

getHiddenTopicsXML()

Forum::getHiddenTopicsXML	(		$wp,
			$start = 0
	)

returns my threads topics XML

Parameters

$wp	return whole page XML

Definition at line 720 of file Forum.php.

getLivePostsXML()

Forum::getLivePostsXML	(		$count = 10,
			$ts = 0
	)

Definition at line 1138 of file Forum.php.

getLoginUser()

Forum::getLoginUser

(

)

returns logged in user

Definition at line 1713 of file Forum.php.

getMyFlagsXML()

Forum::getMyFlagsXML	(		$wp,
			$start = 0
	)

returns flagged topics XML

Parameters

$wp	return whole page XML

Definition at line 738 of file Forum.php.

getMyThreadsXML()

Forum::getMyThreadsXML	(		$wp,
			$start = 0
	)

returns my threads topics XML

Parameters

$wp	return whole page XML

Definition at line 729 of file Forum.php.

getNewTopicXML()

Forum::getNewTopicXML	(		$forum_uri,
			$isWholePage = false
	)

returns new topic page XML

Definition at line 220 of file Forum.php.

getPageXML()

Forum::getPageXML	(		$first_load = 1,
		&	$p
	)

returns page XML

Reimplemented from ThingPage.

Definition at line 1076 of file Forum.php.

getPostReplyXML()

Forum::getPostReplyXML	(		$forum_id,
			$topic_id
	)

returns post reply page XML

Definition at line 277 of file Forum.php.

getPostsXML()

Forum::getPostsXML	(		$topic_uri,
			$wp
	)

returns topic posts XML

Parameters

$topic_id
$wp	return whole page XML

Definition at line 433 of file Forum.php.

getRecentTopicsXML()

Forum::getRecentTopicsXML	(		$wp,
			$start = 0
	)

returns recent topics XML

Parameters

$forum_id	forum id
$wp	return whole page XML
$start	record to start with

Definition at line 861 of file Forum.php.

getRssAll()

Forum::getRssAll

(

$sort

)

all posts rss feed, 10 latest posts

Parameters

$user	username
$sort	sort : rnd | top | latest - default

Definition at line 1961 of file Forum.php.

getRssForum()

Forum::getRssForum

(

$forum_uri

)

forum rss feed, 10 latest topics in the forum

Parameters

$forum_id

forum id

Definition at line 1819 of file Forum.php.

getRssTopic()

Forum::getRssTopic

(

$topic_uri

)

topic rss feed, 10 latest posts in the topic

Parameters

$forum_id

forum id

Definition at line 1888 of file Forum.php.

getRssUpdatedTopics()

Forum::getRssUpdatedTopics

(

)

latest updates feed, 10 latest topics

Parameters

$forum_id

forum id

Definition at line 1856 of file Forum.php.

getRssUser()

Forum::getRssUser	(		$user,
			$sort
	)

user posts rss feed, 10 latest posts of specified user

Parameters

$user	username
$sort	sort : rnd | top | latest - default

Definition at line 1927 of file Forum.php.

getSearchResultsXML()

Forum::getSearchResultsXML	(		$text,
			$type,
			$forum,
			$u,
			$disp,
			$start = 0,
			$isWholePage = false
	)

returns search results XML

Parameters

$text	search string
$type	search type: msgs - messages | tlts - titles
$forum	forum id to search within
$u	search posts of this user only
$disp	display: topics | posts
$start	for pagination

Definition at line 44 of file Forum.php.

getSearchXML()

Forum::getSearchXML

(

$wp = false

)

returns search page XML

Definition at line 198 of file Forum.php.

getTopicsXML()

Forum::getTopicsXML	(		$forum_uri,
			$wp,
			$start = 0
	)

returns forum topics XML

Parameters

$forum_id	forum id
$wp	return whole page XML
$start	record to start with

Definition at line 749 of file Forum.php.

getTrackTopics()

Forum::getTrackTopics

(

)

returns array with viewed topics

Definition at line 945 of file Forum.php.

getXxxTopicsXML()

Forum::getXxxTopicsXML	(		$wp,
			$sTitle,
			$sDesc,
			$sFunc,
			$start = 0
	)

returns my threads topics XML

Parameters

$wp	return whole page XML

Definition at line 624 of file Forum.php.

hidePost()

Forum::hidePost	(		$is_hide,
			$post_id
	)

hide or unhide post

Parameters

$post_id	post id
$topic_id	topic id
$forum_id	forum id

Definition at line 1487 of file Forum.php.

hideTopic()

Forum::hideTopic	(		$is_hide,
			$topic_id
	)

hide or unhide post

Parameters

$is_hide	hide or unhide
$topic_id	topic id

Definition at line 1586 of file Forum.php.

isAdmin()

Forum::isAdmin

(

)

Definition at line 1704 of file Forum.php.

isNewPost()

Forum::isNewPost

(

$ts

)

check if new posts are available

Parameters

$ts	timestamp of last post

Definition at line 1190 of file Forum.php.

isNewTopic()

Forum::isNewTopic	(		$topic_id,
			$topic_last_time,
			$user_last_time
	)

detect new topic by last topic update time and user activity and cookies

Definition at line 967 of file Forum.php.

liveTracker()

Forum::liveTracker

(

)

Definition at line 1132 of file Forum.php.

lock()

Forum::lock

(

$topic_id

)

lock/unlock topic

Parameters

$topic_id

topic id

Definition at line 1624 of file Forum.php.

logout()

Forum::logout

(

)

Definition at line 1729 of file Forum.php.

moveTopicForm()

Forum::moveTopicForm

(

$topic_id

)

move topic

Parameters

$topic_id

topic id to move

Definition at line 1507 of file Forum.php.

moveTopicSubmit()

Forum::moveTopicSubmit	(		$topic_id,
			$forum_id,
			$old_forum_id,
			$goto_new_location
	)

Definition at line 1545 of file Forum.php.

postNewTopicXML()

Forum::postNewTopicXML

(

$p

)

post new topic

Parameters

$p	_post array

Definition at line 1641 of file Forum.php.

postReplyXML()

Forum::postReplyXML

(

&

$p

)

post reply

Parameters

$p	_post array

Definition at line 1200 of file Forum.php.

report()

Forum::report

(

$post_id

)

report post

Parameters

$post_id

post id

Definition at line 1767 of file Forum.php.

setTitle()

Forum::setTitle

(

$s

)

Definition at line 2215 of file Forum.php.

setTrackTopic()

Forum::setTrackTopic

(

$topic_id

)

mark topic as viewed

Definition at line 955 of file Forum.php.

showProfile()

Forum::showProfile	(		$u,
			$wp
	)

profile xml

Parameters

$u	username
$wp	return whole page XML

Definition at line 2040 of file Forum.php.

stick()

Forum::stick

(

$topic_id

)

stick/unstick topic

Parameters

$topic_id

topic id

Definition at line 1606 of file Forum.php.

topicAutoContinue()

Forum::topicAutoContinue

(

$t

)

Automatically close old topic and begin new one

Parameters

$t	- old topic array

Returns

new topic array

Definition at line 1267 of file Forum.php.

updateCurrentUserActivity()

Forum::updateCurrentUserActivity

(

)

updates current user last activity time

Definition at line 1721 of file Forum.php.

uriCheckUniq()

Forum::uriCheckUniq	(		$s,
			$sTable,
			$sField
	)

Definition at line 2210 of file Forum.php.

uriGenerate()

Forum::uriGenerate	(		$s,
			$sTable,
			$sField,
			$iMaxLen = 255
	)

Definition at line 2178 of file Forum.php.

votePost()

Forum::votePost	(		$post_id,
			$vote
	)

post voting

Parameters

$post_id	post id
$vote	vote (1|-1)

Definition at line 1748 of file Forum.php.

Member Data Documentation

$getLoginUser

Forum::$getLoginUser

Definition at line 15 of file Forum.php.

$getUserInfo

Forum::$getUserInfo

Definition at line 13 of file Forum.php.

$getUserPerm

Forum::$getUserPerm

Definition at line 14 of file Forum.php.

$onFlag

Forum::$onFlag

Definition at line 24 of file Forum.php.

$onNewTopic

Forum::$onNewTopic

Definition at line 21 of file Forum.php.

$onPostDelete

Forum::$onPostDelete

Definition at line 20 of file Forum.php.

$onPostEdit

Forum::$onPostEdit

Definition at line 19 of file Forum.php.

$onPostReply

Forum::$onPostReply

Definition at line 18 of file Forum.php.

$onReport

Forum::$onReport

Definition at line 23 of file Forum.php.

$onUnflag

Forum::$onUnflag

Definition at line 25 of file Forum.php.

$onVote

Forum::$onVote

Definition at line 22 of file Forum.php.

---

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

• modules/cheetah/forum/classes/Forum.php