moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 08:56:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-12886 one more external group function, other minor fixes

Browse source
This commit is contained in:
skodak 2009-10-22 23:54:35 +00:00
parent f507217757
commit 246f6da2b8
6 changed files with 122 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

58
group/externallib.php
View file

@ -124,15 +124,14 @@ class moodle_group_external extends external_api {
}
/**
* Get groups definition
* Get groups definition specified by ids
* @param array $groupids arrays of group ids
* @return array of group objects (id, courseid, name, enrolmentkey)
*/
public static function get_groups($groupids) {
$groups = array();
$params = self::validate_parameters(self::get_groups_parameters(), array('groupids'=>$groupids));
$groups = array();
foreach ($params['groupids'] as $groupid) {
// validate params
$group = groups_get_group($groupid, 'id, courseid, name, description, enrolmentkey', MUST_EXIST);
@ -166,6 +165,59 @@ class moodle_group_external extends external_api {
);
}
/**
* Returns description of method parameters
* @return external_function_parameters
*/
public static function get_course_groups_parameters() {
return new external_function_parameters(
array(
'courseid' => new external_value(PARAM_INT, 'id of course'),
)
);
}
/**
* Get all groups in the specified course
* @param int $courseid id of course
* @return array of group objects (id, courseid, name, enrolmentkey)
*/
public static function get_course_groups($courseid) {
$params = self::validate_parameters(self::get_course_groups_parameters(), array('courseid'=>$courseid));
// now security checks
$context = get_context_instance(CONTEXT_COURSE, $params['courseid']);
self::validate_context($context);
require_capability('moodle/course:managegroups', $context);
$gs = groups_get_all_groups($params['courseid'], 0, 0, 'g.id, g.courseid, g.name, g.description, g.enrolmentkey');
$groups = array();
foreach ($gs as $group) {
$groups[] = (array)$group;
}
return $groups;
}
/**
* Returns description of method result value
* @return external_description
*/
public static function get_course_groups_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'group record id'),
'courseid' => new external_value(PARAM_INT, 'id of course'),
'name' => new external_value(PARAM_TEXT, 'multilang compatible name, course unique'),
'description' => new external_value(PARAM_RAW, 'group description text'),
'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
)
)
);
}
public static function delete_groups_parameters() {
//TODO
}