Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

Core grades external functions

Copyright: 2012 Andrew Davis
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 678 lines (35 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: core_grades_external  - X-Ref

core grades functions

get_grades_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_grades($courseid, $component = null, $activityid = null, $userids = array()   X-Ref
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.

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

get_grade_item($courseid, $itemtype, $itemmodule = null, $iteminstance = null, $itemnumber = null)   X-Ref
Get a grade item

param: int $courseid        Course id
param: string $itemtype     Item type
param: string $itemmodule   Item module
param: int $iteminstance    Item instance
param: int $itemnumber      Item number
return: grade_item           A grade_item instance

get_grades_returns()   X-Ref
Returns description of method result value

return: external_description

get_grades_is_deprecated()   X-Ref
Marking the method as deprecated.

return: bool

update_grades_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

update_grades($source, $courseid, $component, $activityid,$itemnumber, $grades = array()   X-Ref
Update a grade item and, optionally, student grades

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

update_grades_returns()   X-Ref
Returns description of method result value

return: external_description

create_gradecategory_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

create_gradecategory(int $courseid, string $fullname, array $options)   X-Ref
Creates a gradecategory inside of the specified course.

param: int $courseid the courseid to create the gradecategory in.
param: string $fullname the fullname of the grade category to create.
param: array $options array of options to set.
return: array array of created categoryid and warnings.

create_gradecategory_returns()   X-Ref
Returns description of method result value

return: external_description

create_gradecategory_is_deprecated()   X-Ref
Marking the method as deprecated. See MDL-71031 for details.

return: bool