Inheritance diagram for gradereport_user_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_grade_items ($courseid, $userid=0, $groupid=0)
	Returns the complete list of grade items for users in a course. More...

static	get_grade_items_parameters ()
	Describes the parameters for get_grade_items. More...

static	get_grade_items_returns ()
	Describes tget_grade_items return value. More...

static	get_grades_table ($courseid, $userid=0, $groupid=0)
	Returns a list of grades tables for users in a course. More...

static	get_grades_table_parameters ()
	Describes the parameters for get_grades_table. More...

static	get_grades_table_returns ()
	Describes tget_grades_table return 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	view_grade_report ($courseid, $userid=0)
	Trigger the user report events, do the same that the web interface view of the report. More...

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

static	view_grade_report_returns ()
	Returns description of method result value. More...

Static Protected Member Functions
static	check_report_access ($courseid, $userid, $groupid=0)
	Validate access permissions to the report. More...

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

static	get_report_data ($course, $context, $user, $userid, $groupid, $tabledata=true)
	Get the report data. 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.

◆ check_report_access()

static gradereport_user_external::check_report_access	(	$courseid,
		$userid,
		$groupid = `0`
	)

staticprotected

Validate access permissions to the report.

Parameters

int	$courseid	the courseid
int	$userid	the user id to retrieve data from
int	$groupid	the group id

Return values

array with the parameters cleaned and other required information

Since: Moodle 3.2

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

static gradereport_user_external::get_grade_items	(	$courseid,
		$userid = `0`,
		$groupid = `0`
	)

static

Returns the complete list of grade items for users in a course.

Parameters

int	$courseid	Course Id
int	$userid	Only this user (optional)
int	$groupid	Get users from this group only

Return values

array the grades tables

Since: Moodle 3.2

◆ get_grade_items_parameters()

static gradereport_user_external::get_grade_items_parameters ( )

static

Describes the parameters for get_grade_items.

Return values

external_function_parameters

Since: Moodle 3.2

◆ get_grade_items_returns()

static gradereport_user_external::get_grade_items_returns ( )

static

Describes tget_grade_items return value.

Return values

external_single_structure

Since: Moodle 3.2

◆ get_grades_table()

static gradereport_user_external::get_grades_table	(	$courseid,
		$userid = `0`,
		$groupid = `0`
	)

static

Returns a list of grades tables for users in a course.

Parameters

int	$courseid	Course Id
int	$userid	Only this user (optional)
int	$groupid	Get users from this group only

Return values

array the grades tables

Since: Moodle 2.9

◆ get_grades_table_parameters()

static gradereport_user_external::get_grades_table_parameters ( )

static

Describes the parameters for get_grades_table.

Return values

external_function_parameters

Since: Moodle 2.9

◆ get_grades_table_returns()

static gradereport_user_external::get_grades_table_returns ( )

static

Describes tget_grades_table return value.

Return values

external_single_structure

Since: Moodle 2.9

◆ get_report_data()

static gradereport_user_external::get_report_data	(	$course,
		$context,
		$user,
		$userid,
		$groupid,
		$tabledata = `true`
	)

staticprotected

Get the report data.

Parameters

stdClass	$course	course object
stdClass	$context	context object
stdClass	$user	user object (it can be null for all the users)
int	$userid	the user to retrieve data from, 0 for all
int	$groupid	the group id to filter
bool	$tabledata	whether to get the table data (true) or the gradeitemdata

Return values

array data and possible warnings

Since: Moodle 3.2

◆ 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

◆ view_grade_report()

static gradereport_user_external::view_grade_report	(	$courseid,
		$userid = `0`
	)

static

Trigger the user report events, do the same that the web interface view of the report.

Parameters

int	$courseid	id of course
int	$userid	id of the user the report belongs to

Return values

array of warnings and status result

Since: Moodle 2.9

Exceptions

moodle_exception

◆ view_grade_report_parameters()

static gradereport_user_external::view_grade_report_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 2.9

◆ view_grade_report_returns()

static gradereport_user_external::view_grade_report_returns ( )

static

Returns description of method result value.

Return values

external_description

Since: Moodle 2.9

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

grade/report/user/externallib.php

Static Public Member Functions

Static Protected Member Functions

Member Function Documentation

◆ call_external_function()

◆ check_report_access()

◆ clean_returnvalue()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_grade_items()

◆ get_grade_items_parameters()

◆ get_grade_items_returns()

◆ get_grades_table()

◆ get_grades_table_parameters()

◆ get_grades_table_returns()

◆ get_report_data()

◆ set_context_restriction()

◆ set_timeout()

◆ validate_context()

◆ validate_parameters()

◆ view_grade_report()

◆ view_grade_report_parameters()

◆ view_grade_report_returns()