InternalMessage Class Reference

Inheritance diagram for InternalMessage:
MessageToSend StoredMessage ReceivedMessage SentMessage

Public Member Functions

 getSubject ()
 getMessage ()
 getSender ()
 getCourseCode ()
 getGroupId ()
 getToolsLabel ()

Data Fields

const NOSUBJECT = "No subject"
const NOMESSAGE = "No message"

Protected Attributes

 $sender
 $subject
 $message
 $course = NULL
 $group = NULL
 $tools = NULL

Detailed Description

Definition at line 17 of file internalmessage.lib.php.


Member Function Documentation

getCourseCode (  ) 

return the course code of the current message (NULL is not existant)

Returns:
string course code

Definition at line 67 of file internalmessage.lib.php.

getGroupId (  ) 

return the goup identification of the current message (NULL is not existant)

Returns:
int group identification

Definition at line 77 of file internalmessage.lib.php.

getMessage (  ) 

return the message of the current message

Returns:
string message of the current message

Definition at line 47 of file internalmessage.lib.php.

getSender (  ) 

return the sender identification

Returns:
int user identification

Definition at line 57 of file internalmessage.lib.php.

getSubject (  ) 

return the subject of the current message

Returns:
string subject of the message

Definition at line 37 of file internalmessage.lib.php.

getToolsLabel (  ) 

return the tool identification of the current message (NULL is not existant)

Returns:
string tool identification

Definition at line 87 of file internalmessage.lib.php.


Field Documentation

$course = NULL [protected]

Definition at line 25 of file internalmessage.lib.php.

$group = NULL [protected]

Definition at line 26 of file internalmessage.lib.php.

$message [protected]

Definition at line 24 of file internalmessage.lib.php.

$sender [protected]

Definition at line 22 of file internalmessage.lib.php.

$subject [protected]

Definition at line 23 of file internalmessage.lib.php.

$tools = NULL [protected]

Definition at line 27 of file internalmessage.lib.php.

const NOMESSAGE = "No message"

Definition at line 20 of file internalmessage.lib.php.

const NOSUBJECT = "No subject"

Definition at line 19 of file internalmessage.lib.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 8 12:28:39 2010 for Claroline API by  doxygen 1.6.3