MDL-57890 ws: Return cmid in all get_by_courses WebServices
[moodle.git] / mod / page / classes / external.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Page external API
19  *
20  * @package    mod_page
21  * @category   external
22  * @copyright  2015 Juan Leyva <juan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.0
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once("$CFG->libdir/externallib.php");
31 /**
32  * Page external functions
33  *
34  * @package    mod_page
35  * @category   external
36  * @copyright  2015 Juan Leyva <juan@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  * @since      Moodle 3.0
39  */
40 class mod_page_external extends external_api {
42     /**
43      * Returns description of method parameters
44      *
45      * @return external_function_parameters
46      * @since Moodle 3.0
47      */
48     public static function view_page_parameters() {
49         return new external_function_parameters(
50             array(
51                 'pageid' => new external_value(PARAM_INT, 'page instance id')
52             )
53         );
54     }
56     /**
57      * Simulate the page/view.php web interface page: trigger events, completion, etc...
58      *
59      * @param int $pageid the page instance id
60      * @return array of warnings and status result
61      * @since Moodle 3.0
62      * @throws moodle_exception
63      */
64     public static function view_page($pageid) {
65         global $DB, $CFG;
66         require_once($CFG->dirroot . "/mod/page/lib.php");
68         $params = self::validate_parameters(self::view_page_parameters(),
69                                             array(
70                                                 'pageid' => $pageid
71                                             ));
72         $warnings = array();
74         // Request and permission validation.
75         $page = $DB->get_record('page', array('id' => $params['pageid']), '*', MUST_EXIST);
76         list($course, $cm) = get_course_and_cm_from_instance($page, 'page');
78         $context = context_module::instance($cm->id);
79         self::validate_context($context);
81         require_capability('mod/page:view', $context);
83         // Call the page/lib API.
84         page_view($page, $course, $cm, $context);
86         $result = array();
87         $result['status'] = true;
88         $result['warnings'] = $warnings;
89         return $result;
90     }
92     /**
93      * Returns description of method result value
94      *
95      * @return external_description
96      * @since Moodle 3.0
97      */
98     public static function view_page_returns() {
99         return new external_single_structure(
100             array(
101                 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
102                 'warnings' => new external_warnings()
103             )
104         );
105     }
107     /**
108      * Describes the parameters for get_pages_by_courses.
109      *
110      * @return external_function_parameters
111      * @since Moodle 3.3
112      */
113     public static function get_pages_by_courses_parameters() {
114         return new external_function_parameters (
115             array(
116                 'courseids' => new external_multiple_structure(
117                     new external_value(PARAM_INT, 'Course id'), 'Array of course ids', VALUE_DEFAULT, array()
118                 ),
119             )
120         );
121     }
123     /**
124      * Returns a list of pages in a provided list of courses.
125      * If no list is provided all pages that the user can view will be returned.
126      *
127      * @param array $courseids course ids
128      * @return array of warnings and pages
129      * @since Moodle 3.3
130      */
131     public static function get_pages_by_courses($courseids = array()) {
133         $warnings = array();
134         $returnedpages = array();
136         $params = array(
137             'courseids' => $courseids,
138         );
139         $params = self::validate_parameters(self::get_pages_by_courses_parameters(), $params);
141         $mycourses = array();
142         if (empty($params['courseids'])) {
143             $mycourses = enrol_get_my_courses();
144             $params['courseids'] = array_keys($mycourses);
145         }
147         // Ensure there are courseids to loop through.
148         if (!empty($params['courseids'])) {
150             list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
152             // Get the pages in this course, this function checks users visibility permissions.
153             // We can avoid then additional validate_context calls.
154             $pages = get_all_instances_in_courses("page", $courses);
155             foreach ($pages as $page) {
156                 $context = context_module::instance($page->coursemodule);
157                 // Entry to return.
158                 $page->name = external_format_string($page->name, $context->id);
160                 list($page->intro, $page->introformat) = external_format_text($page->intro,
161                                                                 $page->introformat, $context->id, 'mod_page', 'intro', null);
162                 $page->introfiles = external_util::get_area_files($context->id, 'mod_page', 'intro', false, false);
164                 list($page->content, $page->contentformat) = external_format_text($page->content, $page->contentformat,
165                                                                 $context->id, 'mod_page', 'content', $page->revision);
166                 $page->contentfiles = external_util::get_area_files($context->id, 'mod_page', 'content');
168                 $returnedpages[] = $page;
169             }
170         }
172         $result = array(
173             'pages' => $returnedpages,
174             'warnings' => $warnings
175         );
176         return $result;
177     }
179     /**
180      * Describes the get_pages_by_courses return value.
181      *
182      * @return external_single_structure
183      * @since Moodle 3.3
184      */
185     public static function get_pages_by_courses_returns() {
186         return new external_single_structure(
187             array(
188                 'pages' => new external_multiple_structure(
189                     new external_single_structure(
190                         array(
191                             'id' => new external_value(PARAM_INT, 'Module id'),
192                             'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
193                             'course' => new external_value(PARAM_INT, 'Course id'),
194                             'name' => new external_value(PARAM_RAW, 'Page name'),
195                             'intro' => new external_value(PARAM_RAW, 'Summary'),
196                             'introformat' => new external_format_value('intro', 'Summary format'),
197                             'introfiles' => new external_files('Files in the introduction text'),
198                             'content' => new external_value(PARAM_RAW, 'Page content'),
199                             'contentformat' => new external_format_value('content', 'Content format'),
200                             'contentfiles' => new external_files('Files in the content'),
201                             'legacyfiles' => new external_value(PARAM_INT, 'Legacy files flag'),
202                             'legacyfileslast' => new external_value(PARAM_INT, 'Legacy files last control flag'),
203                             'display' => new external_value(PARAM_INT, 'How to display the page'),
204                             'displayoptions' => new external_value(PARAM_RAW, 'Display options (width, height)'),
205                             'revision' => new external_value(PARAM_INT, 'Incremented when after each file changes, to avoid cache'),
206                             'timemodified' => new external_value(PARAM_INT, 'Last time the page was modified'),
207                             'section' => new external_value(PARAM_INT, 'Course section id'),
208                             'visible' => new external_value(PARAM_INT, 'Module visibility'),
209                             'groupmode' => new external_value(PARAM_INT, 'Group mode'),
210                             'groupingid' => new external_value(PARAM_INT, 'Grouping id'),
211                         )
212                     )
213                 ),
214                 'warnings' => new external_warnings(),
215             )
216         );
217     }