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.
126 lines
3.8 KiB
126 lines
3.8 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/>.
|
|
|
|
/**
|
|
* Notification viewed event.
|
|
*
|
|
* @package core
|
|
* @copyright 2018 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\event;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Notification viewed event class.
|
|
*
|
|
* @package core
|
|
* @copyright 2018 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class notification_viewed extends base {
|
|
|
|
/**
|
|
* Create event using ids.
|
|
*
|
|
* @param int $userfromid
|
|
* @param int $usertoid
|
|
* @param int $notificationid
|
|
* @return notification_viewed
|
|
*/
|
|
public static function create_from_ids($userfromid, $usertoid, $notificationid) {
|
|
// We may be sending a notification from the 'noreply' address, which means we are not actually sending a
|
|
// notification from a valid user. In this case, we will set the userid to 0.
|
|
// Check if the userid is valid.
|
|
if (!\core_user::is_real_user($userfromid)) {
|
|
$userfromid = 0;
|
|
}
|
|
|
|
// Get the context for the user who received the notification.
|
|
$context = \context_user::instance($usertoid, IGNORE_MISSING);
|
|
// If the user no longer exists the context value will be false, in this case use the system context.
|
|
if ($context === false) {
|
|
$context = \context_system::instance();
|
|
}
|
|
|
|
$event = self::create(
|
|
[
|
|
'objectid' => $notificationid,
|
|
'userid' => $usertoid, // Using the user who read the notification as they are the ones performing the action.
|
|
'context' => $context,
|
|
'relateduserid' => $userfromid
|
|
]
|
|
);
|
|
|
|
return $event;
|
|
}
|
|
|
|
/**
|
|
* Init method.
|
|
*/
|
|
protected function init() {
|
|
$this->data['objecttable'] = 'notifications';
|
|
$this->data['crud'] = 'u';
|
|
$this->data['edulevel'] = self::LEVEL_OTHER;
|
|
}
|
|
|
|
/**
|
|
* Returns localised general event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_name() {
|
|
return get_string('eventnotificationviewed', 'message');
|
|
}
|
|
|
|
/**
|
|
* Returns relevant URL.
|
|
*
|
|
* @return \moodle_url
|
|
*/
|
|
public function get_url() {
|
|
return new \moodle_url('/message/output/popup/notifications.php', array('notificationid' => $this->objectid));
|
|
}
|
|
|
|
/**
|
|
* Returns description of what happened.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_description() {
|
|
return "The user with id '$this->userid' read a notification from the user with id '$this->relateduserid'.";
|
|
}
|
|
|
|
/**
|
|
* Custom validation.
|
|
*
|
|
* @throws \coding_exception
|
|
* @return void
|
|
*/
|
|
protected function validate_data() {
|
|
parent::validate_data();
|
|
|
|
if (!isset($this->relateduserid)) {
|
|
throw new \coding_exception('The \'relateduserid\' must be set.');
|
|
}
|
|
}
|
|
|
|
public static function get_objectid_mapping() {
|
|
return array('db' => 'notifications', 'restore' => base::NOT_MAPPED);
|
|
}
|
|
}
|
|
|