ChatMsgList Class Reference

Public Member Functions
	__construct ($courseId, $groupId=null)
	load ($from= '', $to= '')
	render ()
	flush ()
	addMsg ($message, $userId)
	archive ()
Private Member Functions
	renderSingleMsg ($message)
Private Attributes
	$msgList = array()
	$courseId = null
	$groupId = null
	$tblChatMsg = ''
	$tblUser = ''

---

Detailed Description

Definition at line 18 of file chatMsgList.class.php.

---

Constructor & Destructor Documentation

__construct	(	$	courseId,
		$	groupId = null
	)

Definition at line 28 of file chatMsgList.class.php.

---

Member Function Documentation

addMsg	(	$	message,
		$	userId
	)

Add a message to chat

Author:

Sebastien Piraux <pir@cerdecam.be>

Parameters:

string

$message

Returns:

boolean

Definition at line 184 of file chatMsgList.class.php.

archive

(

)

Generate a file with all messages and copy it in the document tool

Author:

Sebastien Piraux <pir@cerdecam.be>

Returns:

mixed filename if successfull, false if failed

Definition at line 214 of file chatMsgList.class.php.

flush

(

)

Delete all messages from DB for current course

Author:

Sebastien Piraux <pir@cerdecam.be>

Returns:

boolean if query was successfull

Definition at line 170 of file chatMsgList.class.php.

load	(	$	from = '',
		$	to = ''
	)

load message list of this course from DB

Author:

Sebastien Piraux <pir@cerdecam.be>

Parameters:

	int	$from unixtime
	int	$to unixtime

Returns:

result of operation

Definition at line 53 of file chatMsgList.class.php.

render

(

)

Produce html to display the message list

Author:

Sebastien Piraux <pir@cerdecam.be>

Returns:

string html output

Definition at line 104 of file chatMsgList.class.php.

renderSingleMsg

(

$

message

)

[private]

Get html to display one message with clickable links

Author:

Sebastien Piraux <pir@cerdecam.be>

Parameters:

array

$message('unixPostTime','message','lastname','firstname','isCourseCreator')

Returns:

string html output for $message

Definition at line 147 of file chatMsgList.class.php.

---

Field Documentation

$courseId = null [private]

Definition at line 22 of file chatMsgList.class.php.

$groupId = null [private]

Definition at line 23 of file chatMsgList.class.php.

$msgList = array() [private]

Definition at line 20 of file chatMsgList.class.php.

$tblChatMsg = '' [private]

Definition at line 25 of file chatMsgList.class.php.

$tblUser = '' [private]

Definition at line 26 of file chatMsgList.class.php.

---

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

• claroline/module/CLCHAT/lib/chatMsgList.class.php