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

Static Public Member Functions

static execute (int $courseid, ?int $groupid=0, bool $onlyactive=false)
 Given a course ID find the gradable users within a group.
 
static execute_parameters ()
 Returns description of method parameters.
 
static execute_returns ()
 Returns description of method result value.
 

Member Function Documentation

◆ execute()

static core_grades\external\get_gradable_users::execute ( int $courseid,
?int $groupid = 0,
bool $onlyactive = false )
static

Given a course ID find the gradable users within a group.

Parameters
int$courseidCourse ID
int | null$groupidGroup ID
bool$onlyactiveWhether we should only return active enrolments.
Return values
arrayUsers and warnings.
Exceptions
coding_exception
invalid_parameter_exception
moodle_exception
restricted_context_exception

◆ execute_parameters()

static core_grades\external\get_gradable_users::execute_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters

◆ execute_returns()

static core_grades\external\get_gradable_users::execute_returns ( )
static

Returns description of method result value.

Return values
external_single_structure

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