StoredMessage Class Reference

Inheritance diagram for StoredMessage:
InternalMessage ReceivedMessage SentMessage

Public Member Functions

 getId ()
 getSendTime ()
 setSenderFirstName ($firstName)
 setSenderLastName ($lastName)
 getSenderFirstName ()
 getSenderLastName ()
 isPlatformMessage ()

Protected Member Functions

 setFromArray ($messageData)

Protected Attributes

 $messageId
 $sendTime
 $senderFirstName
 $senderLastName

Detailed Description

Definition at line 21 of file storedmessage.lib.php.


Member Function Documentation

getId (  ) 

return the identification of the current message

Returns:
int message identification

Definition at line 126 of file storedmessage.lib.php.

getSenderFirstName (  ) 

Definition at line 151 of file storedmessage.lib.php.

getSenderLastName (  ) 

Definition at line 156 of file storedmessage.lib.php.

getSendTime (  ) 

return the send time of the message

Returns:
string send time of the message

Definition at line 136 of file storedmessage.lib.php.

isPlatformMessage (  ) 

return true if the current message is a platform message, false if this is not a platform message

Returns:
boolean true if the current message is a platform message false if the current message is not a platform message

Definition at line 168 of file storedmessage.lib.php.

setFromArray ( messageData  )  [protected]

set the fields of the current message

Parameters:
array $messageData $messageData['message_id'] $messageData['subject'] $messageData['message'] $messageData['sender'] $messageData['send_time'] $messageData['course'] $messageData['group'] $messageData['tools']

Reimplemented in ReceivedMessage.

Definition at line 44 of file storedmessage.lib.php.

setSenderFirstName ( firstName  ) 

Definition at line 141 of file storedmessage.lib.php.

setSenderLastName ( lastName  ) 

Definition at line 146 of file storedmessage.lib.php.


Field Documentation

$messageId [protected]

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

$senderFirstName [protected]

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

$senderLastName [protected]

Definition at line 28 of file storedmessage.lib.php.

$sendTime [protected]

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


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