ReceivedMessageBox Class Reference
Public Member Functions | |
| markUnread ($messageId, $userId=NULL) | |
| markRead ($messageId, $userId=NULL) | |
| moveMessageToTrashBox ($messageId, $userId=NULL) | |
| moveMessageToInBox ($messageId, $userId=NULL) | |
| loadMessageList () | |
| current () | |
| getNumberOfMessage () | |
| numberOfUnreadMessage () | |
| numberOfPlatformMessage () | |
| getNumberOfPage () | |
| empyTrashBox () | |
Protected Member Functions | |
| loadNumberOfMessage () | |
Protected Attributes | |
| $numberOfUnreadMessage = FALSE | |
| $numberOfPlatformMessage = FALSE | |
Detailed Description
Definition at line 23 of file receivedmessagebox.lib.php.
Member Function Documentation
| current | ( | ) |
return the current message
- Returns:
- ReceivedMessage the current message
Definition at line 125 of file receivedmessagebox.lib.php.
| empyTrashBox | ( | ) |
empty the trashbox
Definition at line 254 of file receivedmessagebox.lib.php.
| getNumberOfMessage | ( | ) |
- See also:
- MessageBox
Reimplemented from MessageBox.
Definition at line 133 of file receivedmessagebox.lib.php.
| getNumberOfPage | ( | ) |
return the number of page of the current message box
- Returns:
- int number of page
Definition at line 245 of file receivedmessagebox.lib.php.
| loadMessageList | ( | ) |
- See also:
- MessageBox
Reimplemented from MessageBox.
Definition at line 82 of file receivedmessagebox.lib.php.
| loadNumberOfMessage | ( | ) | [protected] |
Definition at line 141 of file receivedmessagebox.lib.php.
| markRead | ( | $ | messageId, | |
| $ | userId = NULL | |||
| ) |
mark the message (by the message id) as read for the user (user identifiation) in parameter
- Parameters:
-
int $messageId message identification int $userId user identification
Definition at line 46 of file receivedmessagebox.lib.php.
| markUnread | ( | $ | messageId, | |
| $ | userId = NULL | |||
| ) |
mark the message (by the message id) as unread for the user (user identifiation) in parameter
- Parameters:
-
int $messageId message identification int $userId user identification
Definition at line 34 of file receivedmessagebox.lib.php.
| moveMessageToInBox | ( | $ | messageId, | |
| $ | userId = NULL | |||
| ) |
Set the deleted status as not deleted in the data base
- Parameters:
-
int $messageId message identification int $userId user identification if it not defined it use current user id
Definition at line 72 of file receivedmessagebox.lib.php.
| moveMessageToTrashBox | ( | $ | messageId, | |
| $ | userId = NULL | |||
| ) |
Set the deleted status as deleted for the message in parameter
- Parameters:
-
int $messageId message identification int $userId user identification if it not defined it use current user id
Definition at line 59 of file receivedmessagebox.lib.php.
| numberOfPlatformMessage | ( | ) |
return the number of platform message
- Returns:
- int the number of platform message
Definition at line 210 of file receivedmessagebox.lib.php.
| numberOfUnreadMessage | ( | ) |
return the number of unread message
- Returns:
- int the number of unread message
Definition at line 174 of file receivedmessagebox.lib.php.
Field Documentation
$numberOfPlatformMessage = FALSE [protected] |
Definition at line 26 of file receivedmessagebox.lib.php.
$numberOfUnreadMessage = FALSE [protected] |
Definition at line 25 of file receivedmessagebox.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/messaging/lib/messagebox/receivedmessagebox.lib.php
