core grades functions More...

Inheritance diagram for core_grades_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	get_grades ($courseid, $component=null, $activityid=null, $userids=array())
	Returns student course total grade and grades for activities. More...

static	get_grades_is_deprecated ()
	Marking the method as deprecated. More...

static	get_grades_parameters ()
	Returns description of method parameters. More...

static	get_grades_returns ()
	Returns description of method 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_grades ($source, $courseid, $component, $activityid, $itemnumber, $grades=array(), $itemdetails=array())
	Update a grade item and, optionally, student grades. More...

static	update_grades_parameters ()
	Returns description of method parameters. More...

static	update_grades_returns ()
	Returns description of method result 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 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

core grades functions

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 tool_lp\external, and core_competency\external.

◆ get_grades()

static core_grades_external::get_grades	(	$courseid,
		$component = `null`,
		$activityid = `null`,
		$userids = `array()`
	)

static

Returns student course total grade and grades for activities.

This function does not return category or manual items. This function is suitable for managers or teachers not students.

Parameters

int	$courseid	Course id
string	$component	Component name
int	$activityid	Activity id
array	$userids	Array of user ids

Return values

array Array of grades

Since: Moodle 2.7

Deprecated:: Moodle 3.2 MDL-51373 - Please do not call this function any more.

See also: gradereport_user_external::get_grade_items for a similar function

◆ get_grades_is_deprecated()

static core_grades_external::get_grades_is_deprecated ( )

static

Marking the method as deprecated.

Return values

bool

◆ get_grades_parameters()

static core_grades_external::get_grades_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.7

Deprecated:: Moodle 3.2 MDL-51373 - Please do not call this function any more.

See also: gradereport_user_external::get_grade_items for a similar function

◆ get_grades_returns()

static core_grades_external::get_grades_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.7

Deprecated:: Moodle 3.2 MDL-51373 - Please do not call this function any more.

See also: gradereport_user_external::get_grade_items for a similar function

◆ 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_grades()

static core_grades_external::update_grades	(	$source,
		$courseid,
		$component,
		$activityid,
		$itemnumber,
		$grades = `array()`,
		$itemdetails = `array()`
	)

static

Update a grade item and, optionally, student grades.

Parameters

string	$source	The source of the grade update
int	$courseid	The course id
string	$component	Component name
int	$activityid	The activity id
int	$itemnumber	The item number
array	$grades	Array of grades
array	$itemdetails	Array of item details

Return values

int	A status flag

Since: Moodle 2.7

◆ update_grades_parameters()

static core_grades_external::update_grades_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.7

◆ update_grades_returns()

static core_grades_external::update_grades_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.7

◆ 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/grades_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()

◆ get_grades()

◆ get_grades_is_deprecated()

◆ get_grades_parameters()

◆ get_grades_returns()

◆ set_context_restriction()

◆ set_timeout()

◆ update_grades()

◆ update_grades_parameters()

◆ update_grades_returns()

◆ validate_context()

◆ validate_parameters()