MDL-41101 mod_assign: replaced 'save grading feedback' add_to_log call with an event
authorMark Nelson <markn@moodle.com>
Thu, 3 Apr 2014 05:17:38 +0000 (22:17 -0700)
committerPetr Skoda <skodak@mujMac.local>
Thu, 17 Apr 2014 01:51:11 +0000 (09:51 +0800)
mod/assign/classes/event/feedback_updated.php [new file with mode: 0644]
mod/assign/feedback/offline/locallib.php
mod/assign/lang/en/assign.php
mod/assign/tests/events_test.php

diff --git a/mod/assign/classes/event/feedback_updated.php b/mod/assign/classes/event/feedback_updated.php
new file mode 100644 (file)
index 0000000..e02c26e
--- /dev/null
@@ -0,0 +1,81 @@
+<?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_assign feedback updated event.
+ *
+ * @property-read array $other {
+ *      Extra information about event.
+ *
+ *      - int assignid: the id of the assignment.
+ * }
+ *
+ * @package    mod_assign
+ * @since      Moodle 2.7
+ * @copyright  2014 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_assign\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+class feedback_updated extends base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_TEACHING;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventfeedbackupdated', 'mod_assign');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with the id {$this->userid} updated the feedback for the user with the id {$this->relateduserid}
+            for the assignment with the id {$this->other['assignid']}.";
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     */
+    protected function validate_data() {
+        parent::validate_data();
+
+        if (!isset($this->relateduserid)) {
+            throw new \coding_exception('The \'relateduserid\' must be set.');
+        }
+
+        if (!isset($this->other['assignid'])) {
+            throw new \coding_exception('The \'assignid\' must be set in other.');
+        }
+    }
+}
index d2ead7c..a16448b 100644 (file)
@@ -188,12 +188,21 @@ class assign_feedback_offline extends assign_feedback_plugin {
                         $grade = $this->assignment->get_user_grade($record->user->id, true);
                         $this->assignment->notify_grade_modified($grade);
                         if ($plugin->set_editor_text($field, $newvalue, $grade->id)) {
-                            $logdesc = get_string('feedbackupdate', 'assignfeedback_offline',
+                            $logdesc = new lang_string('feedbackupdate', 'assignfeedback_offline',
                                                   array('field'=>$description,
                                                         'student'=>$userdesc,
                                                         'text'=>$newvalue));
 
-                            $this->assignment->add_to_log('save grading feedback', $logdesc);
+                            // Trigger event for updating the feedback.
+                            $event = \mod_assign\event\feedback_updated::create(array(
+                                'relateduserid' => $user->id,
+                                'context' => $this->assignment->get_context(),
+                                'other' => array(
+                                    'assignid' => $this->assignment->get_instance()->id
+                                )
+                            ));
+                            $event->set_legacy_logdata('save grading feedback', $logdesc);
+                            $event->trigger();
                         }
 
                         // If this is the gradebook comments plugin - post an update to the gradebook.
index f56cf1c..83c66a3 100644 (file)
@@ -145,6 +145,7 @@ $string['eventassessablesubmitted'] = 'A submission has been submitted.';
 $string['eventbatchsetmarkerallocationviewed'] = 'Batch set marker allocation viewed';
 $string['eventbatchsetworkflowstateviewed'] = 'Batch set workflow state viewed.';
 $string['eventextensiongranted'] = 'An extension has been granted.';
+$string['eventfeedbackupdated'] = 'Feedback updated';
 $string['eventfeedbackviewed'] = 'Feedback viewed';
 $string['eventgradingformviewed'] = 'Grading form viewed';
 $string['eventgradingtableviewed'] = 'Grading table viewed';
index efdc027..a6f220f 100644 (file)
@@ -624,6 +624,40 @@ class assign_events_testcase extends mod_assign_base_testcase {
         $this->assertEventContextNotUsed($event);
     }
 
+    /**
+     * Test the feedback_updated event.
+     */
+    public function test_feedback_updated() {
+        $assign = $this->create_instance();
+
+        $logdesc = get_string('feedbackupdate', 'assignfeedback_offline',
+            array('field' => 'The description',
+                  'student' => 'The student\'s name',
+                  'text' => 'Text'));
+        $event = \mod_assign\event\feedback_updated::create(array(
+            'userid' => 2,
+            'relateduserid' => 2,
+            'context' => $assign->get_context(),
+            'other' => array(
+                'assignid' => $assign->get_instance()->id
+            )
+        ));
+        $event->set_legacy_logdata('save grading feedback', $logdesc);
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        $event->trigger();
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        $this->assertInstanceOf('\mod_assign\event\feedback_updated', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $expectedlog = array($assign->get_course()->id, 'assign', 'save grading feedback', 'view.php?id=' . $assign->get_course_module()->id,
+            $logdesc, $assign->get_course_module()->id);
+        $this->assertEventLegacyLogData($expectedlog, $event);
+        $this->assertEventContextNotUsed($event);
+    }
+
     /**
      * Test the grading_form_viewed event.
      */