core_group_external Class Reference

Inheritance diagram for core_group_external:

Collaboration diagram for core_group_external:

Static Public Member Functions
static	create_groups_parameters ()
static	create_groups ($groups)
static	create_groups_returns ()
static	get_groups_parameters ()
static	get_groups ($groupids)
static	get_groups_returns ()
static	get_course_groups_parameters ()
static	get_course_groups ($courseid)
static	get_course_groups_returns ()
static	delete_groups_parameters ()
static	delete_groups ($groupids)
static	delete_groups_returns ()
static	get_group_members_parameters ()
static	get_group_members ($groupids)
static	get_group_members_returns ()
static	add_group_members_parameters ()
static	add_group_members ($members)
static	add_group_members_returns ()
static	delete_group_members_parameters ()
static	delete_group_members ($members)
static	delete_group_members_returns ()

---

Detailed Description

Group functions

Definition at line 32 of file externallib.php.

---

Member Function Documentation

static add_group_members

(

$

members

)

[static]

Add group members

Parameters:

array

$members

of arrays with keys userid, groupid

Returns:

void

Definition at line 392 of file externallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static add_group_members_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 372 of file externallib.php.

Here is the caller graph for this function:

static add_group_members_returns

(

)

[static]

Returns description of method result value

Returns:

null

Definition at line 436 of file externallib.php.

Here is the caller graph for this function:

static create_groups

(

$

groups

)

[static]

Create groups

Parameters:

array

$groups

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

Returns:

array of newly created groups

Definition at line 60 of file externallib.php.

Here is the call graph for this function:

static create_groups_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 38 of file externallib.php.

static create_groups_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 107 of file externallib.php.

static delete_group_members

(

$

members

)

[static]

Delete group members

Parameters:

array

$members

of arrays with keys userid, groupid

Returns:

void

Definition at line 465 of file externallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static delete_group_members_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 445 of file externallib.php.

Here is the caller graph for this function:

static delete_group_members_returns

(

)

[static]

Returns description of method result value

Returns:

null

Definition at line 504 of file externallib.php.

Here is the caller graph for this function:

static delete_groups

(

$

groupids

)

[static]

Delete groups

Parameters:

array

$groupids

array of group ids

Returns:

void

Definition at line 262 of file externallib.php.

Here is the call graph for this function:

static delete_groups_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 249 of file externallib.php.

static delete_groups_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 301 of file externallib.php.

static get_course_groups

(

$

courseid

)

[static]

Get all groups in the specified course

Parameters:

int

$courseid

id of course

Returns:

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

Definition at line 201 of file externallib.php.

Here is the call graph for this function:

static get_course_groups_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 188 of file externallib.php.

static get_course_groups_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 231 of file externallib.php.

static get_group_members

(

$

groupids

)

[static]

Return all members for a group

Parameters:

array

$groupids

array of group ids

Returns:

array with group id keys containing arrays of user ids

Definition at line 323 of file externallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static get_group_members_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 310 of file externallib.php.

Here is the caller graph for this function:

static get_group_members_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 356 of file externallib.php.

Here is the caller graph for this function:

static get_groups

(

$

groupids

)

[static]

Get groups definition specified by ids

Parameters:

array

$groupids

arrays of group ids

Returns:

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

Definition at line 139 of file externallib.php.

Here is the call graph for this function:

static get_groups_parameters

(

)

[static]

Returns description of method parameters

Returns:

external_function_parameters

Definition at line 125 of file externallib.php.

static get_groups_returns

(

)

[static]

Returns description of method result value

Returns:

external_description

Definition at line 170 of file externallib.php.

---

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

• C:/xampp/htdocs/moodle/group/externallib.php