core_group_external Class Reference

Group external functions. More...

Inheritance diagram for core_group_external:

Static Public Member Functions
static	add_group_members ($members)
	Add group members.
static	add_group_members_parameters ()
	Returns description of method parameters.
static	add_group_members_returns ()
	Returns description of method result value.
static	assign_grouping ($assignments)
	Assign a group to a grouping.
static	assign_grouping_parameters ()
	Returns description of method parameters.
static	assign_grouping_returns ()
	Returns description of method result value.
static	create_groupings ($groupings)
	Create groupings.
static	create_groupings_parameters ()
	Returns description of method parameters.
static	create_groupings_returns ()
	Returns description of method result value.
static	create_groups ($groups)
	Create groups.
static	create_groups_parameters ()
	Returns description of method parameters.
static	create_groups_returns ()
	Returns description of method result value.
static	delete_group_members ($members)
	Delete group members.
static	delete_group_members_parameters ()
	Returns description of method parameters.
static	delete_group_members_returns ()
	Returns description of method result value.
static	delete_groupings ($groupingids)
	Delete groupings.
static	delete_groupings_parameters ()
	Returns description of method parameters.
static	delete_groupings_returns ()
	Returns description of method result value.
static	delete_groups ($groupids)
	Delete groups.
static	delete_groups_parameters ()
	Returns description of method parameters.
static	delete_groups_returns ()
	Returns description of method result value.
static	get_activity_allowed_groups ($cmid, $userid=0)
	Gets a list of groups that the user is allowed to access within the specified activity.
static	get_activity_allowed_groups_parameters ()
	Returns description of method parameters.
static	get_activity_allowed_groups_returns ()
	Returns description of method result value.
static	get_activity_groupmode ($cmid)
	Returns effective groupmode used in a given activity.
static	get_activity_groupmode_parameters ()
	Returns description of method parameters.
static	get_activity_groupmode_returns ()
	Returns description of method result value.
static	get_course_groupings ($courseid)
	Get all groupings in the specified course.
static	get_course_groupings_parameters ()
	Returns description of method parameters.
static	get_course_groupings_returns ()
	Returns description of method result value.
static	get_course_groups ($courseid)
	Get all groups in the specified course.
static	get_course_groups_parameters ()
	Returns description of method parameters.
static	get_course_groups_returns ()
	Returns description of method result value.
static	get_course_user_groups ($courseid=0, $userid=0, $groupingid=0)
	Get all groups in the specified course for the specified user.
static	get_course_user_groups_parameters ()
	Returns description of method parameters.
static	get_course_user_groups_returns ()
	Returns description of method result value.
static	get_group_members ($groupids)
	Return all members for a group.
static	get_group_members_parameters ()
	Returns description of method parameters.
static	get_group_members_returns ()
	Returns description of method result value.
static	get_groupings ($groupingids, $returngroups=false)
	Get groupings definition specified by ids.
static	get_groupings_parameters ()
	Returns description of method parameters.
static	get_groupings_returns ()
	Returns description of method result value.
static	get_groups ($groupids)
	Get groups definition specified by ids.
static	get_groups_parameters ()
	Returns description of method parameters.
static	get_groups_returns ()
	Returns description of method result value.
static	group_description ()
	Create group return value description.
static	unassign_grouping ($unassignments)
	Unassign a group from a grouping.
static	unassign_grouping_parameters ()
	Returns description of method parameters.
static	unassign_grouping_returns ()
	Returns description of method result value.
static	update_groupings ($groupings)
	Update groupings.
static	update_groupings_parameters ()
	Returns description of method parameters.
static	update_groupings_returns ()
	Returns description of method result value.
static	update_groups ($groups)
	Update groups.
static	update_groups_parameters ()
	Returns description of method parameters.
static	update_groups_returns ()
	Returns description of method result value.

Static Protected Member Functions
static	build_custom_field_name (string $shortname)
	Builds a suitable name of a custom field for a custom field handler based on provided shortname.
static	build_custom_fields_parameters_structure ()
	Builds a structure for custom fields parameters.
static	build_custom_fields_returns_structure ()
	Builds a structure for custom fields returns.
static	validate_visibility (int $visibility)
	Validate visibility.

