Public Attributes | |
const | OK = 0 |
const | NONEXISTENT = 1 |
Setup/Initialization/Destruction | |
Message ($MessageId=NULL) | |
Object constructor. | |
Delete () | |
Delete this message from the underlying database. | |
Accessors | |
MessageId () | |
Get this message's messageId. | |
PosterName () | |
Get the CWIS username of the most recent poster. | |
PosterEmail () | |
Get the email address of the most recent poster. | |
ParentId ($NewValue=DB_NOVALUE) | |
Get or set the ParentId. | |
ParentType ($NewValue=DB_NOVALUE) | |
Get or set the ParentType. | |
DatePosted ($NewValue=DB_NOVALUE) | |
Get or set the date posted. | |
PosterId ($NewValue=DB_NOVALUE) | |
Get or set the poster id (e.g., the author) for this message. | |
Subject ($NewValue=DB_NOVALUE) | |
Get or set the message subject. | |
Body ($NewValue=DB_NOVALUE) | |
Get or set the message body. | |
GetErrorStatus () | |
Retrieve the error status. |
Definition at line 28 of file Message.php.
Message::Body | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the message body.
NewValue | (OPTIONAL) |
Definition at line 163 of file Message.php.
Message::DatePosted | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the date posted.
NewValue | (OPTIONAL) |
Definition at line 142 of file Message.php.
Message::Delete | ( | ) |
Delete this message from the underlying database.
Definition at line 80 of file Message.php.
References MessageId(), and OK.
Message::GetErrorStatus | ( | ) |
Retrieve the error status.
Definition at line 169 of file Message.php.
Message::Message | ( | $ | MessageId = NULL |
) |
Object constructor.
After constructing the object, be sure to call GetErrorStatus() and verify that it returns Message::OK.
MessageId | The message Id to retrieve from the database, or -1 to create a new message |
Definition at line 45 of file Message.php.
References MessageId(), NONEXISTENT, and OK.
Message::MessageId | ( | ) |
Get this message's messageId.
Definition at line 97 of file Message.php.
Referenced by Delete(), and Message().
Message::ParentId | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the ParentId.
For forum posts, the ParentId is a TopicId. For resource comments, the ParentId is the ResourceId.
NewValue | New value to set (OPTIONAL) |
Definition at line 126 of file Message.php.
Message::ParentType | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the ParentType.
Parent Type = 1 for forum posts and Parent Type = 2 for resource comments
NewValue | (OPTIONAL) |
Definition at line 135 of file Message.php.
Message::PosterEmail | ( | ) |
Get the email address of the most recent poster.
Definition at line 113 of file Message.php.
References PosterId().
Message::PosterId | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the poster id (e.g., the author) for this message.
NewValue | (OPTIONAL) |
Definition at line 149 of file Message.php.
Referenced by PosterEmail(), and PosterName().
Message::PosterName | ( | ) |
Get the CWIS username of the most recent poster.
Definition at line 103 of file Message.php.
References PosterId().
Message::Subject | ( | $ | NewValue = DB_NOVALUE |
) |
Get or set the message subject.
NewValue | (OPTIONAL) |
Definition at line 156 of file Message.php.
const Message::NONEXISTENT = 1 |
const Message::OK = 0 |