AdminMessageBox Class Reference

Public Member Functions

 __contruct ($selector=false)
 setSelector ($selector)
 getSelector ()
 current ()
 key ()
 next ()
 rewind ()
 valid ()
 getNumberOfMessage ()
 getNumberOfPage ()
 deleteAllMessages ()
 deleteAllMessageFromUser ($uid)
 deleteMessageOlderThan ($date)
 deletePlatformMessage ()
 deleteMessageList ($messageIdList)

Protected Member Functions

 loadMessageList ()
 loadNumberOfMessage ()

Protected Attributes

 $selector = false
 $numberOfMessage = false
 $messageList = false
 $index = 0

Detailed Description

Definition at line 22 of file adminmessagebox.lib.php.


Member Function Documentation

__contruct ( selector = false  ) 

Definition at line 29 of file adminmessagebox.lib.php.

current (  ) 

Definition at line 49 of file adminmessagebox.lib.php.

deleteAllMessageFromUser ( uid  ) 

delete message all user's messages (user in parameter)

Parameters:
int $uid user di

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

deleteAllMessages (  ) 

delete from the database all messages

Definition at line 165 of file adminmessagebox.lib.php.

deleteMessageList ( messageIdList  ) 

delete all message of the list in parameter

Parameters:
array of int $messageIdList array of message_id

Definition at line 245 of file adminmessagebox.lib.php.

deleteMessageOlderThan ( date  ) 

delete all message older than

Parameters:
int $date date in unixtime format

Definition at line 209 of file adminmessagebox.lib.php.

deletePlatformMessage (  ) 

delete all platform message

Definition at line 226 of file adminmessagebox.lib.php.

getNumberOfMessage (  ) 

Definition at line 122 of file adminmessagebox.lib.php.

getNumberOfPage (  ) 

Definition at line 156 of file adminmessagebox.lib.php.

getSelector (  ) 

Definition at line 39 of file adminmessagebox.lib.php.

key (  ) 

Definition at line 58 of file adminmessagebox.lib.php.

loadMessageList (  )  [protected]

load the message list if it is not loaded

Definition at line 91 of file adminmessagebox.lib.php.

loadNumberOfMessage (  )  [protected]

load the number of message the message box

Definition at line 134 of file adminmessagebox.lib.php.

next (  ) 

Definition at line 66 of file adminmessagebox.lib.php.

rewind (  ) 

Definition at line 74 of file adminmessagebox.lib.php.

setSelector ( selector  ) 

Definition at line 34 of file adminmessagebox.lib.php.

valid (  ) 

Definition at line 79 of file adminmessagebox.lib.php.


Field Documentation

$index = 0 [protected]

Definition at line 27 of file adminmessagebox.lib.php.

$messageList = false [protected]

Definition at line 26 of file adminmessagebox.lib.php.

$numberOfMessage = false [protected]

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

$selector = false [protected]

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


The documentation for this class was generated from the following file:
Generated on Tue Jun 8 12:28:37 2010 for Claroline API by  doxygen 1.6.3