Detailed Description

Group external functions.

Copyright

2011 Jerome Mouneyrac

License

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

Since

Moodle 2.2

Member Function Documentation

add_group_members()

static core_group_external::add_group_members ( $members )

static

Add group members.

Parameters

array

$members

of arrays with keys userid, groupid

Since

Moodle 2.2

add_group_members_parameters()

static core_group_external::add_group_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

add_group_members_returns()

static core_group_external::add_group_members_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.2

assign_grouping()

static core_group_external::assign_grouping ( $assignments )

static

Assign a group to a grouping.

Parameters

array

$assignments

of arrays with keys groupid, groupingid

Return values

void

Since

Moodle 2.3

assign_grouping_parameters()

static core_group_external::assign_grouping_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

assign_grouping_returns()

static core_group_external::assign_grouping_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.3

build_custom_field_name()

static core_group_external::build_custom_field_name ( string $shortname )

staticprotected

Builds a suitable name of a custom field for a custom field handler based on provided shortname.

Parameters

string

$shortname

shortname to use.

Return values

string

build_custom_fields_parameters_structure()

static core_group_external::build_custom_fields_parameters_structure ( )

staticprotected

Builds a structure for custom fields parameters.

Return values

core_external\external_multiple_structure

build_custom_fields_returns_structure()

static core_group_external::build_custom_fields_returns_structure ( )

staticprotected

Builds a structure for custom fields returns.

Return values

core_external\external_multiple_structure

create_groupings()

static core_group_external::create_groupings ( $groupings )

static

Create groupings.

Parameters

array

$groupings

array of grouping description arrays (with keys groupname and courseid)

Return values

array

of newly created groupings

Since

Moodle 2.3

create_groupings_parameters()

static core_group_external::create_groupings_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

create_groupings_returns()

static core_group_external::create_groupings_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.3

create_groups()

static core_group_external::create_groups ( $groups )

static

Create groups.

Parameters

array

$groups

array of group description arrays (with keys groupname and courseid)

Return values

array

of newly created groups

Since

Moodle 2.2

create_groups_parameters()

static core_group_external::create_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

create_groups_returns()

static core_group_external::create_groups_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.2

delete_group_members()

static core_group_external::delete_group_members ( $members )

static

Delete group members.

Parameters

array

$members

of arrays with keys userid, groupid

Since

Moodle 2.2

delete_group_members_parameters()

static core_group_external::delete_group_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

delete_group_members_returns()

static core_group_external::delete_group_members_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.2

delete_groupings()

static core_group_external::delete_groupings ( $groupingids )

static

Delete groupings.

Parameters

array

$groupingids

array of grouping ids

Return values

void

Since

Moodle 2.3

delete_groupings_parameters()

static core_group_external::delete_groupings_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

delete_groupings_returns()

static core_group_external::delete_groupings_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.3

delete_groups()

static core_group_external::delete_groups ( $groupids )

static

Delete groups.

Parameters

array

$groupids

array of group ids

Since

Moodle 2.2

delete_groups_parameters()

static core_group_external::delete_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

delete_groups_returns()

static core_group_external::delete_groups_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.2

get_activity_allowed_groups()

static core_group_external::get_activity_allowed_groups ( $cmid, $userid = 0 )

static

Gets a list of groups that the user is allowed to access within the specified activity.

Exceptions

moodle_exception

Parameters

int	$cmid	course module id
int	$userid	id of user.

Return values

array

of group objects (id, name, description, format) and possible warnings.

Since

Moodle 3.0

get_activity_allowed_groups_parameters()

static core_group_external::get_activity_allowed_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

get_activity_allowed_groups_returns()

static core_group_external::get_activity_allowed_groups_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

A single structure containing groups and possible warnings.

Since

Moodle 3.0

get_activity_groupmode()

static core_group_external::get_activity_groupmode ( $cmid )

static

Returns effective groupmode used in a given activity.

Exceptions

moodle_exception

Parameters

int

$cmid

course module id.

Return values

array

containing the group mode and possible warnings.

Since

Moodle 3.0

Exceptions

moodle_exception

get_activity_groupmode_parameters()

static core_group_external::get_activity_groupmode_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

get_activity_groupmode_returns()

