MessageToSend Class Reference
Inheritance diagram for MessageToSend:
Public Member Functions | |
| __construct ($sender=NULL, $subject=parent::NOSUBJECT, $message=parent::NOMESSAGE) | |
| setSender ($senderId=NULL) | |
| setSubject ($subject) | |
| setMessage ($message) | |
| setCourse ($course) | |
| setGroup ($group) | |
| setTools ($tools) | |
Detailed Description
Definition at line 23 of file messagetosend.lib.php.
Constructor & Destructor Documentation
| __construct | ( | $ | sender = NULL, |
|
| $ | subject = parent::NOSUBJECT, |
|||
| $ | message = parent::NOMESSAGE | |||
| ) |
create an message to send with the information in parameters
- Parameters:
-
int $sender user identification if it's not defined it use the current user id string $subject subject of the message string $message content of the message
Definition at line 34 of file messagetosend.lib.php.
Member Function Documentation
| setCourse | ( | $ | course | ) |
set the course id of the current message
- Parameters:
-
string $course course identification
Definition at line 93 of file messagetosend.lib.php.
| setGroup | ( | $ | group | ) |
set the group id of the current message
- Parameters:
-
int $group groupe identification
Definition at line 103 of file messagetosend.lib.php.
| setMessage | ( | $ | message | ) |
set the content of the current message
- Parameters:
-
string $message message
Definition at line 83 of file messagetosend.lib.php.
| setSender | ( | $ | senderId = NULL |
) |
set the send identification
- Parameters:
-
int $senderId sender identification (optional, default NULL)
Definition at line 56 of file messagetosend.lib.php.
| setSubject | ( | $ | subject | ) |
set the subject of the current message
- Parameters:
-
string $subject suject of the message
Definition at line 73 of file messagetosend.lib.php.
| setTools | ( | $ | tools | ) |
set the Tlabel of tool of the current message
- Parameters:
-
string $tools course identification
Definition at line 113 of file messagetosend.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/messaging/lib/message/messagetosend.lib.php
