Merge branch 'MDL-22937_message_html2' of git://github.com/andyjdavis/moodle
[moodle.git] / mod / chat / locallib.php
index 5b24d4d..1a14659 100644 (file)
@@ -154,3 +154,97 @@ class chat_portfolio_caller extends portfolio_module_caller_base {
                 : '');
     }
 }
+
+/**
+ * A chat event such a user entering or leaving a chat activity
+ *
+ * @package    mod_chat
+ * @copyright  2012 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class event_message implements renderable {
+
+    /** @var string The URL of the profile of the user who caused the event */
+    public $senderprofile;
+
+    /** @var string The ready to display name of the user who caused the event */
+    public $sendername;
+
+    /** @var string Ready to display event time */
+    public $time;
+
+    /** @var string Event description */
+    public $event;
+
+    /** @var string The chat theme name */
+    public $theme;
+
+    /**
+     * event_message constructor
+     *
+     * @param string $senderprofile The URL of the profile of the user who caused the event
+     * @param string $sendername The ready to display name of the user who caused the event
+     * @param string $time Ready to display event time
+     * @param string $theme The chat theme name
+     */
+    function __construct($senderprofile, $sendername, $time, $event, $theme) {
+
+        $this->senderprofile = $senderprofile;
+        $this->sendername = $sendername;
+        $this->time = $time;
+        $this->event = $event;
+        $this->theme = $theme;
+    }
+}
+
+/**
+ * A chat message from a user
+ *
+ * @package    mod_chat
+ * @copyright  2012 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_message implements renderable {
+
+    /** @var string The URL of the profile of the user sending the message */
+    public $senderprofile;
+
+    /** @var string The ready to display name of the user sending the message */
+    public $sendername;
+
+    /** @var string HTML for the avatar of the user sending the message */
+    public $avatar;
+
+    /** @var string Empty or a html class definition to append to the html */
+    public $mymessageclass;
+
+    /** @var string Ready to display message time */
+    public $time;
+
+    /** @var string The message */
+    public $message;
+
+    /** @var string The name of the chat theme to use */
+    public $theme;
+
+    /**
+     * user_message constructor
+     *
+     * @param string $senderprofile The URL of the profile of the user sending the message
+     * @param string $sendername The ready to display name of the user sending the message
+     * @param string $avatar HTML for the avatar of the user sending the message
+     * @param string $mymessageclass Empty or a html class definition to append to the html
+     * @param string $time Ready to display message time
+     * @param string $message The message
+     * @param string $theme The name of the chat theme to use
+     */
+    function __construct($senderprofile, $sendername, $avatar, $mymessageclass, $time, $message, $theme) {
+
+        $this->sendername = $sendername;
+        $this->avatar = $avatar;
+        $this->mymessageclass = $mymessageclass;
+        $this->time = $time;
+        $this->message = $message;
+        $this->theme = $theme;
+    }
+}