Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/mod/survey/classes/ -> external.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
Survey external API
| Copyright: | 2015 Juan Leyva <juan@moodle.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 389 lines (15 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
mod_survey_external:: (12 methods):
get_surveys_by_courses_parameters()
get_surveys_by_courses()
get_surveys_by_courses_returns()
view_survey_parameters()
view_survey()
view_survey_returns()
get_questions_parameters()
get_questions()
get_questions_returns()
submit_answers_parameters()
submit_answers()
submit_answers_returns()
Class: mod_survey_external - X-Ref
Survey external functions| get_surveys_by_courses_parameters() X-Ref |
| Describes the parameters for get_surveys_by_courses. return: external_function_parameters |
| get_surveys_by_courses($courseids = array() X-Ref |
| 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 |
| get_surveys_by_courses_returns() X-Ref |
| Describes the get_surveys_by_courses return value. return: external_single_structure |
| view_survey_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_survey($surveyid) X-Ref |
| 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 |
| view_survey_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_questions_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| get_questions($surveyid) X-Ref |
| 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 |
| get_questions_returns() X-Ref |
| Returns description of method result value return: external_description |
| submit_answers_parameters() X-Ref |
| Describes the parameters for submit_answers. return: external_function_parameters |
| submit_answers($surveyid, $answers) X-Ref |
| 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 |
| submit_answers_returns() X-Ref |
| Returns description of method result value return: external_description |
