MDL-57890 ws: Return cmid in all get_by_courses WebServices

ragusa87 · Feb 7, 2017 · 16840c7 · 16840c7
1 parent f993134
commit 16840c7
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 8 deletions.
diff --git a/mod/folder/classes/external.php b/mod/folder/classes/external.php
@@ -185,6 +185,7 @@ public static function get_folders_by_courses_returns() {
                     new external_single_structure(
                         array(
                             'id' => new external_value(PARAM_INT, 'Module id'),
+                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
                             'course' => new external_value(PARAM_INT, 'Course id'),
                             'name' => new external_value(PARAM_RAW, 'Page name'),
                             'intro' => new external_value(PARAM_RAW, 'Summary'),

diff --git a/mod/folder/tests/externallib_test.php b/mod/folder/tests/externallib_test.php
@@ -152,8 +152,9 @@ public function test_mod_folder_get_folders_by_courses() {
         $returndescription = mod_folder_external::get_folders_by_courses_returns();
 
         // Create what we expect to be returned when querying the two courses.
-        $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles', 'revision', 'timemodified',
-                                'display', 'showexpanded', 'showdownloadfolder', 'section', 'visible', 'groupmode', 'groupingid');
+        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'revision',
+                                'timemodified', 'display', 'showexpanded', 'showdownloadfolder', 'section', 'visible',
+                                'groupmode', 'groupingid');
 
         // Add expected coursemodule and data.
         $folder1->coursemodule = $folder1->cmid;

diff --git a/mod/label/classes/external.php b/mod/label/classes/external.php
@@ -120,6 +120,7 @@ public static function get_labels_by_courses_returns() {
                     new external_single_structure(
                         array(
                             'id' => new external_value(PARAM_INT, 'Module id'),
+                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
                             'course' => new external_value(PARAM_INT, 'Course id'),
                             'name' => new external_value(PARAM_RAW, 'Label name'),
                             'intro' => new external_value(PARAM_RAW, 'Label contents'),

diff --git a/mod/label/tests/externallib_test.php b/mod/label/tests/externallib_test.php
@@ -82,8 +82,8 @@ public function test_mod_label_get_labels_by_courses() {
         $returndescription = mod_label_external::get_labels_by_courses_returns();
 
         // Create what we expect to be returned when querying the two courses.
-        $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles', 'timemodified', 'section',
-                                    'visible', 'groupmode', 'groupingid');
+        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'timemodified',
+                                'section', 'visible', 'groupmode', 'groupingid');
 
         // Add expected coursemodule and data.
         $label1->coursemodule = $label1->cmid;

diff --git a/mod/page/classes/external.php b/mod/page/classes/external.php
@@ -189,6 +189,7 @@ public static function get_pages_by_courses_returns() {
                     new external_single_structure(
                         array(
                             'id' => new external_value(PARAM_INT, 'Module id'),
+                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
                             'course' => new external_value(PARAM_INT, 'Course id'),
                             'name' => new external_value(PARAM_RAW, 'Page name'),
                             'intro' => new external_value(PARAM_RAW, 'Summary'),

diff --git a/mod/page/tests/externallib_test.php b/mod/page/tests/externallib_test.php
@@ -152,7 +152,7 @@ public function test_mod_page_get_pages_by_courses() {
         $returndescription = mod_page_external::get_pages_by_courses_returns();
 
         // Create what we expect to be returned when querying the two courses.
-        $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles',
+        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles',
                                 'content', 'contentformat', 'contentfiles', 'legacyfiles', 'legacyfileslast', 'display',
                                 'displayoptions', 'revision', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid');
 

diff --git a/mod/resource/classes/external.php b/mod/resource/classes/external.php
@@ -186,6 +186,7 @@ public static function get_resources_by_courses_returns() {
                     new external_single_structure(
                         array(
                             'id' => new external_value(PARAM_INT, 'Module id'),
+                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
                             'course' => new external_value(PARAM_INT, 'Course id'),
                             'name' => new external_value(PARAM_RAW, 'Page name'),
                             'intro' => new external_value(PARAM_RAW, 'Summary'),

diff --git a/mod/resource/tests/externallib_test.php b/mod/resource/tests/externallib_test.php
@@ -153,7 +153,7 @@ public function test_mod_resource_get_resources_by_courses() {
         $returndescription = mod_resource_external::get_resources_by_courses_returns();
 
         // Create what we expect to be returned when querying the two courses.
-        $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles',
+        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles',
                                 'contentfiles', 'tobemigrated', 'legacyfiles', 'legacyfileslast', 'display', 'displayoptions',
                                 'filterfiles', 'revision', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid');
 

diff --git a/mod/url/classes/external.php b/mod/url/classes/external.php
@@ -185,6 +185,7 @@ public static function get_urls_by_courses_returns() {
                     new external_single_structure(
                         array(
                             'id' => new external_value(PARAM_INT, 'Module id'),
+                            'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
                             'course' => new external_value(PARAM_INT, 'Course id'),
                             'name' => new external_value(PARAM_RAW, 'URL name'),
                             'intro' => new external_value(PARAM_RAW, 'Summary'),

diff --git a/mod/url/tests/externallib_test.php b/mod/url/tests/externallib_test.php
@@ -152,8 +152,9 @@ public function test_mod_url_get_urls_by_courses() {
         $returndescription = mod_url_external::get_urls_by_courses_returns();
 
         // Create what we expect to be returned when querying the two courses.
-        $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles', 'externalurl', 'display',
-                                'displayoptions', 'parameters', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid');
+        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'externalurl',
+                                'display', 'displayoptions', 'parameters', 'timemodified', 'section', 'visible', 'groupmode',
+                                'groupingid');
 
         // Add expected coursemodule and data.
         $url1->coursemodule = $url1->cmid;