MDL-41101 mod_assign: replaced 'view' add_to_log call for the submission status page...
authorMark Nelson <markn@moodle.com>
Fri, 28 Mar 2014 00:54:04 +0000 (17:54 -0700)
committerPetr Skoda <skodak@mujMac.local>
Thu, 17 Apr 2014 01:51:10 +0000 (09:51 +0800)
mod/assign/classes/event/submission_status_viewed.php [new file with mode: 0644]
mod/assign/lang/en/assign.php
mod/assign/locallib.php
mod/assign/tests/events_test.php

diff --git a/mod/assign/classes/event/submission_status_viewed.php b/mod/assign/classes/event/submission_status_viewed.php
new file mode 100644 (file)
index 0000000..011e812
--- /dev/null
@@ -0,0 +1,79 @@
+<?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 submission status viewed 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 submission_status_viewed extends base {
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventsubmissionstatusviewed', 'mod_assign');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with the id {$this->userid} has viewed the status of their submission for the assignment with
+            the id {$this->other['assignid']}.";
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     */
+    protected function validate_data() {
+        parent::validate_data();
+
+        if (!isset($this->other['assignid'])) {
+            throw new \coding_exception('The \'assignid\' must be set in other.');
+        }
+    }
+}
index 80e677a..09b17dd 100644 (file)
@@ -157,6 +157,7 @@ $string['eventsubmissionformviewed'] = 'Submission form viewed.';
 $string['eventsubmissiongraded'] = 'The submission has been graded.';
 $string['eventsubmissionlocked'] = 'The submissions have been locked for a user.';
 $string['eventsubmissionstatusupdated'] = 'The status of the submission has been updated.';
+$string['eventsubmissionstatusviewed'] = 'The status of the submission has been viewed.';
 $string['eventsubmissionunlocked'] = 'The submissions have been unlocked for a user.';
 $string['eventsubmissionupdated'] = 'Submission updated.';
 $string['eventsubmissionviewed'] = 'Submission viewed.';
index 48c8eaf..d44bdb8 100644 (file)
@@ -4091,7 +4091,17 @@ class assign {
         }
 
         $o .= $this->view_footer();
-        $this->add_to_log('view', get_string('viewownsubmissionstatus', 'assign'));
+
+        $params = array(
+            'context' => $this->context,
+            'other' => array(
+                'assignid' => $this->get_instance()->id
+            )
+        );
+        $event = \mod_assign\event\submission_status_viewed::create($params);
+        $event->set_legacy_logdata('view', new lang_string('viewownsubmissionstatus', 'assign'));
+        $event->trigger();
+
         return $o;
     }
 
index 8e34a6f..764d999 100644 (file)
@@ -243,6 +243,41 @@ class assign_events_testcase extends mod_assign_base_testcase {
         $this->editingteachers[0]->ignoresesskey = false;
     }
 
+    /**
+     * Test the submission_status_viewed event.
+     */
+    public function test_submission_status_viewed() {
+        global $PAGE;
+
+        $this->setUser($this->editingteachers[0]);
+
+        $assign = $this->create_instance();
+
+        // We need to set the URL in order to view the feedback.
+        $PAGE->set_url('/a_url');
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        $assign->view();
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Check that the event contains the expected values.
+        $this->assertInstanceOf('\mod_assign\event\submission_status_viewed', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $expected = array(
+            $assign->get_course()->id,
+            'assign',
+            'view',
+            'view.php?id=' . $assign->get_course_module()->id,
+            get_string('viewownsubmissionstatus', 'assign'),
+            $assign->get_course_module()->id
+        );
+        $this->assertEventLegacyLogData($expected, $event);
+        $this->assertEventContextNotUsed($event);
+    }
+
     public function test_submission_status_updated() {
         $this->editingteachers[0]->ignoresesskey = true;
         $this->setUser($this->editingteachers[0]);