RecipientList Class Reference
Inheritance diagram for RecipientList:
Public Member Functions | |
| getRecipientList () | |
| sendMessage ($message) | |
Protected Member Functions | |
| addRecipient ($messageId, $userId) | |
Private Member Functions | |
| addMessage ($messageToSend) | |
| sendMessageToUser ($recipientListId, $messageId) | |
Detailed Description
Definition at line 22 of file recipientlist.lib.php.
Member Function Documentation
| addMessage | ( | $ | messageToSend | ) | [final, private] |
create the message in the message table and return the identification of this
- Returns:
- int message identification
Definition at line 74 of file recipientlist.lib.php.
| addRecipient | ( | $ | messageId, | |
| $ | userId | |||
| ) | [abstract, protected] |
add the userId as recpient of the message id
- Parameters:
-
int $messageId message id int $userId user id
Reimplemented in AllUsersRecipient, CourseRecipient, GroupRecipient, SingleUserRecipient, and UserListRecipient.
| getRecipientList | ( | ) | [abstract] |
Return an array of the users identification (int)
- Returns:
- array the identification of the users
Reimplemented in AllUsersRecipient, CourseRecipient, GroupRecipient, SingleUserRecipient, and UserListRecipient.
| sendMessage | ( | $ | message | ) | [final] |
send the current message to the user in the recipientList
- Parameters:
-
messageToSend
- Returns:
- int id of the message
Definition at line 45 of file recipientlist.lib.php.
| sendMessageToUser | ( | $ | recipientListId, | |
| $ | messageId | |||
| ) | [final, private] |
Send the message to member of user list
- Parameters:
-
array of userId $recipientListID list of user identification int $messageId message identification
Definition at line 143 of file recipientlist.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/messaging/lib/recipient/recipientlist.lib.php
