core_grades_external Class Reference

core grades functions More...

Inheritance diagram for core_grades_external:

Static Public Member Functions
static	create_gradecategory (int $courseid, string $fullname, array $options)
	Creates a gradecategory inside of the specified course.
static	create_gradecategory_is_deprecated ()
	Marking the method as deprecated.
static	create_gradecategory_parameters ()
	Returns description of method parameters.
static	create_gradecategory_returns ()
	Returns description of method result value.
static	update_grades ($source, $courseid, $component, $activityid, $itemnumber, $grades=array(), $itemdetails=array())
	Update a grade item and, optionally, student grades.
static	update_grades_parameters ()
	Returns description of method parameters.
static	update_grades_returns ()
	Returns description of method result value.

Detailed Description

core grades functions

Member Function Documentation

create_gradecategory()

static core_grades_external::create_gradecategory ( int $courseid, string $fullname, array $options )

static

Creates a gradecategory inside of the specified course.

Deprecated

since Moodle 3.11 MDL-71031 - please do not use this function any more.

Todo

MDL-71325 This will be deleted in Moodle 4.3.

See also

core_grades\external\create_gradecategories\create_gradecategories()

Parameters

int	$courseid	the courseid to create the gradecategory in.
string	$fullname	the fullname of the grade category to create.
array	$options	array of options to set.

Return values

array

array of created categoryid and warnings.

create_gradecategory_is_deprecated()

static core_grades_external::create_gradecategory_is_deprecated ( )

static

Marking the method as deprecated.

See MDL-71031 for details.

Since

Moodle 3.11

Return values

bool

create_gradecategory_parameters()

static core_grades_external::create_gradecategory_parameters ( )

static

Returns description of method parameters.

Deprecated

since Moodle 3.11 MDL-71031 - please do not use this function any more.

Todo

MDL-71325 This will be deleted in Moodle 4.3.

See also

core_grades\external\create_gradecategories\create_gradecategories()

Return values

external_function_parameters

Since

Moodle 3.10

create_gradecategory_returns()

static core_grades_external::create_gradecategory_returns ( )

static

Returns description of method result value.

Deprecated

since Moodle 3.11 MDL-71031 - please do not use this function any more.

Todo

MDL-71325 This will be deleted in Moodle 4.3.

See also

core_grades\external\create_gradecategories\create_gradecategories()

Return values

core_external\external_description

Since

Moodle 3.10

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

core_external\external_description

Since

Moodle 2.7

---

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

• lib/classes/grades_external.php