static core_group_external::get_activity_groupmode_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 3.0

get_course_groupings()

static core_group_external::get_course_groupings ( $courseid )

static

Get all groupings in the specified course.

Parameters

int

$courseid

id of course

Return values

array

of grouping objects (id, courseid, name, enrolmentkey)

Since

Moodle 2.3

get_course_groupings_parameters()

static core_group_external::get_course_groupings_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

get_course_groupings_returns()

static core_group_external::get_course_groupings_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.3

get_course_groups()

static core_group_external::get_course_groups ( $courseid )

static

Get all groups in the specified course.

Parameters

int

$courseid

id of course

Return values

array

of group objects (id, courseid, name, enrolmentkey)

Since

Moodle 2.2

get_course_groups_parameters()

static core_group_external::get_course_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

get_course_groups_returns()

static core_group_external::get_course_groups_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.2

get_course_user_groups()

static core_group_external::get_course_user_groups ( $courseid = 0, $userid = 0, $groupingid = 0 )

static

Get all groups in the specified course for the specified user.

Exceptions

moodle_exception

Parameters

int	$courseid	id of course.
int	$userid	id of user.
int	$groupingid	optional returns only groups in the specified grouping.

Return values

array

of group objects (id, name, description, format) and possible warnings.

Since

Moodle 2.9

get_course_user_groups_parameters()

static core_group_external::get_course_user_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.9

get_course_user_groups_returns()

static core_group_external::get_course_user_groups_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

A single structure containing groups and possible warnings.

Since

Moodle 2.9

get_group_members()

static core_group_external::get_group_members ( $groupids )

static

Return all members for a group.

Parameters

array

$groupids

array of group ids

Return values

array

with group id keys containing arrays of user ids

Since

Moodle 2.2

get_group_members_parameters()

static core_group_external::get_group_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

get_group_members_returns()

static core_group_external::get_group_members_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.2

get_groupings()

static core_group_external::get_groupings ( $groupingids, $returngroups = false )

static

Get groupings definition specified by ids.

Parameters

array	$groupingids	arrays of grouping ids
boolean	$returngroups	return the associated groups if true. The default is false.

Return values

array

of grouping objects (id, courseid, name)

Since

Moodle 2.3

get_groupings_parameters()

static core_group_external::get_groupings_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

get_groupings_returns()

static core_group_external::get_groupings_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.3

get_groups()

static core_group_external::get_groups ( $groupids )

static

Get groups definition specified by ids.

Parameters

array

$groupids

arrays of group ids

Return values

array

of group objects (id, courseid, name, enrolmentkey)

Since

Moodle 2.2

get_groups_parameters()

static core_group_external::get_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

get_groups_returns()

static core_group_external::get_groups_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.2

group_description()

static core_group_external::group_description ( )

static

Create group return value description.

Return values

external_single_structure

The group description

unassign_grouping()

static core_group_external::unassign_grouping ( $unassignments )

static

Unassign a group from a grouping.

Parameters

array

$unassignments

of arrays with keys groupid, groupingid

Return values

void

Since

Moodle 2.3

unassign_grouping_parameters()

static core_group_external::unassign_grouping_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

unassign_grouping_returns()

static core_group_external::unassign_grouping_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.3

update_groupings()

static core_group_external::update_groupings ( $groupings )

static

Update groupings.

Parameters

array

$groupings

array of grouping description arrays (with keys groupname and courseid)

Return values

array

of newly updated groupings

Since

Moodle 2.3

update_groupings_parameters()

static core_group_external::update_groupings_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.3

update_groupings_returns()

static core_group_external::update_groupings_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 2.3

update_groups()

static core_group_external::update_groups ( $groups )

static

Update groups.

Parameters

array

$groups

Return values

null

Since

Moodle 3.6

update_groups_parameters()

static core_group_external::update_groups_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.6

update_groups_returns()

static core_group_external::update_groups_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 3.6

validate_visibility()

static core_group_external::validate_visibility ( int $visibility )

staticprotected

Validate visibility.

Parameters

int

$visibility

Visibility string, must one of the visibility class constants.

Exceptions

invalid_parameter_exception

if visibility is not an allowed value.

---

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

• group/externallib.php