Inheritance diagram for core_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	fetch_notifications ($contextid)
	Returns the list of notifications against the current session. More...

static	fetch_notifications_parameters ()
	Returns description of fetch_notifications() parameters. More...

static	fetch_notifications_returns ()
	Returns description of fetch_notifications() result value. More...

static	format_string_parameters ($stringparams)
	Format the received string parameters to be sent to the core get_string() function. More...

static	get_component_strings ($component, $lang=null)
	Return all lang strings of a component - call to core get_component_strings(). More...

static	get_component_strings_parameters ()
	Returns description of get_component_strings parameters. More...

static	get_component_strings_returns ()
	Returns description of get_component_strings() result value. More...

static	get_fragment ($component, $callback, $contextid, $args=null)
	Get a HTML fragment for inserting into something. More...

static	get_fragment_parameters ()
	Returns description of get_fragment parameters. More...

static	get_fragment_returns ()
	Returns description of get_fragment() result value. More...

static	get_string ($stringid, $component='moodle', $lang=null, $stringparams=array())
	Return a core get_string() call. More...

static	get_string_parameters ()
	Returns description of get_string parameters. More...

static	get_string_returns ()
	Returns description of get_string() result value. More...

static	get_strings ($strings)
	Return multiple call to core get_string() More...

static	get_strings_parameters ()
	Returns description of get_string parameters. More...

static	get_strings_returns ()
	Returns description of get_string() result value. More...

static	get_user_dates ($contextid, $contextlevel, $instanceid, $timestamps)
	Format an array of timestamps. More...

static	get_user_dates_parameters ()
	Returns description of get_user_dates parameters. More...

static	get_user_dates_returns ()
	Returns description of get_user_dates() 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	update_inplace_editable ($component, $itemtype, $itemid, $value)
	Update any component's editable value assuming that component implements necessary callback. More...

static	update_inplace_editable_parameters ()
	Parameters for function update_inplace_editable() More...

static	update_inplace_editable_returns ()
	Return structure for update_inplace_editable() 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...

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

◆ fetch_notifications()

static core_external::fetch_notifications ( $contextid )

static

Returns the list of notifications against the current session.

Return values

array

Since: Moodle 3.1

◆ fetch_notifications_parameters()

static core_external::fetch_notifications_parameters ( )

static

Returns description of fetch_notifications() parameters.

Return values

external_function_parameters

Since: Moodle 3.1

◆ fetch_notifications_returns()

static core_external::fetch_notifications_returns ( )

static

Returns description of fetch_notifications() result value.

Return values

external_description

Since: Moodle 3.1

◆ format_string_parameters()

static core_external::format_string_parameters ( $stringparams )

static

Format the received string parameters to be sent to the core get_string() function.

Parameters

array $stringparams

Return values

object|string

Since: Moodle 2.4

◆ get_component_strings()

static core_external::get_component_strings	(	$component,
		$lang = `null`
	)

static

Return all lang strings of a component - call to core get_component_strings().

Parameters

string $component component name

Return values

array

Since: Moodle 2.4

◆ get_component_strings_parameters()

static core_external::get_component_strings_parameters ( )

static

Returns description of get_component_strings parameters.

Return values

external_function_parameters

Since: Moodle 2.4

◆ get_component_strings_returns()

static core_external::get_component_strings_returns ( )

static

Returns description of get_component_strings() result value.

Return values

external_description

Since: Moodle 2.4

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

◆ get_fragment()

static core_external::get_fragment	(	$component,
		$callback,
		$contextid,
		$args = `null`
	)

static

Get a HTML fragment for inserting into something.

Initial use is for inserting mforms into a page using AJAX. This web service is designed to be called only via AJAX and not directly. Callbacks that are called by this web service are responsible for doing the appropriate security checks to access the information returned. This only does minimal validation on the context.

Parameters

string	$component	Name of the component.
string	$callback	Function callback name.
int	$contextid	Context ID this fragment is in.
array	$args	optional arguments for the callback.

Return values

array HTML and JavaScript fragments for insertion into stuff.

Since: Moodle 3.1

◆ get_fragment_parameters()

static core_external::get_fragment_parameters ( )

static

Returns description of get_fragment parameters.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_fragment_returns()

static core_external::get_fragment_returns ( )

static

Returns description of get_fragment() result value.

Return values

external_description

Since: Moodle 3.1

◆ get_string()

static core_external::get_string	(	$stringid,
		$component = `'moodle'`,
		$lang = `null`,
		$stringparams = `array()`
	)

static

Return a core get_string() call.

Parameters

string	$identifier	string identifier
string	$component	string component
array	$stringparams	the string params

Return values

string

Since: Moodle 2.4

◆ get_string_parameters()

static core_external::get_string_parameters ( )

static

Returns description of get_string parameters.

Return values

external_function_parameters

Since: Moodle 2.4

◆ get_string_returns()

static core_external::get_string_returns ( )

static

Returns description of get_string() result value.

Return values

external_description

Since: Moodle 2.4

◆ get_strings()

static core_external::get_strings ( $strings )

static

Return multiple call to core get_string()

Parameters

array $strings strings to translate

Return values

array

Since: Moodle 2.4

◆ get_strings_parameters()

static core_external::get_strings_parameters ( )

static

Returns description of get_string parameters.

Return values

external_function_parameters

Since: Moodle 2.4

◆ get_strings_returns()

static core_external::get_strings_returns ( )

static

Returns description of get_string() result value.

Return values

external_description

Since: Moodle 2.4

◆ get_user_dates()

static core_external::get_user_dates	(	$contextid,
		$contextlevel,
		$instanceid,
		$timestamps
	)

static

Format an array of timestamps.

Parameters

int \| null	$contextid	The contenxt id
string \| null	$contextlevel	The context level
int \| null	$instanceid	The instnace id for the context level
array	$timestamps	Timestamps to format

Return values

array

◆ get_user_dates_parameters()

static core_external::get_user_dates_parameters ( )

static

Returns description of get_user_dates parameters.

Return values

external_function_parameters

◆ get_user_dates_returns()

static core_external::get_user_dates_returns ( )

static

Returns description of get_user_dates() 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

◆ update_inplace_editable()

static core_external::update_inplace_editable	(	$component,
		$itemtype,
		$itemid,
		$value
	)

static

Update any component's editable value assuming that component implements necessary callback.

Since: Moodle 3.1

Parameters

string	$component
string	$itemtype
string	$itemid
string	$value

◆ update_inplace_editable_parameters()

static core_external::update_inplace_editable_parameters ( )

static

Parameters for function update_inplace_editable()

Since: Moodle 3.1

Return values

external_function_parameters

◆ update_inplace_editable_returns()

static core_external::update_inplace_editable_returns ( )

static

Return structure for update_inplace_editable()

Since: Moodle 3.1

Return values

external_description

◆ 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/external/externallib.php

Static Public Member Functions

Static Protected Member Functions

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ external_function_info()

◆ fetch_notifications()

◆ fetch_notifications_parameters()

◆ fetch_notifications_returns()

◆ format_string_parameters()

◆ get_component_strings()

◆ get_component_strings_parameters()

◆ get_component_strings_returns()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_fragment()

◆ get_fragment_parameters()

◆ get_fragment_returns()

◆ get_string()

◆ get_string_parameters()

◆ get_string_returns()

◆ get_strings()

◆ get_strings_parameters()

◆ get_strings_returns()

◆ get_user_dates()

◆ get_user_dates_parameters()

◆ get_user_dates_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ update_inplace_editable()

◆ update_inplace_editable_parameters()

◆ update_inplace_editable_returns()

◆ validate_context()

◆ validate_parameters()