You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.9 KiB
114 lines
3.9 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Contains class used to return information to display for the message popup.
|
|
*
|
|
* @package message_popup
|
|
* @copyright 2016 Ryan Wyllie <ryan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace message_popup;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Class used to return information to display for the message popup.
|
|
*
|
|
* @copyright 2016 Ryan Wyllie <ryan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class api {
|
|
/**
|
|
* Get popup notifications for the specified users. Nothing is returned if notifications are disabled.
|
|
*
|
|
* @param int $useridto the user id who received the notification
|
|
* @param string $sort the column name to order by including optionally direction
|
|
* @param int $limit limit the number of result returned
|
|
* @param int $offset offset the result set by this amount
|
|
* @return array notification records
|
|
* @throws \moodle_exception
|
|
* @since 3.2
|
|
*/
|
|
public static function get_popup_notifications($useridto = 0, $sort = 'DESC', $limit = 0, $offset = 0) {
|
|
global $DB, $USER;
|
|
|
|
$sort = strtoupper($sort);
|
|
if ($sort != 'DESC' && $sort != 'ASC') {
|
|
throw new \moodle_exception('invalid parameter: sort: must be "DESC" or "ASC"');
|
|
}
|
|
|
|
if (empty($useridto)) {
|
|
$useridto = $USER->id;
|
|
}
|
|
|
|
// Is notification enabled ?
|
|
if ($useridto == $USER->id) {
|
|
$disabled = $USER->emailstop;
|
|
} else {
|
|
$user = \core_user::get_user($useridto, "emailstop", MUST_EXIST);
|
|
$disabled = $user->emailstop;
|
|
}
|
|
if ($disabled) {
|
|
// Notifications are disabled.
|
|
return array();
|
|
}
|
|
|
|
$sql = "SELECT n.id, n.useridfrom, n.useridto,
|
|
n.subject, n.fullmessage, n.fullmessageformat,
|
|
n.fullmessagehtml, n.smallmessage, n.contexturl,
|
|
n.contexturlname, n.timecreated, n.component,
|
|
n.eventtype, n.timeread, n.customdata
|
|
FROM {notifications} n
|
|
WHERE n.id IN (SELECT notificationid FROM {message_popup_notifications})
|
|
AND n.useridto = ?
|
|
ORDER BY timecreated $sort, timeread $sort, id $sort";
|
|
|
|
$notifications = [];
|
|
$records = $DB->get_recordset_sql($sql, [$useridto], $offset, $limit);
|
|
foreach ($records as $record) {
|
|
$notifications[] = (object) $record;
|
|
}
|
|
$records->close();
|
|
|
|
return $notifications;
|
|
}
|
|
|
|
/**
|
|
* Count the unread notifications for a user.
|
|
*
|
|
* @param int $useridto the user id who received the notification
|
|
* @return int count of the unread notifications
|
|
* @since 3.2
|
|
*/
|
|
public static function count_unread_popup_notifications($useridto = 0) {
|
|
global $USER, $DB;
|
|
|
|
if (empty($useridto)) {
|
|
$useridto = $USER->id;
|
|
}
|
|
|
|
return $DB->count_records_sql(
|
|
"SELECT count(id)
|
|
FROM {notifications}
|
|
WHERE id IN (SELECT notificationid FROM {message_popup_notifications})
|
|
AND useridto = ?
|
|
AND timeread is NULL",
|
|
[$useridto]
|
|
);
|
|
}
|
|
}
|
|
|