Web services relating to fetching of a rubric for the grading panel. More...

Inheritance diagram for gradingform_rubric\grades\grader\gradingpanel\external\fetch:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly.

static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute.

static	execute (string $component, int $contextid, string $itemname, int $gradeduserid)
	Fetch the data required to build a grading panel for a simple grade.

static	execute_parameters ()
	Describes the parameters for fetching the grading panel for a simple grade.

static	execute_returns ()
	Describes the data returned from the external function.

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

static	get_fetch_data (gradeitem $gradeitem, stdClass $gradeduser)
	Get the data to be fetched and create the structure ready for Mustache.

static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls.

static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish!

static	validate_context ($context)
	Makes sure user may execute functions in this context.

static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters.

static	get_context_parameters ()
	Returns a prepared structure to use a context parameters.

static	get_formatted_text (context $context, int $definitionid, string $filearea, string $text, int $format)
	Get a formatted version of the remark/description/etc.

Detailed Description

Web services relating to fetching of a rubric for the grading panel.

Copyright: 2019 Mathew May <mathew.solutions>

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

◆ execute()

static gradingform_rubric\grades\grader\gradingpanel\external\fetch::execute	(	string	$component,
		int	$contextid,
		string	$itemname,
		int	$gradeduserid )

static

Fetch the data required to build a grading panel for a simple grade.

Parameters

string	$component
int	$contextid
string	$itemname
int	$gradeduserid

Return values

array

Since: Moodle 3.8

◆ execute_parameters()

static gradingform_rubric\grades\grader\gradingpanel\external\fetch::execute_parameters ( )

static

Describes the parameters for fetching the grading panel for a simple grade.

Return values

external_function_parameters

Since: Moodle 3.8

◆ execute_returns()

static gradingform_rubric\grades\grader\gradingpanel\external\fetch::execute_returns ( )

static

Describes the data returned from the external function.

Return values

external_single_structure

Since: Moodle 3.8

◆ 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

Exceptions

coding_exception for any property and/or method that is missing or invalid

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.

◆ get_fetch_data()

static gradingform_rubric\grades\grader\gradingpanel\external\fetch::get_fetch_data	(	gradeitem	$gradeitem,
		stdClass	$gradeduser )

static

Get the data to be fetched and create the structure ready for Mustache.

Parameters

gradeitem	$gradeitem
stdClass	$gradeduser

Return values

array

◆ get_formatted_text()

static gradingform_rubric\grades\grader\gradingpanel\external\fetch::get_formatted_text	(	context	$context,
		int	$definitionid,
		string	$filearea,
		string	$text,
		int	$format )

staticprotected

Get a formatted version of the remark/description/etc.

Parameters

context	$context
int	$definitionid
string	$filearea	The file area of the field
string	$text	The text to be formatted
int	$format	The input format of the string

Return values

string

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

grade/grading/form/rubric/classes/grades/grader/gradingpanel/external/fetch.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ call_external_function()

◆ clean_returnvalue()

◆ execute()

◆ execute_parameters()

◆ execute_returns()

◆ external_function_info()

◆ get_context_from_params()

◆ get_context_parameters()

◆ get_fetch_data()

◆ get_formatted_text()

◆ set_context_restriction()

◆ set_timeout()

◆ validate_context()

◆ validate_parameters()