Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradereport_user\external\user Class Reference
Inheritance diagram for gradereport_user\external\user:

Static Public Member Functions

static get_grade_items (int $courseid, int $userid=0, int $groupid=0)
 Returns the complete list of grade items for users in a course.
 
static get_grade_items_parameters ()
 Describes the parameters for get_grade_items.
 
static get_grade_items_returns ()
 Describes tget_grade_items return value.
 
static get_grades_table (int $courseid, int $userid=0, int $groupid=0)
 Returns a list of grades tables for users in a course.
 
static get_grades_table_parameters ()
 Describes the parameters for get_grades_table.
 
static get_grades_table_returns ()
 Describes tget_grades_table return value.
 
static view_grade_report (int $courseid, int $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.
 

Static Protected Member Functions

static check_report_access (int $courseid, int $userid, int $groupid=0)
 Validate access permissions to the report.
 
static get_report_data (stdClass $course, stdClass $context, ?stdClass $user, int $userid, int $groupid, bool $tabledata=true)
 Get the report data.
 

Detailed Description

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

Member Function Documentation

◆ check_report_access()

static gradereport_user\external\user::check_report_access ( int $courseid,
int $userid,
int $groupid = 0 )
staticprotected

Validate access permissions to the report.

Parameters
int$courseidthe courseid
int$useridthe user id to retrieve data from
int$groupidthe group id
Return values
arraywith the parameters cleaned and other required information
Since
Moodle 3.2

◆ get_grade_items()

static gradereport_user\external\user::get_grade_items ( int $courseid,
int $userid = 0,
int $groupid = 0 )
static

Returns the complete list of grade items for users in a course.

Parameters
int$courseidCourse Id
int$useridOnly this user (optional)
int$groupidGet users from this group only
Return values
arraythe grades tables
Since
Moodle 3.2

◆ get_grade_items_parameters()

static gradereport_user\external\user::get_grade_items_parameters ( )
static

Describes the parameters for get_grade_items.

Return values
external_function_parameters
Since
Moodle 3.2

◆ get_grade_items_returns()

static gradereport_user\external\user::get_grade_items_returns ( )
static

Describes tget_grade_items return value.

Return values
external_single_structure
Since
Moodle 3.2

◆ get_grades_table()

static gradereport_user\external\user::get_grades_table ( int $courseid,
int $userid = 0,
int $groupid = 0 )
static

Returns a list of grades tables for users in a course.

Parameters
int$courseidCourse Id
int$useridOnly this user (optional)
int$groupidGet users from this group only
Return values
arraythe grades tables
Since
Moodle 2.9

◆ get_grades_table_parameters()

static gradereport_user\external\user::get_grades_table_parameters ( )
static

Describes the parameters for get_grades_table.

Return values
external_function_parameters
Since
Moodle 2.9

◆ get_grades_table_returns()

static gradereport_user\external\user::get_grades_table_returns ( )
static

Describes tget_grades_table return value.

Return values
external_single_structure
Since
Moodle 2.9

◆ get_report_data()

static gradereport_user\external\user::get_report_data ( stdClass $course,
stdClass $context,
?stdClass $user,
int $userid,
int $groupid,
bool $tabledata = true )
staticprotected

Get the report data.

Parameters
stdClass$coursecourse object
stdClass$contextcontext object
null | stdClass$useruser object (it can be null for all the users)
int$useridthe user to retrieve data from, 0 for all
int$groupidthe group id to filter
bool$tabledatawhether to get the table data (true) or the gradeitemdata
Return values
arraydata and possible warnings
Since
Moodle 3.2

◆ view_grade_report()

static gradereport_user\external\user::view_grade_report ( int $courseid,
int $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 2.9
Exceptions
moodle_exception

◆ view_grade_report_parameters()

static gradereport_user\external\user::view_grade_report_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 2.9

◆ view_grade_report_returns()

static gradereport_user\external\user::view_grade_report_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 2.9

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