Your IP : 192.168.165.1
<?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/>.
/**
* Message sent event.
*
* @package core
* @copyright 2014 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();
/**
* Message sent event class.
*
* @property-read array $other {
* Extra information about event.
*
* - int courseid: the id of the related course.
* }
*
* @package core
* @since Moodle 2.7
* @copyright 2014 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class message_sent extends base {
/**
* Create event using ids.
* @param int $userfromid
* @param int $usertoid
* @param int $messageid
* @param int $courseid course id the event is related with.
* @return message_sent
*/
public static function create_from_ids(int $userfromid, int $usertoid, int $messageid, int $courseid) {
// We may be sending a message from the 'noreply' address, which means we are not actually sending a
// message 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;
}
$event = self::create(array(
'objectid' => $messageid,
'userid' => $userfromid,
'context' => \context_system::instance(),
'relateduserid' => $usertoid,
'other' => array(
'courseid' => $courseid
)
));
return $event;
}
/**
* Init method.
*/
protected function init() {
$this->data['objecttable'] = 'messages';
$this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_OTHER;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventmessagesent', 'message');
}
/**
* Returns relevant URL.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
}
/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
// Check if we are sending from a valid user.
if (\core_user::is_real_user($this->userid)) {
return "The user with id '$this->userid' sent a message to the user with id '$this->relateduserid'.";
}
return "A message was sent by the system to the user with id '$this->relateduserid'.";
}
/**
* Return legacy data for add_to_log().
*
* @return array
*/
protected function get_legacy_logdata() {
// The add_to_log function was only ever called when we sent a message from one user to another. We do not want
// to return the legacy log data if we are sending a system message, so check that the userid is valid.
if (\core_user::is_real_user($this->userid)) {
$messageid = $this->other['messageid'] ?? $this->objectid; // For BC we may have 'messageid' in other.
return array(SITEID, 'message', 'write', 'index.php?user=' . $this->userid . '&id=' . $this->relateduserid .
'&history=1#m' . $messageid, $this->userid);
}
return null;
}
/**
* 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.');
}
if (!isset($this->other['courseid'])) {
throw new \coding_exception('The \'courseid\' value must be set in other.');
}
}
public static function get_objectid_mapping() {
return array('db' => 'messages', 'restore' => base::NOT_MAPPED);
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['courseid'] = array('db' => 'course', 'restore' => base::NOT_MAPPED);
return $othermapped;
}
}