CWIS Developer Documentation
|
A converastion forum which includes topics and messages. More...
Public Attributes | |
const | OK = 0 |
const | NONEXISTENT = 1 |
Setup/Initialization/Destruction | |
Forum ($ForumId=NULL) | |
Object Constructor. | |
Delete () | |
Remove this forum, deleting all assocated topics and messages. | |
Accessors | |
ForumId () | |
Get the forum's Id. | |
LastMessageDate () | |
Get the date of the most recent post. | |
LastMessagePoster () | |
Get the CWIS username of the most recent poster. | |
LastMessagePosterEmail () | |
Get the email address of the most recent poster. | |
ModeratorName () | |
Get the CWIS username of the forum's moderator. | |
ModeratorEmail () | |
Get the email of the forum's moderator. | |
GetTopicList () | |
Get a list of the topics in this forum. | |
GetLastMessage () | |
Get the last message posted in the forum. | |
ForumName ($NewValue=DB_NOVALUE) | |
Get or modify the forum's name. | |
ForumDescription ($NewValue=DB_NOVALUE) | |
Get or modify the forum description. | |
TopicCount ($NewValue=DB_NOVALUE) | |
Get or set the forum's topic count. | |
MessageCount ($NewValue=DB_NOVALUE) | |
Get or set the forum's message count. | |
ModeratorId ($NewValue=DB_NOVALUE) | |
Get or set the forum's moderator. | |
GetErrorStatus () | |
Retrieve error codes associated with the creation of the forum. | |
Forum::Delete | ( | ) |
Forum::Forum | ( | $ForumId = NULL | ) |
Object Constructor.
After constructing the object, be sure to call GetErrorStatus() and verify that it returns Forum::OK.
ForumId | The Id number of the forum to retrieve from the database, or -1 to create a new forum |
Definition at line 43 of file Forum.php.
References ForumId(), NONEXISTENT, and OK.
Forum::ForumDescription | ( | $NewValue = DB_NOVALUE | ) |
Forum::ForumId | ( | ) |
Get the forum's Id.
Definition at line 110 of file Forum.php.
Referenced by Delete(), Forum(), GetLastMessage(), and GetTopicList().
Forum::ForumName | ( | $NewValue = DB_NOVALUE | ) |
Forum::GetErrorStatus | ( | ) |
Forum::GetLastMessage | ( | ) |
Get the last message posted in the forum.
Definition at line 190 of file Forum.php.
References ForumId(), and Message\PARENTTYPE_TOPIC.
Referenced by LastMessageDate(), LastMessagePoster(), and LastMessagePosterEmail().
Forum::GetTopicList | ( | ) |
Forum::LastMessageDate | ( | ) |
Get the date of the most recent post.
Definition at line 116 of file Forum.php.
References GetLastMessage().
Forum::LastMessagePoster | ( | ) |
Get the CWIS username of the most recent poster.
Definition at line 129 of file Forum.php.
References GetLastMessage().
Forum::LastMessagePosterEmail | ( | ) |
Get the email address of the most recent poster.
Definition at line 140 of file Forum.php.
References GetLastMessage().
Forum::MessageCount | ( | $NewValue = DB_NOVALUE | ) |
Forum::ModeratorEmail | ( | ) |
Get the email of the forum's moderator.
Definition at line 161 of file Forum.php.
References ModeratorId().
Forum::ModeratorId | ( | $NewValue = DB_NOVALUE | ) |
Get or set the forum's moderator.
NewValue | (OPTIONAL) |
Definition at line 245 of file Forum.php.
Referenced by ModeratorEmail(), and ModeratorName().
Forum::ModeratorName | ( | ) |
Get the CWIS username of the forum's moderator.
Definition at line 151 of file Forum.php.
References ModeratorId().
Forum::TopicCount | ( | $NewValue = DB_NOVALUE | ) |