MDL-32662 Added get_course_groupings method
authorJuan Leyva <juanleyvadelgado@gmail.com>
Mon, 30 Apr 2012 14:53:53 +0000 (16:53 +0200)
committerJuan Leyva <juanleyvadelgado@gmail.com>
Thu, 10 May 2012 09:40:40 +0000 (11:40 +0200)
group/externallib.php

index cfe5cb0..be8be1d 100644 (file)
@@ -797,6 +797,76 @@ class core_group_external extends external_api {
         );
     }
 
+    /**
+     * Returns description of method parameters
+     * @return external_function_parameters
+     */
+    public static function get_course_groupings_parameters() {
+        return new external_function_parameters(
+            array(
+                'courseid' => new external_value(PARAM_INT, 'id of course'),
+            )
+        );
+    }
+
+    /**
+     * Get all groupings in the specified course
+     * @param int $courseid id of course
+     * @return array of grouping objects (id, courseid, name, enrolmentkey)
+     */
+    public static function get_course_groupings($courseid) {
+        global $CFG;
+        require_once("$CFG->dirroot/group/lib.php");
+
+        $params = self::validate_parameters(self::get_course_groupings_parameters(), array('courseid'=>$courseid));
+
+        // Now security checks.
+        $context = context_course::instance($params['courseid']);
+
+        try {
+            self::validate_context($context);
+        } catch (Exception $e) {
+                $exceptionparam = new stdClass();
+                $exceptionparam->message = $e->getMessage();
+                $exceptionparam->courseid = $params['courseid'];
+                throw new moodle_exception('errorcoursecontextnotvalid' , 'webservice', '', $exceptionparam);
+        }
+        require_capability('moodle/course:managegroups', $context);
+
+        $gs = groups_get_all_groupings($params['courseid']);
+
+        $groupings = array();
+        foreach ($gs as $grouping) {
+            $grouping->description = file_rewrite_pluginfile_urls($grouping->description, 'webservice/pluginfile.php', $context->id, 'grouping', 'description', $grouping->id);
+
+            $options = new stdClass;
+            $options->noclean = true;
+            $options->para = false;
+            $grouping->description = format_text($grouping->description, FORMAT_HTML, $options);
+
+            $groupings[] = (array)$grouping;
+        }
+
+        return $groupings;
+    }
+
+   /**
+     * Returns description of method result value
+     * @return external_description
+     */
+    public static function get_course_groupings_returns() {
+        return new external_multiple_structure(
+            new external_single_structure(
+                array(
+                    'id' => new external_value(PARAM_INT, 'grouping 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_CLEANHTML, 'grouping description text')
+                )
+            )
+        );
+    }
+
 }
 
 /**