core_group\external\get_groups_for_selector Class Reference

Inheritance diagram for core_group\external\get_groups_for_selector:

Static Public Member Functions
static	execute (int $courseid)
	Given a course ID find the existing user groups and map some fields to the returned array of group objects.
static	execute_parameters ()
	Returns description of method parameters.
static	execute_returns ()
	Returns description of what the group search for the widget should return.
static	group_description ()
	Create group return value description.

Detailed Description

License

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

Member Function Documentation

execute()

static core_group\external\get_groups_for_selector::execute ( int $courseid )

static

Given a course ID find the existing user groups and map some fields to the returned array of group objects.

Parameters

int

$courseid

Return values

array

Groups and warnings to pass back to the calling widget.

execute_parameters()

static core_group\external\get_groups_for_selector::execute_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

execute_returns()

static core_group\external\get_groups_for_selector::execute_returns ( )

static

Returns description of what the group search for the widget should return.

Return values

external_single_structure

group_description()

static core_group\external\get_groups_for_selector::group_description ( )

static

Create group return value description.

Return values

external_description

---

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

• group/classes/external/get_groups_for_selector.php