Merge branch 'MDL-25616_recent_messages' of git://github.com/andyjdavis/moodle
[moodle.git] / message / lib.php
index bd774f3..8dfc3e7 100644 (file)
@@ -60,6 +60,9 @@ define('VIEW_BLOCKED','blockedusers');
 define('VIEW_COURSE','course_');
 define('VIEW_SEARCH','search');
 
+define('MESSAGE_USER1_PARAM','user1');
+define('MESSAGE_USER2_PARAM','user2');
+
 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
 
 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
@@ -1958,6 +1961,7 @@ function message_format_contexturl($message) {
  * @param object $userto the message recipient
  * @param string $message the message
  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
+ * @return int|false the ID of the new message or false
  */
 function message_post_message($userfrom, $userto, $message, $format) {
     global $SITE, $CFG, $USER;
@@ -2202,7 +2206,7 @@ function message_mark_messages_read($touserid, $fromuserid){
 * @param message an object with an object property ie $message->id which is an id in the message table
 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
-* @return void
+* @return int the ID of the message in the message_read table
 */
 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
     global $DB;
@@ -2216,8 +2220,9 @@ function message_mark_message_read($message, $timeread, $messageworkingempty=fal
     if (!$messageworkingempty) {
         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
     }
-    $DB->insert_record('message_read', $message);
+    $messagereadid = $DB->insert_record('message_read', $message);
     $DB->delete_records('message', array('id' => $messageid));
+    return $messagereadid;
 }
 
 /**