Files
moodle/lib/classes/event/course_module_created.php
T
Rajesh Taneja aa13929988 MDL-42584 Events: modified get_description in events
blog_entry_created - Removed summary field
blog_entry_deleted - Removed summary field and unwanted entry record
blog_entry_updated - Fixed single quotes and removed summary field
course_module_created - Removed subject
course_module_updated - Removed subject
user_deleted - Removed user firstname and last name
course_module_viewed - Fixed description
2013-10-29 15:24:23 +08:00

127 lines
3.8 KiB
PHP

<?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/>.
/**
* Event to be triggered when a new course module is created.
*
* @package core
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
namespace core\event;
defined('MOODLE_INTERNAL') || die();
/**
* Class course_module_created
*
* Class for event to be triggered when a new course module is created.
*
* @package core
* @copyright 2013 Ankit Agarwal
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class course_module_created extends base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'course_modules';
$this->data['crud'] = 'c';
$this->data['level'] = self::LEVEL_TEACHING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventcoursemodulecreated', 'core');
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
return 'The '. $this->other['modulename'] . ' module with instance id ' . $this->other['instanceid'] .
' was created by user with id ' . $this->userid;
}
/**
* Returns relevant URL.
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/mod/' . $this->other['modulename'] . '/view.php', array('id' => $this->other['instanceid']));
}
/**
* Legacy event name.
*
* @return string legacy event name
*/
public static function get_legacy_eventname() {
return 'mod_created';
}
/**
* Legacy event data.
*
* @return \stdClass
*/
protected function get_legacy_eventdata() {
$eventdata = new \stdClass();
$eventdata->modulename = $this->other['modulename'];
$eventdata->name = $this->other['name'];
$eventdata->cmid = $this->objectid;
$eventdata->courseid = $this->courseid;
$eventdata->userid = $this->userid;
return $eventdata;
}
/**
* replace add_to_log() statement.
*
* @return array of parameters to be passed to legacy add_to_log() function.
*/
protected function get_legacy_logdata() {
return array ($this->courseid, "course", "add mod", "../mod/" . $this->other['modulename'] . "/view.php?id=" .
$this->other['instanceid'], $this->other['modulename'] . " " . $this->other['instanceid']);
}
/**
* custom validations
*
* Throw \coding_exception notice in case of any problems.
*/
protected function validate_data() {
if (!isset($this->other['modulename'])) {
throw new \coding_exception("Field other['modulename'] cannot be empty");
}
if (!isset($this->other['instanceid'])) {
throw new \coding_exception("Field other['instanceid'] cannot be empty");
}
if (!isset($this->other['name'])) {
throw new \coding_exception("Field other['name'] cannot be empty");
}
}
}