MDL-44321 events: cleaning up course_module_instance_list_viewed event

lib/classes/event/course_module_instance_list_viewed.php

@@ -105,8 +105,8 @@ abstract class course_module_instance_list_viewed extends base{
      * @return void
      */
     protected function validate_data() {
-        if ($this->contextlevel !== CONTEXT_COURSE) {
-            throw new \coding_exception('The context must be a course level context.');
+        if ($this->contextlevel != CONTEXT_COURSE) {
+            throw new \coding_exception('Context passed must be course context.');
         }
     }
 

mod/book/index.php

@@ -51,6 +51,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_book\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 // Get all the appropriate data

mod/chat/index.php

@@ -18,6 +18,7 @@ $params = array(
     'context' => context_course::instance($id)
 );
 $event = \mod_chat\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 /// Get all required strings

mod/choice/index.php

@@ -16,6 +16,7 @@
 
     $eventdata = array('context' => context_course::instance($id));
     $event = \mod_choice\event\course_module_instance_list_viewed::create($eventdata);
+    $event->add_record_snapshot('course', $course);
     $event->trigger();
 
     $strchoice = get_string("modulename", "choice");

mod/data/index.php

@@ -43,6 +43,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_data\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strname = get_string('name');

mod/feedback/index.php

@@ -42,6 +42,7 @@ $PAGE->set_pagelayout('incourse');
 
 // Trigger instances list viewed event.
 $event = \mod_feedback\event\course_module_instance_list_viewed::create(array('context' => $context));
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 /// Print the page header

mod/folder/index.php

@@ -36,6 +36,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_folder\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strfolder       = get_string('modulename', 'folder');

mod/forum/index.php

@@ -55,6 +55,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_forum\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strforums       = get_string('forums', 'forum');

mod/lesson/index.php

@@ -43,6 +43,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_lesson\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 /// Get all required strings

mod/lti/index.php

@@ -59,6 +59,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_lti\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $PAGE->set_url('/mod/lti/index.php', array('id' => $course->id));

mod/page/index.php

@@ -34,6 +34,7 @@ $PAGE->set_pagelayout('incourse');
 
 // Trigger instances list viewed event.
 $event = \mod_page\event\course_module_instance_list_viewed::create(array('context' => context_course::instance($course->id)));
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strpage         = get_string('modulename', 'page');

mod/resource/index.php

@@ -36,6 +36,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_resource\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strresource     = get_string('modulename', 'resource');

mod/scorm/index.php

@@ -34,6 +34,7 @@ $PAGE->set_pagelayout('incourse');
 
 // Trigger instances list viewed event.
 $event = \mod_scorm\event\course_module_instance_list_viewed::create(array('context' => context_course::instance($course->id)));
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strscorm = get_string("modulename", "scorm");

mod/url/index.php

@@ -36,6 +36,7 @@ $params = array(
     'context' => context_course::instance($course->id)
 );
 $event = \mod_url\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 $strurl       = get_string('modulename', 'url');

mod/wiki/index.php

@@ -46,6 +46,7 @@ $PAGE->set_pagelayout('incourse');
 $context = context_course::instance($course->id);
 
 $event = \mod_wiki\event\course_module_instance_list_viewed::create(array('context' => $context));
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 /// Get all required stringswiki

mod/workshop/classes/event/course_module_instance_list_viewed.php

@@ -34,42 +34,5 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright  2013 Adrian Greeve
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class instances_list_viewed extends \core\event\course_module_instance_list_viewed {
-
-    /**
-     * Returns description of what happened.
-     *
-     * @return string
-     */
-    public function get_description() {
-        return 'User ' . $this->userid . ' viewed the list of workshop activities in the course ' . $this->courseid . '.';
-    }
-
-    /**
-     * Return the legacy event log data.
-     *
-     * @return array|null
-     */
-    protected function get_legacy_logdata() {
-        return array($this->courseid, 'workshop', 'view all', 'index.php?id=' . $this->courseid, '');
-    }
-
-    /**
-     * Return localised event name.
-     *
-     * @return string
-     */
-    public static function get_name() {
-        return get_string('eventinstanceslistviewed', 'mod_workshop');
-    }
-
-    /**
-     * Get URL related to the action
-     *
-     * @return \moodle_url
-     */
-    public function get_url() {
-        return new \moodle_url('/mod/workshop/index.php', array('id' => $this->courseid));
-    }
-
+class course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed {
 }

mod/workshop/index.php

@@ -43,7 +43,8 @@ $PAGE->navbar->add(get_string('modulenameplural', 'workshop'));
 echo $OUTPUT->header();
 
 $params = array('context' => context_course::instance($course->id));
-$event = \mod_workshop\event\instances_list_viewed::create($params);
+$event = \mod_workshop\event\course_module_instance_list_viewed::create($params);
+$event->add_record_snapshot('course', $course);
 $event->trigger();
 
 /// Get all the appropriate data

mod/workshop/lang/en/workshop.php

@@ -108,7 +108,6 @@ $string['eventassessmentevaluationsreset'] = 'Assessment evaluations reset';
 $string['eventassessableuploaded'] = 'Assessable uploaded';
 $string['eventassessmentevaluated'] = 'Assessment evaluated';
 $string['eventassessmentreevaluated'] = 'Assessment re-evaluated';
-$string['eventinstanceslistviewed'] = 'Workshop instance list viewed';
 $string['eventsubmissionassessed'] = 'Submission assessed';
 $string['eventsubmissionassessmentsreset'] = 'Submission assessments cleared';
 $string['eventsubmissioncreated'] = 'Submission created';

mod/workshop/tests/events_test.php

@@ -193,7 +193,7 @@ class mod_workshop_events_testcase extends advanced_testcase {
 
         $context = context_course::instance($this->course->id);
 
-        $event = \mod_workshop\event\instances_list_viewed::create(array('context' => $context));
+        $event = \mod_workshop\event\course_module_instance_list_viewed::create(array('context' => $context));
 
         // Trigger and capture the event.
         $sink = $this->redirectEvents();