MDL-53035 mod_assign: add course_module_viewed event

diff --git a/mod/assign/classes/event/course_module_viewed.php b/mod/assign/classes/event/course_module_viewed.php
new file mode 100644 (file)
index 0000000..7581d79
--- /dev/null
+++ b/mod/assign/classes/event/course_module_viewed.php
@@ -0,0 +1,56 @@
+<?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 course module viewed event.
+ *
+ * @package    mod_assign
+ * @copyright  2018 Victor Deniz <victor@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_assign\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * The mod_assign course module viewed event class.
+ *
+ * @package    mod_assign
+ * @since      Moodle 3.6
+ * @copyright  2018 Victor Deniz <victor@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class course_module_viewed extends \core\event\course_module_viewed {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+        $this->data['objecttable'] = 'assign';
+    }
+
+    /**
+     * Get objectid mapping
+     */
+    public static function get_objectid_mapping() {
+        return array('db' => 'assign', 'restore' => 'assign');
+    }
+}
\ No newline at end of file

diff --git a/mod/assign/locallib.php b/mod/assign/locallib.php
index d6ebc69..52ee112 100644 (file)
--- a/mod/assign/locallib.php
+++ b/mod/assign/locallib.php
@@ -8754,13 +8754,23 @@ class assign {
     }
 
     /**
-     * Update the module completion status (set it viewed).
+     * Update the module completion status (set it viewed) and trigger module viewed event.
      *
      * @since Moodle 3.2
      */
     public function set_module_viewed() {
         $completion = new completion_info($this->get_course());
         $completion->set_module_viewed($this->get_course_module());
+
+        // Trigger the course module viewed event.
+        $assigninstance = $this->get_instance();
+        $event = \mod_assign\event\course_module_viewed::create(array(
+                'objectid' => $assigninstance->id,
+                'context' => $this->get_context()
+        ));
+
+        $event->add_record_snapshot('assign', $assigninstance);
+        $event->trigger();
     }
 
     /**

diff --git a/mod/assign/tests/events_test.php b/mod/assign/tests/events_test.php
index 8dfd768..b2fc975 100644 (file)
--- a/mod/assign/tests/events_test.php
+++ b/mod/assign/tests/events_test.php
@@ -1323,4 +1323,34 @@ class assign_events_testcase extends advanced_testcase {
         $this->assertEquals(context_module::instance($cm->id), $event->get_context());
         $this->assertEventContextNotUsed($event);
     }
+
+    /**
+     * Test the course module viewed event.
+     */
+    public function test_course_module_viewed() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $assign = $this->create_instance($course);
+
+        $context = $assign->get_context();
+
+        $params = array(
+            'context' => $context,
+            'objectid' => $assign->get_instance()->id
+        );
+
+        $event = \mod_assign\event\course_module_viewed::create($params);
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        $event->trigger();
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Check that the event contains the expected values.
+        $this->assertInstanceOf('\mod_assign\event\course_module_viewed', $event);
+        $this->assertEquals($context, $event->get_context());
+    }
 }

diff --git a/version.php b/version.php
index ed3c32b..2c47582 100644 (file)
--- a/version.php
+++ b/version.php
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2018110700.00;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2018110700.01;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.