core_group_external Class Reference

Inheritance diagram for core_group_external:

Static Public Member Functions
static	add_group_members ($members)
	Add group members. More...
static	add_group_members_parameters ()
	Returns description of method parameters. More...
static	add_group_members_returns ()
	Returns description of method result value. More...
static	assign_grouping ($assignments)
	Assign a group to a grouping. More...
static	assign_grouping_parameters ()
	Returns description of method parameters. More...
static	assign_grouping_returns ()
	Returns description of method result value. More...
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
static	create_groupings ($groupings)
	Create groupings. More...
static	create_groupings_parameters ()
	Returns description of method parameters. More...
static	create_groupings_returns ()
	Returns description of method result value. More...
static	create_groups ($groups)
	Create groups. More...
static	create_groups_parameters ()
	Returns description of method parameters. More...
static	create_groups_returns ()
	Returns description of method result value. More...
static	delete_group_members ($members)
	Delete group members. More...
static	delete_group_members_parameters ()
	Returns description of method parameters. More...
static	delete_group_members_returns ()
	Returns description of method result value. More...
static	delete_groupings ($groupingids)
	Delete groupings. More...
static	delete_groupings_parameters ()
	Returns description of method parameters. More...
static	delete_groupings_returns ()
	Returns description of method result value. More...
static	delete_groups ($groupids)
	Delete groups. More...
static	delete_groups_parameters ()
	Returns description of method parameters. More...
static	delete_groups_returns ()
	Returns description of method result value. More...
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	get_activity_allowed_groups ($cmid, $userid=0)
	Gets a list of groups that the user is allowed to access within the specified activity. More...
static	get_activity_allowed_groups_parameters ()
	Returns description of method parameters. More...
static	get_activity_allowed_groups_returns ()
	Returns description of method result value. More...
static	get_activity_groupmode ($cmid)
	Returns effective groupmode used in a given activity. More...
static	get_activity_groupmode_parameters ()
	Returns description of method parameters. More...
static	get_activity_groupmode_returns ()
	Returns description of method result value. More...
static	get_course_groupings ($courseid)
	Get all groupings in the specified course. More...
static	get_course_groupings_parameters ()
	Returns description of method parameters. More...
static	get_course_groupings_returns ()
	Returns description of method result value. More...
static	get_course_groups ($courseid)
	Get all groups in the specified course. More...
static	get_course_groups_parameters ()
	Returns description of method parameters. More...
static	get_course_groups_returns ()
	Returns description of method result value. More...
static	get_course_user_groups ($courseid=0, $userid=0, $groupingid=0)
	Get all groups in the specified course for the specified user. More...
static	get_course_user_groups_parameters ()
	Returns description of method parameters. More...
static	get_course_user_groups_returns ()
	Returns description of method result value. More...
static	get_group_members ($groupids)
	Return all members for a group. More...
static	get_group_members_parameters ()
	Returns description of method parameters. More...
static	get_group_members_returns ()
	Returns description of method result value. More...
static	get_groupings ($groupingids, $returngroups=false)
	Get groupings definition specified by ids. More...
static	get_groupings_parameters ()
	Returns description of method parameters. More...
static	get_groupings_returns ()
	Returns description of method result value. More...
static	get_groups ($groupids)
	Get groups definition specified by ids. More...
static	get_groups_parameters ()
	Returns description of method parameters. More...
static	get_groups_returns ()
	Returns description of method result value. More...
static	group_description ()
	Create group return value description. More...
static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...
static	unassign_grouping ($unassignments)
	Unassign a group from a grouping. More...
static	unassign_grouping_parameters ()
	Returns description of method parameters. More...
static	unassign_grouping_returns ()
	Returns description of method result value. More...
static	update_groupings ($groupings)
	Update groupings. More...
static	update_groupings_parameters ()
	Returns description of method parameters. More...
static	update_groupings_returns ()
	Returns description of method result value. More...
static	update_groups ($groups)
	Update groups. More...
static	update_groups_parameters ()
	Returns description of method parameters. More...
static	update_groups_returns ()
	Returns description of method result value. More...
static	validate_context ($context)
	Makes sure user may execute functions in this context. More...
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters. More...
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

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

call_external_function()

static external_api::call_external_function (   $function,   $args,   $ajaxonly = false  )

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array

containing keys for error (bool), exception and data.

clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,   $response  )

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed

response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author

2010 Jerome Mouneyrac

Since

Moodle 2.0

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

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

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

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

external_function_info()

static external_api::external_function_info (   $function,   $strictness = MUST_EXIST  )

staticinherited

Returns detailed function information.

Parameters

string | object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

description or false if not found or exception thrown

Since

Moodle 2.0

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

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

external_description

Since

Moodle 3.0

get_context_from_params()

static external_api::get_context_from_params (   $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array

$param

Since

Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in core_competency\external, and tool_lp\external.

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

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

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

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

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

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

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

set_context_restriction()

static external_api::set_context_restriction (   $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass

$context

the context restriction

Since

Moodle 2.0

set_timeout()

static external_api::set_timeout (   $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int

$seconds

max expected time the next operation needs

Since

Moodle 2.0

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

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_context()

static external_api::validate_context (   $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass

$context

Since

Moodle 2.0

validate_parameters()

static external_api::validate_parameters ( external_description  $description,   $params  )

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed

params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since

Moodle 2.0

---

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

• group/externallib.php