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.
115 lines
3.1 KiB
115 lines
3.1 KiB
2 years ago
|
<?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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Abstract comment created event.
|
||
|
|
*
|
||
|
|
* @package core
|
||
|
|
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace core\event;
|
||
|
|
|
||
|
|
defined('MOODLE_INTERNAL') || die();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Abstract comment created event class.
|
||
|
|
*
|
||
|
|
* This class has to be extended by any event which is triggred while creating new comment.
|
||
|
|
*
|
||
|
|
* @property-read array $other {
|
||
|
|
* Extra information about event.
|
||
|
|
*
|
||
|
|
* - int itemid: id of item for which comment is added.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* @package core
|
||
|
|
* @since Moodle 2.7
|
||
|
|
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
abstract class comment_created extends base {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Init method.
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
protected function init() {
|
||
|
|
$this->data['crud'] = 'c';
|
||
|
|
$this->data['edulevel'] = self::LEVEL_PARTICIPATING;
|
||
|
|
$this->data['objecttable'] = 'comments';
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return localised event name.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public static function get_name() {
|
||
|
|
return get_string('eventcommentcreated', 'moodle');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns description of what happened.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_description() {
|
||
|
|
return "The user with id '$this->userid' added the comment with id '$this->objectid' to the '$this->component' " .
|
||
|
|
"with course module id '$this->contextinstanceid'.";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get URL related to the action.
|
||
|
|
*
|
||
|
|
* @return \moodle_url
|
||
|
|
*/
|
||
|
|
public function get_url() {
|
||
|
|
$context = $this->get_context();
|
||
|
|
if ($context) {
|
||
|
|
return $context->get_url();
|
||
|
|
} else {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Custom validation.
|
||
|
|
*
|
||
|
|
* @throws \coding_exception
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
protected function validate_data() {
|
||
|
|
parent::validate_data();
|
||
|
|
if (!isset($this->other['itemid'])) {
|
||
|
|
throw new \coding_exception('The \'itemid\' value must be set in other.');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public static function get_objectid_mapping() {
|
||
|
|
return array('db' => 'comments', 'restore' => 'comment');
|
||
|
|
}
|
||
|
|
|
||
|
|
public static function get_other_mapping() {
|
||
|
|
// We cannot map fields that do not have a 1:1 mapping.
|
||
|
|
$othermapped = array();
|
||
|
|
$othermapped['itemid'] = base::NOT_MAPPED;
|
||
|
|
return $othermapped;
|
||
|
|
}
|
||
|
|
}
|