Merge branch 'MDL-66899-log-quiz-regrade' of https://github.com/rboyatt/moodle

mod/quiz/classes/event/attempt_regraded.php

@@ -0,0 +1,122 @@
+<?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/>.
+
+/**
+ * The mod_quiz attempt regraded event.
+ *
+ * @package    mod_quiz
+ * @copyright  2020 Russell Boyatt <russell.boyatt@warwick.ac.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_quiz\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The mod_quiz attempt regraded event class.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ *
+ *      - int quizid: the id of the quiz.
+ * }
+ *
+ * @package    mod_quiz
+ * @copyright  2020 Russell Boyatt <russell.boyatt@warwick.ac.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class attempt_regraded extends \core\event\base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'quiz_attempts';
+        $this->data['crud'] = 'u';
+        $this->data['edulevel'] = self::LEVEL_TEACHING;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventquizattemptregraded', 'mod_quiz');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' regraded quiz attempt with id '$this->objectid' by user " .
+          "with id '$this->relateduserid' for the quiz with course module id '$this->contextinstanceid'.";
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('/mod/quiz/review.php', array('attempt' => $this->objectid));
+    }
+
+    /**
+     * 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->userid)) {
+            throw new \coding_exception('The \'userid\' must be set.');
+        }
+
+        if (!isset($this->other['quizid'])) {
+            throw new \coding_exception('The \'quizid\' value must be set in other.');
+        }
+    }
+
+    /**
+     * Get mapping to objects
+     *
+     * @return array Array of mappings
+     */
+    public static function get_objectid_mapping() {
+        return array('db' => 'quiz_attempts', 'restore' => 'quiz_attempt');
+    }
+
+    /**
+     * Retrieve other mapping detail for the event.
+     *
+     * @return array Array of array mappings
+     */
+    public static function get_other_mapping() {
+        $othermapped = array();
+        $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
+
+        return $othermapped;
+    }
+}

mod/quiz/lang/en/quiz.php

@@ -342,6 +342,7 @@ $string['eventoverrideupdated'] = 'Quiz override updated';
 $string['eventquestionmanuallygraded'] = 'Question manually graded';
 $string['eventquizattemptabandoned'] = 'Quiz attempt abandoned';
 $string['eventquizattempttimelimitexceeded'] = 'Quiz attempt time limit exceeded';
+$string['eventquizattemptregraded'] = 'Quiz attempt regraded';
 $string['eventquizattemptstarted'] = 'Quiz attempt started';
 $string['eventquizattemptsubmitted'] = 'Quiz attempt submitted';
 $string['eventreportviewed'] = 'Quiz report viewed';

mod/quiz/report/overview/report.php

@@ -357,6 +357,17 @@ class quiz_overview_report extends quiz_attempts_report {
 
         if (!$dryrun) {
             question_engine::save_questions_usage_by_activity($quba);
+
+            $params = array(
+              'objectid' => $attempt->id,
+              'relateduserid' => $attempt->userid,
+              'context' => $this->context,
+              'other' => array(
+                'quizid' => $attempt->quiz
+              )
+            );
+            $event = \mod_quiz\event\attempt_regraded::create($params);
+            $event->trigger();
         }
 
         $transaction->allow_commit();

mod/quiz/tests/events_test.php

@@ -749,4 +749,40 @@ class mod_quiz_events_testcase extends advanced_testcase {
         $this->assertEventLegacyLogData($expected, $event);
         $this->assertEventContextNotUsed($event);
     }
+
+    /**
+     * Test the attempt regraded event.
+     *
+     * There is no external API for regrading attempts, so the unit test will simply
+     * create and trigger the event and ensure the event data is returned as expected.
+     */
+    public function test_attempt_regraded() {
+      $this->resetAfterTest();
+
+      $this->setAdminUser();
+      $course = $this->getDataGenerator()->create_course();
+      $quiz = $this->getDataGenerator()->create_module('quiz', array('course' => $course->id));
+
+      $params = array(
+        'objectid' => 1,
+        'relateduserid' => 2,
+        'courseid' => $course->id,
+        'context' => context_module::instance($quiz->cmid),
+        'other' => array(
+          'quizid' => $quiz->id
+        )
+      );
+      $event = \mod_quiz\event\attempt_regraded::create($params);
+
+      // Trigger and capture the event.
+      $sink = $this->redirectEvents();
+      $event->trigger();
+      $events = $sink->get_events();
+      $event = reset($events);
+
+      // Check that the event data is valid.
+      $this->assertInstanceOf('\mod_quiz\event\attempt_regraded', $event);
+      $this->assertEquals(context_module::instance($quiz->cmid), $event->get_context());
+      $this->assertEventContextNotUsed($event);
+    }
 }