MDL-50545 mod_page: New WS mod_page_get_pages_by_courses
[moodle.git] / mod / page / classes / external.php
index 417d8d6..9ef7336 100644 (file)
@@ -104,4 +104,114 @@ class mod_page_external extends external_api {
         );
     }
 
+    /**
+     * Describes the parameters for get_pages_by_courses.
+     *
+     * @return external_function_parameters
+     * @since Moodle 3.3
+     */
+    public static function get_pages_by_courses_parameters() {
+        return new external_function_parameters (
+            array(
+                'courseids' => new external_multiple_structure(
+                    new external_value(PARAM_INT, 'Course id'), 'Array of course ids', VALUE_DEFAULT, array()
+                ),
+            )
+        );
+    }
+
+    /**
+     * Returns a list of pages in a provided list of courses.
+     * If no list is provided all pages that the user can view will be returned.
+     *
+     * @param array $courseids course ids
+     * @return array of warnings and pages
+     * @since Moodle 3.3
+     */
+    public static function get_pages_by_courses($courseids = array()) {
+
+        $warnings = array();
+        $returnedpages = array();
+
+        $params = array(
+            'courseids' => $courseids,
+        );
+        $params = self::validate_parameters(self::get_pages_by_courses_parameters(), $params);
+
+        $mycourses = array();
+        if (empty($params['courseids'])) {
+            $mycourses = enrol_get_my_courses();
+            $params['courseids'] = array_keys($mycourses);
+        }
+
+        // Ensure there are courseids to loop through.
+        if (!empty($params['courseids'])) {
+
+            list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
+
+            // Get the pages in this course, this function checks users visibility permissions.
+            // We can avoid then additional validate_context calls.
+            $pages = get_all_instances_in_courses("page", $courses);
+            foreach ($pages as $page) {
+                $context = context_module::instance($page->coursemodule);
+                // Entry to return.
+                $page->name = external_format_string($page->name, $context->id);
+
+                list($page->intro, $page->introformat) = external_format_text($page->intro,
+                                                                $page->introformat, $context->id, 'mod_page', 'intro', null);
+                $page->introfiles = external_util::get_area_files($context->id, 'mod_page', 'intro', false, false);
+
+                list($page->content, $page->contentformat) = external_format_text($page->content, $page->contentformat,
+                                                                $context->id, 'mod_page', 'content', $page->revision);
+                $page->contentfiles = external_util::get_area_files($context->id, 'mod_page', 'content');
+
+                $returnedpages[] = $page;
+            }
+        }
+
+        $result = array(
+            'pages' => $returnedpages,
+            'warnings' => $warnings
+        );
+        return $result;
+    }
+
+    /**
+     * Describes the get_pages_by_courses return value.
+     *
+     * @return external_single_structure
+     * @since Moodle 3.3
+     */
+    public static function get_pages_by_courses_returns() {
+        return new external_single_structure(
+            array(
+                'pages' => new external_multiple_structure(
+                    new external_single_structure(
+                        array(
+                            'id' => new external_value(PARAM_INT, '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'),
+                            'introformat' => new external_format_value('intro', 'Summary format'),
+                            'introfiles' => new external_files('Files in the introduction text'),
+                            'content' => new external_value(PARAM_RAW, 'Page content'),
+                            'contentformat' => new external_format_value('content', 'Content format'),
+                            'contentfiles' => new external_files('Files in the content'),
+                            'legacyfiles' => new external_value(PARAM_INT, 'Legacy files flag'),
+                            'legacyfileslast' => new external_value(PARAM_INT, 'Legacy files last control flag'),
+                            'display' => new external_value(PARAM_INT, 'How to display the page'),
+                            'displayoptions' => new external_value(PARAM_RAW, 'Display options (width, height)'),
+                            'revision' => new external_value(PARAM_INT, 'Incremented when after each file changes, to avoid cache'),
+                            'timemodified' => new external_value(PARAM_INT, 'Last time the page was modified'),
+                            'section' => new external_value(PARAM_INT, 'Course section id'),
+                            'visible' => new external_value(PARAM_INT, 'Module visibility'),
+                            'groupmode' => new external_value(PARAM_INT, 'Group mode'),
+                            'groupingid' => new external_value(PARAM_INT, 'Grouping id'),
+                        )
+                    )
+                ),
+                'warnings' => new external_warnings(),
+            )
+        );
+    }
 }