MDL-49793 url: Move logging and completion to new API

mod/url/lib.php

@@ -323,3 +323,31 @@ function url_dndupload_handle($uploadinfo) {
 
     return url_add_instance($data, null);
 }
+
+/**
+ * Mark the activity completed (if required) and trigger the course_module_viewed event.
+ *
+ * @param  stdClass $url        url object
+ * @param  stdClass $course     course object
+ * @param  stdClass $cm         course module object
+ * @param  stdClass $context    context object
+ * @since Moodle 3.0
+ */
+function url_view($url, $course, $cm, $context) {
+
+    // Trigger course_module_viewed event.
+    $params = array(
+        'context' => $context,
+        '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();
+
+    // Completion.
+    $completion = new completion_info($course);
+    $completion->set_module_viewed($cm);
+}

mod/url/tests/lib_test.php

@@ -34,14 +34,15 @@
  * @copyright  2011 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class mod_url_lib_testcase extends basic_testcase {
+class mod_url_lib_testcase extends advanced_testcase {
 
     /**
      * Prepares things before this test case is initialised
      * @return void
      */
     public static function setUpBeforeClass() {
         global $CFG;
+        require_once($CFG->dirroot . '/mod/url/lib.php');
         require_once($CFG->dirroot . '/mod/url/locallib.php');
     }
 
@@ -72,4 +73,47 @@ public function test_url_appears_valid_url() {
 
         $this->assertTrue(url_appears_valid_url('lalala://@:@/'));
     }
+
+    /**
+     * Test url_view
+     * @return void
+     */
+    public function test_url_view() {
+        global $CFG;
+
+        $CFG->enablecompletion = 1;
+        $this->resetAfterTest();
+
+        // Setup test data.
+        $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1));
+        $url = $this->getDataGenerator()->create_module('url', array('course' => $course->id),
+                                                            array('completion' => 2, 'completionview' => 1));
+        $context = context_module::instance($url->cmid);
+        $cm = get_coursemodule_from_instance('url', $url->id);
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+
+        $this->setAdminUser();
+        url_view($url, $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_url\event\course_module_viewed', $event);
+        $this->assertEquals($context, $event->get_context());
+        $url = new \moodle_url('/mod/url/view.php', array('id' => $cm->id));
+        $this->assertEquals($url, $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/url/view.php

@@ -24,6 +24,7 @@
  */
 
 require('../../config.php');
+require_once("$CFG->dirroot/mod/url/lib.php");
 require_once("$CFG->dirroot/mod/url/locallib.php");
 require_once($CFG->libdir . '/completionlib.php');
 
@@ -46,19 +47,8 @@
 $context = context_module::instance($cm->id);
 require_capability('mod/url:view', $context);
 
-$params = array(
-    'context' => $context,
-    '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();
-
-// Update 'viewed' state if required by completion system
-$completion = new completion_info($course);
-$completion->set_module_viewed($cm);
+// Completion and trigger events.
+url_view($url, $course, $cm, $context);
 
 $PAGE->set_url('/mod/url/view.php', array('id' => $cm->id));