|
CWIS Developer Documentation
|
Abstraction for topics within a Forum. More...
Public Attributes | |
| const | OK = 0 |
| const | NONEXISTENT = 1 |
Setup/Initialization/Destruction | |
| Topic ($TopicId=NULL) | |
| Object Constructor. More... | |
| Delete () | |
| Remove this topic from the database, deleting the underlying messages. More... | |
Accessors | |
| GetMessageList () | |
| Get the list of messages in this topic. More... | |
| TopicId () | |
| Get the ID of this topic. More... | |
| CreatorName () | |
| Get the CWIS name of the user who created this topic. More... | |
| CreatorEmail () | |
| Get the e-mail address of the user who created this topic. More... | |
| ForumId ($NewValue=DB_NOVALUE) | |
| Set or modify the forum with which this topic is associated. More... | |
| CreatorId ($NewValue=DB_NOVALUE) | |
| Get or set the creator of this topic. More... | |
| DateCreated ($NewValue=DB_NOVALUE) | |
| Get or set the creation date of this topic. More... | |
| TopicName ($NewValue=DB_NOVALUE) | |
| Get or modify the name of this topic. More... | |
| ViewCount ($NewValue=DB_NOVALUE) | |
| Get or set the view count for this topic. More... | |
| MessageCount ($NewValue=DB_NOVALUE) | |
| Get or set the message count for this topic. More... | |
| GetErrorStatus () | |
| Retrieve the error status of the object. More... | |
| Topic::CreatorEmail | ( | ) |
Get the e-mail address of the user who created this topic.
Definition at line 141 of file Topic.php.
References CreatorId().
| Topic::CreatorId | ( | $NewValue = DB_NOVALUE | ) |
Get or set the creator of this topic.
| int | $NewValue | User ID of the creator of this topic. This parameter is optional. |
Definition at line 161 of file Topic.php.
Referenced by CreatorEmail(), and CreatorName().

| Topic::CreatorName | ( | ) |
Get the CWIS name of the user who created this topic.
Definition at line 131 of file Topic.php.
References CreatorId().
| Topic::DateCreated | ( | $NewValue = DB_NOVALUE | ) |
| Topic::Delete | ( | ) |
| Topic::ForumId | ( | $NewValue = DB_NOVALUE | ) |
Set or modify the forum with which this topic is associated.
| int | $NewValue | ID of the forum with which this topic is associated. This parameter is optional. |
Definition at line 153 of file Topic.php.
Referenced by Delete().

| 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.
| int | $TopicId | The Id desired from the database, or -1 to generate a a new topic |
Definition at line 32 of file Topic.php.
References NONEXISTENT, OK, and TopicId().
| Topic::TopicId | ( | ) |
Get the ID of this topic.
Definition at line 125 of file Topic.php.
Referenced by Delete(), GetMessageList(), and Topic().

| Topic::TopicName | ( | $NewValue = DB_NOVALUE | ) |
| Topic::ViewCount | ( | $NewValue = DB_NOVALUE | ) |
| const Topic::OK = 0 |
Definition at line 19 of file Topic.php.
Referenced by Delete(), Forum\DeleteMessage(), Forum\PostMessage(), and Topic().