diff --git a/lib/classes/event/course_module_viewed.php b/lib/classes/event/course_module_viewed.php index b455b345bbc..a6461abf992 100644 --- a/lib/classes/event/course_module_viewed.php +++ b/lib/classes/event/course_module_viewed.php @@ -96,6 +96,10 @@ abstract class course_module_viewed extends base { if (empty($this->objectid) || empty($this->objecttable)) { throw new \coding_exception('course_module_viewed event must define objectid and object table.'); } + // Make sure the context level is set to module. + if ($this->contextlevel != CONTEXT_MODULE) { + throw new \coding_exception('Context passed must be module context.'); + } } } diff --git a/mod/book/view.php b/mod/book/view.php index 0f3901df820..acb7f004a27 100644 --- a/mod/book/view.php +++ b/mod/book/view.php @@ -80,6 +80,8 @@ if ($chapterid == '0') { // Go to first chapter if no given. 'objectid' => $book->id ); $event = \mod_book\event\course_module_viewed::create($params); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); $event->add_record_snapshot('book', $book); $event->trigger(); diff --git a/mod/choice/view.php b/mod/choice/view.php index 27089f592e4..55e1086de0c 100644 --- a/mod/choice/view.php +++ b/mod/choice/view.php @@ -81,9 +81,10 @@ $eventdata = array(); $eventdata['objectid'] = $choice->id; $eventdata['context'] = $context; - $eventdata['courseid'] = $course->id; $event = \mod_choice\event\course_module_viewed::create($eventdata); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); $event->trigger(); /// Check to see if groups are being used in this choice diff --git a/mod/data/view.php b/mod/data/view.php index 1454f902ec7..1d53a5b2ec2 100644 --- a/mod/data/view.php +++ b/mod/data/view.php @@ -260,6 +260,8 @@ 'objectid' => $data->id ); $event = \mod_data\event\course_module_viewed::create($params); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); $event->add_record_snapshot('data', $data); $event->trigger(); diff --git a/mod/feedback/classes/event/course_module_viewed.php b/mod/feedback/classes/event/course_module_viewed.php index 9e21da0549e..b822bca68c2 100644 --- a/mod/feedback/classes/event/course_module_viewed.php +++ b/mod/feedback/classes/event/course_module_viewed.php @@ -92,9 +92,6 @@ class course_module_viewed extends \core\event\course_module_viewed { if (!isset($this->other['anonymous'])) { throw new \coding_exception("Field other['anonymous'] cannot be empty"); } - if (!isset($this->other['cmid'])) { - throw new \coding_exception("Field other['cmid'] cannot be empty"); - } // Call parent validations. parent::validate_data(); diff --git a/mod/feedback/tests/events_test.php b/mod/feedback/tests/events_test.php index 4d887114b6e..6da1f61197d 100644 --- a/mod/feedback/tests/events_test.php +++ b/mod/feedback/tests/events_test.php @@ -176,39 +176,11 @@ class mod_feedback_events_testcase extends advanced_testcase { $context = context_module::instance($this->eventcm->id); - // Test not setting instanceid. - try { - \mod_feedback\event\response_deleted::create(array( - 'context' => $context, - 'objectid' => $this->eventfeedbackcompleted->id, - 'other' => array('cmid' => $this->eventcm->id, 'anonymous' => 2) - )); - $this->assertEventContextNotUsed($event); - $this->fail("Event validation should not allow \\mod_feedback\\event\\response_deleted to be triggered without - other['instanceid']"); - } catch (coding_exception $e) { - $this->assertContains("Field other['instanceid'] cannot be empty", $e->getMessage()); - } - - // Test not setting cmid. - try { - \mod_feedback\event\response_deleted::create(array( - 'context' => $context, - 'objectid' => $this->eventfeedbackcompleted->id, - 'other' => array('instanceid' => $this->eventfeedback->id, 'anonymous' => 2) - )); - $this->fail("Event validation should not allow \\mod_feedback\\event\\response_deleted to be triggered without - other['cmid']"); - } catch (coding_exception $e) { - $this->assertContains("Field other['cmid'] cannot be empty", $e->getMessage()); - } - - // Test not setting anonymous. + // Test not setting other['anonymous']. try { \mod_feedback\event\response_submitted::create(array( 'context' => $context, - 'objectid' => $this->eventfeedbackcompleted->id, - 'other' => array('cmid' => $this->eventcm->id, 'instanceid' => $this->eventfeedback->id) + 'objectid' => $this->eventfeedbackcompleted->id )); $this->fail("Event validation should not allow \\mod_feedback\\event\\response_deleted to be triggered without other['anonymous']"); @@ -252,8 +224,6 @@ class mod_feedback_events_testcase extends advanced_testcase { $this->assertEquals($USER->id, $event->userid); $this->assertEquals($USER->id, $event->relateduserid); $this->assertEquals('feedback_completed', $event->objecttable); - $this->assertEquals($this->eventcm->id, $event->other['cmid']); - $this->assertEquals($this->eventcm->instance, $event->other['instanceid']); $this->assertEquals(FEEDBACK_ANONYMOUS_YES, $event->other['anonymous']); $this->setUser($this->eventuser); $this->assertFalse($event->can_view()); diff --git a/mod/feedback/view.php b/mod/feedback/view.php index bb2a6c362a5..75f86b7035e 100644 --- a/mod/feedback/view.php +++ b/mod/feedback/view.php @@ -101,11 +101,9 @@ $event = \mod_feedback\event\course_module_viewed::create(array( 'objectid' => $feedback->id, 'context' => $context, 'other' => array( - 'cmid' => $cm->id, - 'instanceid' => $feedback->id, 'anonymous' => $feedback->anonymous - ) - )); + ) +)); $event->add_record_snapshot('course_modules', $cm); $event->add_record_snapshot('course', $course); $event->add_record_snapshot('feedback', $feedback); diff --git a/mod/folder/view.php b/mod/folder/view.php index a30cbf04668..afdbcfafc49 100644 --- a/mod/folder/view.php +++ b/mod/folder/view.php @@ -54,6 +54,8 @@ $params = array( 'objectid' => $folder->id ); $event = \mod_folder\event\course_module_viewed::create($params); +$event->add_record_snapshot('course_modules', $cm); +$event->add_record_snapshot('course', $course); $event->add_record_snapshot('folder', $folder); $event->trigger(); diff --git a/mod/forum/classes/event/forum_viewed.php b/mod/forum/classes/event/course_module_viewed.php similarity index 65% rename from mod/forum/classes/event/forum_viewed.php rename to mod/forum/classes/event/course_module_viewed.php index 2df082666d0..dbc5eddd2a5 100644 --- a/mod/forum/classes/event/forum_viewed.php +++ b/mod/forum/classes/event/course_module_viewed.php @@ -33,7 +33,7 @@ defined('MOODLE_INTERNAL') || die(); * @copyright 2014 Dan Poltawski * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class forum_viewed extends \core\event\base { +class course_module_viewed extends \core\event\course_module_viewed { /** * Init method. @@ -46,31 +46,13 @@ class forum_viewed extends \core\event\base { $this->data['objecttable'] = 'forum'; } - /** - * Returns description of what happened. - * - * @return string - */ - public function get_description() { - return "The user {$this->userid} has viewed the forum {$this->objectid}"; - } - - /** - * Return localised event name. - * - * @return string - */ - public static function get_name() { - return get_string('eventforumviewed', 'mod_forum'); - } - /** * Get URL related to the action * * @return \moodle_url */ public function get_url() { - return new \moodle_url('/mod/forum/view.php', array('d' => $this->objectid)); + return new \moodle_url('/mod/forum/view.php', array('f' => $this->objectid)); } /** @@ -83,24 +65,5 @@ class forum_viewed extends \core\event\base { $this->objectid, $this->contextinstanceid); } - /** - * Custom validation. - * - * @throws \coding_exception - * @return void - */ - protected function validate_data() { - parent::validate_data(); - - if ($this->contextlevel != CONTEXT_MODULE) { - throw new \coding_exception('Context passed must be module context.'); - } - - if (!isset($this->objectid)) { - throw new \coding_exception('objectid must be set to the forumid.'); - } - - } - } diff --git a/mod/forum/lang/en/forum.php b/mod/forum/lang/en/forum.php index dc1ab55a1c0..7c775c8d549 100644 --- a/mod/forum/lang/en/forum.php +++ b/mod/forum/lang/en/forum.php @@ -150,7 +150,6 @@ $string['eventdiscussionupdated'] = 'Discussion updated'; $string['eventdiscussiondeleted'] = 'Discussion deleted'; $string['eventdiscussionmoved'] = 'Discussion moved'; $string['eventdiscussionviewed'] = 'Discussion viewed'; -$string['eventforumviewed'] = 'Forum viewed'; $string['eventuserreportviewed'] = 'User report viewed'; $string['eventpostcreated'] = 'Post created'; $string['eventpostdeleted'] = 'Post deleted'; diff --git a/mod/forum/tests/events_test.php b/mod/forum/tests/events_test.php index 105b42ac0fa..388373d2713 100644 --- a/mod/forum/tests/events_test.php +++ b/mod/forum/tests/events_test.php @@ -595,9 +595,9 @@ class mod_forum_events_testcase extends advanced_testcase { } /** - * Ensure forum_viewed event validates that the forumid is set. + * Ensure course_module_viewed event validates that the forumid is set. */ - public function test_forum_viewed_objectid_validation() { + public function test_course_module_viewed_objectid_validation() { $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id)); $context = context_module::instance($forum->cmid); @@ -606,14 +606,14 @@ class mod_forum_events_testcase extends advanced_testcase { 'context' => $context, ); - $this->setExpectedException('coding_exception', 'objectid must be set to the forumid.'); - \mod_forum\event\forum_viewed::create($params); + $this->setExpectedException('coding_exception', 'must define objectid'); + \mod_forum\event\course_module_viewed::create($params); } /** - * Ensure forum_viewed event validates that the contextlevel is correct. + * Ensure course_module_viewed event validates that the contextlevel is correct. */ - public function test_forum_viewed_context_validation() { + public function test_course_module_viewed_context_validation() { $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id)); @@ -623,13 +623,13 @@ class mod_forum_events_testcase extends advanced_testcase { ); $this->setExpectedException('coding_exception', 'Context passed must be module context.'); - \mod_forum\event\forum_viewed::create($params); + \mod_forum\event\course_module_viewed::create($params); } /** - * Test the forum_viewed event. + * Test the course_module_viewed event. */ - public function test_forum_viewed() { + public function test_course_module_viewed() { // Setup test data. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id)); @@ -641,7 +641,7 @@ class mod_forum_events_testcase extends advanced_testcase { 'objectid' => $forum->id, ); - $event = \mod_forum\event\forum_viewed::create($params); + $event = \mod_forum\event\course_module_viewed::create($params); // Trigger and capture the event. $sink = $this->redirectEvents(); @@ -651,7 +651,7 @@ class mod_forum_events_testcase extends advanced_testcase { $event = reset($events); // Checking that the event contains the expected values. - $this->assertInstanceOf('\mod_forum\event\forum_viewed', $event); + $this->assertInstanceOf('\mod_forum\event\course_module_viewed', $event); $this->assertEquals($context, $event->get_context()); $expected = array($course->id, 'forum', 'view forum', "view.php?f={$forum->id}", $forum->id, $forum->cmid); $this->assertEventLegacyLogData($expected, $event); diff --git a/mod/forum/view.php b/mod/forum/view.php index 52dfbf3b074..9cd19aedbb6 100644 --- a/mod/forum/view.php +++ b/mod/forum/view.php @@ -133,7 +133,9 @@ 'context' => $context, 'objectid' => $forum->id ); - $event = \mod_forum\event\forum_viewed::create($params); + $event = \mod_forum\event\course_module_viewed::create($params); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); $event->add_record_snapshot('forum', $forum); $event->trigger(); diff --git a/mod/lesson/view.php b/mod/lesson/view.php index 1e28ab6a7cb..0a008b9640b 100644 --- a/mod/lesson/view.php +++ b/mod/lesson/view.php @@ -287,9 +287,10 @@ if ($pageid != LESSON_EOL) { // Trigger module viewed event. $event = \mod_lesson\event\course_module_viewed::create(array( 'objectid' => $lesson->id, - 'context' => $context, - 'courseid' => $course->id + 'context' => $context )); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); $event->trigger(); // This is where several messages (usually warnings) are displayed diff --git a/mod/lti/view.php b/mod/lti/view.php index d61632eaa61..e31adc7f052 100644 --- a/mod/lti/view.php +++ b/mod/lti/view.php @@ -100,6 +100,8 @@ $params = array( 'objectid' => $lti->id ); $event = \mod_lti\event\course_module_viewed::create($params); +$event->add_record_snapshot('course_modules', $cm); +$event->add_record_snapshot('course', $course); $event->add_record_snapshot('lti', $lti); $event->trigger(); diff --git a/mod/resource/view.php b/mod/resource/view.php index e2e3eedc064..59ad58cc9fe 100644 --- a/mod/resource/view.php +++ b/mod/resource/view.php @@ -57,6 +57,8 @@ $params = array( 'objectid' => $resource->id ); $event = \mod_resource\event\course_module_viewed::create($params); +$event->add_record_snapshot('course_modules', $cm); +$event->add_record_snapshot('course', $course); $event->add_record_snapshot('resource', $resource); $event->trigger(); diff --git a/mod/scorm/view.php b/mod/scorm/view.php index 8f8d5be7669..abfd994a917 100644 --- a/mod/scorm/view.php +++ b/mod/scorm/view.php @@ -118,6 +118,7 @@ $event = \mod_scorm\event\course_module_viewed::create(array( 'objectid' => $scorm->id, 'context' => $contextmodule, )); +$event->add_record_snapshot('course', $course); $event->add_record_snapshot('scorm', $scorm); $event->add_record_snapshot('course_modules', $cm); $event->trigger(); diff --git a/mod/url/view.php b/mod/url/view.php index 1c2d138a7a6..a4600f4281f 100644 --- a/mod/url/view.php +++ b/mod/url/view.php @@ -48,10 +48,11 @@ require_capability('mod/url:view', $context); $params = array( 'context' => $context, - 'objectid' => $url->id, - 'courseid' => $course->id + 'objectid' => $url->id ); $event = \mod_url\event\course_module_viewed::create($params); +$event->add_record_snapshot('course_modules', $cm); +$event->add_record_snapshot('course', $course); $event->add_record_snapshot('url', $url); $event->trigger(); diff --git a/mod/wiki/view.php b/mod/wiki/view.php index f9894846abf..e2051e181b8 100644 --- a/mod/wiki/view.php +++ b/mod/wiki/view.php @@ -296,7 +296,6 @@ if($pageid) { ) ); $event->add_record_snapshot('wiki_pages', $page); - $event->trigger(); } else if($id) { $event = \mod_wiki\event\course_module_viewed::create( array( @@ -304,8 +303,6 @@ if($pageid) { 'objectid' => $wiki->id ) ); - $event->add_record_snapshot('wiki', $wiki); - $event->trigger(); } else if($wid && $title) { $event = \mod_wiki\event\page_viewed::create( array( @@ -320,9 +317,11 @@ if($pageid) { ) ); $event->add_record_snapshot('wiki_pages', $page); - $event->add_record_snapshot('wiki', $wiki); - $event->trigger(); } +$event->add_record_snapshot('course_modules', $cm); +$event->add_record_snapshot('course', $course); +$event->add_record_snapshot('wiki', $wiki); +$event->trigger(); $wikipage->print_header(); $wikipage->print_content(); diff --git a/mod/workshop/view.php b/mod/workshop/view.php index 6b1b5b2a7f0..de989f25b83 100644 --- a/mod/workshop/view.php +++ b/mod/workshop/view.php @@ -61,7 +61,6 @@ $completion->set_module_viewed($cm); $eventdata = array(); $eventdata['objectid'] = $workshop->id; $eventdata['context'] = $workshop->context; -$eventdata['courseid'] = $course->id; $PAGE->set_url($workshop->view_url()); $event = \mod_workshop\event\course_module_viewed::create($eventdata);