Topic Class Reference
Abstraction for topics within a Forum. More...
Public Attributes | |
const | OK = 0 |
const | NONEXISTENT = 1 |
Setup/Initialization/Destruction | |
Topic ($TopicId=NULL) | |
Object Constructor. | |
Delete () | |
Remove this topic from the database, deleting the underlying messages. | |
Accessors | |
GetMessageList () | |
Get a list of messages in this topic. | |
TopicId () | |
Get the Id of this topic. | |
CreatorName () | |
Get the CWIS name of the user who created this topic. | |
CreatorEmail () | |
Get the email address of the user who created this topic. | |
ForumId ($NewValue=DB_NOVALUE) | |
Set or modify the forum with which this topic is associated. | |
CreatorId ($NewValue=DB_NOVALUE) | |
Get or Set the creator of this topic. | |
DateCreated ($NewValue=DB_NOVALUE) | |
Get or set set the creation date of this topic. | |
TopicName ($NewValue=DB_NOVALUE) | |
Get or modify the name of this topic. | |
ViewCount ($NewValue=DB_NOVALUE) | |
Get or set the viewcount for this topic. | |
MessageCount ($NewValue=DB_NOVALUE) | |
Get or set the messagecount for this topic. | |
GetErrorStatus () | |
Retrieve the error status. |
Detailed Description
Abstraction for topics within a Forum.
Definition at line 27 of file Topic.php.
Member Function Documentation
Topic::CreatorEmail | ( | ) |
Get the email address of the user who created this topic.
- Returns:
- Email address of the user who created this topic
Definition at line 152 of file Topic.php.
References CreatorId().
Topic::CreatorId | ( | $ | NewValue = DB_NOVALUE ) |
Get or Set the creator of this topic.
- Parameters:
-
NewValue (OPTIONAL)
- Returns:
- The current CreatorId
Definition at line 170 of file Topic.php.
Referenced by CreatorEmail(), and CreatorName().
Here is the caller graph for this function:

Topic::CreatorName | ( | ) |
Get the CWIS name of the user who created this topic.
- Returns:
- CWIS name of the user who created this topic
Definition at line 142 of file Topic.php.
References CreatorId().
Topic::DateCreated | ( | $ | NewValue = DB_NOVALUE ) |
Topic::Delete | ( | ) |
Topic::ForumId | ( | $ | NewValue = DB_NOVALUE ) |
Topic::GetErrorStatus | ( | ) |
Topic::GetMessageList | ( | ) |
Topic::MessageCount | ( | $ | NewValue = DB_NOVALUE ) |
Topic::Topic | ( | $ | TopicId = NULL ) |
Object Constructor.
After constructing the object, be sure to call GetErrorStatus() and verify that it returns Topic::OK
- Parameters:
-
TopicId The Id desired from the database, or -1 to genreate a new topic
Definition at line 46 of file Topic.php.
References NONEXISTENT, OK, and TopicId().
Topic::TopicId | ( | ) |
Topic::TopicName | ( | $ | NewValue = DB_NOVALUE ) |
Topic::ViewCount | ( | $ | NewValue = DB_NOVALUE ) |
Member Data Documentation
const Topic::NONEXISTENT = 1 |
The documentation for this class was generated from the following file: