Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
gradereport_overview_external Class Reference

External grade overview report API implementation. More...

Inheritance diagram for gradereport_overview_external:

Static Public Member Functions

static get_course_grades ($userid=0)
 Get the given user courses final grades.
 
static get_course_grades_parameters ()
 Describes the parameters for get_course_grades.
 
static get_course_grades_returns ()
 Describes the get_course_grades return value.
 
static view_grade_report ($courseid, $userid=0)
 Trigger the user report events, do the same that the web interface view of the report.
 
static view_grade_report_parameters ()
 Returns description of method parameters.
 
static view_grade_report_returns ()
 Returns description of method result value.
 

Detailed Description

External grade overview report API implementation.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_course_grades()

static gradereport_overview_external::get_course_grades ( $userid = 0)
static

Get the given user courses final grades.

Parameters
int$useridget grades for this user (optional, default current)
Return values
arraythe grades tables
Since
Moodle 3.2

◆ get_course_grades_parameters()

static gradereport_overview_external::get_course_grades_parameters ( )
static

Describes the parameters for get_course_grades.

Return values
external_function_parameters
Since
Moodle 3.2

◆ get_course_grades_returns()

static gradereport_overview_external::get_course_grades_returns ( )
static

Describes the get_course_grades return value.

Return values
external_single_structure
Since
Moodle 3.2

◆ view_grade_report()

static gradereport_overview_external::view_grade_report ( $courseid,
$userid = 0 )
static

Trigger the user report events, do the same that the web interface view of the report.

Parameters
int$courseidid of course
int$useridid of the user the report belongs to
Return values
arrayof warnings and status result
Since
Moodle 3.2
Exceptions
moodle_exception

◆ view_grade_report_parameters()

static gradereport_overview_external::view_grade_report_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.2

◆ view_grade_report_returns()

static gradereport_overview_external::view_grade_report_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.2

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