diff --git a/lang/en/moodle.php b/lang/en/moodle.php index 488667d8fed..5ea320f0e25 100644 --- a/lang/en/moodle.php +++ b/lang/en/moodle.php @@ -665,6 +665,9 @@ $string['eventcoursecategorydeleted'] = 'Category deleted'; $string['eventcoursecontentdeleted'] = 'Course content deleted'; $string['eventcoursecreated'] = 'Course created'; $string['eventcoursedeleted'] = 'Course deleted'; +$string['eventcoursemodulecreated'] = 'Course module created'; +$string['eventcoursemoduledeleted'] = 'Course module deleted'; +$string['eventcoursemoduleupdated'] = 'Course module updated'; $string['eventcourserestored'] = 'Course restored'; $string['eventcourseupdated'] = 'Course updated'; $string['eventcoursesectionupdated'] = ' Course section updated'; diff --git a/lib/classes/event/course_module_created.php b/lib/classes/event/course_module_created.php new file mode 100644 index 00000000000..442c02ea763 --- /dev/null +++ b/lib/classes/event/course_module_created.php @@ -0,0 +1,126 @@ +. + +/** + * 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 ' . $this->other['name']. ' 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"); + } + } +} + diff --git a/lib/classes/event/course_module_deleted.php b/lib/classes/event/course_module_deleted.php new file mode 100644 index 00000000000..67a4b020e40 --- /dev/null +++ b/lib/classes/event/course_module_deleted.php @@ -0,0 +1,114 @@ +. + +/** + * Event to be triggered when a new course module is deleted. + * + * @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_deleted + * + * Class for event to be triggered when a course module is deleted. + * + * @package core + * @copyright 2013 Ankit Agarwal + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. + */ +class course_module_deleted extends base { + + /** + * Set basic properties for the event. + */ + protected function init() { + $this->data['objecttable'] = 'course_modules'; + $this->data['crud'] = 'd'; + $this->data['level'] = self::LEVEL_TEACHING; + } + + /** + * Returns localised general event name. + * + * @return string + */ + public static function get_name() { + return get_string('eventcoursemoduledeleted', 'core'); + } + + /** + * Returns non-localised event description with id's for admin use only. + * + * @return string + */ + public function get_description() { + return 'The module ' . $this->other['modulename'] . ' with instance id ' . $this->other['instanceid']. ' was deleted by + user with id ' . $this->userid; + } + + /** + * Legacy event name. + * + * @return string legacy event name + */ + public static function get_legacy_eventname() { + return 'mod_deleted'; + } + + /** + * Legacy event data. + * + * @return \stdClass + */ + protected function get_legacy_eventdata() { + $eventdata = new \stdClass(); + $eventdata->modulename = $this->other['modulename']; + $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", "delete mod", "view.php?id=$this->courseid", + $this->other['modulename'] . " " . $this->other['instanceid'], $this->objectid); + } + + /** + * 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"); + } + } +} + diff --git a/lib/classes/event/course_module_updated.php b/lib/classes/event/course_module_updated.php new file mode 100644 index 00000000000..e6a7b19bd2f --- /dev/null +++ b/lib/classes/event/course_module_updated.php @@ -0,0 +1,126 @@ +. + +/** + * Event to be triggered when a new course module is updated. + * + * @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_updated + * + * Class for event to be triggered when a course module is updated. + * + * @package core + * @copyright 2013 Ankit Agarwal + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. + */ +class course_module_updated extends base { + + /** + * Set basic properties for the event. + */ + protected function init() { + $this->data['objecttable'] = 'course_modules'; + $this->data['crud'] = 'u'; + $this->data['level'] = self::LEVEL_TEACHING; + } + + /** + * Returns localised general event name. + * + * @return string + */ + public static function get_name() { + return get_string('eventcoursemoduleupdated', '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 ' . $this->other['name']. ' was updated 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_updated'; + } + + /** + * 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", "update 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"); + } + } +} +