SentMessage Class Reference

Inheritance diagram for SentMessage:
StoredMessage InternalMessage

Public Member Functions

 __construct ($messageId)
 getRecipientList ()
 load ()
 delete ()

Static Public Member Functions

static fromArray ($messageData)
static fromId ($messageId)

Protected Member Functions

 loadRecipientList ()

Protected Attributes

 $recipientList = false

Detailed Description

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


Constructor & Destructor Documentation

__construct ( messageId  ) 

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


Member Function Documentation

delete (  ) 

Definition at line 149 of file sentmessage.lib.php.

static fromArray ( messageData  )  [static]

create a new SentMessage with the information in parameter

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

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

static fromId ( messageId  )  [static]

create a new SentMessage

Parameters:
int $messageId identification of the message to create
Returns:
SentMessage message created

Definition at line 109 of file sentmessage.lib.php.

getRecipientList (  ) 

return an array of user information

Returns:
array ['user_id'] ['lastName'] ['firstName'] ['username']

Definition at line 62 of file sentmessage.lib.php.

load (  ) 
See also:
StoredMessage

Definition at line 134 of file sentmessage.lib.php.

loadRecipientList (  )  [protected]

load the list of recipient list of the current message

Definition at line 75 of file sentmessage.lib.php.


Field Documentation

$recipientList = false [protected]

Definition at line 23 of file sentmessage.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