From 4cf51f74be2c0b787f4fc8485a5a4e0c42657741 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=BCsterhus?= Date: Sat, 10 Dec 2011 15:24:36 +0100 Subject: [PATCH] Adding PHPDoc for ChatMessage::jsonify --- file/lib/data/chat/message/ChatMessage.class.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) mode change 100644 => 100755 file/lib/data/chat/message/ChatMessage.class.php diff --git a/file/lib/data/chat/message/ChatMessage.class.php b/file/lib/data/chat/message/ChatMessage.class.php old mode 100644 new mode 100755 index 582556f..3e9ee04 --- a/file/lib/data/chat/message/ChatMessage.class.php +++ b/file/lib/data/chat/message/ChatMessage.class.php @@ -74,7 +74,7 @@ class ChatMessage extends \wcf\data\DatabaseObject { } /** - * Returns the unformatted username + * Returns the unformatted username. * * @return string */ @@ -83,6 +83,11 @@ class ChatMessage extends \wcf\data\DatabaseObject { return $this->username; } + /** + * Converts this message into json-form. + * + * @return string + */ public function jsonify() { return \wcf\util\JSON::encode(array( 'formattedUsername' => $this->getFormattedUsername(), @@ -94,6 +99,5 @@ class ChatMessage extends \wcf\data\DatabaseObject { 'receiver' => $this->receiver, 'type' => $this->type )); - } }