Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
Tags-related web services. More...
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 | external_function_info ($function, $strictness=MUST_EXIST) |
Returns detailed function information. More... | |
static | get_tag_areas () |
Retrieves existing tag areas. More... | |
static | get_tag_areas_parameters () |
Returns description of get_tag_areas() parameters. More... | |
static | get_tag_areas_returns () |
Returns description of get_tag_areas() result value. More... | |
static | get_tag_cloud ($tagcollid=0, $isstandard=false, $limit=150, $sort='name', $search='', $fromctx=0, $ctx=0, $rec=1) |
Retrieves a tag cloud for display. More... | |
static | get_tag_cloud_parameters () |
Returns description of get_tag_cloud() parameters. More... | |
static | get_tag_cloud_returns () |
Returns description of get_tag_cloud() result value. More... | |
static | get_tag_collections () |
Retrieves existing tag collections. More... | |
static | get_tag_collections_parameters () |
Returns description of get_tag_collections() parameters. More... | |
static | get_tag_collections_returns () |
Returns description of get_tag_collections() result value. More... | |
static | get_tagindex ($params) |
Get tags by their ids. More... | |
static | get_tagindex_parameters () |
Parameters for function get_tagindex() More... | |
static | get_tagindex_per_area ($params) |
Returns the tag index per multiple areas if requested. More... | |
static | get_tagindex_per_area_parameters () |
Parameters for function get_tagindex_per_area() More... | |
static | get_tagindex_per_area_returns () |
Return structure for get_tagindex_per_area. More... | |
static | get_tagindex_returns () |
Return structure for get_tag() More... | |
static | get_tags ($tags) |
Get tags by their ids. More... | |
static | get_tags_parameters () |
Parameters for function get_tags() More... | |
static | get_tags_returns () |
Return structure for get_tag() 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 | update_tags ($tags) |
Update tags. More... | |
static | update_tags_parameters () |
Parameters for function update_tags() More... | |
static | update_tags_returns () |
Return structure for update_tag() 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 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... | |
Tags-related web services.
|
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.
string | $function | A webservice function name. |
array | $args | Params array (named params) |
boolean | $ajaxonly | If true, an extra check will be peformed to see if ajax is required. |
array | containing keys for error (bool), exception and data. |
|
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.
external_description | $description | description of the return values |
mixed | $response | the actual response |
mixed | response with added defaults for optional items, invalid_response_exception thrown if any problem found |
|
staticinherited |
Returns detailed function information.
string | object | $function | name of external function or record from external_function |
int | $strictness | IGNORE_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 |
stdClass | description or false if not found or exception thrown |
|
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.
array | $param |
invalid_parameter_exception |
context |
|
staticprotectedinherited |
Returns a prepared structure to use a context parameters.
external_single_structure |
Reimplemented in core_competency\external, and tool_lp\external.
|
static |
Retrieves existing tag areas.
array | an array of warnings and objects containing the plugin information |
moodle_exception |
|
static |
Returns description of get_tag_areas() parameters.
external_function_parameters |
|
static |
Returns description of get_tag_areas() result value.
external_description |
|
static |
Retrieves a tag cloud for display.
int | $tagcollid | tag collection id |
bool | $isstandard | return only standard tags |
int | $limit | maximum number of tags to retrieve, tags are sorted by the instance count descending here regardless of $sort parameter |
string | $sort | sort order for display, default 'name' - tags will be sorted after they are retrieved |
string | $search | search string |
int | $fromctx | context id where this tag cloud is displayed |
int | $ctx | only retrieve tag instances in this context |
int | $rec | retrieve tag instances in the $ctx context and it's children (default 1) |
array | an array of warnings and tag cloud information and items |
moodle_exception |
|
static |
Returns description of get_tag_cloud() parameters.
external_function_parameters |
|
static |
Returns description of get_tag_cloud() result value.
external_description |
|
static |
Retrieves existing tag collections.
array | an array of warnings and tag collections |
moodle_exception |
|
static |
Returns description of get_tag_collections() parameters.
external_function_parameters |
|
static |
Returns description of get_tag_collections() result value.
external_description |
|
static |
Get tags by their ids.
array | $params |
|
static |
Parameters for function get_tagindex()
external_function_parameters |
|
static |
Returns the tag index per multiple areas if requested.
array | $params | Tag index required information. |
moodle_exception |
|
static |
Parameters for function get_tagindex_per_area()
external_function_parameters |
|
static |
|
static |
Return structure for get_tag()
external_description |
|
static |
Get tags by their ids.
array | $tags |
|
static |
Parameters for function get_tags()
external_function_parameters |
|
static |
Return structure for get_tag()
external_description |
|
staticinherited |
Set context restriction for all following subsequent function calls.
stdClass | $context | the context restriction |
|
staticinherited |
This method has to be called before every operation that takes a longer time to finish!
int | $seconds | max expected time the next operation needs |
|
static |
Update tags.
array | $tags |
|
static |
Parameters for function update_tags()
external_function_parameters |
|
static |
Return structure for update_tag()
external_description |
|
staticinherited |
Makes sure user may execute functions in this context.
stdClass | $context |
|
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.
external_description | $description | description of parameters |
mixed | $params | the actual parameters |
mixed | params with added defaults for optional items, invalid_parameters_exception thrown if any problem found |