forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
external.php
413 lines (365 loc) · 16.1 KB
/
external.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<?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/>.
/**
* Survey external API
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
defined('MOODLE_INTERNAL') || die;
require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/mod/survey/lib.php');
/**
* Survey external functions
*
* @package mod_survey
* @category external
* @copyright 2015 Juan Leyva <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class mod_survey_external extends external_api {
/**
* Describes the parameters for get_surveys_by_courses.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_surveys_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 surveys in a provided list of courses,
* if no list is provided all surveys that the user can view will be returned.
*
* @param array $courseids the course ids
* @return array of surveys details
* @since Moodle 3.0
*/
public static function get_surveys_by_courses($courseids = array()) {
global $CFG, $USER, $DB;
$returnedsurveys = array();
$warnings = array();
$params = self::validate_parameters(self::get_surveys_by_courses_parameters(), array('courseids' => $courseids));
$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 surveys in this course, this function checks users visibility permissions.
// We can avoid then additional validate_context calls.
$surveys = get_all_instances_in_courses("survey", $courses);
foreach ($surveys as $survey) {
$context = context_module::instance($survey->coursemodule);
// Entry to return.
$surveydetails = array();
// First, we return information that any user can see in the web interface.
$surveydetails['id'] = $survey->id;
$surveydetails['coursemodule'] = $survey->coursemodule;
$surveydetails['course'] = $survey->course;
$surveydetails['name'] = external_format_string($survey->name, $context->id);
if (has_capability('mod/survey:participate', $context)) {
$trimmedintro = trim($survey->intro);
if (empty($trimmedintro)) {
$tempo = $DB->get_field("survey", "intro", array("id" => $survey->template));
$survey->intro = get_string($tempo, "survey");
}
// Format intro.
list($surveydetails['intro'], $surveydetails['introformat']) =
external_format_text($survey->intro, $survey->introformat, $context->id, 'mod_survey', 'intro', null);
$surveydetails['introfiles'] = external_util::get_area_files($context->id, 'mod_survey', 'intro', false,
false);
$surveydetails['template'] = $survey->template;
$surveydetails['days'] = $survey->days;
$surveydetails['questions'] = $survey->questions;
$surveydetails['surveydone'] = survey_already_done($survey->id, $USER->id) ? 1 : 0;
}
if (has_capability('moodle/course:manageactivities', $context)) {
$surveydetails['timecreated'] = $survey->timecreated;
$surveydetails['timemodified'] = $survey->timemodified;
$surveydetails['section'] = $survey->section;
$surveydetails['visible'] = $survey->visible;
$surveydetails['groupmode'] = $survey->groupmode;
$surveydetails['groupingid'] = $survey->groupingid;
}
$returnedsurveys[] = $surveydetails;
}
}
$result = array();
$result['surveys'] = $returnedsurveys;
$result['warnings'] = $warnings;
return $result;
}
/**
* Describes the get_surveys_by_courses return value.
*
* @return external_single_structure
* @since Moodle 3.0
*/
public static function get_surveys_by_courses_returns() {
return new external_single_structure(
array(
'surveys' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Survey id'),
'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
'course' => new external_value(PARAM_INT, 'Course id'),
'name' => new external_value(PARAM_RAW, 'Survey name'),
'intro' => new external_value(PARAM_RAW, 'The Survey intro', VALUE_OPTIONAL),
'introformat' => new external_format_value('intro', VALUE_OPTIONAL),
'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL),
'template' => new external_value(PARAM_INT, 'Survey type', VALUE_OPTIONAL),
'days' => new external_value(PARAM_INT, 'Days', VALUE_OPTIONAL),
'questions' => new external_value(PARAM_RAW, 'Question ids', VALUE_OPTIONAL),
'surveydone' => new external_value(PARAM_INT, 'Did I finish the survey?', VALUE_OPTIONAL),
'timecreated' => new external_value(PARAM_INT, 'Time of creation', VALUE_OPTIONAL),
'timemodified' => new external_value(PARAM_INT, 'Time of last modification', VALUE_OPTIONAL),
'section' => new external_value(PARAM_INT, 'Course section id', VALUE_OPTIONAL),
'visible' => new external_value(PARAM_INT, 'Visible', VALUE_OPTIONAL),
'groupmode' => new external_value(PARAM_INT, 'Group mode', VALUE_OPTIONAL),
'groupingid' => new external_value(PARAM_INT, 'Group id', VALUE_OPTIONAL),
), 'Surveys'
)
),
'warnings' => new external_warnings(),
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function view_survey_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'survey instance id')
)
);
}
/**
* Trigger the course module viewed event and update the module completion status.
*
* @param int $surveyid the survey instance id
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function view_survey($surveyid) {
global $DB, $USER;
$params = self::validate_parameters(self::view_survey_parameters(),
array(
'surveyid' => $surveyid
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
$viewed = survey_already_done($survey->id, $USER->id) ? 'graph' : 'form';
// Trigger course_module_viewed event and completion.
survey_view($survey, $course, $cm, $context, $viewed);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function view_survey_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_questions_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'survey instance id')
)
);
}
/**
* Get the complete list of questions for the survey, including subquestions.
*
* @param int $surveyid the survey instance id
* @return array of warnings and the question list
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function get_questions($surveyid) {
global $DB, $USER;
$params = self::validate_parameters(self::get_questions_parameters(),
array(
'surveyid' => $surveyid
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
$mainquestions = survey_get_questions($survey);
foreach ($mainquestions as $question) {
if ($question->type >= 0) {
// Parent is used in subquestions.
$question->parent = 0;
$questions[] = survey_translate_question($question);
// Check if the question has subquestions.
if ($question->multi) {
$subquestions = survey_get_subquestions($question);
foreach ($subquestions as $sq) {
$sq->parent = $question->id;
$questions[] = survey_translate_question($sq);
}
}
}
}
$result = array();
$result['questions'] = $questions;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function get_questions_returns() {
return new external_single_structure(
array(
'questions' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Question id'),
'text' => new external_value(PARAM_RAW, 'Question text'),
'shorttext' => new external_value(PARAM_RAW, 'Question short text'),
'multi' => new external_value(PARAM_RAW, 'Subquestions ids'),
'intro' => new external_value(PARAM_RAW, 'The question intro'),
'type' => new external_value(PARAM_INT, 'Question type'),
'options' => new external_value(PARAM_RAW, 'Question options'),
'parent' => new external_value(PARAM_INT, 'Parent question (for subquestions)'),
), 'Questions'
)
),
'warnings' => new external_warnings()
)
);
}
/**
* Describes the parameters for submit_answers.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function submit_answers_parameters() {
return new external_function_parameters(
array(
'surveyid' => new external_value(PARAM_INT, 'Survey id'),
'answers' => new external_multiple_structure(
new external_single_structure(
array(
'key' => new external_value(PARAM_RAW, 'Answer key'),
'value' => new external_value(PARAM_RAW, 'Answer value')
)
)
),
)
);
}
/**
* Submit the answers for a given survey.
*
* @param int $surveyid the survey instance id
* @param array $answers the survey answers
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function submit_answers($surveyid, $answers) {
global $DB, $USER;
$params = self::validate_parameters(self::submit_answers_parameters(),
array(
'surveyid' => $surveyid,
'answers' => $answers
));
$warnings = array();
// Request and permission validation.
$survey = $DB->get_record('survey', array('id' => $params['surveyid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($survey, 'survey');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/survey:participate', $context);
if (survey_already_done($survey->id, $USER->id)) {
throw new moodle_exception("alreadysubmitted", "survey");
}
// Build the answers array. Data is cleaned inside the survey_save_answers function.
$answers = array();
foreach ($params['answers'] as $answer) {
$key = $answer['key'];
$answers[$key] = $answer['value'];
}
survey_save_answers($survey, $answers, $course, $context);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function submit_answers_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
}