Moodle  2.2.1
http://www.collinsharper.com
moodle_group_external Class Reference
Inheritance diagram for moodle_group_external:
Collaboration diagram for moodle_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_groupmembers_parameters ()
static get_groupmembers ($groupids)
static get_groupmembers_returns ()
static add_groupmembers_parameters ()
static add_groupmembers ($members)
static add_groupmembers_returns ()
static delete_groupmembers_parameters ()
static delete_groupmembers ($members)
static delete_groupmembers_returns ()

Detailed Description

Deprecated group functions

Deprecated:
since Moodle 2.2 please use core_group_external instead

Definition at line 514 of file externallib.php.


Member Function Documentation

static add_groupmembers ( members) [static]

Add group members

Deprecated:
since Moodle 2.2 please use core_group_external::add_group_members instead
Parameters:
array$membersof arrays with keys userid, groupid
Returns:
void

Definition at line 673 of file externallib.php.

Here is the call graph for this function:

static add_groupmembers_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::add_group_members_parameters instead
Returns:
external_function_parameters

Definition at line 663 of file externallib.php.

Here is the call graph for this function:

static add_groupmembers_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::add_group_members_returns instead
Returns:
external_description

Definition at line 682 of file externallib.php.

Here is the call graph for this function:

static create_groups ( groups) [static]

Create groups

Deprecated:
since Moodle 2.2 please use core_group_external::create_groups instead
Parameters:
array$groupsarray of group description arrays (with keys groupname and courseid)
Returns:
array of newly created groups

Definition at line 531 of file externallib.php.

static create_groups_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::create_groups_parameters instead
Returns:
external_function_parameters

Definition at line 521 of file externallib.php.

static create_groups_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::create_groups_returns instead
Returns:
external_description

Definition at line 540 of file externallib.php.

static delete_groupmembers ( members) [static]

Delete group members

Deprecated:
since Moodle 2.2 please use core_group_external::delete_group_members instead
Parameters:
array$membersof arrays with keys userid, groupid
Returns:
void

Definition at line 702 of file externallib.php.

Here is the call graph for this function:

static delete_groupmembers_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::delete_group_members_parameters instead
Returns:
external_function_parameters

Definition at line 692 of file externallib.php.

Here is the call graph for this function:

static delete_groupmembers_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::delete_group_members_returns instead
Returns:
external_description

Definition at line 711 of file externallib.php.

Here is the call graph for this function:

static delete_groups ( groupids) [static]

Delete groups

Deprecated:
since Moodle 2.2 please use core_group_external::delete_groups instead
Parameters:
array$groupidsarray of group ids
Returns:
void

Definition at line 615 of file externallib.php.

static delete_groups_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::delete_group_members_parameters instead
Returns:
external_function_parameters

Definition at line 605 of file externallib.php.

Here is the call graph for this function:

static delete_groups_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::delete_group_members_returns instead
Returns:
external_description

Definition at line 624 of file externallib.php.

Here is the call graph for this function:

static get_course_groups ( courseid) [static]

Get all groups in the specified course

Deprecated:
since Moodle 2.2 please use core_group_external::get_course_groups instead
Parameters:
int$courseidid of course
Returns:
array of group objects (id, courseid, name, enrolmentkey)

Definition at line 587 of file externallib.php.

static get_course_groups_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::get_course_groups_parameters instead
Returns:
external_function_parameters

Definition at line 577 of file externallib.php.

static get_course_groups_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::get_course_groups_returns instead
Returns:
external_description

Definition at line 596 of file externallib.php.

static get_groupmembers ( groupids) [static]

Return all members for a group

Deprecated:
since Moodle 2.2 please use core_group_external::get_group_members instead
Parameters:
array$groupidsarray of group ids
Returns:
array with group id keys containing arrays of user ids

Definition at line 644 of file externallib.php.

Here is the call graph for this function:

static get_groupmembers_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::get_group_members_parameters instead
Returns:
external_function_parameters

Definition at line 634 of file externallib.php.

Here is the call graph for this function:

static get_groupmembers_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::get_group_members_returns instead
Returns:
external_description

Definition at line 653 of file externallib.php.

Here is the call graph for this function:

static get_groups ( groupids) [static]

Get groups definition specified by ids

Deprecated:
since Moodle 2.2 please use core_group_external::get_groups instead
Parameters:
array$groupidsarrays of group ids
Returns:
array of group objects (id, courseid, name, enrolmentkey)

Definition at line 559 of file externallib.php.

static get_groups_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_group_external::get_groups_parameters instead
Returns:
external_function_parameters

Definition at line 549 of file externallib.php.

static get_groups_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_group_external::get_groups_returns instead
Returns:
external_description

Definition at line 568 of file externallib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations