MDL-50015 mod_imscp: Move logging and completion to new API

mod/imscp/lib.php

@@ -416,3 +416,31 @@ function imscp_export_contents($cm, $baseurl) {
 
     return $contents;
 }
+
+/**
+ * Mark the activity completed (if required) and trigger the course_module_viewed event.
+ *
+ * @param  stdClass $imscp   imscp object
+ * @param  stdClass $course     course object
+ * @param  stdClass $cm         course module object
+ * @param  stdClass $context    context object
+ * @since Moodle 3.0
+ */
+function imscp_view($imscp, $course, $cm, $context) {
+
+    // Trigger course_module_viewed event.
+    $params = array(
+        'context' => $context,
+        'objectid' => $imscp->id
+    );
+
+    $event = \mod_imscp\event\course_module_viewed::create($params);
+    $event->add_record_snapshot('course_modules', $cm);
+    $event->add_record_snapshot('course', $course);
+    $event->add_record_snapshot('imscp', $imscp);
+    $event->trigger();
+
+    // Completion.
+    $completion = new completion_info($course);
+    $completion->set_module_viewed($cm);
+}

mod/imscp/tests/lib_test.php

@@ -64,4 +64,47 @@ class mod_imscp_lib_testcase extends advanced_testcase {
         $this->assertEquals(json_encode(unserialize($imscp->structure)), $contents[0]['content']);
 
     }
+
+    /**
+     * Test imscp_view
+     * @return void
+     */
+    public function test_imscp_view() {
+        global $CFG;
+
+        $CFG->enablecompletion = 1;
+        $this->resetAfterTest();
+
+        $this->setAdminUser();
+        // Setup test data.
+        $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+        $imscp = $this->getDataGenerator()->create_module('imscp', array('course' => $course->id),
+                                                            array('completion' => 2, 'completionview' => 1));
+        $context = context_module::instance($imscp->cmid);
+        $cm = get_coursemodule_from_instance('imscp', $imscp->id);
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+
+        imscp_view($imscp, $course, $cm, $context);
+
+        $events = $sink->get_events();
+        // 2 additional events thanks to completion.
+        $this->assertCount(3, $events);
+        $event = array_shift($events);
+
+        // Checking that the event contains the expected values.
+        $this->assertInstanceOf('\mod_imscp\event\course_module_viewed', $event);
+        $this->assertEquals($context, $event->get_context());
+        $moodleurl = new \moodle_url('/mod/imscp/view.php', array('id' => $cm->id));
+        $this->assertEquals($moodleurl, $event->get_url());
+        $this->assertEventContextNotUsed($event);
+        $this->assertNotEmpty($event->get_name());
+
+        // Check completion status.
+        $completion = new completion_info($course);
+        $completiondata = $completion->get_data($cm);
+        $this->assertEquals(1, $completiondata->completionstate);
+
+    }
 }

mod/imscp/view.php

@@ -23,6 +23,7 @@
  */
 
 require('../../config.php');
+require_once($CFG->dirroot . '/mod/imscp/lib.php');
 require_once("$CFG->dirroot/mod/imscp/locallib.php");
 require_once($CFG->libdir . '/completionlib.php');
 
@@ -44,17 +45,8 @@ require_course_login($course, true, $cm);
 $context = context_module::instance($cm->id);
 require_capability('mod/imscp:view', $context);
 
-$params = array(
-    'context' => $context,
-    'objectid' => $imscp->id
-);
-$event = \mod_imscp\event\course_module_viewed::create($params);
-$event->add_record_snapshot('imscp', $imscp);
-$event->trigger();
-
-// Update 'viewed' state if required by completion system.
-$completion = new completion_info($course);
-$completion->set_module_viewed($cm);
+// Completion and trigger events.
+imscp_view($imscp, $course, $cm, $context);
 
 $PAGE->set_url('/mod/imscp/view.php', array('id' => $cm->id));
 $PAGE->requires->js('/mod/imscp/dummyapi.js', true);