MDL-40042 Completion: added course_completion_updated event to remove related add_to_log
authorRajesh Taneja <rajesh@moodle.com>
Thu, 8 Aug 2013 04:43:02 +0000 (12:43 +0800)
committerRajesh Taneja <rajesh@moodle.com>
Fri, 16 Aug 2013 01:34:23 +0000 (09:34 +0800)
course/completion.php
lang/en/completion.php
lib/classes/event/course_completion_updated.php [new file with mode: 0644]
lib/tests/completionlib_test.php

index 8c16a87..12e4859 100644 (file)
@@ -134,8 +134,14 @@ if ($form->is_cancelled()){
     $aggregation->setMethod($data->role_aggregation);
     $aggregation->save();
 
-    // Log changes.
-    add_to_log($course->id, 'course', 'completion updated', 'completion.php?id='.$course->id);
+    // Trigger an event for course module completion changed.
+    $event = \core\event\course_completion_updated::create(
+            array(
+                'courseid' => $course->id,
+                'context' => context_course::instance($course->id)
+                )
+            );
+    $event->trigger();
 
     // Redirect to the course main page.
     $url = new moodle_url('/course/view.php', array('id' => $course->id));
index 5fdeed1..56cae77 100644 (file)
@@ -124,6 +124,7 @@ $string['err_nousers'] = 'There are no students on this course or group for whom
 $string['err_settingslocked'] = 'One or more students have already completed a criteria so the settings have been locked. Unlocking the completion criteria settings will delete any existing user data and may cause confusion.';
 $string['err_system'] = 'An internal error occurred in the completion system. (System administrators can enable debugging information to see more detail.)';
 $string['eventcoursecompleted'] = 'Course completed';
+$string['eventcoursecompletionupdated'] = 'Course completion updated';
 $string['eventcoursemodulecompletionupdated'] = 'Course module completion updated';
 $string['excelcsvdownload'] = 'Download in Excel-compatible format (.csv)';
 $string['fraction'] = 'Fraction';
diff --git a/lib/classes/event/course_completion_updated.php b/lib/classes/event/course_completion_updated.php
new file mode 100644 (file)
index 0000000..3da8eda
--- /dev/null
@@ -0,0 +1,82 @@
+<?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/>.
+
+/**
+ * Event when course module completion is updated.
+ *
+ * @package    core
+ * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Event when course module completion is updated.
+ *
+ * @package    core
+ * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class course_completion_updated extends base {
+
+    /**
+     * Initialise required event data properties.
+     */
+    protected function init() {
+        $this->data['crud'] = 'u';
+        // TODO: MDL-37658 set level.
+        $this->data['level'] = 50;
+    }
+
+    /**
+     * Returns localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return new get_string('eventcoursecompletionupdated', 'core_completion');
+    }
+
+    /**
+     * Returns non-localised event description with id's for admin use only.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return 'Course completion for course' . $this->courseid . ' is updated by user ' . $this->userid;
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new moodle_url('/course/completion.php', array('id' => $this->courseid));
+    }
+
+    /**
+     * Return legacy add_to_log() data.
+     *
+     * @return array of parameters to be passed to legacy add_to_log() function.
+     */
+    protected function get_legacy_logdata() {
+        return array($this->courseid, 'course', 'completion updated', 'completion.php?id=' . $this->courseid);
+    }
+}
index 112b712..9286a5f 100644 (file)
@@ -809,8 +809,34 @@ class core_completionlib_testcase extends advanced_testcase {
         $data = $ccompletion->get_record_data();
         $this->assertEventLegacyData($data, $event);
     }
-}
 
+    /**
+     * Test course completed event.
+     */
+    public function test_course_completion_updated_event() {
+        $this->setup_data();
+        $coursecontext = context_course::instance($this->course->id);
+        $coursecompletionevent = \core\event\course_completion_updated::create(
+                array(
+                    'courseid' => $this->course->id,
+                    'context' => $coursecontext
+                    )
+                );
+
+        // Mark course as complete and get triggered event.
+        $sink = $this->redirectEvents();
+        $coursecompletionevent->trigger();
+        $events = $sink->get_events();
+        $event = array_pop($events);
+        $sink->close();
+
+        $this->assertInstanceOf('\core\event\course_completion_updated', $event);
+        $this->assertEquals($this->course->id, $event->courseid);
+        $this->assertEquals($coursecontext, $event->get_context());
+        $expectedlegacylog = array($this->course->id, 'course', 'completion updated', 'completion.php?id='.$this->course->id);
+        $this->assertEventLegacyLogData($expectedlegacylog, $event);
+    }
+}
 
 class core_completionlib_fake_recordset implements Iterator {
     protected $closed;