Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 402] [Versions 310 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


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