This class contains a list of webservice functions related to output. More...

Inheritance diagram for core\output\external:

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	load_fontawesome_icon_map ()
	Return a mapping of icon names to icons. More...

static	load_fontawesome_icon_map_parameters ()
	Returns description of load_icon_map() parameters. More...

static	load_fontawesome_icon_map_returns ()
	Returns description of load_icon_map() result value. More...

static	load_template ($component, $template, $themename, $includecomments=false)
	Return a mustache template, and all the strings it requires. More...

static	load_template_parameters ()
	Returns description of load_template() parameters. More...

static	load_template_returns ()
	Returns description of load_template() result value. More...

static	load_template_with_dependencies (string $component, string $template, string $themename, bool $includecomments=false, string $lang=null)
	Return a mustache template, and all the child templates and strings it requires. More...

static	load_template_with_dependencies_parameters ()
	Returns description of load_template_with_dependencies() parameters. More...

static	load_template_with_dependencies_returns ()
	Returns description of load_template_with_dependencies() result 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	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...

Detailed Description

This class contains a list of webservice functions related to output.

Copyright: 2015 Damyon Wiese

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since: 2.9

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	$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.

Return values

array containing 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	$description	description of the return values
mixed	$response	the actual response

Return values

mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author: 2010 Jerome Mouneyrac

Since: Moodle 2.0

◆ external_function_info()

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

staticinherited

Returns detailed function information.

Parameters

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

Return values

stdClass description or false if not found or exception thrown

Since: Moodle 2.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 core_competency\external, and tool_lp\external.

◆ load_fontawesome_icon_map()

static core\output\external::load_fontawesome_icon_map ( )

static

Return a mapping of icon names to icons.

Return values

array the mapping

◆ load_fontawesome_icon_map_parameters()

static core\output\external::load_fontawesome_icon_map_parameters ( )

static

Returns description of load_icon_map() parameters.

Return values

external_function_parameters

◆ load_fontawesome_icon_map_returns()

static core\output\external::load_fontawesome_icon_map_returns ( )

static

Returns description of load_icon_map() result value.

Return values

external_description

◆ load_template()

static core\output\external::load_template	(	$component,
		$template,
		$themename,
		$includecomments = `false`
	)

static

Return a mustache template, and all the strings it requires.

Parameters

string	$component	The component that holds the template.
string	$templatename	The name of the template.
string	$themename	The name of the current theme.

Return values

string the template

◆ load_template_parameters()

static core\output\external::load_template_parameters ( )

static

Returns description of load_template() parameters.

Return values

external_function_parameters

◆ load_template_returns()

static core\output\external::load_template_returns ( )

static

Returns description of load_template() result value.

Return values

external_description

◆ load_template_with_dependencies()

static core\output\external::load_template_with_dependencies	(	string	$component,
		string	$template,
		string	$themename,
		bool	$includecomments = `false`,
		string	$lang = `null`
	)

static

Return a mustache template, and all the child templates and strings it requires.

Parameters

string	$component	The component that holds the template.
string	$template	The name of the template.
string	$themename	The name of the current theme.
bool	$includecomments	Whether to strip comments from the template source.
string	$lang	moodle translation language, null means use current.

Return values

string the template

◆ load_template_with_dependencies_parameters()

static core\output\external::load_template_with_dependencies_parameters ( )

static

Returns description of load_template_with_dependencies() parameters.

Return values

external_function_parameters

◆ load_template_with_dependencies_returns()

static core\output\external::load_template_with_dependencies_returns ( )

static

Returns description of load_template_with_dependencies() result value.

Return values

external_description

◆ set_context_restriction()

static external_api::set_context_restriction ( $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass $context the 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 $seconds max expected time the next operation needs

Since: Moodle 2.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	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since: Moodle 2.0

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

lib/classes/output/external.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ load_fontawesome_icon_map()

◆ load_fontawesome_icon_map_parameters()

◆ load_fontawesome_icon_map_returns()

◆ load_template()

◆ load_template_parameters()

◆ load_template_returns()

◆ load_template_with_dependencies()

◆ load_template_with_dependencies_parameters()

◆ load_template_with_dependencies_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ validate_context()

◆ validate_parameters()