Search moodle.org's
Developer Documentation


External groups API

Copyright: 2009 Petr Skodak
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 1430 lines (53 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

core_group_external:: (42 methods):
  create_groups_parameters()
  create_groups()
  create_groups_returns()
  get_groups_parameters()
  get_groups()
  get_groups_returns()
  get_course_groups_parameters()
  get_course_groups()
  get_course_groups_returns()
  delete_groups_parameters()
  delete_groups()
  delete_groups_returns()
  get_group_members_parameters()
  get_group_members()
  get_group_members_returns()
  add_group_members_parameters()
  add_group_members()
  add_group_members_returns()
  delete_group_members_parameters()
  delete_group_members()
  delete_group_members_returns()
  create_groupings_parameters()
  create_groupings()
  create_groupings_returns()
  update_groupings_parameters()
  update_groupings()
  update_groupings_returns()
  get_groupings_parameters()
  get_groupings()
  get_groupings_returns()
  get_course_groupings_parameters()
  get_course_groupings()
  get_course_groupings_returns()
  delete_groupings_parameters()
  delete_groupings()
  delete_groupings_returns()
  assign_grouping_parameters()
  assign_grouping()
  assign_grouping_returns()
  unassign_grouping_parameters()
  unassign_grouping()
  unassign_grouping_returns()

moodle_group_external:: (21 methods):
  create_groups_parameters()
  create_groups()
  create_groups_returns()
  get_groups_parameters()
  get_groups()
  get_groups_returns()
  get_course_groups_parameters()
  get_course_groups()
  get_course_groups_returns()
  delete_groups_parameters()
  delete_groups()
  delete_groups_returns()
  get_groupmembers_parameters()
  get_groupmembers()
  get_groupmembers_returns()
  add_groupmembers_parameters()
  add_groupmembers()
  add_groupmembers_returns()
  delete_groupmembers_parameters()
  delete_groupmembers()
  delete_groupmembers_returns()


Class: core_group_external  - X-Ref

Group external functions

create_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

create_groups($groups)   X-Ref
Create groups

return: array of newly created groups
param: array $groups array of group description arrays (with keys groupname and courseid)

create_groups_returns()   X-Ref
Returns description of method result value

return: external_description

get_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_groups($groupids)   X-Ref
Get groups definition specified by ids

return: array of group objects (id, courseid, name, enrolmentkey)
param: array $groupids arrays of group ids

get_groups_returns()   X-Ref
Returns description of method result value

return: external_description

get_course_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_course_groups($courseid)   X-Ref
Get all groups in the specified course

return: array of group objects (id, courseid, name, enrolmentkey)
param: int $courseid id of course

get_course_groups_returns()   X-Ref
Returns description of method result value

return: external_description

delete_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_groups($groupids)   X-Ref
Delete groups

param: array $groupids array of group ids

delete_groups_returns()   X-Ref
Returns description of method result value

return: null

get_group_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_group_members($groupids)   X-Ref
Return all members for a group

return: array with  group id keys containing arrays of user ids
param: array $groupids array of group ids

get_group_members_returns()   X-Ref
Returns description of method result value

return: external_description

add_group_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

add_group_members($members)   X-Ref
Add group members

param: array $members of arrays with keys userid, groupid

add_group_members_returns()   X-Ref
Returns description of method result value

return: null

delete_group_members_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_group_members($members)   X-Ref
Delete group members

param: array $members of arrays with keys userid, groupid

delete_group_members_returns()   X-Ref
Returns description of method result value

return: null

create_groupings_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

create_groupings($groupings)   X-Ref
Create groupings

return: array of newly created groupings
param: array $groupings array of grouping description arrays (with keys groupname and courseid)

create_groupings_returns()   X-Ref
Returns description of method result value

return: external_description

update_groupings_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

update_groupings($groupings)   X-Ref
Update groupings

return: array of newly updated groupings
param: array $groupings array of grouping description arrays (with keys groupname and courseid)

update_groupings_returns()   X-Ref
Returns description of method result value

return: external_description

get_groupings_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_groupings($groupingids, $returngroups = false)   X-Ref
Get groupings definition specified by ids

return: array of grouping objects (id, courseid, name)
param: array $groupingids arrays of grouping ids
param: boolean $returngroups return the associated groups if true. The default is false.

get_groupings_returns()   X-Ref
Returns description of method result value

return: external_description

get_course_groupings_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_course_groupings($courseid)   X-Ref
Get all groupings in the specified course

return: array of grouping objects (id, courseid, name, enrolmentkey)
param: int $courseid id of course

get_course_groupings_returns()   X-Ref
Returns description of method result value

return: external_description

delete_groupings_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_groupings($groupingids)   X-Ref
Delete groupings

return: void
param: array $groupingids array of grouping ids

delete_groupings_returns()   X-Ref
Returns description of method result value

return: external_description

assign_grouping_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

assign_grouping($assignments)   X-Ref
Assign a group to a grouping

return: void
param: array $assignments of arrays with keys groupid, groupingid

assign_grouping_returns()   X-Ref
Returns description of method result value

return: null

unassign_grouping_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

unassign_grouping($unassignments)   X-Ref
Unassign a group from a grouping

return: void
param: array $unassignments of arrays with keys groupid, groupingid

unassign_grouping_returns()   X-Ref
Returns description of method result value

return: null

Class: moodle_group_external  - X-Ref

Deprecated group external functions

create_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

create_groups($groups)   X-Ref
Create groups

return: array of newly created groups
param: array $groups array of group description arrays (with keys groupname and courseid)

create_groups_returns()   X-Ref
Returns description of method result value

return: external_description

get_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_groups($groupids)   X-Ref
Get groups definition specified by ids

return: array of group objects (id, courseid, name, enrolmentkey)
param: array $groupids arrays of group ids

get_groups_returns()   X-Ref
Returns description of method result value

return: external_description

get_course_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_course_groups($courseid)   X-Ref
Get all groups in the specified course

return: array of group objects (id, courseid, name, enrolmentkey)
param: int $courseid id of course

get_course_groups_returns()   X-Ref
Returns description of method result value

return: external_description

delete_groups_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_groups($groupids)   X-Ref
Delete groups

param: array $groupids array of group ids

delete_groups_returns()   X-Ref
Returns description of method result value

return: null

get_groupmembers_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

get_groupmembers($groupids)   X-Ref
Return all members for a group

return: array with  group id keys containing arrays of user ids
param: array $groupids array of group ids

get_groupmembers_returns()   X-Ref
Returns description of method result value

return: external_description

add_groupmembers_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

add_groupmembers($members)   X-Ref
Add group members

param: array $members of arrays with keys userid, groupid

add_groupmembers_returns()   X-Ref
Returns description of method result value

return: external_description

delete_groupmembers_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

delete_groupmembers($members)   X-Ref
Delete group members

param: array $members of arrays with keys userid, groupid

delete_groupmembers_returns()   X-Ref
Returns description of method result value

return: external_description

Search This Site: