1
0
mirror of https://github.com/wbbaddons/Tims-Chat.git synced 2024-12-22 21:40:08 +00:00

PHPDoc and Removing unneeded code

This commit is contained in:
Tim Düsterhus 2012-06-04 20:30:08 +02:00
parent 0a7fa7f640
commit c1c6c3d5bb

View File

@ -14,6 +14,11 @@
* @subpackage page * @subpackage page
*/ */
class ChatPage extends AbstractPage { class ChatPage extends AbstractPage {
/**
* The version of this installation of Tims Chat 3.
*
* @var string
*/
public $chatVersion = ''; public $chatVersion = '';
/** /**
* @see \wcf\page\AbstractPage::$neededModules * @see \wcf\page\AbstractPage::$neededModules
@ -24,11 +29,48 @@ class ChatPage extends AbstractPage {
* @see \wcf\page\AbstractPage::$neededPermissions * @see \wcf\page\AbstractPage::$neededPermissions
*/ */
public $neededPermissions = array('user.chat.canEnter'); public $neededPermissions = array('user.chat.canEnter');
/**
* The last X messages for the current room.
*
* @var array<\wcf\data\chat\message\ChatMessage>
*/
public $newestMessages = array(); public $newestMessages = array();
/**
* The current room.
*
* @var \wcf\data\chat\room\ChatRoom
*/
public $room = null; public $room = null;
/**
* The given roomID.
*
* @var integer
*/
public $roomID = 0; public $roomID = 0;
/**
* List of accessible rooms.
*
* @var \wcf\data\chat\room\ChatRoomList
*/
public $rooms = array(); public $rooms = array();
/**
* List of smilies in the default category.
*
* @var array<\wcf\data\smiley\Smiley>
* @see \wcf\data\smiley\SmileyCache
*/
public $smilies = array(); public $smilies = array();
/**
* Values read from the UserStorage of the current user.
*
* @var array
*/
public $userData = array(); public $userData = array();
/** /**
@ -92,7 +134,7 @@ public function readData() {
) )
)); ));
$messageAction->executeAction(); $messageAction->executeAction();
$return = $messageAction->getReturnValues(); $messageAction->getReturnValues();
} }
$this->newestMessages = chat\message\ChatMessageList::getNewestMessages($this->room, CHAT_LASTMESSAGES); $this->newestMessages = chat\message\ChatMessageList::getNewestMessages($this->room, CHAT_LASTMESSAGES);