Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Static Public Member Functions | Static Protected Member Functions | List of all members
mod_choice_external Class Reference
Inheritance diagram for mod_choice_external:
external_api

Static Public Member Functions

static call_external_function ($function, $args, $ajaxonly=false)
 Call an external function validating all params/returns correctly. More...
 
static clean_returnvalue (external_description $description, $response)
 Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
 
static delete_choice_responses ($choiceid, $responses=array())
 Delete the given submitted responses in a choice. More...
 
static delete_choice_responses_parameters ()
 Describes the parameters for delete_choice_responses. More...
 
static delete_choice_responses_returns ()
 Describes the delete_choice_responses return value. More...
 
static external_function_info ($function, $strictness=MUST_EXIST)
 Returns detailed function information. More...
 
static get_choice_options ($choiceid)
 Returns options for a specific choice. More...
 
static get_choice_options_parameters ()
 Describes the parameters for mod_choice_get_choice_options. More...
 
static get_choice_options_returns ()
 Describes the get_choice_results return value. More...
 
static get_choice_results ($choiceid)
 Returns user's results for a specific choice and a list of those users that did not answered yet. More...
 
static get_choice_results_parameters ()
 Describes the parameters for get_choices_by_courses. More...
 
static get_choice_results_returns ()
 Describes the get_choice_results return value. More...
 
static get_choices_by_courses ($courseids=array())
 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. More...
 
static get_choices_by_courses_parameters ()
 Describes the parameters for get_choices_by_courses. More...
 
static get_choices_by_courses_returns ()
 Describes the mod_choice_get_choices_by_courses return value. More...
 
static set_context_restriction ($context)
 Set context restriction for all following subsequent function calls. More...
 
static set_timeout ($seconds=360)
 This method has to be called before every operation that takes a longer time to finish! More...
 
static submit_choice_response ($choiceid, $responses)
 Submit choice responses. More...
 
static submit_choice_response_parameters ()
 Describes the parameters for submit_choice_response. More...
 
static submit_choice_response_returns ()
 Describes the submit_choice_response return value. More...
 
static validate_context ($context)
 Makes sure user may execute functions in this context. More...
 
static validate_parameters (external_description $description, $params)
 Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...
 
static view_choice ($choiceid)
 Trigger the course module viewed event and update the module completion status. More...
 
static view_choice_parameters ()
 Returns description of method parameters. More...
 
static view_choice_returns ()
 Returns description of method result value. More...
 

Static Protected Member Functions

static get_context_from_params ($param)
 Get context from passed parameters. More...
 
static get_context_parameters ()
 Returns a prepared structure to use a context parameters. More...
 

Member Function Documentation

◆ call_external_function()

static external_api::call_external_function (   $function,
  $args,
  $ajaxonly = false 
)
staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters
string$functionA webservice function name.
array$argsParams array (named params)
boolean$ajaxonlyIf true, an extra check will be peformed to see if ajax is required.
Return values
arraycontaining keys for error (bool), exception and data.

◆ clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,
  $response 
)
staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters
external_description$descriptiondescription of the return values
mixed$responsethe actual response
Return values
mixedresponse with added defaults for optional items, invalid_response_exception thrown if any problem found
Author
2010 Jerome Mouneyrac
Since
Moodle 2.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$choiceidthe choice instance id
array$responsesthe response ids, empty for deleting all the current user responses
Return values
arraystatus information and warnings
Exceptions
moodle_exception
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

◆ external_function_info()

static external_api::external_function_info (   $function,
  $strictness = MUST_EXIST 
)
staticinherited

Returns detailed function information.

Parameters
string | object$functionname of external function or record from external_function
int$strictnessIGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found
Return values
stdClassdescription or false if not found or exception thrown
Since
Moodle 2.0

◆ get_choice_options()

static mod_choice_external::get_choice_options (   $choiceid)
static

Returns options for a specific choice.

Parameters
int$choiceidthe choice instance id
Return values
arrayof options details
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$choiceidthe choice instance id
Return values
arrayof 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$courseidsthe course ids
Return values
arrayof choices details
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

◆ get_context_from_params()

static external_api::get_context_from_params (   $param)
staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters
array$param
Since
Moodle 2.6
Exceptions
invalid_parameter_exception
Return values
context

◆ get_context_parameters()

static external_api::get_context_parameters ( )
staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values
external_single_structure

Reimplemented in tool_lp\external, and core_competency\external.

◆ set_context_restriction()

static external_api::set_context_restriction (   $context)
staticinherited

Set context restriction for all following subsequent function calls.

Parameters
stdClass$contextthe context restriction
Since
Moodle 2.0

◆ set_timeout()

static external_api::set_timeout (   $seconds = 360)
staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters
int$secondsmax expected time the next operation needs
Since
Moodle 2.0

◆ submit_choice_response()

static mod_choice_external::submit_choice_response (   $choiceid,
  $responses 
)
static

Submit choice responses.

Parameters
int$choiceidthe choice instance id
array$responsesthe response ids
Return values
arrayanswers 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

◆ validate_context()

static external_api::validate_context (   $context)
staticinherited

Makes sure user may execute functions in this context.

Parameters
stdClass$context
Since
Moodle 2.0

◆ validate_parameters()

static external_api::validate_parameters ( external_description  $description,
  $params 
)
staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters
external_description$descriptiondescription of parameters
mixed$paramsthe actual parameters
Return values
mixedparams with added defaults for optional items, invalid_parameters_exception thrown if any problem found
Since
Moodle 2.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$choiceidthe choice instance id
Return values
arrayof warnings and status result
Since
Moodle 3.0
Exceptions
moodle_exception

◆ 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
external_description
Since
Moodle 3.0

The documentation for this class was generated from the following file: