';
+ echo html_writer::start_tag('div', array('class' => 'mdl-left'));
$personsearch = false;
$personsearchstring = null;
@@ -688,11 +1016,11 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) {
}
if (!empty($users)) {
- echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
+ echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
echo get_string('userssearchresults', 'message', count($users));
echo html_writer::end_tag('p');
- echo '';
+ echo html_writer::end_tag('table');
} else {
- echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
+ echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
echo get_string('userssearchresults', 'message', 0).'
'; echo html_writer::end_tag('p'); } @@ -799,14 +1120,14 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) { if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) { /// get a list of contacts - if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) { + if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) { $contacts = array(); } /// print heading with number of results - echo html_writer::start_tag('p', array('class'=>'heading searchresultcount')); + echo html_writer::start_tag('p', array('class' => 'heading searchresultcount')); $countresults = count($messages); - if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) { + if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) { echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")'; } else { echo get_string('keywordssearchresults', 'message', $countresults); @@ -814,16 +1135,16 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) { echo html_writer::end_tag('p'); /// print table headings - echo ''; + echo html_writer::end_tag('table'); } else { - echo '
'; //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message')); - echo '
';
+ echo html_writer::end_tag('div');
}
-
+/**
+ * Print information on a user. Used when printing search results.
+ * @param object/bool $user the user to display or false if you just want $USER
+ * @param bool $iscontact is the user being displayed a contact?
+ * @param bool $isblocked is the user being displayed blocked?
+ * @param bool $includeicontext include text next to the action icons?
+ */
function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
global $USER, $OUTPUT;
if ($user === false) {
- echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
+ echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
} else {
- echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
+ echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
echo ' ';
$return = false;
@@ -941,7 +1276,6 @@ function message_print_user ($user=false, $iscontact=false, $isblocked=false, $i
} else {
message_contact_link($user->id, 'block', $return, $script, $includeicontext);
}
- echo ''; echo html_writer::end_tag('p'); } @@ -799,14 +1120,14 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) { if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) { /// get a list of contacts - if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) { + if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) { $contacts = array(); } /// print heading with number of results - echo html_writer::start_tag('p', array('class'=>'heading searchresultcount')); + echo html_writer::start_tag('p', array('class' => 'heading searchresultcount')); $countresults = count($messages); - if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) { + if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) { echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")'; } else { echo get_string('keywordssearchresults', 'message', $countresults); @@ -814,16 +1135,16 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) { echo html_writer::end_tag('p'); /// print table headings - echo ''; + echo html_writer::end_tag('table'); } else { - echo '
'.get_string('keywordssearchresults', 'message', 0).'
'; + echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading')); } } @@ -915,17 +1244,23 @@ function message_print_search_results($frm, $showicontext=false, $user1=null) { //echo ''; //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message')); - echo '
'; $popupoptions = array( 'height' => MESSAGE_DISCUSSION_HEIGHT, @@ -955,15 +1289,24 @@ function message_print_user ($user=false, $iscontact=false, $isblocked=false, $i $link = new moodle_url("/message/index.php?id=$user->id"); //$action = new popup_action('click', $link, "message_$user->id", $popupoptions); $action = null; - echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user)))); + echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user)))); } } - -/// linktype can be: add, remove, block, unblock +/** + * Print a message contact link + * @staticvar type $str + * @param int $userid the ID of the user to apply to action to + * @param string $linktype can be add, remove, block or unblock + * @param bool $return if true return the link as a string. If false echo the link. + * @param string $script the URL to send the user to when the link is clicked. If null, the current page. + * @param bool $text include text next to the icons? + * @param bool $icon include a graphical icon? + * @return string if $return is true otherwise bool + */ function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) { - global $USER, $CFG, $OUTPUT, $PAGE; + global $OUTPUT, $PAGE; //hold onto the strings as we're probably creating a bunch of links static $str; @@ -1025,8 +1368,19 @@ function message_contact_link($userid, $linktype='add', $return=false, $script=n } } -function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') { - global $USER, $CFG, $OUTPUT; +/** + * echo or return a link to take the user to the full message history between themselves and another user + * @staticvar type $strmessagehistory + * @param int $userid1 the ID of the current user + * @param int $userid2 the ID of the other user + * @param bool $return true to return the link as a string. False to echo the link. + * @param string $keywords any keywords to highlight in the message history + * @param string $position anchor name to jump to within the message history + * @param string $linktext optionally specify the link text + * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean. + */ +function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') { + global $OUTPUT; static $strmessagehistory; @@ -1064,11 +1418,11 @@ function message_history_link($userid1, $userid2, $returnstr=false, $keywords='' $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position"); //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions); $action = null; - $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory)); + $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory)); $str = ''.$str.''; - if ($returnstr) { + if ($return) { return $str; } else { echo $str; @@ -1082,15 +1436,11 @@ function message_history_link($userid1, $userid2, $returnstr=false, $keywords='' * * If $coursid specifies the site course then this function searches * through all undeleted and confirmed users - * - * @uses $CFG, $USER - * @uses SITEID * @param int $courseid The course in question. - * @param string $searchtext ? - * @param string $sort ? - * @param string $exceptions ? + * @param string $searchtext the text to search for + * @param string $sort the column name to order by + * @param string $exceptions comma separated list of user IDs to exclude * @return array An array of {@link $USER} records. - * @todo Finish documenting this function */ function message_search_users($courseid, $searchtext, $sort='', $exceptions='') { global $CFG, $USER, $DB; @@ -1142,9 +1492,15 @@ function message_search_users($courseid, $searchtext, $sort='', $exceptions='') } } - - - +/** + * search a user's messages + * @param array $searchterms an array of search terms (strings) + * @param bool $fromme include messages from the user? + * @param bool $tome include messages to the user? + * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented + * @param int $userid the user ID of the current user + * @return mixed An array of messages or false if no matching messages were found + */ function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) { /// Returns a list of posts found using an array of search terms /// eg word +word -word @@ -1275,14 +1631,15 @@ function message_search($searchterms, $fromme=true, $tome=true, $courseid='none' return (empty($messages)) ? false : $messages; } - - -/// Borrowed with changes from mod/forum/lib.php -function message_shorten_message($message, $minlength=0) { -// Given a post object that we already know has a long message -// this function truncates the message nicely to the first -// sane place between $CFG->forum_longpost and $CFG->forum_shortpost - +/** + * Given a message object that we already know has a long message + * this function truncates the message nicely to the first + * sane place between $CFG->forum_longpost and $CFG->forum_shortpost + * @param string $message the message + * @param int $minlength the minimum length to trim the message to + * @return string the shortened message + */ +function message_shorten_message($message, $minlength = 0) { $i = 0; $tag = false; $length = strlen($message); @@ -1333,6 +1690,8 @@ function message_shorten_message($message, $minlength=0) { * Given a string and an array of keywords, this function looks * for the first keyword in the string, and then chops out a * small section from the text that shows that word in context. + * @param string $message the text to search + * @param array $keywords array of keywords to find */ function message_get_fragment($message, $keywords) { @@ -1376,7 +1735,13 @@ function message_get_fragment($message, $keywords) { return $fragment; } -//retrieve the messages between two users +/** + * Retrieve the messages between two users + * @param object $user1 the current user + * @param object $user2 the other user + * @param int $limitnum the maximum number of messages to retrieve + * @param bool $viewingnewmessages are we currently viewing new messages? + */ function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) { global $DB, $CFG; @@ -1425,22 +1790,35 @@ function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=fa return $messages; } +/** + * Print the message history between two users + * @param object $user1 the current user + * @param object $user2 the other user + * @param string $search search terms to highlight + * @param int $messagelimit maximum number of messages to return + * @param string $messagehistorylink the html for the message history link or false + * @param bool $viewingnewmessages are we currently viewing new messages? + */ function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) { global $CFG, $OUTPUT; echo $OUTPUT->box_start('center'); - echo '
| ';
- echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
- echo ' '.fullname($user1).' ';
- echo ' | ';
- echo '';
- echo ' | ';
- echo '';
- echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
- echo ' '.fullname($user2).' ';
+ echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
+ echo html_writer::start_tag('tr');
+
+ echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
+ echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
+ echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
+ echo html_writer::end_tag('td');
+
+ echo html_writer::start_tag('td', array('align' => 'center'));
+ echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/left'), 'alt' => get_string('from')));
+ echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/right'), 'alt' => get_string('to')));
+ echo html_writer::end_tag('td');
+
+ echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
+ echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
+ echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
if (isset($user2->iscontact) && isset($user2->isblocked)) {
$incontactlist = $user2->iscontact;
@@ -1454,11 +1832,12 @@ function message_print_message_history($user1,$user2,$search='',$messagelimit=0,
$strblock = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
$useractionlinks = $strcontact.' |'.$strblock;
- echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
+ echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
}
- echo ' | ';
- echo '
".message_format_message($message, $user1, $messagedate, $search, 'me').'
'; + $formatted_message = message_format_message($message, $messagedate, $search, 'me'); + $side = 'left'; } else { - $tablecontents .= "
".message_format_message($message, $user2, $messagedate, $search, 'other').'
'; + $formatted_message = message_format_message($message, $messagedate, $search, 'other'); + $side = 'right'; } + $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass")); } - echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory')); + echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory')); } else { - echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory')); + echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory')); } } -function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') { +/** + * Format a message for display in the message history + * @param object $message the message object + * @param string $format optional date format + * @param string $keywords keywords to highlight + * @param string $class CSS class to apply to the div around the message + * @return string the formatted message + */ +function message_format_message($message, $format='', $keywords='', $class='other') { static $dateformat; - if (empty($dateformat)) { + //if we haven't previously set the date format or they've supplied a new one + if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) { if ($format) { $dateformat = $format; } else { - $format = get_string('strftimedatetimeshort'); + $dateformat = get_string('strftimedatetimeshort'); } } $time = userdate($message->timecreated, $dateformat); @@ -1525,17 +1920,7 @@ function message_format_message(&$message, &$user, $format='', $keywords='', $cl $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options); } - if (!empty($message->contexturl)) { - $displaytext = null; - if (!empty($message->contexturlname)) { - $displaytext= $message->contexturlname; - } else { - $displaytext= $message->contexturl; - } - $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext')); - $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl)); - $messagetext .= html_writer::end_tag('div'); - } + $messagetext .= message_format_contexturl($message); if ($keywords) { $messagetext = highlight($keywords, $messagetext); @@ -1545,10 +1930,36 @@ function message_format_message(&$message, &$user, $format='', $keywords='', $cl } /** - * Inserts a message into the database, but also forwards it - * via other means if appropriate. + * Format a the context url and context url name of a message for display + * @param object $message the message object + * @return string the formatted string */ -function message_post_message($userfrom, $userto, $message, $format, $messagetype) { +function message_format_contexturl($message) { + $s = null; + + if (!empty($message->contexturl)) { + $displaytext = null; + if (!empty($message->contexturlname)) { + $displaytext= $message->contexturlname; + } else { + $displaytext= $message->contexturl; + } + $s .= html_writer::start_tag('div',array('class' => 'messagecontext')); + $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl)); + $s .= html_writer::end_tag('div'); + } + + return $s; +} + +/** + * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences + * @param object $userfrom the message sender + * @param object $userto the message recipient + * @param string $message the message + * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML + */ +function message_post_message($userfrom, $userto, $message, $format) { global $SITE, $CFG, $USER; $eventdata = new stdClass(); @@ -1560,7 +1971,7 @@ function message_post_message($userfrom, $userto, $message, $format, $messagetyp //using string manager directly so that strings in the message will be in the message recipients language rather than the senders $eventdata->subject = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang); - if ($format==FORMAT_HTML) { + if ($format == FORMAT_HTML) { $eventdata->fullmessage = ''; $eventdata->fullmessagehtml = $message; } else { @@ -1607,9 +2018,12 @@ function message_get_participants() { /** * Print a row of contactlist displaying user picture, messages waiting and * block links etc - * @param $contact contact object containing all fields required for $OUTPUT->user_picture() - * @param $incontactlist is the user a contact of ours? - * @param $selectcontacturl string the url to send the user to when a contact's name is clicked + * @param object $contact contact object containing all fields required for $OUTPUT->user_picture() + * @param bool $incontactlist is the user a contact of ours? + * @param bool $isblocked is the user blocked? + * @param string $selectcontacturl the url to send the user to when a contact's name is clicked + * @param bool $showactionlinks display action links next to the other users (add contact, block user etc) + * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted. */ function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) { global $OUTPUT, $USER; @@ -1617,7 +2031,7 @@ function message_print_contactlist_user($contact, $incontactlist = true, $isbloc $fullnamelink = $fullname; $linkclass = ''; - if (!empty($selecteduser) && $contact->id==$selecteduser->id) { + if (!empty($selecteduser) && $contact->id == $selecteduser->id) { $linkclass = 'messageselecteduser'; } @@ -1634,10 +2048,12 @@ function message_print_contactlist_user($contact, $incontactlist = true, $isbloc $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon'); } - echo '