BaseForum Class Reference
[Base Objects]

Inheritance diagram for BaseForum:

List of all members.

---

Detailed Description

Used in combination with BaseForumThread and BaseForumThreadComment to make a nice little forum system.

The forum object holds a title, description, thread and comment counts for itself. Forums have threads which are just holders for the comments. Behold the power of BaseJumper.

Definition at line 10 of file base-forum.inc.php.

Public Member Functions
	__construct ($id=null, $table= 'forums')
	the constructor.
	getPagesXml ()
	add in our special pages
	save ()
	save and update our thread/comment counts
	canView ()
	by default, everyone can view the forum.
	canEdit ()
	by default, only admins can edit forums
	canDelete ()
	by default, only admins can delete forums
	editFormAddFields ($form)
	add our edit form fields in.
	getName ($link=false)
	get our forum name.
	drawRow ()
	draw our forum row.
	initPostPage ()
	init our post new thread page.
	drawPostPage ()
	draw our post new thread page.
	createPostForm ()
	create our form for posting new threads
	drawViewPage ()
	draw our forum view page...
	getRssItem ()
	get the forum as an RSS item
	getPublicData ()
	get some data to export via API
	getCreateFieldsArray ()
	add our custom fields in.
Public Attributes
	$ThreadClass = 'Thread'
	the string name of our BaseForumThread class
	$ThreadManagerClass = 'Threads'
	the string name of our BaseForumThreads class (the manager off)
	$CommentClass = 'ThreadComment'
	the string name of our BaseForumThreadComment class

---

Member Function Documentation

BaseForum::__construct (  $  id = null, $  table = 'forums' )

the constructor. data and table. pretty basic. Reimplemented from BaseObject. Definition at line 32 of file base-forum.inc.php.

BaseForum::canDelete (   )

by default, only admins can delete forums Reimplemented from BaseObject. Definition at line 110 of file base-forum.inc.php. References canEdit().

BaseForum::canEdit (   )

by default, only admins can edit forums Reimplemented from BaseObject. Definition at line 100 of file base-forum.inc.php. Referenced by canDelete().

BaseForum::canView (   )

by default, everyone can view the forum. Reimplemented from BaseObject. Definition at line 92 of file base-forum.inc.php.

BaseForum::createPostForm (   )

create our form for posting new threads Returns: new Form for posting threads Definition at line 227 of file base-forum.inc.php. References BaseModule::getUrl(). Referenced by drawPostPage().

BaseForum::drawPostPage (   )

draw our post new thread page. Definition at line 179 of file base-forum.inc.php. References createPostForm(), BaseModule::params(), and Util::redirect().

BaseForum::drawRow (   )

draw our forum row. Reimplemented from BaseObject. Definition at line 153 of file base-forum.inc.php. References Linkify::bbcode(), and getName().

BaseForum::drawViewPage (   )

draw our forum view page... all the threads. Definition at line 262 of file base-forum.inc.php. References BaseModule::drawPageNavigation().

BaseForum::editFormAddFields (  $  form  )

add our edit form fields in. name, description, sequence, etc. Reimplemented from BaseObject. Definition at line 120 of file base-forum.inc.php.

BaseForum::getCreateFieldsArray (   )

add our custom fields in. Reimplemented from BaseObject. Definition at line 315 of file base-forum.inc.php.

BaseForum::getName (  $  link = false  )

get our forum name. Definition at line 145 of file base-forum.inc.php. Referenced by drawRow(), getPublicData(), and getRssItem().

BaseForum::getPagesXml (   )

add in our special pages post - post a new thread to the forum Reimplemented from BaseObject. Definition at line 48 of file base-forum.inc.php.

BaseForum::getPublicData (   )

get some data to export via API Reimplemented from BaseObject. Definition at line 299 of file base-forum.inc.php. References Linkify::bbcode(), and getName().

BaseForum::getRssItem (   )

get the forum as an RSS item Reimplemented from BaseObject. Definition at line 286 of file base-forum.inc.php. References Linkify::bbcode(), and getName().

BaseForum::initPostPage (   )

init our post new thread page. Definition at line 169 of file base-forum.inc.php. References BaseModule::assertLogin().

BaseForum::save (   )

save and update our thread/comment counts Reimplemented from BaseObject. Definition at line 63 of file base-forum.inc.php. References dbFetchAssoc(), and dbQuery().

---

Member Data Documentation

BaseForum::$CommentClass = 'ThreadComment'

the string name of our BaseForumThreadComment class Definition at line 25 of file base-forum.inc.php.

BaseForum::$ThreadClass = 'Thread'

the string name of our BaseForumThread class Definition at line 15 of file base-forum.inc.php.

BaseForum::$ThreadManagerClass = 'Threads'

the string name of our BaseForumThreads class (the manager off) Definition at line 20 of file base-forum.inc.php.

---

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

• lib/modules/base-forum.inc.php

---