MDL-58659 enroll: Add start and end date fields required by overview

Those fields are required to display the courses overview for final users.
robjoyce · Apr 20, 2017 · 01c2670 · 01c2670
1 parent ef83fc2
commit 01c2670
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/enrol/externallib.php b/enrol/externallib.php
@@ -300,7 +300,7 @@ public static function get_users_courses($userid) {
         $params = self::validate_parameters(self::get_users_courses_parameters(), array('userid'=>$userid));
 
         $courses = enrol_get_users_courses($params['userid'], true, 'id, shortname, fullname, idnumber, visible,
-                   summary, summaryformat, format, showgrades, lang, enablecompletion, category');
+                   summary, summaryformat, format, showgrades, lang, enablecompletion, category, startdate, enddate');
         $result = array();
 
         foreach ($courses as $course) {
@@ -346,6 +346,8 @@ public static function get_users_courses($userid) {
                 'enablecompletion' => $course->enablecompletion,
                 'category' => $course->category,
                 'progress' => $progress,
+                'startdate' => $course->startdate,
+                'enddate' => $course->enddate,
             );
         }
 
@@ -376,6 +378,8 @@ public static function get_users_courses_returns() {
                                                                 VALUE_OPTIONAL),
                     'category' => new external_value(PARAM_INT, 'course category id', VALUE_OPTIONAL),
                     'progress' => new external_value(PARAM_FLOAT, 'Progress percentage', VALUE_OPTIONAL),
+                    'startdate' => new external_value(PARAM_INT, 'Timestamp when the course start', VALUE_OPTIONAL),
+                    'enddate' => new external_value(PARAM_INT, 'Timestamp when the course end', VALUE_OPTIONAL),
                 )
             )
         );

diff --git a/enrol/tests/externallib_test.php b/enrol/tests/externallib_test.php
@@ -363,14 +363,17 @@ public function test_get_users_courses() {
 
         $this->resetAfterTest(true);
 
+        $timenow = time();
         $coursedata1 = array(
             'fullname'         => '<b>Course 1</b>',                // Adding tags here to check that external_format_string works.
             'shortname'         => '<b>Course 1</b>',               // Adding tags here to check that external_format_string works.
             'summary'          => 'Lightwork Course 1 description',
             'summaryformat'    => FORMAT_MOODLE,
             'lang'             => 'en',
             'enablecompletion' => true,
-            'showgrades'       => true
+            'showgrades'       => true,
+            'startdate'        => $timenow,
+            'enddate'          => $timenow + WEEKSECS
         );
 
         $course1 = self::getDataGenerator()->create_course($coursedata1);

diff --git a/enrol/upgrade.txt b/enrol/upgrade.txt
@@ -1,6 +1,10 @@
 This files describes API changes in /enrol/* - plugins,
 information provided here is intended especially for developers.
 
+=== 3.3 ===
+
+* External function core_enrol_external::get_users_courses now return the user progress, start and the end course dates.
+
 === 3.2 ===
 
 * External function core_enrol_external::get_users_courses now return the category id as an additional optional field.