Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/classes/ -> grades_external.php (source)

[Source view]

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

Core grades external functions

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

Defines 1 class

core_grades_external:: (7 methods):
  update_grades_parameters()
  update_grades()
  update_grades_returns()
  create_gradecategory_parameters()
  create_gradecategory()
  create_gradecategory_returns()
  create_gradecategory_is_deprecated()


Class: core_grades_external  - X-Ref

core grades functions

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