Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
- Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
Differences Between: [Versions 39 and 310] [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]
Choice module external API
| Copyright: | 2015 Costantino Cito <ccito@cvaconsulting.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 701 lines (30 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
mod_choice_external:: (18 methods):
get_choice_results_parameters()
get_choice_results()
get_choice_results_returns()
get_choice_options_parameters()
get_choice_options()
get_choice_options_returns()
submit_choice_response_parameters()
submit_choice_response()
submit_choice_response_returns()
view_choice_parameters()
view_choice()
view_choice_returns()
get_choices_by_courses_parameters()
get_choices_by_courses()
get_choices_by_courses_returns()
delete_choice_responses_parameters()
delete_choice_responses()
delete_choice_responses_returns()
Class: mod_choice_external - X-Ref
Choice module external functions| get_choice_results_parameters() X-Ref |
| Describes the parameters for get_choices_by_courses. return: external_function_parameters |
| get_choice_results($choiceid) X-Ref |
| Returns user's results for a specific choice and a list of those users that did not answered yet. param: int $choiceid the choice instance id return: array of responses details |
| get_choice_results_returns() X-Ref |
| Describes the get_choice_results return value. return: external_single_structure |
| get_choice_options_parameters() X-Ref |
| Describes the parameters for mod_choice_get_choice_options. return: external_function_parameters |
| get_choice_options($choiceid) X-Ref |
| Returns options for a specific choice param: int $choiceid the choice instance id return: array of options details |
| get_choice_options_returns() X-Ref |
| Describes the get_choice_results return value. return: external_multiple_structure |
| submit_choice_response_parameters() X-Ref |
| Describes the parameters for submit_choice_response. return: external_function_parameters |
| submit_choice_response($choiceid, $responses) X-Ref |
| Submit choice responses param: int $choiceid the choice instance id param: array $responses the response ids return: array answers information and warnings |
| submit_choice_response_returns() X-Ref |
| Describes the submit_choice_response return value. return: external_multiple_structure |
| view_choice_parameters() X-Ref |
| Returns description of method parameters return: external_function_parameters |
| view_choice($choiceid) X-Ref |
| Trigger the course module viewed event and update the module completion status. param: int $choiceid the choice instance id return: array of warnings and status result |
| view_choice_returns() X-Ref |
| Returns description of method result value return: external_description |
| get_choices_by_courses_parameters() X-Ref |
| Describes the parameters for get_choices_by_courses. return: external_function_parameters |
| get_choices_by_courses($courseids = array() X-Ref |
| Returns a list of choices in a provided list of courses, if no list is provided all choices that the user can view will be returned. param: array $courseids the course ids return: array of choices details |
| get_choices_by_courses_returns() X-Ref |
| Describes the mod_choice_get_choices_by_courses return value. return: external_single_structure |
| delete_choice_responses_parameters() X-Ref |
| Describes the parameters for delete_choice_responses. return: external_function_parameters |
| delete_choice_responses($choiceid, $responses = array() X-Ref |
| Delete the given submitted responses in a choice param: int $choiceid the choice instance id param: array $responses the response ids, empty for deleting all the current user responses return: array status information and warnings |
| delete_choice_responses_returns() X-Ref |
| Describes the delete_choice_responses return value. return: external_multiple_structure |
