Class core_customfield_external. More...

Inheritance diagram for core_customfield_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	create_category ($component, $area, $itemid)
	Create category function. More...

static	create_category_parameters ()
	Parameters for create category. More...

static	create_category_returns ()
	Return for create category.

static	delete_category ($id)
	Delete category function. More...

static	delete_category_parameters ()
	Parameters for delete category. More...

static	delete_category_returns ()
	Return for delete category.

static	delete_field ($id)
	Delete custom field function. More...

static	delete_field_parameters ()
	Parameters for delete_field. More...

static	delete_field_returns ()
	Return for delete_field.

static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...

static	move_category (int $id, int $beforeid)
	Reorder categories. More...

static	move_category_parameters ()
	Return for move category. More...

static	move_category_returns ()
	Return for move category.

static	move_field ($id, $categoryid, $beforeid)
	Move/reorder field. More...

static	move_field_parameters ()
	Parameters for move field. More...

static	move_field_returns ()
	Return for move field.

static	reload_template ($component, $area, $itemid)
	Reload template function. More...

static	reload_template_parameters ()
	Parameters for reload template function. More...

static	reload_template_returns ()
	Ajax returns on reload template. 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

Class core_customfield_external.

Copyright: 2018 David Matamoros david.nosp@m.mc@m.nosp@m.oodle.nosp@m..com

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

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

◆ create_category()

static core_customfield_external::create_category	(	$component,
		$area,
		$itemid
	)

static

Create category function.

Parameters

string	$component
string	$area
int	$itemid

Return values

mixed

◆ create_category_parameters()

static core_customfield_external::create_category_parameters ( )

static

Parameters for create category.

Return values

external_function_parameters

◆ delete_category()

static core_customfield_external::delete_category ( $id )

static

Delete category function.

Parameters

int $id

◆ delete_category_parameters()

static core_customfield_external::delete_category_parameters ( )

static

Parameters for delete category.

Return values

external_function_parameters

◆ delete_field()

static core_customfield_external::delete_field ( $id )

static

Delete custom field function.

Parameters

int $id

◆ delete_field_parameters()

static core_customfield_external::delete_field_parameters ( )

static

Parameters for delete_field.

Return values

external_function_parameters

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

◆ move_category()

static core_customfield_external::move_category	(	int	$id,
		int	$beforeid
	)

static

Reorder categories.

Move category to the new position

Parameters

int	$id	category id
int	$beforeid

◆ move_category_parameters()

static core_customfield_external::move_category_parameters ( )

static

Return for move category.

Return values

external_function_parameters

◆ move_field()

static core_customfield_external::move_field	(	$id,
		$categoryid,
		$beforeid
	)

static

Move/reorder field.

Move a field to another category and/or change sortorder of fields

Parameters

int	$id	field id
int	$categoryid
int	$beforeid

◆ move_field_parameters()

static core_customfield_external::move_field_parameters ( )

static

Parameters for move field.

Return values

external_function_parameters

◆ reload_template()

static core_customfield_external::reload_template	(	$component,
		$area,
		$itemid
	)

static

Reload template function.

Parameters

string	$component
string	$area
int	$itemid

Return values

array|object|stdClass

◆ reload_template_parameters()

static core_customfield_external::reload_template_parameters ( )

static

Parameters for reload template function.

Return values

external_function_parameters

◆ reload_template_returns()

static core_customfield_external::reload_template_returns ( )

static

Ajax returns on reload template.

Return values

external_single_structure

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

customfield/externallib.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ create_category()

◆ create_category_parameters()

◆ delete_category()

◆ delete_category_parameters()

◆ delete_field()

◆ delete_field_parameters()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ move_category()

◆ move_category_parameters()

◆ move_field()

◆ move_field_parameters()

◆ reload_template()

◆ reload_template_parameters()

◆ reload_template_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ validate_context()

◆ validate_parameters()