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.
/grade/report/overview/classes/ -> external.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

External grade report overview API

Copyright: 2016 Juan Leyva <juan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 224 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

gradereport_overview_external:: (6 methods):
  get_course_grades_parameters()
  get_course_grades()
  get_course_grades_returns()
  view_grade_report_parameters()
  view_grade_report()
  view_grade_report_returns()


Class: gradereport_overview_external  - X-Ref

External grade overview report API implementation

get_course_grades_parameters()   X-Ref
Describes the parameters for get_course_grades.

return: external_function_parameters

get_course_grades($userid = 0)   X-Ref
Get the given user courses final grades

param: int $userid get grades for this user (optional, default current)
return: array the grades tables

get_course_grades_returns()   X-Ref
Describes the get_course_grades return value.

return: external_single_structure

view_grade_report_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

view_grade_report($courseid, $userid = 0)   X-Ref
Trigger the user report events, do the same that the web interface view of the report

param: int $courseid id of course
param: int $userid id of the user the report belongs to
return: array of warnings and status result

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

return: external_description