Choice module external functions.
More...
Choice module external functions.
- Copyright
- 2015 Costantino Cito ccito.nosp@m.@cva.nosp@m.consu.nosp@m.ltin.nosp@m.g.com
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- Since
- Moodle 3.0
◆ delete_choice_responses()
static mod_choice_external::delete_choice_responses |
( |
| $choiceid, |
|
|
| $responses = array() ) |
|
static |
Delete the given submitted responses in a choice.
- Parameters
-
int | $choiceid | the choice instance id |
array | $responses | the response ids, empty for deleting all the current user responses |
- Return values
-
array | status information and warnings |
- Exceptions
-
- Since
- Moodle 3.0
◆ delete_choice_responses_parameters()
static mod_choice_external::delete_choice_responses_parameters |
( |
| ) |
|
|
static |
Describes the parameters for delete_choice_responses.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ delete_choice_responses_returns()
static mod_choice_external::delete_choice_responses_returns |
( |
| ) |
|
|
static |
Describes the delete_choice_responses return value.
- Return values
-
external_multiple_structure | |
- Since
- Moodle 3.0
◆ get_choice_options()
static mod_choice_external::get_choice_options |
( |
| $choiceid | ) |
|
|
static |
Returns options for a specific choice.
- Parameters
-
int | $choiceid | the choice instance id |
- Return values
-
- Since
- Moodle 3.0
◆ get_choice_options_parameters()
static mod_choice_external::get_choice_options_parameters |
( |
| ) |
|
|
static |
Describes the parameters for mod_choice_get_choice_options.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ get_choice_options_returns()
static mod_choice_external::get_choice_options_returns |
( |
| ) |
|
|
static |
Describes the get_choice_results return value.
- Return values
-
external_multiple_structure | |
- Since
- Moodle 3.0
◆ get_choice_results()
static mod_choice_external::get_choice_results |
( |
| $choiceid | ) |
|
|
static |
Returns user's results for a specific choice and a list of those users that did not answered yet.
- Parameters
-
int | $choiceid | the choice instance id |
- Return values
-
array | of responses details |
- Since
- Moodle 3.0
◆ get_choice_results_parameters()
static mod_choice_external::get_choice_results_parameters |
( |
| ) |
|
|
static |
Describes the parameters for get_choices_by_courses.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ get_choice_results_returns()
static mod_choice_external::get_choice_results_returns |
( |
| ) |
|
|
static |
Describes the get_choice_results return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.0
◆ get_choices_by_courses()
static mod_choice_external::get_choices_by_courses |
( |
| $courseids = array() | ) |
|
|
static |
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.
- Parameters
-
array | $courseids | the course ids |
- Return values
-
- Since
- Moodle 3.0
◆ get_choices_by_courses_parameters()
static mod_choice_external::get_choices_by_courses_parameters |
( |
| ) |
|
|
static |
Describes the parameters for get_choices_by_courses.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ get_choices_by_courses_returns()
static mod_choice_external::get_choices_by_courses_returns |
( |
| ) |
|
|
static |
Describes the mod_choice_get_choices_by_courses return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.0
◆ submit_choice_response()
static mod_choice_external::submit_choice_response |
( |
| $choiceid, |
|
|
| $responses ) |
|
static |
Submit choice responses.
- Parameters
-
int | $choiceid | the choice instance id |
array | $responses | the response ids |
- Return values
-
array | answers information and warnings |
- Since
- Moodle 3.0
◆ submit_choice_response_parameters()
static mod_choice_external::submit_choice_response_parameters |
( |
| ) |
|
|
static |
Describes the parameters for submit_choice_response.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ submit_choice_response_returns()
static mod_choice_external::submit_choice_response_returns |
( |
| ) |
|
|
static |
Describes the submit_choice_response return value.
- Return values
-
external_multiple_structure | |
- Since
- Moodle 3.0
◆ view_choice()
static mod_choice_external::view_choice |
( |
| $choiceid | ) |
|
|
static |
Trigger the course module viewed event and update the module completion status.
- Parameters
-
int | $choiceid | the choice instance id |
- Return values
-
array | of warnings and status result |
- Since
- Moodle 3.0
- Exceptions
-
◆ view_choice_parameters()
static mod_choice_external::view_choice_parameters |
( |
| ) |
|
|
static |
Returns description of method parameters.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.0
◆ view_choice_returns()
static mod_choice_external::view_choice_returns |
( |
| ) |
|
|
static |
Returns description of method result value.
- Return values
-
- Since
- Moodle 3.0
The documentation for this class was generated from the following file:
- mod/choice/classes/external.php