diff --git a/mod/quiz/classes/event/group_override_deleted.php b/mod/quiz/classes/event/group_override_deleted.php new file mode 100644 index 00000000000..f1304bb6c64 --- /dev/null +++ b/mod/quiz/classes/event/group_override_deleted.php @@ -0,0 +1,102 @@ +. + +/** + * Group override deleted event class. + * + * @property-read array $other { + * Extra information about event. + * + * - int quizid: the id of the quiz. + * - int groupid: the id of the group. + * } + * + * @package mod_quiz + * @since Moodle 2.7 + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_quiz\event; + +defined('MOODLE_INTERNAL') || die(); + +class group_override_deleted extends \core\event\base { + + /** + * Init method. + */ + protected function init() { + $this->data['objecttable'] = 'quiz_overrides'; + $this->data['crud'] = 'd'; + $this->data['edulevel'] = self::LEVEL_TEACHING; + } + + /** + * Returns localised general event name. + * + * @return string + */ + public static function get_name() { + return get_string('eventoverridedeleted', 'mod_quiz'); + } + + /** + * Returns description of what happened. + * + * @return string + */ + public function get_description() { + return 'An override with the id ' . $this->objectid . ' for the quiz with the id of ' . $this->other['quizid'] . + ' was deleted by the user with the id ' . $this->userid . ' for the group with the id ' . $this->other['groupid']; + } + + /** + * Returns relevant URL. + * + * @return \moodle_url + */ + public function get_url() { + return new \moodle_url('/mod/quiz/overrides.php', array('cmid' => $this->contextinstanceid)); + } + + /** + * Return the legacy event log data. + * + * @return array + */ + protected function get_legacy_logdata() { + return array($this->courseid, 'quiz', 'delete override', 'overrides.php?cmid=' . $this->contextinstanceid, + $this->other['quizid'], $this->contextinstanceid); + } + + /** + * Custom validation. + * + * @throws \coding_exception + * @return void + */ + protected function validate_data() { + parent::validate_data(); + + if (!isset($this->other['quizid'])) { + throw new \coding_exception('The \'quizid\' must be set in other.'); + } + + if (!isset($this->other['groupid'])) { + throw new \coding_exception('The \'groupid\' must be set in other.'); + } + } +} diff --git a/mod/quiz/classes/event/user_override_deleted.php b/mod/quiz/classes/event/user_override_deleted.php new file mode 100644 index 00000000000..b441593014a --- /dev/null +++ b/mod/quiz/classes/event/user_override_deleted.php @@ -0,0 +1,101 @@ +. + +/** + * User override deleted event class. + * + * @property-read array $other { + * Extra information about event. + * + * - int quizid: the id of the quiz. + * } + * + * @package mod_quiz + * @since Moodle 2.7 + * @copyright 2014 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace mod_quiz\event; + +defined('MOODLE_INTERNAL') || die(); + +class user_override_deleted extends \core\event\base { + + /** + * Init method. + */ + protected function init() { + $this->data['objecttable'] = 'quiz_overrides'; + $this->data['crud'] = 'd'; + $this->data['edulevel'] = self::LEVEL_TEACHING; + } + + /** + * Returns localised general event name. + * + * @return string + */ + public static function get_name() { + return get_string('eventoverridedeleted', 'mod_quiz'); + } + + /** + * Returns description of what happened. + * + * @return string + */ + public function get_description() { + return 'An override with the id ' . $this->objectid . ' for the quiz with the id of ' . $this->other['quizid'] . + ' was deleted by the user with the id ' . $this->userid . ' for the user with the id ' . $this->relateduserid; + } + + /** + * Returns relevant URL. + * + * @return \moodle_url + */ + public function get_url() { + return new \moodle_url('/mod/quiz/overrides.php', array('cmid' => $this->contextinstanceid)); + } + + /** + * Return the legacy event log data. + * + * @return array + */ + protected function get_legacy_logdata() { + return array($this->courseid, 'quiz', 'delete override', 'overrides.php?cmid=' . $this->contextinstanceid, + $this->other['quizid'], $this->contextinstanceid); + } + + /** + * 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['quizid'])) { + throw new \coding_exception('The \'quizid\' must be set in other.'); + } + } +} diff --git a/mod/quiz/lang/en/quiz.php b/mod/quiz/lang/en/quiz.php index c54cf0189d7..583250584ff 100644 --- a/mod/quiz/lang/en/quiz.php +++ b/mod/quiz/lang/en/quiz.php @@ -309,6 +309,7 @@ $string['eventattemptdeleted'] = 'Quiz attempt deleted'; $string['eventattemptreviewed'] = 'Quiz attempt reviewed'; $string['eventattemptsummaryviewed'] = 'Quiz attempt summary viewed'; $string['eventeditpageviewed'] = 'Quiz edit page viewed'; +$string['eventoverridedeleted'] = 'Quiz override deleted'; $string['eventoverrideupdated'] = 'Quiz override updated'; $string['eventquizattemptabandoned'] = 'Quiz attempt abandoned'; $string['eventquizattempttimelimitexceeded'] = 'Quiz attempt time limit exceeded'; diff --git a/mod/quiz/lib.php b/mod/quiz/lib.php index 4cc17c55152..35e3b790e5b 100644 --- a/mod/quiz/lib.php +++ b/mod/quiz/lib.php @@ -203,6 +203,28 @@ function quiz_delete_override($quiz, $overrideid) { } $DB->delete_records('quiz_overrides', array('id' => $overrideid)); + + // Set the common parameters for one of the events we will be triggering. + $params = array( + 'objectid' => $override->id, + 'context' => context_module::instance($quiz->cmid), + 'other' => array( + 'quizid' => $override->quiz + ) + ); + // Determine which override deleted event to fire. + if (!empty($override->userid)) { + $params['relateduserid'] = $override->userid; + $event = \mod_quiz\event\user_override_deleted::create($params); + } else { + $params['other']['groupid'] = $override->groupid; + $event = \mod_quiz\event\group_override_deleted::create($params); + } + + // Trigger the override deleted event. + $event->add_record_snapshot('quiz_overrides', $override); + $event->trigger(); + return true; } diff --git a/mod/quiz/overridedelete.php b/mod/quiz/overridedelete.php index 8d9144fc8ac..ec841aef784 100644 --- a/mod/quiz/overridedelete.php +++ b/mod/quiz/overridedelete.php @@ -63,9 +63,6 @@ if ($confirm) { quiz_delete_override($quiz, $override->id); - add_to_log($cm->course, 'quiz', 'delete override', - "overrides.php?cmid=$cm->id", $quiz->id, $cm->id); - redirect($cancelurl); } diff --git a/mod/quiz/overrideedit.php b/mod/quiz/overrideedit.php index 1cde4bc5eab..fcdd3601063 100644 --- a/mod/quiz/overrideedit.php +++ b/mod/quiz/overrideedit.php @@ -155,8 +155,7 @@ if ($mform->is_cancelled()) { $fromform->{$key} = $oldoverride->{$key}; } } - // Delete the old override. - $DB->delete_records('quiz_overrides', array('id' => $oldoverride->id)); + quiz_delete_override($quiz, $oldoverride->id); } } diff --git a/mod/quiz/tests/events_test.php b/mod/quiz/tests/events_test.php index e6b29b7a763..bf97c8cca4e 100644 --- a/mod/quiz/tests/events_test.php +++ b/mod/quiz/tests/events_test.php @@ -467,4 +467,68 @@ class mod_quiz_events_testcase extends advanced_testcase { $this->assertEventLegacyLogData($expected, $event); $this->assertEventContextNotUsed($event); } + + /** + * Test the user override deleted event. + */ + public function test_user_override_deleted() { + global $DB; + + $this->resetAfterTest(); + + $this->setAdminUser(); + $course = $this->getDataGenerator()->create_course(); + $quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id)); + + // Create an override. + $override = new stdClass(); + $override->quiz = $quiz->id; + $override->userid = 2; + $override->id = $DB->insert_record('quiz_overrides', $override); + + // Trigger and capture the event. + $sink = $this->redirectEvents(); + quiz_delete_override($quiz, $override->id); + $events = $sink->get_events(); + $event = reset($events); + + // Check that the event data is valid. + $this->assertInstanceOf('\mod_quiz\event\user_override_deleted', $event); + $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context()); + $expected = array($course->id, 'quiz', 'delete override', 'overrides.php?cmid=' . $quiz->cmid, $quiz->id, $quiz->cmid); + $this->assertEventLegacyLogData($expected, $event); + $this->assertEventContextNotUsed($event); + } + + /** + * Test the group override deleted event. + */ + public function test_group_override_deleted() { + global $DB; + + $this->resetAfterTest(); + + $this->setAdminUser(); + $course = $this->getDataGenerator()->create_course(); + $quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id)); + + // Create an override. + $override = new stdClass(); + $override->quiz = $quiz->id; + $override->groupid = 2; + $override->id = $DB->insert_record('quiz_overrides', $override); + + // Trigger and capture the event. + $sink = $this->redirectEvents(); + quiz_delete_override($quiz, $override->id); + $events = $sink->get_events(); + $event = reset($events); + + // Check that the event data is valid. + $this->assertInstanceOf('\mod_quiz\event\group_override_deleted', $event); + $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context()); + $expected = array($course->id, 'quiz', 'delete override', 'overrides.php?cmid=' . $quiz->cmid, $quiz->id, $quiz->cmid); + $this->assertEventLegacyLogData($expected, $event); + $this->assertEventContextNotUsed($event); + } }