MDL-43044 events: Add a course_module_instance_list_viewed abstract class

lang/en/moodle.php

@@ -723,6 +723,7 @@ $string['eventcourseresetstarted'] = 'Course reset started';
 $string['eventcourserestored'] = 'Course restored';
 $string['eventcourseupdated'] = 'Course updated';
 $string['eventcoursesectionupdated'] = ' Course section updated';
+$string['eventcoursemoduleinstancelistviewed'] = 'Course module instance list viewed';
 $string['eventusercreated'] = 'User created';
 $string['eventuserdeleted'] = 'User deleted';
 $string['eventuserlistviewed'] = 'User list viewed';

lib/classes/event/course_module_instance_list_viewed.php

@@ -0,0 +1,113 @@
+<?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/>.
+
+/**
+ * Course module instance list viewed event.
+ *
+ * @package    core
+ * @copyright  2013 onwards Ankit Agarwal
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Course module instance list viewed event class.
+ *
+ * This is an abstract to guide the developers in using this event name for their events.
+ * It is intended to be used when the user viewes the list of all the instances of a module
+ * in a course. This replaces the historical 'view all' log entry generated in mod/somemod/index.php.
+ *
+ * Example:
+ *
+ *     \mod_chat\event\course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed
+ *
+ * @package    core
+ * @copyright  2013 onwards Ankit Agarwal
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class course_module_instance_list_viewed extends base{
+
+    /** @var string private var to store mod name */
+    private $modname;
+
+    /**
+     * Init method.
+     *
+     * @return void
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['level'] = self::LEVEL_OTHER;
+        if (strstr($this->component, 'mod_') === false) {
+            throw new \coding_exception('The event name or namespace is invalid.');
+        } else {
+            $this->modname = str_replace('mod_', '', $this->component);
+        }
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "User with id '$this->userid' viewed instance list for module '$this->modname' in course with id
+                '$this->courseid'";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventcoursemoduleinstancelistviewed', 'core');
+    }
+
+    /**
+     * Get URL related to the action.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url("/mod/$this->modname/index.php", array('id' => $this->courseid));
+    }
+
+    /**
+     * Return the legacy event log data.
+     *
+     * @return array|null
+     */
+    protected function get_legacy_logdata() {
+        return array($this->courseid, $this->modname, 'view all', 'index.php?id=' . $this->courseid, '');
+    }
+
+
+    /**
+     * Custom validation.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        if ($this->context->contextlevel !== CONTEXT_COURSE) {
+            throw new \coding_exception('The context must be a course level context.');
+        }
+    }
+
+}

lib/classes/event/course_module_instances_list_viewed.php

@@ -79,3 +79,4 @@ abstract class course_module_instances_list_viewed extends \core\event\content_v
     }
 
 }
+