ReceivedMessage Class Reference

Inheritance diagram for ReceivedMessage:

Public Member Functions
	__construct ($messageId, $userId=NULL)
	getRecipient ()
	isRead ()
	isDeleted ()
	moveToTrashBox ()
	moveToInBox ()
	markUnread ()
	markRead ()
	load ()
Static Public Member Functions
static	fromArray ($messageData)
static	fromId ($messageId, $userId=NULL)
Protected Member Functions
	changeReadStatus ($isRead)
	setFromArray ($messageData)
Protected Attributes
	$isRead
	$isDeleted
	$userId
Private Member Functions
	moveMessage ($deledeStatus)

---

Detailed Description

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

---

Constructor & Destructor Documentation

__construct	(	$	messageId,
		$	userId = NULL
	)

create a received message

Parameters:

	int	$messageId message identification
	int	$userId user identification

Definition at line 33 of file receivedmessage.lib.php.

---

Member Function Documentation

changeReadStatus

(

$

isRead

)

[protected]

change the read status of the current message

Parameters:

int

$isRead value of the readStatus

Definition at line 153 of file receivedmessage.lib.php.

static fromArray

(

$

messageData

)

[static]

create a new ReceviedMessage with the information in the parameter

Parameters:

array

$messageData $messageData['message_id'] $messageData['subject'] $messageData['message'] $messageData['sender'] $messageData['send_time'] $messageData['course'] $messageData['group'] $messageData['tools'] $messageData['is_read'] $messageData['is_deleted'] $messageData['user_id'] $messageData['firstName'] $messageData['lastName']

Returns:

ReceivedMessage the message created

Definition at line 252 of file receivedmessage.lib.php.

static fromId	(	$	messageId,
		$	userId = NULL
	)			[static]

create a new message

Parameters:

	int	$messageId message identification
	int	$userId user identification if it not defined it use the current user identification

Returns:

ReceivedMessage the message created

Definition at line 269 of file receivedmessage.lib.php.

getRecipient

(

)

return the user recepient

Returns:

int user identification

Definition at line 51 of file receivedmessage.lib.php.

isDeleted

(

)

Returns:

bool true if the message is deleted false if the message is not deleted

Definition at line 78 of file receivedmessage.lib.php.

isRead

(

)

Returns:

bool true if the message is read false if the message is not read

Definition at line 60 of file receivedmessage.lib.php.

load

(

)

load the current message from the data base

Definition at line 325 of file receivedmessage.lib.php.

markRead

(

)

mark the current message as read

Definition at line 138 of file receivedmessage.lib.php.

markUnread

(

)

mark the current message as unread

Definition at line 129 of file receivedmessage.lib.php.

moveMessage

(

$

deledeStatus

)

[private]

change the deleted_flag in the database and the field in the current message

Parameters:

int

$deledeStatus value of the deleted_flag in the database

Definition at line 111 of file receivedmessage.lib.php.

moveToInBox

(

)

restore the current message

Definition at line 101 of file receivedmessage.lib.php.

moveToTrashBox

(

)

delete the current message

Definition at line 93 of file receivedmessage.lib.php.

setFromArray

(

$

messageData

)

[protected]

set 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'] $messageData['is_read'] $messageData['is_deleted'] $messageData['user_id'] $messageData['firstName'] $messageData['lastName']

Reimplemented from StoredMessage.

Definition at line 184 of file receivedmessage.lib.php.

---

Field Documentation

$isDeleted [protected]

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

$isRead [protected]

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

$userId [protected]

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

---

The documentation for this class was generated from the following file:

• claroline/claroline/messaging/lib/message/receivedmessage.lib.php